jackson学习之十(终篇)：springboot整合(配置类)

欢迎访问我的GitHub

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，涉及Java、Docker、Kubernetes、DevOPS等；

系列文章汇总

本篇概览

本文是《jackson学习》系列的终篇，经过前面的一系列实战，相信您已可以熟练使用jackson灵活的执行各种json序列化和反序列化操作，那么，本篇就以轻松的方式来完成整个系列吧；
上一篇介绍的是在springboot中通过配置文件对jackson做设置，今天要聊的是另一种常用的jackson配置方式：配置类，就是自己编写代码实例化和配置springboot全局使用的ObjectMapper实例；

源码下载

如果您不想编码，可以在GitHub下载所有源码，地址和链接信息如下表所示(https://github.com/zq2599/blog_demos)：

名称

链接

备注

项目主页

https://github.com/zq2599/blog_demos

该项目在GitHub上的主页

git仓库地址(https)

https://github.com/zq2599/blog_demos.git

该项目源码的仓库地址，https协议

git仓库地址(ssh)

git@github.com:zq2599/blog_demos.git

该项目源码的仓库地址，ssh协议

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

jackson学习之十(终篇)：springboot整合(配置类)

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

jackson学习之十(终篇)：springboot整合(配置类)

编码

在父工程jacksondemo下新增子工程springbootconfigbean，pom.xml如下：

4.0.0 jacksondemo com.bolingcavalry 1.0-SNAPSHOT ../pom.xml com.bolingcavalry springbootconfigbean 0.0.1-SNAPSHOT springbootconfigbean Demo project for Spring Boot with Jackson, configuration from config bean <java.version>1.8</java.version> 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

本文最重要的代码是配置类JacksonConfig.java，如下，需要ConditionalOnMissingBean注解避免冲突，另外还给实例指定了名称customizeObjectMapper，如果应用中通过Autowired使用此实例，需要指定这个名字，避免报错"There is more than one bean of 'ObjectMapper ' type"：

@Configuration public class JacksonConfig {

@Bean("customizeObjectMapper")
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper getObjectMapper(Jackson2ObjectMapperBuilder builder) {
    ObjectMapper mapper = builder.build();

    // 日期格式
    mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd hh:mm:ss"));

    // 美化输出
    mapper.enable(SerializationFeature.INDENT_OUTPUT);

    return mapper;
}

}

对于JacksonConfig.getObjectMapper方法内的设置，如果您想做更多设置，请参考《jackson学习之三：常用API操作》里面的设置内容；

启动类依然很简单：

package com.bolingcavalry.springbootconfigbean;

import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication public class SpringbootConfigBeanApplication {
```
public static void main(String[] args) {
    SpringApplication.run(SpringbootConfigBeanApplication.class, args);
}
```
}

swagger配置：

package com.bolingcavalry.springbootconfigbean;

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 @EnableSwagger2 public 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.springbootconfigbean.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();
}

}

最后是测试用的Controller类，要注意的是在使用ObjectMapper实例的地方，用Autowired注解的时候，记得带上Qualifier注解：

package com.bolingcavalry.springbootconfigbean.controller;

import com.bolingcavalry.springbootconfigbean.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.beans.factory.annotation.Qualifier; 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);

@Qualifier("customizeObjectMapper")
@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();
}
```
}