SpringMVC之JSON
八、JSON
目录：JSON简介、Controller返回JSON数据、FastJson
1.JSON简介
1）简介
JSON（JavaScript Object Notation，JS 对象标记）是一种轻量级的数据交换格式，目前使用特别广 泛。
采用完全独立于编程语言的文本格式来存储和表示数据。
简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。
易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。
在JavaScript语言中，一切都是对象。因此，任何JavaScript 支持的类型都可以通过 JSON 来表示，例如字符串、数字、对象、数组等。看看他的要求和语法格式：、对象表示为键值对，数据由逗号分隔、花括号保存对象、方括号保存数组。
JSON键值对是用来保存 JavaScript 对象的一种方式，和 JavaScript 对象的写法也大同小异，键值对组合中的键名写在前面并用双引号""包裹，使用冒号:分隔，然后紧接着值。
例：
{"name": "Ping"}
{"age": "20"}
{"sex": "男"}
JSON和JavaScript对象的关系：JSON是JavaScript对象的字符串表示法，它使用文本表示一个JS对象的信息，本质是一个字符串。
var obj = {a: 'Hello', b: 'World'}; //这是一个对象，键名是可以使用引号包裹的
var json = '{"a": "Hello", "b": "World"}'; //这是一个JSON字符串，本质就是一个字符串
2）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”}’
3）代码测试
①新建一个module，添加web app的支持。
②在web目录下新建一个json.html，编写测试的内容。
DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>JSONtitle>
head>
<body>
<script type="text/javascript">
//编写一个js的对象
var user = { name:"Ping", age:20, sex:"男" };
//将js对象转换成json字符串
var str = JSON.stringify(user);
console.log(str);
//将json字符串转换为js对象
var user2 = JSON.parse(str);
console.log(user2.name,user2.age,user2.sex);
script>
body>
html>
③在IDEA中使用浏览器打开，查看控制台输出。
结果：
{“name”:“Ping”, “age:20”, “sex”:“男” }
“Ping” 20 “男”
2.Controller返回JSON数据
Jackson应该是目前比较好的json解析工具了。当然工具不止这一个，比如还有阿里巴巴的fastjson等等。
1）代码实现
①这里使用Jackson，使用它需要导入它的jar包。
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-databindartifactId>
<version>2.12.4version>
dependency>
②配置SpringMVC需要的配置。
Ⅰweb.xml：
<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">
<servlet>
<servlet-name>SpringMVCservlet-name>
<servlet- class>org.springframework.web.servlet.DispatcherServletservlet-class>
<init-param>
<param-name>contextConfigLocationparam-name>
<param-value>classpath:springmvc-servlet.xmlparam-value>
init-param>
<load-on-startup>1load-on-startup>
servlet>
<servlet-mapping>
<servlet-name>SpringMVCservlet-name>
<url-pattern>/url-pattern>
servlet-mapping>
<filter>
<filter-name>encodingfilter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
<init-param>
<param-name>encodingparam-name>
<param-value>utf-8param-value>
init-param>
filter>
<filter-mapping>
<filter-name>encodingfilter-name>
<url-pattern>/url-pattern>
filter-mapping>
web-app>
Ⅱspringmvc-servlet.xml：
<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">
<context:component-scan base-package="com.ping.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的实体类。
package com.ping.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;
}
④编写一个Controller。
@Controller
public class UserController {
@RequestMapping("/json1")
@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("Ping", 20, "男");
//将对象解析成为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解，这里会将str转成json格式返回
return str;
}
}
⑤配置Tomcat，启动测试。
⑥发现出现了乱码问题，需要设置一下编码格式为utf-8，以及它返回的类型。
通过@RequestMaping的produces属性来实现，修改代码：
//produces：指定响应体返回类型和编码
@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")
⑦再次测试，http://localhost:8080/json1，成功解决乱码问题。
注意：使用json一定要处理乱码问题。
2）代码优化
①乱码统一解决。
上述方法比较麻烦，如果项目中有许多请求则每一个都要添加，可以通过Spring配置统一指定，这样就不用每次去处理了。
可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter进行转换配置。
<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字符串统一解决。
在类上直接使用@RestController，里面所有的方法都只会返 json字符串了，不用再每一个都添加@ResponseBody。在前后端分离开发中，一般都使用@RestController。
@RestController
public class UserController {
//produces：指定响应体返回类型和编码
@RequestMapping(value = "/json1")
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象 User user = new User("Ping", 20, "男");
//将对象解析成为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解，这里会将str转成json格式返回
return str;
}
}
3）测试集合输出
增加一个新的方法，进行测试。
@RequestMapping("/json2")
public String json2() throws JsonProcessingException {
//创建一个jackson的对象映射器，用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user1 = new User("Ping", 20, "男");
User user2 = new User("Ping2", 20, "男");
User user3 = new User("Ping3", 20, "男");
User user4 = new User("Ping4", 20, "男");
List<User> list = new ArrayList<User>();
list.add(user1);
list.add(user2);
list.add(user3);
list.add(user4);
//将对象解析成为json格式
String str = mapper.writeValueAsString(list);
return str;
}
4）输出时间对象
增加一个新的方法，使用timestamps形式。
@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日到当前日期的毫秒数，这就是时间戳timestamps。
Jackson默认是会把时间转成timestamps形式。
取消timestamps形式 ， 自定义时间格式。
@RequestMapping("/json4")
public String json4() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//不使用时间戳的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定义日期格式对象
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//指定日期格式
mapper.setDateFormat(sdf);
Date date = new Date();
String str = mapper.writeValueAsString(date);
return str;
}
5）抽取为工具类
将上述这些输出时间对象代码封装到一个工具类中。
package com.ping.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;
}
}
使用此工具类。
@RequestMapping("/json5")
public String json5() throws JsonProcessingException {
Date date = new Date();
String json = JsonUtils.getJson(date);
return json;
}
3.FastJson
fastjson.jar是阿里开发的一款专门用于Java开发的包，可以方便的实现json对象与JavaBean对象的转换，实现JavaBean对象与json字符串的转换，实现json对象与json字符串的转换。实现json的转换方法很多，最后的实现结果都是一样的。
fastjson包的依赖
<dependency>
<groupId>com.alibabagroupId>
<artifactId>fastjsonartifactId>
<version>1.2.76version>
dependency>
fastjson三个主要的类：
①JSONObject（代表json对象）：JSONObject实现了Map接口，猜想JSONObject底层操作是由Map实现的。
JSONObject对应json对象，通过各种形式的get()方法可以获取json对象中的数据，也可利用诸如size()，isEmpty()等方法获取"键: 值"对的个数和判断是否为空。其本质是通过实现Map接口并调用接口中的方法完成的。
②JSONArray（代表json对象数组）：内部是有List接口中的方法来完成操作的。
③JSON（代表JSONObject和JSONArray的转化）：JSON类源码分析与使用。这些方法主要是实现json对象，json对象数组，javabean对象，json字符串之间的相互转化。
代码测试：
新建一个FastJsonDemo类。
package com.ping.controller;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.kuang.pojo.User;
import java.util.ArrayList;
import java.util.List;
public class FastJsonDemo {
public static void main(String[] args) {
//创建对象
User user1 = new User("Ping", 20, "男");
User user2 = new User("Ping2", 20, "男");
User user3 = new User("Ping3", 20, "男");
User user4 = new User("Ping4", 20, "男");
List<User> list = new ArrayList<User>();
list.add(user1);
list.add(user2);
list.add(user3);
list.add(user4);
System.out.println("Java对象转 JSON字符串");
String str1 = JSON.toJSONString(list);
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);
}
}