Spring boot2.x-第04讲：Jackson

最新推荐文章于 2020-05-15 11:11:11 发布
最新推荐文章于 2020-05-15 11:11:11 发布
阅读量719 收藏
点赞数 2
分类专栏： SpringFamily 文章标签： Spring boot2.x
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fupinghaohao/article/details/102017251
版权

Spring boot2.x-第04讲：Jackson

1. 基本介绍

  • 序列化
    将内存中的对象转换为字节序列，方便持久化到磁盘(文件或数据库)或者网络传输。
  • 反序列化
    将字节序列转换为内存中的对象。

Spring MVC框架默认使用Jackson处理json。

对于Controller类：
请求时，在方法的形参中使用@RequestBody注解时，默认使用Jackson反序列化为对象；
响应时，在类上使用@RestController注解，在返回前使用Jackson将对象序列化为json。

2. Jackson的使用

2.1 API返回值去除为NULL的字段

当Controller类方法上使用@ResponseBody注解时，对于值为null的属性根本没必要返回。针对前后端分离的工程，有效解决数据传输过程中的流量浪费。当然可以举一反三，比如不返回空字符串的属性等。

2.1.1 现象

Controller测试类

package com.tong.hao.online.service.controller.test;

import com.tong.hao.online.api.model.test.DemoReq;
import com.tong.hao.online.api.model.test.DemoRes;
import com.tong.hao.online.api.service.test.ITestController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName TestController
 * @Author 友野浩二
 * @Description 测试控制器
 * @Version 1.0
 */
@Api(tags = {"测试控制器"})
@RestController
@Slf4j
@RequestMapping(value = "/test")
public class TestController implements ITestController {
    @Override
    @ApiOperation(value = "数据校验测试-POST")
    @RequestMapping(method = RequestMethod.POST, value = VALID_POST)
    public DemoRes demoValidOfPost(@RequestBody DemoReq demoReq) {
        System.err.println("数据校验测试-POST");
        DemoRes demoRes = new DemoRes();
        demoRes.setPhone("15789098766");
//        demoRes.setAddress("陕西省汉中市汉台区石门栈道");
        return demoRes;
    }
}

可以看到响应模型没有设置address属性。现在进行测试如下：
请求报文

{
	"tongInHead":{
		"clientNo":"123",
		"reqSystemId":"TWX",
		"reqBusinessNo":"123456789",
		"reqTranDate":"2019-09-28",
		"reqControllerUrl":"/test/valid/post"
	},
	"name":"呵呵",
	"age":"8",
	"sex":"I"
}

响应报文

{
    "tongOutHead": {
        "exceptionResultList": [
            {
                "retCode": "111111",
                "retMsg": "交易成功!"
            }
        ],
        "timestamp": "2019-10-03 21:16:23.414"
    },
    "phone": "15789098766",
    "address": null
}

问题
可以看到address的值为null，但还是给返回了。好像有点浪费流量。

2.1.2 解决方案

在application.ymal中配置spring.jackson.default-property-inclusion = 控制[序列化]期间包含的属性。配置如下：

spring.jackson.default-property-inclusion=non_null

【注意】：该配置有可能不生效，此时需要查看项目中有没有使用@EnableWebMvc注解，如果使用了，就需要删除了；如果没使用再看一下有没有哪个类继承了WebMvcConfigurationSupport(包涵了@EnableWebMvc)，如果有，则改为implements WebMvcConfigurer即可。

再次进行测试，响应报文如下：

{
    "tongOutHead": {
        "exceptionResultList": [
            {
                "retCode": "111111",
                "retMsg": "交易成功!"
            }
        ],
        "timestamp": "2019-10-03 21:28:20.307"
    },
    "phone": "15789098766"
}

由此可以看出address已经不再返回了。

2.2 Date类型入参和返回json格式化

当使用@ResponseBody或@RequestBody时，Date类型对象反序列化和序列化时，需要格式化。

2.2.1 现象一

Controller测试类

package com.tong.hao.online.service.controller.test;

import com.tong.hao.common.utils.ThBusinessUtils;
import com.tong.hao.common.utils.ThDateUtils;
import com.tong.hao.online.api.model.test.DemoReq;
import com.tong.hao.online.api.model.test.DemoRes;
import com.tong.hao.online.api.service.test.ITestController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName TestController
 * @Author 友野浩二
 * @Description 测试控制器
 * @Version 1.0
 */
@Api(tags = {"测试控制器"})
@RestController
@Slf4j
@RequestMapping(value = "/test")
public class TestController implements ITestController {
    @Override
    @ApiOperation(value = "数据校验测试-POST")
    @RequestMapping(method = RequestMethod.POST, value = VALID_POST)
    public DemoRes demoValidOfPost(@RequestBody DemoReq demoReq) {
        DemoRes demoRes = new DemoRes();
        demoRes.setPhone("15789098766");
//        demoRes.setAddress("陕西省汉中市汉台区石门栈道");
        demoRes.setBirthday(ThDateUtils.convertStr2Date("1994-03-03 20:20:20", ThDateUtils.PATTERN_ISO_DATETIME));
    }
}

请求报文不变
响应报文如下

{
    "tongOutHead": {
        "exceptionResultList": [
            {
                "retCode": "111111",
                "retMsg": "交易成功!"
            }
        ],
        "timestamp": "2019-10-03 21:36:13.831"
    },
    "phone": "15789098766",
    "birthday": "1994-03-03T12:20:20.000+0000"
}

问题
可以看到，日期……乱了……

2.2.2 解决方案

在application.ymal添加如下配置
spring.jackson.date-format = 配置日期[序列化]和[反序列化]格式

# 东八区时间
spring.jackson.time-zone=GMT+8
# 指定项目中所有日期类型返回的json格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss

再次测试，响应报文如下：

{
    "tongOutHead": {
        "exceptionResultList": [
            {
                "retCode": "111111",
                "retMsg": "交易成功!"
            }
        ],
        "timestamp": "2019-10-03 21:44:09.127"
    },
    "phone": "15789098766",
    "birthday": "1994-03-03 20:20:20"
}

2.2.3 现象二

Controller测试类

package com.tong.hao.online.service.controller.test;

import com.tong.hao.common.utils.ThBusinessUtils;
import com.tong.hao.common.utils.ThDateUtils;
import com.tong.hao.online.api.model.test.DemoReq;
import com.tong.hao.online.api.model.test.DemoRes;
import com.tong.hao.online.api.service.test.ITestController;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName TestController
 * @Author 友野浩二
 * @Description 测试控制器
 * @Version 1.0
 */
@Api(tags = {"测试控制器"})
@RestController
@Slf4j
@RequestMapping(value = "/test")
public class TestController implements ITestController {
    @Override
    @ApiOperation(value = "数据校验测试-POST")
    @RequestMapping(method = RequestMethod.POST, value = VALID_POST)
    public DemoRes demoValidOfPost(@RequestBody DemoReq demoReq) {
        System.err.println("数据校验测试-POST");
        DemoRes demoRes = new DemoRes();
        demoRes.setPhone("15789098766");
//        demoRes.setAddress("陕西省汉中市汉台区石门栈道");
        demoRes.setBirthday(ThDateUtils.convertStr2Date("1994-03-03 20:20:20", ThDateUtils.PATTERN_ISO_DATETIME));
        demoRes.setWeddingDay(ThDateUtils.convertStr2Date("2019-10-03", ThDateUtils.PATTERN_ISO_DATE));
        return demoRes;
    }
}

响应模型添加了weddingDay属性。
请求报文不变
响应报文如下

{
    "tongOutHead": {
        "exceptionResultList": [
            {
                "retCode": "111111",
                "retMsg": "交易成功!"
            }
        ],
        "timestamp": "2019-10-03 21:46:34.543"
    },
    "phone": "15789098766",
    "birthday": "1994-03-03 20:20:20",
    "weddingDay": "2019-10-03 00:00:00"
}

问题
可以看到weddingDay属性在代码中赋值为"2019-10-03"，即yyyy-MM-dd，并没有时分秒。

2.2.4 解决方案

针对响应模型中Date类型的属性需要特殊格式处理的，加入@JsonFormat注解即可。

package com.tong.hao.online.api.model.test;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.tong.hao.common.entity.api.TongBaseResponse;
import io.swagger.annotations.ApiModelProperty;
import lombok.*;

import java.util.Date;

@Setter
@Getter
@EqualsAndHashCode(callSuper = false)
@AllArgsConstructor
@NoArgsConstructor
public class DemoRes extends TongBaseResponse {
    @ApiModelProperty(value = "手机号")
    private String phone;

    @ApiModelProperty(value = "住址")
    private String address;

    @ApiModelProperty(value = "破壳日")
    private Date birthday;

    @ApiModelProperty(value = "结婚纪念日")
    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd")
    private Date weddingDay;
}

响应报文

{
    "tongOutHead": {
        "exceptionResultList": [
            {
                "retCode": "111111",
                "retMsg": "交易成功!"
            }
        ],
        "timestamp": "2019-10-03 21:51:26.738"
    },
    "phone": "15789098766",
    "birthday": "1994-03-03 20:20:20",
    "weddingDay": "2019-10-03"
}

完成了……

3. 参考资料

感谢！！！

ZePingPingZe
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot2.x系列教程（十二）Jackson常用注解使用详解
程序新视界
01-02 2329
在前些文章中我们曾提到一个问题，比如在Spring Boot中返回的对象，我们并不想直接返回所有的字段或者想指定字段的别名，那么该如何处理呢？ Jackson为我们提供了一些相关的注解来帮助我们处理以上问题。下面，我们逐个通过实例来了解一下Jackson针对Java对象的常用注解使用。 使用场景是用户登录时会使用一个LoginUser对象，该对象基本定义如下： public class Login...
SpringBoot2.x系列教程（十三）Jackson命名策略及自定义序列化
程序新视界
01-02 4159
上篇文章中我们介绍了常见的Jackson注解，本篇文章对其进行扩展，重点介绍指定自定义序列化的注解@JsonSerialize。 @JsonNaming 首先，上节课的注解中漏掉了一个@JsonNaming注解，我们先来看一下该注解的具体使用。 @JsonNaming：作用于类或属性上，用于指定命名的策略。Jackson默认自带了多种策略。该注解可对照@JsonProperty的功能。 比如，根据...
Spring Boot2自动化配置及使用jackson进行json解析
江南雨敲窗的博客
01-09 3677
快速体验 jackson jackson是spring boot 默认的json解析方案，当我们创建maven工程引入 spring-boot-starter-web时 jackson的相关依赖就以及自动引入了，如下， <dependency> <groupId>org.springframework.boot</groupId> <ar...
springBoot(2)---快速创建项目，初解jackson
a8892117的博客
05-11 163
快速创建项目，初解jackson 一、快速创建项目 springboot官网提供了工具类自动创建web应用：网址：http://start.spring.io/ 官网页面 1、快速创建一个 选择web代表这是一个web项目 这样就可以吧项目放到eclipse或者idea中进行运行了。 这里需要注意几点： 1.springboot2...
SpringBoot2.0整合jackson配置日期格式化和反序列化的实现
08-26
主要介绍了SpringBoot2.0整合jackson配置日期格式化和反序列化的实现，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
spring-boot-web-restfulcrud代码示例
07-22
Spring Boot 提供了 `spring-boot-starter-web` 依赖，它包含了 Servlet 容器（如 Tomcat 或 Jetty）、Spring MVC 和 Jackson JSON 处理库等关键组件。Spring MVC 是 Spring 框架的一部分，负责处理 HTTP 请求和响应...
Spring Boot快速开始.docx
06-26
2. **导入Spring Boot依赖**：在`pom.xml`中添加Spring Boot的父工程依赖`spring-boot-starter-parent`，并引入`spring-boot-starter-web`。这个`spring-boot-starter-web`包含了处理HTTP请求、视图解析等功能的依赖...
weibo-api-playgroud:微博火场
06-18
3. Spring Boot：快速构建RESTful服务，简化配置和依赖管理。 4. Log4j或SLF4J：日志记录，便于调试和问题定位。 六、项目实践 实际操作中，开发者首先需要注册成为微博开发者，获取API密钥，然后根据项目文档配置...
SpringiA4_SourceCode:Spring实战第四版源码，学习用。
01-19
《Spring实战第四版》是Java开发领域中一本深入讲解Spring框架的经典著作，源代码的提供为读者提供了亲自动手实践的机会，有助于加深理解和应用。在这个压缩包中，包含的文件名为"spring4源码_Code4"，我们可以推测...
5分钟快速学会spring boot整合Mybatis的方法
08-25
在整合Spring Boot和Mybatis的第一步，我们需要在`pom.xml`文件中引入必要的依赖。这里我们看到，已经引入了`spring-boot-starter-parent`作为父POM，确保我们获得Spring Boot的基础配置。接着，引入`mybatis-spring...
SpringBoot2.x系列教程（十五）SpringBoot Jackson属性配置详解
程序新视界
01-03 4720
在SpringBoot中使用Jackson，Spring Boot默认提供了一套初始化配置，同时也提供了可通过application配置文件进行配置的项目。 通过这些配置项，可更加方便的进行Json转化的配置。其实，Spring Boot针对内置的几种Json框架都有相应的配置，比如GSON和JSON-B的。本篇文章重点解析Spring Boot默认使用Jackson的属性配置。 对应配置配置定义...
SpringBoot2.1.X 常用json框架和Jackson返回结果处理
分享我的点点滴滴，在成长路上与你同行！
09-10 505
简介：介绍常用json框架和注解的使用，自定义返回json结构和格式 1、常用框架 阿里 fastjson,谷歌gson等 JavaBean序列化为Json，性能：Jackson > FastJson > Gson > Json-lib 同个结构 Jackson、FastJson、Gson类库各有优点，各有自己的专长 空间换时间，时间换空间 2、jac...
手摸手，一起重温SpringBoot 2知识点（五）处理JSON解析之Jackson、Gson、Fastjson格式化日期
The man was lazy and left no message
05-15 296
Spring Boot 支持三种 Json 库： Gson Jackson JSON-B 默认使用的是Jackson 一、Jackson方式 全局配置类： package com.junya.thymeleaf; import com.fasterxml.jackson.databind.ObjectMapper; import org.springframework.context.annotation.Bean; import org.springframework.context.annotat
spring boot 最佳实践（一）--使用jackson
热门推荐
老螺丝的技术人生
05-17 5万+
目前java json解析工具有阿里的fastjson，google的GSON，以及SpringMVC 默认的解析工具Jackson。建议在spring boot项目中只使用Jackson。
0x06 Spring Boot 2.x 之 JSON
极客星云-CSDN博客
02-07 689
Spring Boot 提供了三种JSON 解析类库： - Gson - Jackson - JSON-B 默认使用的Jackson.
SpringBoot2.x | Json及时间戳处理
qq_37244513的博客
10-28 2608
pom.xml &lt;!-- Json解析 --&gt; &lt;dependency&gt; &lt;groupId&gt;com.alibaba&lt;/groupId&gt; &lt;artifactId&gt;fastjson&lt;/artifactId&gt; &lt;version&gt;1.2.51&lt;/version &lt;/dependency
SpringBoot2.X学习总结:(2)json框架和注解
fenfeng2012
09-18 640
1、常用框架fastjson,gson等     JavaBean序列化Json,性能:Jackson-&gt;FastJson-&gt;Gson-&gt;Json-Lib 2、jackson处理相关    1)指定字段不返回:@JsonIgnore     2)指定日期格式:@JsonFormat(pattern="yyyy-MM-dd hh:mm:ss",locale="zh",tim...
Spring Boot (二) fastJSON的使用
不管风吹浪打，胜似闲庭信步
04-29 5114
Spring boot，通过创建实体类，然后通过实体类返回则就是json的格式，所以使用spring boot，不用担心返回格式处理不了的问题。 springBoot，默认使用的json解析框架是Jackson。 虽然jackson能够满足json的解析，但是心里最熟悉的依旧是alibaba的fastjon,当然，fastjon的要求springboot也是可以满足的，我们只需要在pom
SpringBoot系列之二 关于JSON使用的那点事儿
yeputi_WK的博客
06-21 4385
一、使用JSON 1、使用SpringBoot 中的Controller如果返回对象，返回到前端的数据默认为JSON @RequestMapping("getPerson") public Person getPerson() { Person person = new Person(); person.setId(0); person.setName("Kmagic枣庄智行公
spring.datasource.url=jdbc:mysql://localhost:3306/debook?characterEncoding=utf-8 spring.datasource.username=root spring.datasource.password=root spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.tomcat.initial-size=10 spring.datasource.tomcat.max-active=50 spring.datasource.tomcat.max-idle=30 spring.datasource.tomcat.min-idle=10 spring.freemarker.template-loader-path=classpath:/templates/ spring.freemarker.charset=utf-8 spring.freemarker.cache=false spring.freemarker.expose-request-attributes=true spring.freemarker.expose-session-attributes=true spring.freemarker.expose-spring-macro-helpers=true spring.freemarker.suffix=.ftl spring.jackson.date-format=yyyy-MM-dd spring.jackson.time-zone=GMT+8 mybatis.type-aliases-package=com.de.debook.entity mybatis.mapper-locations=classpath:mapper/*.xml debug=true logging.level.com.de.debook.mapper=debug
最新发布
05-25
这是一个 Spring Boot 应用程序的配置文件，其中包含了一些关于数据库连接、Freemarker 模板引擎的配置以及 MyBatis 的配置。 - 数据库连接：指定了数据库的连接地址、用户名、密码、驱动等信息，使用的是 MySQL ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值