Jerkson 技术文档

1. 安装指南

环境要求

• Scala 2.8.2 或 2.9.1
• Jackson 1.9.x

添加依赖

在项目的 pom.xml 文件中添加以下内容：

<repositories>
  <repository>
    <id>repo.codahale.com</id>
    <url>http://repo.codahale.com</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.codahale</groupId>
    <artifactId>jerkson_${scala.version}</artifactId>
    <version>0.5.0</version>
  </dependency>
</dependencies>

2. 项目的使用说明

解析 JSON

解析 JSON 数组

import com.codahale.jerkson.Json._

// 解析 JSON 数组
parse[List[Int]]("[1,2,3]") //=> List(1,2,3)

解析 JSON 对象

// 解析 JSON 对象
parse[Map[String, Int]]("""{"one":1,"two":2}""") //=> Map("one"->1,"two"->2)

解析 JSON 对象为 case class

// 解析 JSON 对象为 case class
case class Person(id: Long, name: String)
parse[Person]("""{"id":1,"name":"Coda"}""") //=> Person(1,"Coda")

解析流式数组

// 解析流式数组
for (person <- stream[Person](inputStream)) {
  println("New person: " + person)
}

生成 JSON

生成 JSON 数组

// 生成 JSON 数组
generate(List(1, 2, 3)) //=> [1,2,3]

生成 JSON 对象

// 生成 JSON 对象
generate(Map("one"->1, "two"->"dos")) //=> {"one":1,"two":"dos"}

3. 项目 API 使用文档

解析 JSON

• parse[T](json: String): T：将 JSON 字符串解析为指定类型的对象。
• stream[T](inputStream: InputStream): Iterator[T]：从输入流中解析 JSON 数组，并返回一个迭代器。

生成 JSON

• generate(obj: Any): String：将 Scala 对象转换为 JSON 字符串。

处理 snake_case 字段名

• @JsonSnakeCase：用于 case class，将字段名转换为 snake_case 格式。

4. 项目安装方式

通过 Maven 安装

在项目的 pom.xml 文件中添加以下依赖：

<repositories>
  <repository>
    <id>repo.codahale.com</id>
    <url>http://repo.codahale.com</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>com.codahale</groupId>
    <artifactId>jerkson_${scala.version}</artifactId>
    <version>0.5.0</version>
  </dependency>
</dependencies>

通过 SBT 安装

在 build.sbt 文件中添加以下内容：

resolvers += "repo.codahale.com" at "http://repo.codahale.com"

libraryDependencies += "com.codahale" %% "jerkson" % "0.5.0"

通过以上步骤，您可以成功安装并使用 Jerkson 项目。