在上一篇 Play2 自定义模板类型 (Java&Scala)，是基于 Play2.2 怎么自定义 Json 模板类型，分别用 Java 和 Scala 实现。从 Play2.3 开始，模板明确了是用 Twirl，所以构建文件上的配置略有不同，并且模板编译出的源文件位置也不一样，Play2.2 前生成的模板源文件在 target/scala-2.10/src_managed/main/views 目录，现在是生成在 target/twirl/main/views 目录。
在 Play2.3 中仍然是默认只支持 html, txt, xml, js 四种类型的模板，见 SbtTwirl。我们这里还是以增加 Json 模板支持为例，且只介绍用 Java 的方式。因为 Play2 尽管可以用 Java 来编写应用，但实现部份基本是 Scala，所以如果用 Scala 来进行扩展相对来说来比用 Java 简单些。
Play2.3 官方的自定义模板的文档 Adding support for a custom format to the template engine 有些出入，似乎还未来得急更新，以实操为证。
还是从构建文件开始
一： 修改 build.sbt 文件，加上 (你要是愿意用 Build.scala 也无妨):
|
1 2 3 4 5 |
import play.twirl.sbt.Import.TwirlKeys ...... ...... TwirlKeys.templateFormats += ("json" -> "templates.JsonFormat.instance") |
play.twirl.sbt.Import.TwirlKeys 下总共有以下六个关于模板的配置项
twirlVersion, templateFormats, templateImports , useOldParser, sourceEncoding, compileTemplates
二：Json.java
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
package templates; import play.twirl.api.BufferedContent; import scala.collection.immutable.Seq; import scala.collection.immutable.Vector; public class Json extends BufferedContent<Json> { public Json(String jsonString) { super(Vector.<Json>empty(), jsonString); } public Json(Seq<Json> elements) { super(elements, ""); } public String contentType() { return "application/json"; } } |
需要额外处理通过 Seq<Json> 构造 Json 实例。
三：JsonFormat.java
|
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 |
package templates; import play.twirl.api.Format; import scala.collection.immutable.Seq; public class JsonFormat implements Format<Json> { @Override public Json raw(String text) { return new Json(text); } @Override public Json escape(String text) { return new Json(text); } @Override public Json empty() { return new Json(""); } @Override public Json fill(Seq<Json> elements) { return new Json(elements); } public static final JsonFormat instance = new JsonFormat(); } |
现在的 Format 多了两个抽象方法, empty() 和 fill(Seq<Json> elements)
其余怎么写模板文件，怎么在 Controller 中渲染和这里 Play2 自定义模板类型 (Java&Scala) 是一样的。
本文链接 https://yanbin.blog/play2-3-custom-view-template-java/, 来自 隔叶黄莺 Yanbin Blog
[版权声明] 
本文采用 署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0) 进行许可。