jackson學習之十(終篇)：springboot整合(配置類)-有解無憂

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

內容：所有原創文章分類匯總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；

系列文章匯總

jackson學習之一：基本資訊
jackson學習之二：jackson-core
jackson學習之三：常用API操作
jackson學習之四：WRAP_ROOT_VALUE（root物件）
jackson學習之五：JsonInclude注解
jackson學習之六：常用類注解
jackson學習之七：常用Field注解
jackson學習之八：常用方法注解
jackson學習之九：springboot整合(組態檔)
jackson學習之十(終篇)：springboot整合(配置類)

本篇概覽

本文是《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)	[email protected]:zq2599/blog_demos.git	該專案原始碼的倉庫地址，ssh協議

這個git專案中有多個檔案夾，本章的應用在jacksondemo檔案夾下，如下圖紅框所示：

在這里插入圖片描述

jacksondemo是父子結構的工程，本篇的代碼在springbootconfigbean子工程中，如下圖：

在這里插入圖片描述

編碼

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

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>jacksondemo</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>springbootconfigbean</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springbootconfigbean</name>
    <description>Demo project for Spring Boot with Jackson, configuration from config bean</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <!--不用spring-boot-starter-parent作為parent時的配置-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.3.3.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- swagger依賴 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!-- swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

本文最重要的代碼是配置類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", "[email protected]"))
                //版本號
                .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 = "https://www.cnblogs.com/bolingcavalry/p/測驗序列化", notes = "測驗序列化")
    @RequestMapping(value = "https://www.cnblogs.com/serialization", method = RequestMethod.GET)
    public Test serialization() throws JsonProcessingException {

        Test test = new Test();
        logger.info(mapper.writeValueAsString(test));

        return test;
    }

    @ApiOperation(value = "https://www.cnblogs.com/bolingcavalry/p/測驗反序列化", notes="測驗反序列化")
    @RequestMapping(value = "https://www.cnblogs.com/deserialization",method = RequestMethod.PUT)
    public String deserialization(@RequestBody Test test) {
        return test.toString();
    }
}

驗證

啟動SpringbootConfigBeanApplication后，瀏覽器打開：http://localhost:8080/swagger-ui.html
先驗證序列化介面/jsonproperty/serialization：

在這里插入圖片描述
3. 再驗證反序列化介面 /jsonproperty/deserialization：

在這里插入圖片描述

至此，整個《jackson學習》系列就全部完成了，希望這十篇內容能夠給您帶來一些參考，助您在編碼程序中更加得心應手的使用Jackson；

你不孤單，欣宸原創一路相伴

Java系列
Spring系列
Docker系列
kubernetes系列
資料庫+中間件系列
DevOps系列

歡迎關注公眾號：程式員欣宸

微信搜索「程式員欣宸」，我是欣宸，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/257707.html

標籤：Java

上一篇：一個方便 LeetCode 復習的腳本

下一篇：jackson學習之十(終篇)：springboot整合(配置類)