Json

什么是 Json?
- JSON 和 JavaScript 对象互转
Jackson
- 统一乱码解决
- 返回 Json 字符串统一解决
- Json 返回集合
- Json 输出时间对象
- 抽取工具类
fastjson

更多内容参见 SpringMVC 学习笔记目录：【Spring MVC】学习笔记汇总

什么是 Json?

JSON（JavaScript Object Notation）

是一种轻量级的数据交换格式，目前使用特别广泛。
采用完全独立于编程语言的文本格式来存储和表示数据。
简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。
易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

Json 语法格式：

{"name": "QinJiang"}
{"age": "3"}
{"sex": "男"}

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"}'

测试代码：

// 编写一个 js对象
var user = {name : "yusael",age : 3,sex : "男"
};
// 将 js对象 转为 json字符串
var str = JSON.stringify(user);
console.log(str);
// 将 json字符串 转为js对象
var userObj = JSON.parse(str);
console.log(userObj);

Jackson

Jackson 应该是目前比较好的 json 解析工具了

当然工具不止这一个，比如还有阿里巴巴的 fastjson 等等。

使用 Jackson，使用它需要导入它的 jar 包：

<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.11.0</version>
</dependency>

使用 json 注意 解决乱码问题：用 @RequestMaping 的 produces 指定响应体返回类型和编码。

@RequestMapping(value = "/json", produces = "application/json;charset=utf-8")

@Controller
public class UserController {// 解决乱码问题@RequestMapping(value = "/json", produces = "application/json;charset=utf-8")@ResponseBodypublic String json() throws JsonProcessingException {// 创建一个 jackson 的对象映射器, 用来解析数据ObjectMapper mapper = new ObjectMapper();// 创建一个对象User user = new User(1, "zhenyu", "男");// 将对象解析成 json 格式String str = mapper.writeValueAsString(user);System.out.println(str);// 由于@ResponseBody注解, 这里会将 str 转成 json 格式返回return str;}
}

统一乱码解决

通过 @RequestMapping(value = "/json", produces = "application/json;charset=utf-8") 解决乱码比较麻烦，如果项目中有许多请求则每一个都要添加，可以通过 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 // 使得所有方法都返回 Json 字符串
public class UserController {@RequestMapping(value = "/json")public String json() throws JsonProcessingException {// 创建一个 jackson 的对象映射器, 用来解析数据ObjectMapper mapper = new ObjectMapper();// 创建一个对象User user = new User(1, "zhenyu", "男");// 将对象解析成 json 格式String str = mapper.writeValueAsString(user);System.out.println(str);// 由于@RestController 注解, 这里会将 str 转成 json 格式返回;return str;}
}

Json 返回集合

@RequestMapping("/json1")
public String json2() throws JsonProcessingException {ObjectMapper mapper = new ObjectMapper();User user1 = new User(1, "Jack", "男");User user2 = new User(2, "Rose", "女");User user3 = new User(3, "Kitty", "女");User user4 = new User(4, "Jerry", "男");User user5 = new User(5, "Yusael", "男");List<User> users = new ArrayList<>();users.add(user1);users.add(user2);users.add(user3);users.add(user4);users.add(user5);String str = mapper.writeValueAsString(users);return str;
}

Json 输出时间对象

默认日期格式是 时间戳 —— 1970年1月1日到当前日期的毫秒数。

Jackson 默认是会把时间转成 timestamps 形式。

@RequestMapping("/json2")
public String json2() throws JsonProcessingException {ObjectMapper mapper = new ObjectMapper();Date date = new Date();String str = mapper.writeValueAsString(date);return str;
}

解决方案：取消 timestamps 形式，自定义时间格式。

@RequestMapping("/json3")
public String json3() 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;
}

抽取工具类

如果要经常使用的话，这样是比较麻烦的，我们可以将这些代码封装到一个工具类中；

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);Date date = new Date();try {return mapper.writeValueAsString(date);} catch (JsonProcessingException e) {e.printStackTrace();}return null;}}

使用工具类，代码就变得更加简单了。

@RequestMapping("/json4")
public String json4() throws JsonProcessingException {ObjectMapper mapper = new ObjectMapper();return JsonUtils.getJson(new Date());
}

fastjson

fastjson.jar 是阿里开发的一款专门用于 Java 开发的包，可以方便的实现 json 对象与 JavaBean 对象的转换，实现 JavaBean 对象与 Json 字符串的转换，实现 Json 对象与 Json字符串的转换。

实现 Json 的转换方法很多，最后的实现结果都是一样的。

fastjson 的 pom 依赖：

<dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.60</version>
</dependency>

fastjson 中三个主要的类：

JSONObject 代表 Json 对象
JSONObject 实现了 Map 接口, 猜想 JSONObject 底层操作是由 Map 实现的。
JSONObject 对应 Json 对象，通过各种形式的 get() 方法可以获取 Json 对象中的数据，也可利用诸如 size()，isEmpty() 等方法获取 “键 : 值对” 的个数和判断是否为空。其本质是通过实现 Map 接口并调用接口中的方法完成的。
JSONArray 代表 Json 对象数组
内部是由 List 接口中的方法来完成操作的。
JSON 代表 JSONObject 和 JSONArray 的转化