SpringMVC【五】JSON
9、JSON
9.1 JSON 简介
- JSON(JavaScript Object Notation,JS 对象标记)是一种轻量级的数据交换格式,目前使用特别广泛。
- 采用完全独立于编程语言的文本格式来存储和表示数据。
- 简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。
- 易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率。
9.2 JSON 与 JavaScript
在 JavaScript 语言中,一切都是对象。因此,任何 JavaScript 支持的类型都可以通过 JSON 来表示,例如字符串、数字、对象、数组等。
JSON 是 JavaScript 对象的字符串表示法,它使用文本表示一个 JS 对象的信息,本质是一个字符串。
var obj = {a: 'Hello', b: 'World'}; //这是一个对象,注意键名也是可以使用引号包裹的
var json = '{"a": "Hello", "b": "World"}'; //这是一个 JSON 字符串,本质是一个字符串
要求和语法格式:
- 对象表示为键值对,数据由逗号分隔
- 花括号保存对象
- 方括号保存数组
JSON 键值对是用来保存 JavaScript 对象的一种方式,和 JavaScript 对象的写法也大同小异,键/值对组合中的键名写在前面并用双引号 "" 包裹,使用冒号 : 分隔,然后紧接着值:
{"name": "张三"}
{"age": "3"}
{"sex": "男"}
JSON 和 JavaScript 对象互转:
-
JSON 字符串转换为 JavaScript 对象,使用
JSON.parse()
方法: -
JavaScript 对象转换为 JSON 字符串,使用
JSON.stringify()
方法:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<script type="text/javascript">
// 编写一个 JavaScript 对象
var user = {
name:"张三",
age:3,
sex:"男"
};
//将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>
浏览器的控制台输出为:
9.3 Jackson——Controller 返回 JSON 数据
Jackson 应该是目前比较好的 json 解析工具,当然工具不止这一个,比如还有阿里巴巴的 Fastjson 等。
测试一:输出对象
-
这里使用 Jackson,使用它需要导入它的jar包
<dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.10.0</version> </dependency>
-
web.xml 配置 servlet 和 乱码过滤
-
springmvc-servlet.xml 配置视图解析器和开启自动扫描包
-
实体类 User
@Data //这里使用了 Lombok,需要先导入 Lombok 的依赖 @AllArgsConstructor @NoArgsConstructor public class User { private String name; private int age; private String sex; }
-
Controller 类,需要使用一个注解 @RestController 和一个 ObjectMapper 对象
-
被 @RestController 注解的类和方法,不会走视图解析器,会直接在页面输出我们返回的结果;
-
ObjectMapper 会创建一个 Jackson 的对象映射器,用来解析数据。
@Controller // 会走视图解析器 //@RestController //里面所有的方法都只会返回 json 字符串 public class UserControlller { //produces:指定响应体返回类型和编码 //@RequestMapping(value = "/j1",produces = "application/json;charset=utf-8") @RequestMapping("/j1") @ResponseBody //它就不会走视图解析器,会直接返回一个字符串,配合@Controller使用 public String json1() throws JsonProcessingException { // jackson ObjectMapper //创建一个jackson的对象映射器,用来解析数据 ObjectMapper mapper = new ObjectMapper(); //创建一个对象 User user = new User("张三", 3, "男"); //将我们的对象解析成为json格式 String str = mapper.writeValueAsString(user); //由于 @ResponseBody 注解,这里会将str转成json格式返回;十分方便 return str; }
注意:在类上直接使用 @RestController,这样里面所有的方法都只会返回 json 字符串了,不用再每一个都添加 @ResponseBody,在前后端分离开发中,一般都使用 @RestController ,十分便捷。
-
-
配置Tomcat , 启动测试,浏览器地址栏输入 http 😕/localhost:8080/j1,输出出现乱码问题
-
乱码解决
- 通过 @RequestMaping 的 produces 属性来实现
//produces:指定响应体返回类型和编码 @RequestMapping(value = "/j1",produces = "application/json;charset=utf-8")
- 乱码的统一解决方法:
前面解决乱码的方法比较麻烦,如果项目中有许多请求则每一个都要添加 produces属性,可以通过 Spring 配置统一指定,这样就不用每次都去处理。
可以在 springmvc 的配置文件上添加一段消息 StringHttpMessageConverter 转换配置:
<!--json乱码问题配置--> <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>
测试二:输出集合
-
在 UserControlller 类中增加一个新的方法
@RequestMapping("/j2") public String json2() throws JsonProcessingException { //创建一个jackson的对象映射器,用来解析数据 ObjectMapper mapper = new ObjectMapper(); //创建一个对象 User user1 = new User("张三1号", 3, "男"); User user2 = new User("张三2号", 3, "男"); User user3 = new User("张三3号", 3, "男"); User user4 = new User("张三4号", 3, "男"); 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; }
-
运行,成功输出结果
测试三:输出时间对象
-
在 UserControlller 类中增加一个新的方法
@RequestMapping("/j3") public String json3() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); //创建时间一个对象,java.util.Date Date date = new Date(); //将我们的对象解析成为json格式 String str = mapper.writeValueAsString(date); return str; }
-
运行:结果为一串数字
ObjectMapper 将时间解析后的默认格式为:Timestamp 时间戳,即默认日期格式会变成一个数字,是1970年1月1日到当前日期的毫秒数。
-
解决方法
- 使用 java 中的日期转换方式
@RequestMapping("/j3") public String json3() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); // 自定义日期格式 SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); //创建时间一个对象,java.util.Date Date date = new Date(); return mapper.writeValueAsString(date); // ObjectMapper 时间解析后的默认格式为:Timestamp 时间戳 return mapper.writeValueAsString(sdf.format(date)); }
- 使用 ObjectMapper 对象来格式化输出:取消timestamps形式 , 自定义时间格式
@RequestMapping("/j3") public String json3() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); // 使用ObjectMapper来格式化输出,不使用时间戳的方式 mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); // 自定义日期格式对象 SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); //指定日期格式 mapper.setDateFormat(sdf); //创建时间一个对象,java.util.Date Date date = new Date(); return mapper.writeValueAsString(date); }
抽取为工具类
可以将之前重复写代码封装到一个工具类中,以后使用时会更加简洁
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("/j4")
public String json4() throws JsonProcessingException {
Date date = new Date();
// 使用工具类
return JsonUtils.getJson(date);
}
9.4 FastJson
Fastjson 是阿里开发的一款专门用于 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 对象
-
JSONArray 代表 json 对象数组
-
JSON 代表 JSONObject 和 JSONArray 的转化
Fastjson 的使用:
@RequestMapping("/j5")
public String json5() throws JsonProcessingException {
//创建一个对象
User user1 = new User("张三1号", 3, "男");
User user2 = new User("张三2号", 3, "男");
User user3 = new User("张三3号", 3, "男");
User user4 = new User("张三4号", 3, "男");
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);
return "hello";
}
结果,控制台输出
*******Java对象 转 JSON字符串*******
JSON.toJSONString(list)==>[{"age":3,"name":"张三1号","sex":"男"},{"age":3,"name":"张三2号","sex":"男"},{"age":3,"name":"张三3号","sex":"男"},{"age":3,"name":"张三4号","sex":"男"}]
JSON.toJSONString(user1)==>{"age":3,"name":"张三1号","sex":"男"}
****** JSON字符串 转 Java对象*******
JSON.parseObject(str2,User.class)==>User(name=张三1号, age=3, sex=男)
****** Java对象 转 JSON对象 ******
(JSONObject) JSON.toJSON(user2)==>张三2号
****** JSON对象 转 Java对象 ******
JSON.toJavaObject(jsonObject1, User.class)==>User(name=张三2号, age=3, sex=男)