Play 2.6 Play enhancer

Play enhancer

英文原文
https://playframework.com/documentation/2.6.x/PlayEnhancer

Play enhancer是sbt的一个插件，用来产生Java bean的get set方法，并且重写了那些通过getters和setters来获取域的代码。

动机

Java的一大缺点就是一个简单的东西需要一大堆样板代码，这其中最出门的例子就是对域的封装——对域的读写都要封装在方法中，这样可以方便未来对代码进行修改。在Java中，这意味这将域变为私有，然后设置getters和setters方法。

并且有许多类库通过反射的方式来获取对象中的域，比如ORM，这也要求类为每个属性提供getters和setters方法

Play enhancer提供了一个更加简便的方法。在编译类产生字节码的过程中添加一些处理, 这也被称为字节码增强。对于类中的每一个公有域，Play会自动生成getters和setters并将那些使用到这些域的代码进行重写，重写为使用getters和setters的形式。

缺点

使用字节码来生成getters和setters会带来一些问题：
- 字节码增强是不透明的，你看不到生成的getters和setters方法，所以一旦出现问题，就很难去排查哪里出现了问题。
- 字节码增强可能会与一些工具的操作产生冲突，比如IDE，因为它们无法预见最终生成的字节码。比如在IDE中进行测试时，IDE在编译代码时不会去运行字节码，这有可能会导致测试失败。
- 现有的Java开发者可能不了解你的代码基础，这有可能会导致冲突。

如果你决定在项目中使用Play enhancer，最重要的是了解enhancer做了什么，以及其中的风险唉哪里。

准备阶段

在project/plugin.sbt中添加配置

addSbtPlugin("com.typesafe.sbt" % "sbt-play-enhancer" % "1.1.0")

Play enhancer应该对所有的项目起效，如果你想在某个特别的项目中禁用，可以在build.sbt中添加下面配置

lazy val nonEnhancedProject = (project in file("non-enhanced"))
  .disablePlugins(PlayEnhancer)

在一些情况下可能无法禁用enhancer插件。如果你使用了Play ebean插件，这会需要enchaer来保证getters和setters在字节码增强前生成。如果你不想生成getters和setters，可以使用playEnhancerEnabled来设置

playEnhancerEnabled := false

操作

对于Java类中的所以域，enhancer看起来都是公有的、非静态的、
非finla的

对于没有getters和setters的域，enhancer都会自动生成一个。如果你想使用自己的，只需写一个就行，Play会略过那些已经存在的。

配置

如果你想把控在哪些域中使用字节码增强，可以通过配置sources task scoped to the playEnhancerGenerateAccessors and playEnhancerRewriteAccessors tasks。比如只想在models包中使用

sources in (Compile, playEnhancerGenerateAccessors) := {
  ((javaSource in Compile).value / "models" ** "*.java").get
}