1.json的概念
详情看博客Json知识
2、Controller返回JSON数据使用Jackson工具
- Jackson应该是目前比较好的json解析工具了
- 当然工具不止这一个,比如还有阿里巴巴的 fastjson 等等。
- 我们这里使用Jackson,使用它需要导入它的jar包
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jacksoncore -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.11.3</version>
</dependency>
记得添加完要导包
配置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>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<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>
<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">
<context:component-scan base-package="com.loey.controller"/>
<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!--前缀-->
<property name="prefix" value="/WEB-INF/jsp/"/>
<!--后缀-->
<property name="suffix" value=".jsp"/>
</bean>
</beans>
编写一个User的实体类,然后我们去编写我们的测试Controller
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private Integer age;
}
这里我们需要两个新东西,一个是@ResponseBody,一个是ObjectMapper对象,我们看下具体 的用法 编写一个Controller
@Controller
public class UserController {
//思考问题,我们正常返回他会走视图解析器,而json需要返回的是一个字符串;
//市面上有很多的第三方jar包可以实现这个功能,jackson.只需要一个简单的注解就可以实现了;
//@ResponseBody , 将服务器端返回的对象转换为json对象响应回去;
@RequestMapping(value = "/json1")
@ResponseBody
public String json1() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("王嘉尔", 26);
//将我们的对象解析成为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解,这里会将str转成json格式返回;十分方便
return str;
}
}
出现问题:
解决方法:https://blog.csdn.net/wym2011aaj/article/details/100770779
配置Tomcat , 启动测试一下
- 发现出现了乱码问题,我们需要设置一下他的编码格式为utf-8,以及它返回的类型;
- 通过@RequestMaping的produces属性来实现,修改下代码
//produces:指定响应体返回类型和编码
@RequestMapping(value = "/json1",produces = "application/json;charset=utf-8")
@ResponseBody
【注意:使用json记得处理乱码问题】
3、代码优化
乱码统一解决
上一种方法比较麻烦,如果项目中有许多请求则每一个都要添加,可以通过Spring配置统一指定,这 样就不用每次都去处理了!
我们可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter转换配置!
<mvc:default-servlet-handler/>
<mvc:annotation-driven>
<!--JSON格式乱码处理方式-->
<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 {
@RequestMapping("/json2")
public String json2() throws JsonProcessingException {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//创建一个对象
User user = new User("王嘉尔", 26);
//将我们的对象解析成为json格式
String str = mapper.writeValueAsString(user);
//由于@ResponseBody注解,这里会将str转成json格式返回;十分方便
return str;
}
}
启动tomcat测试,结果都正常输出!
4、测试集合输出
增加一个新的方法
@RequestMapping("/json3")
public String listJson() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
User user1 = new User("张三", 23);
User user2 = new User("张三", 23);
User user3 = new User("张三", 23);
User user4 = new User("张三", 23);
List<User> users = new ArrayList<>();
users.add(user1);
users.add(user2);
users.add(user3);
users.add(user4);
String str = mapper.writeValueAsString(users);
return str;
}
5、输出时间对象
增加一个新的方法
@RequestMapping("/json4")
public String timeJson() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//创建时间一个对象,java.util.Date
Date date = new Date();
//发现问题:时间默认返回的json字符串变成了时间戳的格式: Timestamp
String str = mapper.writeValueAsString(date);
return str;
}
- 默认日期格式会变成一个数字,是1970年1月1日到当前日期的毫秒数!
- Jackson 默认是会把时间转成timestamps形式
解决方案:取消timestamps形式 , 自定义时间格式
@RequestMapping("/json4")
public String timeJson() 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);
//创建时间一个对象,java.util.Date
Date date = new Date();
//发现问题:时间默认返回的json字符串变成了时间戳的格式: Timestamp
String str = mapper.writeValueAsString(date);
return str;
}
6、抽取为工具类
如果要经常使用的话,这样是比较麻烦的,我们可以将这些代码封装到一个工具类中;我们去编写下
public class JsonUtils {
public static String getJson(Object Object) {
return getJson(Object,"yyyy-MM-dd HH:mm:dd");
}
public static String getJson(Object Object,String dateFormat) {
//创建一个jackson的对象映射器,用来解析数据
ObjectMapper mapper = new ObjectMapper();
//不使用时间戳的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
//自定义日期格式对象
SimpleDateFormat simpleDateFormat = new SimpleDateFormat(dateFormat);
//指定日期格式
mapper.setDateFormat(simpleDateFormat);
try {
return mapper.writeValueAsString(Object);
} catch (JsonProcessingException e) {
e.printStackTrace();
}
return null;
}
}
我们使用工具类,代码就更加简洁了!
@RequestMapping("/json5")
public String jsonUtil(){
Date date = new Date();
String str = JsonUtils.getJson(date, "yyyy-MM-dd HH:mm:dd");
return str;
}
@RequestMapping("/json6")
public String jsonUtil1(){
User user = new User("李四",34);
String str = JsonUtils.getJson(user);
return str;
}
7、FastJson
fastjson.jar是阿里开发的一款专门用于Java开发的包,可以方便的实现json对象与JavaBean对象的转 换,实现JavaBean对象与json字符串的转换,实现json对象与json字符串的转换。实现json的转换方法 很多,最后的实现结果都是一样的。
fastjson 的 pom依赖
<!-- <dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.75</version>
</dependency>
fastjson 三个主要的类:
- 【JSONObject 代表 json 对象 】
1. JSONObject实现了Map接口, 猜想 JSONObject底层操作是由Map实现的。
2.JSONObject对应json对象,通过各种形式的get()方法可以获取json对象中的数据,也可利用 诸如size(),isEmpty()等方法获取"键:值"对的个数和判断是否为空。其本质是通过实现Map 接口并调用接口中的方法完成的。 【 - JSONArray 代表 json 对象数组】
内部是有List接口中的方法来完成操作的。 - 【JSON 代表 JSONObject和JSONArray的转化】
JSON类源码分析与使用 仔细观察这些方法,主要是实现json对象,json对象数组,javabean对象,json字符串之间 的相互转化
代码测试,我们新建一个FastJsonDemo 类
package com.loey.controller;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.loey.pojo.User;
import java.util.ArrayList;
import java.util.List;
public class FastJsonDemo {
public static void main(String[] args) {
User user1 = new User("张三", 23);
User user2 = new User("张三", 23);
User user3 = new User("张三", 23);
User user4 = new User("张三", 23);
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(user1);
System.out.println("JSON.toJSONString(user1)==>" + str1);
String str2 = JSON.toJSONString(list);
System.out.println("JSON.toJSONString(list)==>" + str2);
System.out.println();
System.out.println("******************json字符串转JAVA对象****************");
User user = JSON.parseObject(str1, User.class);
System.out.println("JSON.parseObject(str2, User.class)==>" + user);
System.out.println();
System.out.println("******************java对象转json对象****************");
JSONObject jsonObject = (JSONObject)JSON.toJSON(user1);
System.out.println("(JSONObject)JSON.toJSON(user1)==>" + jsonObject.getString("name"));
System.out.println();
System.out.println("******************json对象转java对象****************");
User user5 = JSON.toJavaObject(jsonObject, User.class);
System.out.println("(JSON.toJavaObject(jsonObject, User.class)==>" + user5);
}
}
这种工具类,我们只需要掌握使用就好了,在使用的时候在根据具体的业务去找对应的实现。和以前的 commons-io那种工具包一样,拿来用就好了