jackson学习之九：springboot整合(配置文件)-白红宇

jackson学习之九：springboot整合(配置文件)

阅读量：419 次

发布时间：2019-03-06

本文共 8431 字，大约阅读时间需要 28 分钟。

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码)：

系列文章汇总

关于springboot整合jackson

本文是《jackson学习》系列的第九篇，学习如何在springboot项目中使用jackson，以springboot-2.3.3版本为例，jackson是springboot的默认json处理工具，如下图红框所示，jackson在maven配置中被spring-boot-starter-web间接依赖，可直接使用：

在springboot项目中常用的配置方式有两种：

用properties或yml配置文件来配置，即本篇的内容；

本篇概览

今天实战内容如下：

开发springboot应用，体验springboot默认支持jackson，包括jackson注解和ObjectMapper实例的注入；

在application.yml中添加jackson配置，验证是否生效；

源码下载

如果您不想编码，可以在GitHub下载所有源码，地址和链接信息如下表所示()：

名称	链接	备注
项目主页		该项目在GitHub上的主页
git仓库地址(https)		该项目源码的仓库地址，https协议
git仓库地址(ssh)	git@github.com:zq2599/blog_demos.git	该项目源码的仓库地址，ssh协议

这个git项目中有多个文件夹，本章的应用在jacksondemo文件夹下，如下图红框所示：

jacksondemo是父子结构的工程，本篇的代码在springbootproperties子工程中，如下图：

开始实战

由于同属于《jackson学习》系列文章，因此本篇的springboot工程作为jacksondemo的子工程存在，pom.xml如下，需要注意的是parent不能使用spring-boot-starter-parent，而是通过dependencyManagement节点来引入springboot依赖：


   
       
    
     4.0.0
        
            
     
      jacksondemo
             
     
      com.bolingcavalry
             
     
      1.0-SNAPSHOT
             
     
      ../pom.xml
         
        
    
     com.bolingcavalry
        
    
     springbootproperties
        
    
     0.0.1-SNAPSHOT
        
    
     springbootproperties
        
    
     Demo project for Spring Boot
        
            
     
      1.8
         
        
        
            
                 
                      
       
        org.springframework.boot
                       
       
        spring-boot-dependencies
                       
       
        2.3.3.RELEASE
                       
       
        pom
                       
       
        import
                   
              
         
        
            
                 
      
       org.springframework.boot
                  
      
       spring-boot-starter-web
              
             
                 
      
       org.springframework.boot
                  
      
       spring-boot-starter-test
                  
      
       test
                  
                      
                           
        
         org.junit.vintage
                            
        
         junit-vintage-engine
                        
                   
              
             
             
                 
      
       io.springfox
                  
      
       springfox-swagger2
              
             
             
                 
      
       io.springfox
                  
      
       springfox-swagger-ui
              
         
        
            
                 
                      
       
        org.springframework.boot
                       
       
        spring-boot-maven-plugin

启动类很平常：

package com.bolingcavalry.springbootproperties;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublic class SpringbootpropertiesApplication {    public static void main(String[] args) {        SpringApplication.run(SpringbootpropertiesApplication.class, args);    }}

由于用到了swagger，因此要添加swagger配置：

package com.bolingcavalry.springbootproperties;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.service.Contact;import springfox.documentation.service.Tag;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig {    @Bean    public Docket createRestApi() {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .tags(new Tag("JsonPropertySerializationController", "JsonProperty相关测试"))                .select()                // 当前包路径                .apis(RequestHandlerSelectors.basePackage("com.bolingcavalry.springbootproperties.controller"))                .paths(PathSelectors.any())                .build();    }    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                //页面标题                .title("SpringBoot整合Jackson(基于配置文件)")                //创建人                .contact(new Contact("程序员欣宸", "https://github.com/zq2599/blog_demos", "zq2599@gmail.com"))                //版本号                .version("1.0")                //描述                .description("API 描述")                .build();    }}

序列化和反序列化用到的Bean类，可见使用了JsonProperty属性来设置序列化和反序列化时的json属性名，field0字段刻意没有get方法，是为了验证JsonProperty的序列化能力：

package com.bolingcavalry.springbootproperties.bean;import com.fasterxml.jackson.annotation.JsonProperty;import io.swagger.annotations.ApiModel;import io.swagger.annotations.ApiModelProperty;import java.util.Date;@ApiModel(description = "JsonProperty注解测试类")public class Test {    @ApiModelProperty(value = "私有成员变量")    @JsonProperty(value = "json_field0", index = 1)    private Date field0 = new Date();    public void setField0(Date field0) {        this.field0 = field0;    }    @ApiModelProperty(value = "来自get方法的字符串")    @JsonProperty(value = "json_field1", index = 0)    public String getField1() {        return "111";    }    @Override    public String toString() {        return "Test{" +                "field0=" + field0 +                '}';    }}

测试用的Controller代码如下，很简单只有两个接口，serialization返回序列化结果，deserialization接受客户端请求参数，反序列化成实例，通过toString()来检查反序列化的结果，另外，还通过Autowired注解从spring容器中将ObjectMapper实例直接拿来用：

package com.bolingcavalry.springbootproperties.controller;import com.bolingcavalry.springbootproperties.bean.Test;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.beans.factory.annotation.Autowired;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;@RestController@RequestMapping("/jsonproperty")@Api(tags = {"JsonPropertySerializationController"})public class JsonPropertySerializationController {    private static final Logger logger = LoggerFactory.getLogger(JsonPropertySerializationController.class);    @Autowired    ObjectMapper mapper;    @ApiOperation(value = "测试序列化", notes = "测试序列化")    @RequestMapping(value = "/serialization", method = RequestMethod.GET)    public Test serialization() throws JsonProcessingException {        Test test = new Test();        logger.info(mapper.writeValueAsString(test));        return test;    }    @ApiOperation(value = "测试反序列化", notes="测试反序列化")    @RequestMapping(value = "/deserialization",method = RequestMethod.PUT)    public String deserialization(@RequestBody Test test) {        return test.toString();    }}

验证(不用配置文件)

先来看看没有配置文件时，默认的jackson配置的表现，直接在IDEA上运行SpringbootpropertiesApplication；

浏览器访问http://localhost:8080/swagger-ui.html ，如下图红框1，json_field0和json_field1都是JsonProperty注释，出现在了swagger的model中，这证明jackson注解已经生效：

点击上图的红框2，看看springboot引用返回的序列化结果，如下图：

另外，上述红框中的json格式，每个属性单独一行，像是做了格式化调整的，这是springboot做的？还是swagger展示的时候做的？用浏览器访问http://localhost:8080/jsonproperty/serialization ，结果如下，可见springboot返回的是未经过格式化的json：

接下来咱们添加jackson相关的配置信息并验证是否生效；

添加配置文件并验证

在resources目录新增application.yml文件，内容如下：

spring:  jackson:    # 日期格式化    date-format: yyyy-MM-dd HH:mm:ss    # 序列化相关    serialization:      # 格式化输出      indent_output: true      # 忽略无法转换的对象      fail_on_empty_beans: true    # 反序列化相关    deserialization:      # 解析json时，遇到不存在的属性就忽略      fail_on_unknown_properties: false    # 设置空如何序列化    defaultPropertyInclusion: NON_EMPTY    parser:      # 允许特殊和转义符      allow_unquoted_control_chars: true      # 允许单引号      allow_single_quotes: true