什么是JSON?
- JSON(JavaScript Object Notation, JS 对象标记) 是一种轻量级的数据交换格式,目前使用特别广泛。
- 采用完全独立于编程语言的文本格式来存储和表示数据。
- 简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。
- 易于人阅读和编写,同时也易于机器解析和生成,并有效地提升网络传输效率。
在 JavaScript 语言中,一切都是对象。因此,任何JavaScript 支持的类型都可以通过 JSON 来表示,例如字符串、数字、对象、数组等。
- 对象表示为键值对,数据由逗号分隔
- 花括号保存对象
- 方括号保存数组
JSON 键值对是用来保存 JavaScript 对象的一种方式,和 JavaScript 对象的写法也大同小异,键/值对组合中的键名写在前面并用双引号 “” 包裹,使用冒号 : 分隔,然后紧接着值:
{"id": "1"}
{"name": "hui"}
{"age": "18"}
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"}'
Controller返回JSON数据
jackson应该是目前比较好的json解析工具了,当然工具不止这一个,比如还有阿里巴巴的 fastjson 等等。
jackson的使用
1.我们要使用JackSon,首先要导入maven依赖
2.配置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">
<servlet>
<!--配置DispatcherServlet:这是个springmvc的核心:请求分发器,请前端控制器-->
<servlet-name>spring-mvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--DispatcherServlet要绑定spring配置文件-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-servlet.xml</param-value>
</init-param>
<!--启动级别 1 数字越小,启动越早-->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<!-- / 匹配所有的请求:(不包括jsp)-->
<!-- /* 匹配所有的请求:(包括jsp) 不要用这个会404-->
<servlet-name>spring-mvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!--配置SpringMVC的中文乱码过滤-->
<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>
<!--/ 匹配所有的请求:(不包括jsp)-->
<!--/* 匹配所有的请求:(包括jsp)-->
<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.ys.controller"/>
<!--解决返回字符串(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>-->
<!--视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
<!--前缀-->
<property name="prefix" value="/WEB-INF/jsp/"/>
<!--后缀-->
<property name="suffix" value=".jsp"/>
</bean>
</beans>
乱码问题解决
在springmvc的配置文件上添加下列代码
<!--解决返回字符串(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>
3.我们随便编写一个User的实体类,然后我们去编写我们的测试Controller
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private int id;
private String name;
private int age;
}
4.编写Controller
@Controller和@RestController的区别:
@RestController类下的返回值只会返回字符串,效果相当于@Controller配合@ResponseBody
注:
在类上直接使用 @RestController ,这样里面所有的方法都只会返回 json 字符串了,不用再每一个都添加@ResponseBody !
我们在前后端分离开发中,一般都使用 @RestController ,十分便捷!
<1>测试对象输出
//@Controller//@Controller注解会返回字符串会被视图解析器解析
@RestController//类下的返回值只会返回字符串,效果相当于@Controller配合@ResponseBody
public class UserController {
//@RequestMapping(value = "/j1",produces = "application/json;charset=utf-8")
// @ResponseBody//加上@ResponseBody就不会走视图解析器,会返回一个字符串
@RequestMapping(value = "/j1")
public String json1() throws JsonProcessingException {
//创建一个对象
User user = new User(3,"张三",18);
// Jackson-json解析工具,对象转为json格式
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(user);
return json;//返回值简写为一行 new ObjectMapper().writeValueAsString(user);
}
}
<2>测试集合输出
@RequestMapping("/j2")
public String json2() throws JsonProcessingException {
//创建对象
User user1 = new User(3,"张三1",18);
User user2 = new User(3,"张三2",18);
User user3 = new User(3,"张三3",18);
//创建集合,并把对象放入集合
List<User> userList = new ArrayList<User>();
userList.add(user1);
userList.add(user2);
userList.add(user3);
//Jackson-json解析工具,对象转为json格式
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(userList);
return json;//返回值简写为一行 new ObjectMapper().writeValueAsString(userList);
}
<3>输出时间对象
ObjectMapper解析时间对象后会转换为默认格式Timestamp:时间戳(时间戳是北京时间1970年01月01日08时00分00秒起至现在的总毫秒数)
1.为了将日期格式化,我们可以先自定义定日期格式并把日期对象转换为日期字符串,日期字符串转为json字符串。
//输出时间对象的两种方式
//1.java方式获取时间对象格式转换为json字符串
@RequestMapping(value = "/j3")
public static String json3() throws JsonProcessingException {
//Jackson-json解析工具,对象转为json格式
//ObjectMapper解析时间对象后会转换为默认格式Timestamp:时间戳(时间戳是北京时间1970年01月01日08时00分00秒起至现在的总毫秒数)
ObjectMapper mapper = new ObjectMapper();
//获取当前日期
Date date = new Date();
//自定义日期的格式://如果不自定义日期格式用ObjectMapper解析时间后会转换为默认格式Timestamp:
// 时间戳(时间戳是北京时间1970年01月01日08时00分00秒起至现在的总毫秒数)
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//当前日期格式字符串
String dateFormat = sdf.format(date);
//转换为json字符串日期格式
String jsonDate = mapper.writeValueAsString(dateFormat);
return jsonDate;//返回值简写为一行 new ObjectMapper().writeValueAsString(dateformat);
}
2.把ObjectMapper解析时间对象后会转换为默认格式Timestamp:时间戳关闭,并为ObjectMapper设置指定日期格式,把当前日期对象转换为指定日期格式json字符串。
@RequestMapping(value = "/j3")
public String json4() throws JsonProcessingException {
//Jackson-json解析工具,对象转为json格式
ObjectMapper mapper = new ObjectMapper();
//不使用时间戳的方式,默认使用时间戳,改为false不使用时间戳,
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定义日期格式对象
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//ObjectMapper设置指定日期格式
mapper.setDateFormat(sdf);
//获取当前日期
Date date = new Date();
String json = mapper.writeValueAsString(date);
return json;
}
以上几段代码,我们都需要先获取mapper对象再进行对应处理,非常的麻烦,所以我们想到可以将其抽取为工具类,降低耦合,实现代码重用!
抽取为json工具类
public class JsonUtils {
//重载
public static String getJson(Object object,String dateFormat){
ObjectMapper mapper = new ObjectMapper();
//不使用时间戳的方法
mapper.configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS,false);
//自定义日期的格式
SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
mapper.setDateFormat(sdf);
try {
return mapper.writeValueAsString(object);
} catch (JsonProcessingException e) {
e.printStackTrace();
}
return null;
}
//工具类内实现自己的代码重用,JDK很多代码都是这样写的
public static String getJson(Object object){
return getJson(object,"yyyy-MM-dd HH:mm:ss");
}
}
此时,我们再次对以上几个案例进行测试,代码十分简洁!
@RequestMapping("/j1")
//@ResponseBody //不会走视图解析器,而是返回一个字符串
public String json1(){
User user = new User(1, "明凯", 18);
return JsonUtils.getJson(user);
}
@RequestMapping("/j2")
public String json2(){
User user1 = new User(1, "明凯1", 18);
User user2 = new User(2, "明凯2", 18);
User user3 = new User(3, "明凯3", 18);
User user4 = new User(4, "明凯4", 18);
List<User> userList = new ArrayList<>();
userList.add(user1);
userList.add(user2);
userList.add(user3);
userList.add(user4);
return JsonUtils.getJson(userList);
}
@RequestMapping("/j3")
public String json3(){
Date date = new Date();
return JsonUtils.getJson(date,"yyyy-MM-dd HH:mm:ss");
}
FastJson
fastjson.jar是阿里开发的一款专门用于Java开发的包,可以方便的实现json对象与JavaBean对象的转换,实现JavaBean对象与json字符串的转换,实现json对象与json字符串的转换。实现json的转换方法很多,最后的实现结果都是一样的。
fastjson 的maven依赖
<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的转化】
JSON类源码分析与使用
仔细观察这些方法,主要是实现json对象,json对象数组,javabean对象,json字符串之间的相互转化。
@RequestMapping("/j4")
public String json4(){
User user1 = new User(1, "明凯1", 18);
User user2 = new User(2, "明凯2", 18);
User user3 = new User(3, "明凯3", 18);
User user4 = new User(4, "明凯4", 18);
List<User> userList = new ArrayList<>();
userList.add(user1);
userList.add(user2);
userList.add(user3);
userList.add(user4);
// FastJson-json解析工具
//java对象
//java对象转为json字符串
String user_to_jsonStr = toJSONString(user1);
//java对象转为json对象
JSONObject user_to_json = (JSONObject)toJSON(user1);
//javaList集合
//javaList集合转为JSON数组
JSONArray list_to_jsonArray= JSONArray.parseArray(toJSONString(userList));
//javaList集合转为json字符串
String list_to_json = toJSONString(userList);
//JSON数组
//JSON数组转为javaList集合
List<User> jsonArray_to_list = JSONObject.parseArray(list_to_jsonArray.toJSONString(), User.class);
//json字符串
//json字符串转为javaList集合
List<User> jsonStr_to_list = JSONObject.parseArray(list_to_json,User.class);
//json字符串转为java对象
User jsonStr_to_user= JSON.parseObject(user_to_jsonStr, User.class);
//json对象
//json对象转为java对象
User json_to_user = JSON.toJavaObject(user_to_json, User.class);
return toJSONString(userList);
}
这种工具类,我们只需要掌握使用就好了,在使用的时候在根据具体的业务去找对应的实现