Jackson--JSON解析工具的使用以及复用思想

yui方木

已于 2024-04-24 09:22:19 修改

阅读量523

点赞数 3

分类专栏： SpringMVC 文章标签： json spring java

于 2021-01-06 23:46:45 首次发布

本文链接：https://blog.csdn.net/weixin_44976835/article/details/112300196

版权

SpringMVC 专栏收录该内容

11 篇文章 2 订阅

订阅专栏

1.首先还是导入jar包：

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.12.0</version>
</dependency>

2.然后配置web.xml：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
version="5.0">

<!--注册DispatcherServlet SpringMVC的核心 请求分发器-->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--DispatcherServlet必须要关联一个springmvc的配置文件：【servlet name】-servlet.xml-->
<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>
<!--“\” 匹配所有的请求（不包括.jsp） 一般都是“/”-->
<!--"\*" 匹配所有的请求（包括.jsp）-->
<servlet-mapping>
<servlet-name>springmvc</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>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>

3.配置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
https://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="controller"/>
<mvc:default-servlet-handler/>
<!--使用注解自动配置HandlerMapping和HandlerAdapter,并且自动注入-->
<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>

4.随便编写一个User实体类，然后编写测试用Controller

package controller;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String name;
private int age;
private String sex;
}

现在我们要做的就是把这个User的对象转换为JSON对象-字符串，然后传递给前端
这里有两个注解：@ResponseBody //加了这个注解就不会走视图解析器，会直接返回一个String字符串
也可以在类上方加@RestController标签，这样整个类的所有方法都不会走视图解析器，直接返回一个String字符串

下面编写一个Controller类方法来将实体类对象转换为JSON对象，通过Jackson包的ObjectMapper对象的writeValueAsString方法：

@RequestMapping("/json")
@ResponseBody //加了这个注解就不会走视图解析器，会直接返回一个String字符串
public String json() throws Exception{

//创建一个对象
User user = new User("张三",18,"男");

//Jackson包内有一个对象objectMapper
ObjectMapper objectMapper = new ObjectMapper();
String s = objectMapper.writeValueAsString(user);
return s;

}

开启Tomcat服务器，访问/json，可以看到返回的User对象转化的JSON对象：
在这里插入图片描述
因为没有走视图解析器，所以没有走到过滤器，出现乱码，需要自己手动设置utf-8编码：
在@RequestMapping标签中加上produces：然后设置JSON编码即可：

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

所以Controller类代码为：

package controller;


import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {
@RequestMapping(value = "/json",produces = "application/json;charset=utf-8")
@ResponseBody //加了这个注解就不会走视图解析器，会直接返回一个String字符串
public String json() throws Exception{

//创建一个对象
User user = new User("张三",18,"男");

//Jackson包内有一个对象objectMapper
ObjectMapper objectMapper = new ObjectMapper();
String s = objectMapper.writeValueAsString(user);
return s;

}
}

再次部署Tomcat服务器：乱码问题解决
在这里插入图片描述
上面解决乱码的方法是很麻烦的，每个都要配置，SpringMVC有一个统一解决JSON乱码的方法：
在springmvc-servlet.xml的mvc:annotation-driven中配置：mvc:message-converters register-defaults="true"

<?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
https://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="controller"/>
<mvc:default-servlet-handler/>
<!--使用注解自动配置HandlerMapping和HandlerAdapter,并且自动注入-->
<!-- 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>

这样就不需要手动在RequestMapping注解内配置produces了。
重新开启Tomcat，乱码问题依然解决：
在这里插入图片描述

5.Jackson的一些应用场景

1.JSON返回一个对象集合：

@Controller
public class UserController {
@RequestMapping(value = "/json")
@ResponseBody //加了这个注解就不会走视图解析器，会直接返回一个String字符串
public String json() throws Exception{

ArrayList<User> list = new ArrayList<>();
//创建一个对象
User user = new User("张三",18,"男");
User user1 = new User("李四", 16, "女");
User user2 = new User("王五",12,"男");

list.add(user);
list.add(user1);
list.add(user2);
//Jackson包内有一个对象objectMapper
ObjectMapper objectMapper = new ObjectMapper();
String s = objectMapper.writeValueAsString(list);
return s;

}

只需要创建一个集合然后把对象装进去，然后将整个集合一起转为JSON对象即可：
开启Tomcat：
[ ]一个集合内所有{ }每个对象。
在这里插入图片描述
2.JSON返回一个时间对象：

@RequestMapping("/date")
@ResponseBody
public String json02() throws Exception{
ObjectMapper objectMapper = new ObjectMapper();
Date date = new Date();
//JSON:时间解析后的默认格式Timestamp时间戳
String s = objectMapper.writeValueAsString(date);
return s;
}

开启Tomcat，得到一个时间戳Timestamp：JSON解析时间的默认格式
在这里插入图片描述
改变时间输出格式的两个方法：

1.可以通过SimpleDateFormat方法来转换时间格式：

@RequestMapping("/date")
@ResponseBody
public String json02() throws Exception{
ObjectMapper objectMapper = new ObjectMapper();
Date date = new Date();
//JSON:时间解析后的默认格式Timestamp时间戳
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String format = simpleDateFormat.format(date);
String s = objectMapper.writeValueAsString(format);
return s;
}

2.配置ObjectMapper，规定输出时间的格式

@RequestMapping("/date")
@ResponseBody
public String json02() throws Exception{
ObjectMapper objectMapper = new ObjectMapper();
//规定ObjectMapper不使用时间戳的形式输出时间
objectMapper.configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS,false);
SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//自定义ObjectMapper输出时间的格式
objectMapper.setDateFormat(simpleDateFormat);

Date date = new Date();
//JSON:时间解析后的默认格式Timestamp时间戳
String s = objectMapper.writeValueAsString(date);
return s;
}

6.代码的复用的思想：

我们可以把转换日期为JSON对象封装成一个方法类（utils）：

package utils;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

import java.text.SimpleDateFormat;

public class DateJSONUtil {
public String getDate (Object obj,String sdf) throws Exception{
ObjectMapper mapper = new ObjectMapper();
mapper.configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS,false);
SimpleDateFormat simpleDateFormat = new SimpleDateFormat(sdf);
mapper.setDateFormat(simpleDateFormat);
String s = mapper.writeValueAsString(obj);
return s;
}
}

这样可以实现方法的复用，再要转换时间的时候可以直接调用方法即可：

@RequestMapping("/date")
@ResponseBody
public String json02() throws Exception{
Date date = new Date();
DateJSONUtil dateJSONUtil = new DateJSONUtil();
String date1 = dateJSONUtil.getDate(date, "yyyy-MM-dd HH:mm:ss");
return date1;
}

无论什么方法都可以在封装到utils类中实现复用，只要将要转换为JSON对象的对象传递给utils方法即可。

这也是底层java源码的编写方式，相互调用，所以我们日常编写代码时也要充分运用这种思想，不要反复造轮子。

yui方木

关注

3
点赞
踩
1

收藏

觉得还不错? 一键收藏
打赏
1
评论
Jackson--JSON解析工具的使用以及复用思想

1.首先还是导入jar包：<dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <v
复制链接

扫一扫