DynamicVariable in Scala

scala.util.DynamicVariable,这个类有点类似于 java 里面 ThreadLocal,适合用来保存和传递上下文(Context)相关的信息。

Scala 的官方文档 是这么介绍的:

DynamicVariables 提供了一种绑定机制,即变量的当前值是通过动态范围来查找的,但是对变量自身的访问是在静态范围里的。

这句话看着挺抽象的。简单的说,就和类名的含义一致,变量的值是动态获取的。使用 value 方法可以获取到当前的值。通过 withValue 方法设置新的值,但是这个新设置的值只有在 withValue 方法的第二个参数,一个无参数的闭包,执行的时候时候有效。一旦第二个参数执行完毕后,变量的值重新回到以前。类似于一个栈。

1
2
3
4
5
6
7
8
9
val hello = new DynamicVariable[String]("hello")
println(hello.value)
//hello
hello.withValue("world") {
println(hello.value)
}
//world
println(hello.value)
//hello

Each thread gets its own stack of bindings. When a new thread is created, the DynamicVariable gets a copy of the stack of bindings from the parent thread, and from then on the bindings for the new thread are independent of those for the original thread.

withValue 中创建一个新的线程,该线程从 DynamicVariable 中取出当前绑定的值,此后该值和父线程里面的绑定值就再无关联了。

实际上,从 DynamicVariable 的源码来看,就是基于 InheritableThreadLocal 实现的。代码也并不复杂:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class DynamicVariable[T](init: T) {
private val tl = new InheritableThreadLocal[T] {
override def initialValue = init.asInstanceOf[T with AnyRef]
}

/** Retrieve the current value */
def value: T = tl.get.asInstanceOf[T]

/** Set the value of the variable while executing the specified
* thunk.
*
* @param newval The value to which to set the variable
* @param thunk The code to evaluate under the new setting
*/
def withValue[S](newval: T)(thunk: => S): S = {
val oldval = value
tl set newval

try thunk
finally tl set oldval
}

/** Change the currently bound value, discarding the old value.
* Usually withValue() gives better semantics.
*/
def value_=(newval: T) = tl set newval

override def toString: String = "DynamicVariable(" + value + ")"
}

这个问题很好地说明了我们应该怎么用 DynamicVariable

It’s a non-intrusive way to store and pass around context(thread)-specific information.

其中一个答案里提到 Concole.println 这个方法的实现,很有意思。

  • println()Console.println()
  • Console.println()基于 DynamicVariable[PrintStream], 默认值是 java.lang.System.out
  • Console 提供了一个 withOut,实际上就是对内部动态变量的 withValue 方法的封装
1
2
3
4
def noisy() { println("robot human robot human") }
noisy() // prints to stdout
val ps = new java.io.PrintStream("/tmp/mylog")
scala.Console.withOut(ps) { noisy() } // output now goes to /tmp/mylog file

参考