Play2 自定义模板类型 (Java&Scala)

Play2 默认支持的模板类型是 html, txt, xml 和 js,不在这些支持之列的模板文件即使放到 app/views 目录中,也不会被编译的。如果要支持自定义的模板类型就要些定制了,这比 Play1 复杂些。模板的定制包括在 Build.scala 或 build.sbt 中加上 templatesTypes 配置,并需创建 BufferedContent 和 Format 实现类。下面以增加 json 模板类型为例,兼顾 Scala 和 Java 的实现类,是基于 Play2.2 的,在 Play2.3 中又略有不同。

官方有相关的文档,参考:Custom formats on Scala, Custom formats on Java模板定义参考.

在较新一些的 2.2 的 PlaySettings 中,可以看到

弄清了上面的原理后,开始我们的步骤

第一步:修改项目构建文件

在构建文件 build.sbt 或 Build.scala 中增加下面的内容作为项目的 setting

Build.scala 中要加到下面的位置上

第二步:实现 Json 和 JsonFormat 类

和相应的实现类,前面说过需要两个类型

class Json extends BufferedContent  和 class JsonFormat implements Format, 实现各自接口中要求的方法和指定 Content-Type 为 application/json, Format 的 escape() 方法是 view 模板中默认被调用的,比如需要字符串的双引号转议等。

开始例子,可以选择下面的某一种实现方:

1. Scala 实现自定义 JSON template

Scala 的 Json 和 JsonFormat 类/对象 可以写在同一个文件中,比如说 JsonTemplate.scala 文件,内容如下:

2. Java 实现自定义 JSON template

Java 的实现则需要把 Json 和 JsonFormat 分到两个文件中去,因为它们必须都是 public 的,分别是

Json.java

JsonFormat.java

至此,自定义部分已经完成,开始应用 Json 模板了。

1. 书写 json 模板文件

模板文件必须以 .scala.json 结尾,比如创建文件 views/user/userlist.scala.json

假设在 models 包中已创建了 User(name: String) 类,如果 User 不在 models 包中就得写全路径,如 @(user: models.some.User),也可以在构建文件中用 templatesImport 加上默认引入包。

这时候一切正常的话,Play2 将为你生成源文件 target/scala-2.10/src_managed/main/views/json/user/userlist.template.scala 文件

2. 应用模板,在 controller 中渲染模板

如果你的 controller 是返回的

即使没有现成 F.Promise<User>,我们也可以 F.Promise.<String>pure("") 一个出来再 map。

这样可以想见模板中将要显示的内容。

附加内容, 可另立主题:view template 中调用外部 Java/Scala 方法


view template 的默认行为会把 null 显示为空字符串,这不是我们想要的,所以可以在模板中调用 Java/Scala 方法使用 Jackson 的手段来显示对象或对象属性

做法如下

1. JsonFormat 中稍作改动

把 escape 方法改成如下,此处不进行字符串转义,把任务交给后端代码去做

2. 创建 views/json/Helper 文件

3. 修改项目构建文件

4. 模板文件

上面完全是调用 Jackson 来输出 json 格式,所以字符串的双引号也省了,最终输出是

引入了 @jsonValue() 方法后,JSON 输出格式变得不可控制了,我们可以在 controller 中把 view 模板的输出重新美化成规整的 JSON 字符串。此是后话,非必要,随便便弄个浏览器就可以格式的很漂亮。

参考:

  1. https://searchcode.com/?q=play.api.templates.TxtFormat
  2. https://groups.google.com/forum/#!topic/play-framework/JKic1yVzgY0
  3. https://github.com/playframework/playframework/blob/2.2.x/framework/src/play/src/main/scala/play/api/templates/Templates.scala
  4. https://searchcode.com/codesearch/view/64071723/#l-217
  5. https://searchcode.com/codesearch/view/2451189/#l-210
  6. https://searchcode.com/codesearch/view/2451189/

类别: PlayFramework. 标签: , . 阅读(568). 订阅评论. TrackBack.

Leave a Reply

Be the First to Comment!

avatar
wpDiscuz