實例詳解SpringBoot默認的JSON解析方案

Posted on 2021-08-16 by WalkonNet

一、什麼是JSON

JSON（JavaScript Object Notation）是一種基於JavaScript語法子集的開放標準數據交換格式。JSON是基於文本的，輕量級的，通常被認為易於讀/寫。

好瞭，廢話不多說，下面開始介紹如何在SpringBoot中使用JSON。

二、如何在SpringBoot中使用JSON

在學習json之前，我們必須先瞭解一下HttpMessageConverter，其實看名字就知道，這是一個消息轉換工具。

下面我來介紹一下它的兩個功能：

1、將服務端返回的對象序列化成 JSON 字符串。

2、將前端傳來的 JSON 字符串反序列化成 Java 對象。

所有的 JSON 生成都離不開相關的 HttpMessageConverter。

SpringMVC 自動配置瞭 Jackson 和 Gson 的 HttpMessageConverter，Spring Boot 中又對此做瞭自動化配置，下面是兩者對應源碼的路徑：

org.springframework.boot.autoconfigure.http.JacksonHttpMessageConvertersConfiguration

org.springframework.boot.autoconfigure.http.GsonHttpMessageConvertersConfiguration

所以，如果用戶使用 jackson 和 gson 的話，沒有其他額外配置，則隻需要添加依賴即可。

三、舉例

【第一步】老規矩，先創建一個SpringBoot項目。通過右邊的Maven可以看到，其實SpringBoot已經將json集成進來瞭，Maven結構如下圖：

【第二步】創建一個bean和一個controller類，具體項目結構和代碼如下：

【項目結構】

【User.java】

package com.mango.json.bean;

import com.fasterxml.jackson.annotation.JsonFormat;

import java.util.Date;

public class User {

    private Integer id;
    private String username;
    private String address;
    
    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}

【UserController.java】

package com.mango.json.controller;

import com.mango.json.bean.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

@RestController
public class UserController {

    @GetMapping("/user")
    public List<User> getUser() {
        List<User> userList = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            User user = new User();
            user.setId(i);
            user.setUsername("mango>>>" + i);
            user.setAddress("www.mango.com>>>" + i);
            user.setBirthday(new Date());
            userList.add(user);
        }
        return userList;
    }
}

【運行結果】

註：大傢可能和我顯示的效果不一樣，但是內容肯定是一樣的，如果需要顯示成我這樣格式，需要給瀏覽器裝一款插件JSONView，這款插件就專門為json格式設計的，因為很復雜的json格式，是不容易閱讀的。

四、拓展

上面就是SpringBoot中json的簡單用法，下面我會再針對json進行一點內容的拓展。

1、如果碰到bean中有日期類型的屬性，json該怎麼處理日期格式？

【第一種辦法】我們可以在該屬性上添加@JsonFormat(pattern = “yyyy-MM-dd”)註解，代碼如下：

package com.mango.json.bean;

import com.fasterxml.jackson.annotation.JsonFormat;

import java.util.Date;

public class User {

    private Integer id;
    private String username;
    private String address;
    
    @JsonFormat(pattern = "yyyy-MM-dd")
    private Date birthday;

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }
}

如果該bean中存在許多日期類型的屬性呢，這麼做就不是那麼合適瞭，所以，可以采用下面的第二種辦法。

【第二種辦法】大傢都知道json肯定離不開ObjectMapper，因為json格式和java中的對象之間進行轉換就是通過ObjectMapper類，想深入研究的朋友可以看看這個類的源碼。

在上面我提到瞭SpringBoot自動化配置json，也給出瞭json源碼的路徑，大傢可以進去看看，是否看到下面一段代碼，這就是它的核心之處。

    @Configuration(proxyBeanMethods = false)
	@ConditionalOnClass(ObjectMapper.class)
	@ConditionalOnBean(ObjectMapper.class)
	@ConditionalOnProperty(name = HttpMessageConvertersAutoConfiguration.PREFERRED_MAPPER_PROPERTY,
			havingValue = "jackson", matchIfMissing = true)
	static class MappingJackson2HttpMessageConverterConfiguration {

		@Bean
		@ConditionalOnMissingBean(value = MappingJackson2HttpMessageConverter.class,
				ignoredType = {
						"org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter",
						"org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter" })
		MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(ObjectMapper objectMapper) {
			return new MappingJackson2HttpMessageConverter(objectMapper);
		}

	}

其中，mappingJackson2HttpMessageConverter方法就是我們需要用到的，這是SpringBoot為我們默認提供的，如果我們不重寫這個方法，默認它就會生效，反之則失效。換句話說，我們不管是否重寫該方法，json我們都可以用。

既然我們現在有需求瞭，我們就重寫這個方法，具體代碼如下：

【WebMvcConfig.java】

package com.mango.json.config;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;

import java.text.SimpleDateFormat;

@Configuration
public class WebMvcConfig {

    @Bean
    MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(){
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));
        converter.setObjectMapper(objectMapper);
        return converter;
    }
}

註：重寫這個方法後，我們可以將bean中的註解@JsonFormat(pattern = “yyyy-MM-dd”)註釋掉，重啟項目即可。（如果大傢有興趣，可以進行debug調試，看看默認的方法是否還有效）

其實，大傢可以從上面的代碼看到，我們真正對日期格式進行設置的是對ObjectMapper進行操作的，所以這段重寫的代碼是否可以精簡呢？答案是：當然可以。

有心的朋友肯定留意到瞭，上面SpringBoot默認提供的mappingJackson2HttpMessageConverter(ObjectMapper objectMapper)方法中，是存在ObjectMapper的，至於這個ObjectMapper是從哪裡來的，大傢可以根據下面路徑中的源碼看看：

【JacksonAutoConfiguration.java源碼路徑】

org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration

【具體源碼如下】

@Configuration(proxyBeanMethods = false)
	@ConditionalOnClass(Jackson2ObjectMapperBuilder.class)
	static class JacksonObjectMapperConfiguration {

		@Bean
		@Primary
		@ConditionalOnMissingBean
		ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
			return builder.createXmlMapper(false).build();
		}

	}

對，其實mappingJackson2HttpMessageConverter(ObjectMapper objectMapper)方法中ObjectMapper就是上面源碼中jacksonObjectMapper方法返回的ObjectMapper，大傢可以debug試一下，看看是否正確。

廢話不多說瞭，下面我就重寫ObjectMapper，具體代碼如下：

【WebMvcConfig.java】

package com.mango.json.config;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;

import java.text.SimpleDateFormat;

@Configuration
public class WebMvcConfig {

    /*@Bean
    MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(){
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));
        converter.setObjectMapper(objectMapper);
        return converter;
    }*/

    @Bean
    ObjectMapper objectMapper(){
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd"));
        return objectMapper;
    }
}

【運行結果】

註：因為上面兩種方法最後的結果都是一樣的，所以運行結果圖隻放一張。

總結

到此這篇關於SpringBoot默認的JSON解析方案的文章就介紹到這瞭,更多相關SpringBoot默認JSON解析內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

實例詳解SpringBoot默認的JSON解析方案

目錄

一、什麼是JSON

二、如何在SpringBoot中使用JSON

三、舉例

四、拓展

總結

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

一、什麼是JSON

二、如何在SpringBoot中使用JSON

三、舉例

四、拓展

總結

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆