使用Scala和Play Framework将自定义类型的映射序列化为JSON

Question

我使用http://www.blaenkdenum.com/notes/play/上的信息创建了自定义类型的地图：

def getAllProductsWithStockItems: Map[Product, List[StockItem]] = {
        DB.withConnection { implicit connection =>
        val sql = SQL("select p.*, s.*" +
        "from products p" +
        "inner join stock_items s on (p.id = s.product_id)")

        val results: List[(Product, StockItem)] = sql.as(productStockItemParser *)

    results.groupBy { _._1 }.mapValues { _.map { _._2 } }
    }
}

我需要将Map[Product, List[StockItem]]序列化/反序列化为JSON，但是我真的不知道该怎么做。 我已经有两个自定义类型（产品和StockItem）的有效序列化程序，这些序列化程序是我使用Play的本机JSON库进行编码的，但是如果更好，我可以使用另一个序列化程序。 有人可以给我一些指示吗？

---

更新 ：List / StockItem示例不是一个很好的示例，但这仅仅是一个抽象。 最后，我有一个表示1到n关系的结构。 因此，考虑到每个产品都有一个StockItem列表，我希望JSON类似于以下内容：

{
"products": [
            {
                "id": 1
                "productName": "coffee",
                "stockitems": [   
                               {
                                   "id":1,
                                   "brandName": "Crazycoffee",
                                   "price": 5
                                   "quantity": 3000
                               },
                               {
                                   "id":2,
                                   "brandName": "Badcoffee",
                                   "price": 1
                                   "quantity": 2000
                               }
                               ]
            },
            {
                "id": 1
                "productName": "ice cream",
                "stockitems": [   
                               {
                                   "id":1,
                                   "brandName": "Sleazyice",
                                   "price": 2
                                   "quantity": 300
                               }
                               ]
            }
            ]
}

Answer 1

我还没有测试过，但是它是从我工作的Java代码的一部分编写的。 使用Jackson库（包含在播放2中）：

import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.ObjectMapper;

public static String toJson(Map<Product, List<StockItem>> lst)
{
    JsonFactory factory = new JsonFactory();
    CharArrayWriter writer = new CharArrayWriter();
    try{
        JsonGenerator gen = factory.createGenerator(writer);
        gen.writeStartObject();
        gen.writeFieldName("infos");
        gen.writeRaw(":" + listToJson(lst));
        gen.writeEndObject();
        gen.close();
    }catch(Throwable e){
        Logger.error("AjaxRequest.generateResponse: " + e.getMessage());
        e.printStackTrace();
    }
    return new String(writer.toCharArray());
}

/**
 * Convert a list into a json string.
 */
public static String listToJson(List<?> lst) throws IOException
{
    ObjectMapper mapper = new ObjectMapper();
    JsonFactory factory = new JsonFactory();
    CharArrayWriter writer = new CharArrayWriter();
    JsonGenerator gen = factory.createGenerator(writer);
    gen.writeRaw(mapper.writeValueAsString(lst));
    gen.close();
    return new String(writer.toCharArray());
}

杰克逊图书馆的作品不错，但远远不容易理解。 无论如何，只需进行少量修改，该代码就可以正常工作。

Answer 2

您可以考虑使用https://playframework.com/documentation/2.5.x/ScalaJsonAutomated ，然后可以节省一些时间，而不必手动编写所有Writer和Readers。 您可以基于顶级JSON元素“产品”（例如ProductsList）创建“包装器”实体，例如。 以下是如何执行此操作的示例：

case class ProductList (
  list: Vector[Product]
)

object ProductList {

  /**
    * Mapping to and from JSON.
    */
  implicit val documentFormatter: Format[ProductList] = (
    (__ \ "products").format[Vector[Product]]
  ) (ProductList.apply, unlift(ProductList.unapply))

}