play Framework play json

2024-06-20 03:18
文章标签 json framework play

本文主要是介绍play Framework play json,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

   概述


    使用JSON的推荐方式是使用 Play 的基于类的JSON库,位于play.api.libs.json下. 

    该库构建于Jerkson之上,它是一个Scala包装者,基于一个超快的基于Java的JSON库,Jackson.

    这种方式的好处是,Java和Scala可以共享同样的库(Jackson),而Scala用户可以享受额外类型安全的好处。 
    play.api.libs.json包中,包含了7个JSON数据类型: 
        JsObject 
        JsNull 
        JsUndefined 
        JsBoolean 
        JsNumber 
        JsArray 
        JsString 
    
    它们都继承自JsValue。 
    
    解析JSON字符串 

    你可以將任何的JSON字符串解析成JsValue。 
?
1
val json : JsValue  = Json.parse(jsonString)

    遍历JSON树


    只要你拥有一个JsValue,你就可以遍历该树。该API看起来很像Scala提供的使用NodeSeq遍历XML文档的方式. 
?
1
2
3
4
val json  = Json.parse(jsonString)
val maybeName  = (json \  "user" \ name).asOpt[String]
val emails  = (json \  "user" \\  "emails" ).map( _ .as[String])

   注意使用 \ 遍历不会导致失败.你必须在末尾使用 asOpt[T]自行处理出错误情形,它將返回 None 如果值缺失的话.否则,你可以使用 as[T],以抛异常的方式处理失败,如果值丢失的话. 

    Scala值转成Json 

    As soon as you have a type class able to transform the Scala type to Json, it is pretty easy to 

    generate any Scala value to Json. For example letʼs create a simple Json object:

    只要你有一个type class 你就能將Scala类型转成Json,很容易將任何的Scala值转成Json.例如让我们创建一个简单的Json对象:

?
1
val jsonNumber  = Json.toJson( 4 )

  或者创建Json数组

?
1
val jsonArray  = Json.toJson(Seq( 1 2 3 4 ))
    这里將Seq[Int]转成Json数组没任何问题。然而当Seq由异构的值组成时,情况將变得复杂: 
?
1
val jsonArray  = Json.toJson(Seq( 1 "Bob" 3 4 ))
    没办法將Seq[Any]转成Json。(Any可以是任何非Json格式支持的对象,对吧?) 

    简单的选择是將它们做为Seq[JsValue]处理: 
?
1
2
3
val jsonArray  = Json.toJson(Seq(
   toJson( 1 ), toJson( "Bob" ), toJson( 3 ), toJson( 4 )
))
    现在让我们看看最后一个创建更复杂的Json对象的例子: 
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
val jsonObject  = Json.toJson(
   Map(
     "users" -> Seq(
       toJson(
         Map(
           "name" -> toJson( "Bob" ),
           "age" -> toJson( 31 ),
           "email" -> toJson( "bob@gmail.com" )
         )
       ),
       toJson(
         Map(
           "name" -> toJson( "Kiki" ),
           "age" -> toJson( 25 ),
           "email" -> JsNull
         )
       )
     )
   )
)

    它將产生如下Json结果: 
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
val jsonObject  = Json.toJson(
   Map(
     "users" -> Seq(
       toJson(
         Map(
           "name" -> toJson( "Bob" ),
           "age" -> toJson( 31 ),
           "email" -> toJson( "bob@gmail.com" )
         )
       ),
       toJson(
         Map(
           "name" -> toJson( "Kiki" ),
           "age" -> toJson( 25 ),
           "email" -> JsNull
         )
       )
     )
   )
)

    Json序列化

    將JsValue转成Json字符串形式很容易: 
?
1
val jsonString : String  = Json.stringify(jsValue)

    其它选择

    上面讨论的基于类型的选择是推荐的形式,当然也不会限制你使用其它JSON库。 
    
    例如,下面是一小段演示怎样將纯Scala对象转成JSON 对象,通过绑定的,基于反射的Jerkson。 
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import com.codahale.jerkson.Json. _
val json  = generate(
   Map(
     "url" ->  "http://nytimes.com" ,
     "attributes" -> Map(
       "name" ->  "nytimes" ,
       "country" ->  "US" ,
       "id" ->  25
     ),
     "links" -> List(
       "http://link1" ,
       "http://link2"
     )
   )
)

    处理Json请求


     处理Json请求 

        一个 JSON 请求是一个使用 request body 搭载经验证的JSON内容的 HTTP 请求.它必须指定 Content-Type 为text/json或application/json mime类型。 

    默认Action使用any content body parser,让你以JSON取值得request body 值(实际上是JsValue): 
?
1
2
3
4
5
6
7
8
9
10
11
def sayHello  = Action { request  = >
   request.body.asJson.map { json  = >
     (json \  "name" ).asOpt[String].map { name  = >
       Ok( "Hello " + name)
     }.getOrElse {
       BadRequest( "Missing parameter [name]" )
     }
   }.getOrElse {
     BadRequest( "Expecting Json data" )
   }
}

    更好的方法是自定义BodyParser,请求Play直接將body解析为JSON: 
?
1
2
3
4
5
6
7
def sayHello  = Action(parse.json) { request  = >
   (request.body \  "name" ).asOpt[String].map { name  = >
     Ok( "Hello " + name)
   }.getOrElse {
     BadRequest( "Missing parameter [name]" )
   }
}

    注意:当使用JSON body parser的时候,request.body的值直接做为一个经验证的JsValue值。 

    你可以通过在命令行中用curl测试: 
?
1
2
3
4
5
curl
   --header "Content-type: application/json"
   --request POST
   --data '{"name": "Guillaume"}'
   http://localhost:9000/sayHello

    返回: 
?
1
2
3
4
5
HTTP/ 1.1 200 OK
Content-Type : text/plain; charset = utf- 8
Content-Length : 15
Hello Guillaume

    返回JSON响应


    前面的一些例子,我们接收JSON请求,但我们返回的是text/plain响应。 
    让我们更改为一个有效的HTTP响应: 
?
1
2
3
4
5
6
7
8
9
10
11
def sayHello  = Action(parse.json) { request  = >
   (request.body \  "name" ).asOpt[String].map { name  = >
     Ok(toJson(
       Map( "status" ->  "OK" "message" -> ( "Hello " + name))
     ))
   }.getOrElse {
     BadRequest(toJson(
       Map( "status" ->  "KO" "message" ->  "Missing parameter [name]" )
     ))
   }
}

    现在它返回: 
?
1
2
3
4
5
HTTP/ 1.1 200 OK
Content-Type : application/json; charset = utf- 8
Content-Length : 43
{ "status" : "OK" , "message" : "Hello Guillaume" }

这篇关于play Framework play json的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1076949

相关文章

轻松上手MYSQL之JSON函数实现高效数据查询与操作

《轻松上手MYSQL之JSON函数实现高效数据查询与操作》:本文主要介绍轻松上手MYSQL之JSON函数实现高效数据查询与操作的相关资料,MySQL提供了多个JSON函数,用于处理和查询JSON数... 目录一、jsON_EXTRACT 提取指定数据二、JSON_UNQUOTE 取消双引号三、JSON_KE

MySQL数据库函数之JSON_EXTRACT示例代码

《MySQL数据库函数之JSON_EXTRACT示例代码》:本文主要介绍MySQL数据库函数之JSON_EXTRACT的相关资料,JSON_EXTRACT()函数用于从JSON文档中提取值,支持对... 目录前言基本语法路径表达式示例示例 1: 提取简单值示例 2: 提取嵌套值示例 3: 提取数组中的值注意

SpringBoot定制JSON响应数据的实现

《SpringBoot定制JSON响应数据的实现》本文主要介绍了SpringBoot定制JSON响应数据的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们... 目录前言一、如何使用@jsonView这个注解?二、应用场景三、实战案例注解方式编程方式总结 前言

JSON字符串转成java的Map对象详细步骤

《JSON字符串转成java的Map对象详细步骤》:本文主要介绍如何将JSON字符串转换为Java对象的步骤,包括定义Element类、使用Jackson库解析JSON和添加依赖,文中通过代码介绍... 目录步骤 1: 定义 Element 类步骤 2: 使用 Jackson 库解析 jsON步骤 3: 添

IDEA如何将String类型转json格式

《IDEA如何将String类型转json格式》在Java中,字符串字面量中的转义字符会被自动转换,但通过网络获取的字符串可能不会自动转换,为了解决IDEA无法识别JSON字符串的问题,可以在本地对字... 目录问题描述问题原因解决方案总结问题描述最近做项目需要使用Ai生成json,可生成String类型

Python中json文件和jsonl文件的区别小结

《Python中json文件和jsonl文件的区别小结》本文主要介绍了JSON和JSONL两种文件格式的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下... 众所周知,jsON 文件是使用php JSON(JavaScripythonpt Object No

使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

《使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)》在现代软件开发中,处理JSON数据是一项非常常见的任务,无论是从API接口获取数据,还是将数据存储为JSON格式,解析... 目录1. 背景介绍1.1 jsON简介1.2 实际案例2. 准备工作2.1 环境搭建2.1.1 添加

Java解析JSON的六种方案

《Java解析JSON的六种方案》这篇文章介绍了6种JSON解析方案,包括Jackson、Gson、FastJSON、JsonPath、、手动解析,分别阐述了它们的功能特点、代码示例、高级功能、优缺点... 目录前言1. 使用 Jackson:业界标配功能特点代码示例高级功能优缺点2. 使用 Gson:轻量

python中json.dumps和json.dump区别

《python中json.dumps和json.dump区别》json.dumps将Python对象序列化为JSON字符串,json.dump直接将Python对象序列化写入文件,本文就来介绍一下两个... 目录1、json.dumps和json.dump的区别2、使用 json.dumps() 然后写入文

Java中JSON字符串反序列化(动态泛型)

《Java中JSON字符串反序列化(动态泛型)》文章讨论了在定时任务中使用反射调用目标对象时处理动态参数的问题,通过将方法参数存储为JSON字符串并进行反序列化,可以实现动态调用,然而,这种方式容易导... 需求:定时任务扫描,反射调用目标对象,但是,方法的传参不是固定的。方案一:将方法参数存成jsON字