Play Framework 2.4写入[-A] vs OWrites [-A]，格式[A] vs OFormat [A]。目的？

Question

PlayFramework Json库中的Writes [-A]和OWrites [-A]有什么区别？我已经使用了Writes [A]，但我无法弄清OWrites的目的是什么。同样的问题适用于格式[A]与OFormat [A]。

源代码可以找到here for Writes和here for Formats。我看过他们，但我无法弄清楚他们的用法上的差异。

Answer 1

通常你知道编码器总是会产生一个JSON对象（而不是任意的JSON值）。在类型系统中跟踪这个事实使得可以使用这样的编码器的输出来工作，而不用跳过通常是必需的环。

例如，假设我们有一个简单的类：

class Foo(val name: String, val age: Long) 

我们写一个Writes情况是这样的：

import play.api.libs.functional.syntax._ 
import play.api.libs.json._ 

implicit val fooWrites: Writes[Foo] = (
    (__ \ 'name).write[String] and (__ \ 'age).write[Long] 
)(foo => (foo.name, foo.age)) 

现在我们可以写：

scala> val json = fooWrites.writes(new Foo("McBar", 101)) 
json: play.api.libs.json.JsValue = {"name":"McBar","age":101} 

现在假设我们想要得到一个字段名称列表，无论出于何种原因。我们必须写这样的事：

scala> json.as[JsObject].keys 
res0: scala.collection.Set[String] = Set(name, age) 

取而代之的是：

scala> json.keys 
<console>:17: error: value keys is not a member of play.api.libs.json.JsValue 
       json.keys 
       ^

但当然我们知道json将永远是一个JsObject。问题是编译器没有。 OWrites解决了这个问题。

implicit val fooWrites: OWrites[Foo] = (
    (__ \ 'name).write[String] and (__ \ 'age).write[Long] 
)(foo => (foo.name, foo.age)) 

然后：

scala> val json = fooWrites.writes(new Foo("McBar", 101)) 
json: play.api.libs.json.JsObject = {"name":"McBar","age":101} 

scala> json.keys 
res1: scala.collection.Set[String] = Set(name, age) 

的writes上OWrites输出静态类型为JsObject，所以我们可以使用.keys没有不安全as[JsObject]演员。

（作为一个方面说明，我制作方法的返回类型的子类更具体的not personally a fan，我已经采取了a slightly different approach在circe解决这个问题。）