[续]使用 Scala Macro Annotation 实现配置项绑定

v0.1.2

续 上篇, 因 @连城404 的转发原文:

@连城404:颇有趣，有可能把 @conf val port = 0 中的 "= 0" 去掉换成现实的类型说明吗？即 @conf port: Int 这个赋值在此处彻底没有实际意义，更像是实现限制而引入的噪声。

class Server {
  @conf val port = 0 
  //  上面的赋值闲得多余, 能够写成:
  // @conf val port: Int
}

确实没有必要, 但意义仍是有的: IDE 不会报错. (至少我用的IDEA 14 的 scala plugin 还不支持 Scala Macro)

那 = 0 能够去掉吗?

答案是能够, 只是在被 @连城404 问到的时候我尚未想到办法.

解决办法方法其实不难, 前提是要对 Scala AST 很熟悉.

经查:

case class ValDef(mods: Modifiers, name: TermName, tpt: Tree, rhs: Tree)

Modifiers 中有个 flags 属性, 其中标记了val port 的各类特征.

那么 val port: Int 和 val port = 0 之间的区别则能够从 flags 中体现出来.

class ModifierFlags {
  final val DEFERRED      = 1 << 4        // was `abstract' for members | trait is virtual
  final val DEFAULTINIT   = 1L << 41      // symbol is initialized to the default value: used by -Xcheckinit

  ...
}

ModifierFlags 里定义了全部的 flags 值, 这里摘录其中两个枚举则对应上面两种不一样的写法.

具体实现的代码的提交, 请见0475d92c.

如何发现这些细节 ?

• print(x), 探查未知对象的展示信息, 多半可以提供重要线索;
• print(x.getClass), 上面的办法无论用, 则须要查明它的类型, 而后去翻源码了.

v0.2.0

上面 v0.1.x 是一种基于ValDef 的声明风格, 实际使用的时候会发现:

编写简单的同时, 代价是类名定义要与配置路径要严格一致, 这并不是适合全部场景

好比写个 Kafka 的消费客户端, 要为它设计其访问服务的配置项

kafka_broker {
  host = 10.0.0.1
  port = 12306
}

此时, 对应的类名就要是KafkaBroker, 这显然违背了设计意图, 像 KafkaConsumer 才是最为天然的选择.

与其大量时间纠结于命名上, 不如换个更好的声明方式.

让 @conf 带参数能够更改默认配置项路径 :

class KafkaConsumer {
  @conf("kafka_broker.host") val host: String
}

嗯, 不错, 可以解决问题. 只是以为像绕了一圈又回去了的感受:

class KafkaConsumer {
  val host = conf.getString("kafka_broker.host")
}

对比这两种写法, 前者彷佛没什么优点了.

回顾用 Macro Annotation 解决配置项绑定的初衷, 是但愿 将代码的元信息与配置项创建映射关系, 减小因中间字符串的 Hard Code 为重构带来的额外成本.

为此, 另外一种写法诞生了, 它是受这篇 Adding Reflection to Scala Macros 的启发.

其中的细节请见 v0.2.0 的 README, 就不累述于此了.

这种新写法还有个好处, 就是可以方便经过从代码来生成配置文件, 转义的代价很小.

嗯...再写个 sbt plugin 吧 :)