7 JSON交互处理
7.1 什么是JSON?
- JSON(JavaScript Object Notation,JS标记对象)是一种轻量级的数据交换格式,目前使用特别广泛。
- 采用独立于编程语言的文本格式来储存和表示数据。
- 简洁和清晰的层次结构使得JSON成为理想的数据交换语言。
- 易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率。
在 JavaScript 语言中,一切都是对象。因此,任何 JavaScript 支持的类型都可以通过 JSON 来表示,例如字符串、数字、对象、数组等。它的要求和语法格式:
- 对象表示为键值对,数据由逗号分隔
- 花括号保存对象
- 方括号保存数组
JSON键值对是用来保存 JavaScript 对象的一种方式,和 JavaScript 对象的写法也大同小异,键/值对组合中的键名写在前面并用双引号 " " 包裹,使用冒号 : 分隔,然后紧接着值:
{"name":"Serene"}
{"age":"3"}
{"sex":"男"}
很多人搞不清楚 JSON 和 JavaScript 对象的关系,甚至连谁是谁都不清楚。其实,可以这么理解:
JSON 是 JavaScript 对象的字符串表示法,它使用文本表示一个 JS 对象的信息,本质是一个字符串。
var obj = {a:'Hello',b:'World'};//这是一个对象,注意键名也是可以使用引号包裹的
var json = '{"a":"Hello","b":"World"}';//这是一个JSON字符串,本质是一个字符串
JSON 和 JavaScript 对象转换
要实现从 JSON 字符串转换为 JavaScript 对象,使用 JSON.parse() 方法:
var obj = JSON.parse('{"a": "Hello", "b": "World"}');
//结果是 {a: 'Hello', b: 'World'}
要实现 JavaScript 对象转换为 JSON 字符串,要使用 JSON.stringify() 方法:
var json = JSON.stringify({a: 'Hello', b: 'World'});
//结果是 '{"a": "Hello", "b": "World"}'
代码测试
-
新建一个Module,springmvc-05-json ,添加 web 的支持;
-
在 web目录下新建一个json-1.html,编写测试内容
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> <script type="text/javascript"> //编写一个js的对象 ES6 为什么var提示修改为 const // let和const都是es5,es6新版本的js语言规范出来的定义,在这以前定义一个变量只能用 var。 // let和const都是为了弥补var的一些缺陷而新设计出来的 var user = { name:"晴朗", age:3, sex:"男" }; console.log(user); //将js对象转换成json字符串 var str = JSON.stringify(user); console.log(str); //将json字符串转换为js对象 var user2 = JSON.parse(str); console.log(user2) </script> </head> <body> </body> </html>
-
在IDEA中使用浏览器打开,查看控制台输出:
JS对象–JSON字符串–JS对象
7.2 Controller 返回JSON数据
Jackson 应该是目前比较好的 json 解析工具了!当然工具不止这一个,比如阿里的 fastjson 等等。
这里使用 Jackson,使用它需要导入它的 jar 包
<!-- Jackson依赖包 -->
<dependencies>
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.8</version>
</dependency>
</dependencies>
配置SpringMVC 需要的配置,web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<!--1.注册servlet-->
<servlet>
<servlet-name>SpringMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--通过初始化参数指定SpringMVC配置文件的位置,进行关联-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-servlet.xml</param-value>
</init-param>
<!-- 启动顺序,数字越小,启动越早 -->
<load-on-startup>1</load-on-startup>
</servlet>
<!--所有请求都会被springmvc拦截 -->
<servlet-mapping>
<servlet-name>SpringMVC</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!--添加过滤器解决乱码问题-->
<!--<filter>
<filter-name>encoding</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>utf-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>encoding</filter-name>
<url-pattern>/</url-pattern>
</filter-mapping>-->
</web-app>
springmvc-servlet.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 自动扫描指定的包,下面所有注解类交给IOC容器管理 -->
<context:component-scan base-package="com.serene.controller"/>
<!-- 视图解析器 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
id="internalResourceViewResolver">
<!-- 前缀 -->
<property name="prefix" value="/WEB-INF/jsp/" />
<!-- 后缀 -->
<property name="suffix" value=".jsp" />
</bean>
</beans>
编写一个User 的实体类,然后测试Controller;
package com.serene.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
//需要导入lombok依赖
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
private String sex;
}
这里我们需要两个新东西,一个是@ResponseBody一个是 ObjectMapper对象,我们实际编写看下具体的用法,编写一个 UserController;
@Controller
public class UserController {
@RequestMapping(value = "/json1")
@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个Jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("韵宝宝", 3, "男");
//将我们的对象解析为 json 格式
String str = mapper.writeValueAsString(user);
//由于 @ResponseBody 注解,这里会将str转成 json 格式待会;十分方便
return str;
}
}
新建了module,需要从新配置Tomcat,启动测试! http://localhost:8080/json1
可以看到出现了乱码问题,需要设置一下编码格式为utf-8,以及它返回的数据类型;
通过 @RequestMaping的produces属性来实现,修改代码如下:
@Controller
public class UserController {
@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")
//@RequestMapping(value = "/json1")
@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个Jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("韵宝宝", 3, "男");
//将我们的对象解析为 json 格式
String str = mapper.writeValueAsString(user);
//由于 @ResponseBody 注解,这里会将str转成 json 格式待会;十分方便
return str;
}
}
再次测试, http://localhost:8080/json1 ,,乱码问题OK!
7.3 代码优化
乱码统一解决
上一种方法解决乱码问题比较麻烦,如果项目中有多个请求则需要在每一个请求上面都添加。可以通过Spring配置统一指定,这样就不用了每个请求都添加处理了!
在SpringMVC配置文件中添加一段消息StringHttpMessageConverter转换配置!
<!-- springmvc-servlet.xml-->
<!--消息转换配置,解决乱码问题-->
<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<constructor-arg value="UTF-8"/>
</bean>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper">
<bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
<property name="failOnEmptyBeans" value="false"/>
</bean>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
返回json字符串统一解决
同样对于返回字符串也不需要在每个请求中添加 @ResponseBody。在Controller类上直接使用 @RestController,这样所有的方法都只会返回json字符串了!在前后端分离开发中,一般都使用RestController,十分便捷!
//@Controller
@RestController
public class UserController {
//@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")
@RequestMapping(value = "/json1")
//@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个Jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("韵宝宝", 3, "男");
//将我们的对象解析为 json 格式
String str = mapper.writeValueAsString(user);
//由于 @ResponseBody 注解,这里会将str转成 json 格式待会;十分方便
return str;
}
}
7.4 测试集合输出
添加一个新的方法,输出一个集合
//@Controller
@RestController
public class UserController {
@RequestMapping(value = "/json2")
//@ResponseBody
public String json2() throws JsonProcessingException {
//创建一个Jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("韵宝宝", 3, "男");
User user1 = new User("韵宝宝1", 6, "男");
User user2 = new User("韵宝宝2", 9, "男");
User user3 = new User("韵宝宝3", 12, "男");
User user4 = new User("韵宝宝4", 15, "男");
List<User> list = new ArrayList<User>();
list.add(user);
list.add(user1);
list.add(user2);
list.add(user3);
list.add(user4);
//将我们的对象解析为 json 格式
String str = mapper.writeValueAsString(list);
//由于 @ResponseBody 注解,这里会将str转成 json 格式待会;十分方便
return str;
}
}
测试结果:http://localhost:8080/json2
7.4 输出时间对象
增加一个新的方法,输出时间
//@Controller
@RestController
public class UserController {
//输出时间对象 timestamps形式,1970年01月01日到现在的毫秒数
@RequestMapping("json3")
public String json3() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//创建一个时间对象,java.util.Date
Date date = new Date();
//将时间对象解析为 json
String str = mapper.writeValueAsString(date);
return str;
}
}
测试运行:
- 默认日期格式会变成一个数字,是1970年1月1日到当前日期的毫秒数!
- Jackson 默认会把时间转换成 timestamps 形式
解决方案:取消 timestamps 形式,自定义时间格式
@RestController
public class UserController {
//输出时间,取消timestamps形式,输出标准时间格式
@RequestMapping("json4")
public String json4() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//不使用时间戳的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定义时间格式独享
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//指定日期格式
mapper.setDateFormat(simpleDateFormat);
Date date = new Date();
//将时间对象解析为 json
String str = mapper.writeValueAsString(date);
return str;
}
}
测试结果:http://localhost:8080/json4
7.5 抽取为工具类
如果是经常要使用的话,每个请求都写会比较麻烦,可以将这些代码封装到一个工具类中
编写一个输出标准时间的工具类JsonUtils:
package com.serene.utils;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import java.text.SimpleDateFormat;
public class JsonUtils {
public static String getJson(Object object) {
return getJson(object,"yyyy-MM-dd HH:mm:ss");
}
public static String getJson(Object object,String dateFormat) {
ObjectMapper mapper = new ObjectMapper();
//不使用时间差的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定义日期格式对象
SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
//指定日期格式
mapper.setDateFormat(sdf);
try {
return mapper.writeValueAsString(object);
} catch (JsonProcessingException e) {
e.printStackTrace();
}
return null;
}
}
使用工具类完善请求代码,变得非常简洁!
@RestController
public class UserController {
//将输出时间 扩写为工具类
@RequestMapping("/json5")
public String json5() throws JsonProcessingException {
Date date = new Date();
String json = JsonUtils.getJson(date);
return json;
}
}
测试结果:http://localhost:8080/json5
7.6 FastJson
fastjson.jar 是阿里开发的一款专门用于 Java 开发的包,可以方便的实现 json 对象与 JavaBean 对象的转换,实现 JavaBean 对象与 json 字符串的转换,实现 JavaScript 对象与 json 字符串的转换。
实现 json 的转换方法很多,最后的实现结果都是一样的。
导入 fastjson 的依赖:
<dependencies>
<!--阿里 fastJson依赖-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.60</version>
</dependency>
</dependencies>
fastjson 三个主要的类:
JSONObject 代表json对象
- JSONObject 实现了Map接口,猜想 JSONObject底层操作是由Map实现的。
- JSONObject 对应json对象,通过各种形式的get()方法可以获取json对象中的数据,也可以利用注入size(),isEmpty()等方法获取"键:值"对的个数和判断是否为空。其本质是通过实现Map接口并调用接口中的方法完成的。
JSONArray代表 json对象数组
- 内部是由List接口中的方法来完成操作的。
JSONO 代表 JSONObject 和 JSONArray 的转化
- JSON类源码分析与使用
- 仔细观察这些方法,主要是实现 json 对象, json 对象数组,Javabean 对象,json 字符串之间的转化。
新建一个FastJsonDemo类:
package com.serene.controller;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.serene.pojo.User;
import java.util.ArrayList;
import java.util.List;
public class FastJsonDemo {
public static void main(String[] args) {
//创建一个对象
User user = new User("韵宝宝",0,"男");
User user1 = new User("韵宝宝1",1,"男");
User user2 = new User("韵宝宝2",2,"男");
User user3 = new User("韵宝宝3",3,"男");
User user4 = new User("韵宝宝4",4,"男");
List<User> users = new ArrayList<User>();
users.add(user);
users.add(user1);
users.add(user2);
users.add(user3);
users.add(user4);
System.out.println("*******Java对象 转 JSON字符串*******");
String str1 = JSON.toJSONString(users);
System.out.println("JSON.toJSONString(list)==>"+str1);
String str2 = JSON.toJSONString(user1);
System.out.println("JSON.toJSONString(user1)==>"+str2);
System.out.println("\n****** JSON字符串 转 Java对象*******");
User jp_user1=JSON.parseObject(str2,User.class);
System.out.println("JSON.parseObject(str2,User.class)==>"+jp_user1);
System.out.println("\n****** Java对象 转 JSON对象 ******");
JSONObject jsonObject1 = (JSONObject) JSON.toJSON(user2);
System.out.println("(JSONObject) JSON.toJSON(user2)==>"+jsonObject1.getString("name"));
System.out.println("\n****** JSON对象 转 Java对象 ******");
User to_java_user = JSON.toJavaObject(jsonObject1, User.class);
System.out.println("JSON.toJavaObject(jsonObject1, User.class)==>"+to_java_user);
}
}
控制台输出:
这种工具类,需要掌握使用,在使用的时候再根据具体的业务去找对应的实现。
对应代码:springmvc_05-json