Spring Boot返回Json數(shù)據(jù)及如何進(jìn)行數(shù)據(jù)封裝
本來已收錄到我寫的10萬字Springboot經(jīng)典學(xué)習(xí)筆記中，筆記在持續(xù)更新……文末有領(lǐng)取方式
在項(xiàng)目開發(fā)中，接口與接口之間，前后端之間數(shù)據(jù)的傳輸都使用 Json 格式，在 Spring Boot 中，接口返回 Json 格式的數(shù)據(jù)很簡(jiǎn)單，在 Controller 中使用@RestController注解即可返回 Json 格式的數(shù)據(jù)，@RestController也是 Spring Boot 新增的一個(gè)注解，我們點(diǎn)進(jìn)去看一下該注解都包含了哪些東西。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
String value() default "";
}
可以看出， @RestController 注解包含了原來的 @Controller 和 @ResponseBody 注解，使用過 Spring 的朋友對(duì) @Controller 注解已經(jīng)非常了解了，這里不再贅述， @ResponseBody 注解是將返回的數(shù)據(jù)結(jié)構(gòu)轉(zhuǎn)換為 Json 格式。所以在默認(rèn)情況下，使用了 @RestController 注解即可將返回的數(shù)據(jù)結(jié)構(gòu)轉(zhuǎn)換成 Json 格式，Spring Boot 中默認(rèn)使用的 Json 解析技術(shù)框架是 jackson。我們點(diǎn)開 pom.xml 中的 spring-boot-starter-web 依賴，可以看到一個(gè) spring-boot-starter-json 依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-json</artifactId>
<version>2.0.3.RELEASE</version>
<scope>compile</scope>
</dependency>
Spring Boot 中對(duì)依賴都做了很好的封裝，可以看到很多 spring-boot-starter-xxx 系列的依賴，這是 Spring Boot 的特點(diǎn)之一，不需要人為去引入很多相關(guān)的依賴了，starter-xxx 系列直接都包含了所必要的依賴，所以我們?cè)俅吸c(diǎn)進(jìn)去上面這個(gè) spring-boot-starter-json 依賴，可以看到：
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jdk8</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-parameter-names</artifactId>
<version>2.9.6</version>
<scope>compile</scope>
</dependency>
到此為止，我們知道了 Spring Boot 中默認(rèn)使用的 json 解析框架是 jackson。下面我們看一下默認(rèn)的 jackson 框架對(duì)常用數(shù)據(jù)類型的轉(zhuǎn) Json 處理。
1. Spring Boot 默認(rèn)對(duì)Json的處理
在實(shí)際項(xiàng)目中，常用的數(shù)據(jù)結(jié)構(gòu)無非有類對(duì)象、List對(duì)象、Map對(duì)象，我們看一下默認(rèn)的 jackson 框架對(duì)這三個(gè)常用的數(shù)據(jù)結(jié)構(gòu)轉(zhuǎn)成 json 后的格式如何。
1.1 創(chuàng)建 User 實(shí)體類
為了測(cè)試，我們需要?jiǎng)?chuàng)建一個(gè)實(shí)體類，這里我們就用 User 來演示。
public class User {
private Long id;
private String username;
private String password;
/* 省略get、set和帶參構(gòu)造方法 */
}
1.2 創(chuàng)建Controller類
然后我們創(chuàng)建一個(gè) Controller，分別返回 User對(duì)象、List<User> 和 Map<String, Object>。
import com.itcodai.course02.entity.User;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@RestController
@RequestMapping("/json")
public class JsonController {
@RequestMapping("/user")
public User getUser() {
return new User(1, "倪升武", "123456");
}
@RequestMapping("/list")
public List<User> getUserList() {
List<User> userList = new ArrayList<>();
User user1 = new User(1, "倪升武", "123456");
User user2 = new User(2, "達(dá)人課", "123456");
userList.add(user1);
userList.add(user2);
return userList;
}
@RequestMapping("/map")
public Map<String, Object> getMap() {
Map<String, Object> map = new HashMap<>(3);
User user = new User(1, "倪升武", "123456");
map.put("作者信息", user);
map.put("博客地址", "http://blog.itcodai.com");
map.put("CSDN地址", "http://blog.csdn.net/eson_15");
map.put("粉絲數(shù)量", 4153);
return map;
}
}
1.3 測(cè)試不同數(shù)據(jù)類型返回的json
OK，寫好了接口，分別返回了一個(gè) User 對(duì)象、一個(gè) List 集合和一個(gè) Map 集合，其中 Map 集合中的 value 存的是不同的數(shù)據(jù)類型。接下來我們依次來測(cè)試一下效果。
在瀏覽器中輸入：localhost:8080/json/user 返回 json 如下：
{"id":1,"username":"倪升武","password":"123456"}
在瀏覽器中輸入：localhost:8080/json/list 返回 json 如下：
[{"id":1,"username":"倪升武","password":"123456"},{"id":2,"username":"達(dá)人課","password":"123456"}]
在瀏覽器中輸入：localhost:8080/json/map 返回 json 如下：
{"作者信息":{"id":1,"username":"倪升武","password":"123456"},"CSDN地址":"http://blog.csdn.net/eson_15","粉絲數(shù)量":4153,"博客地址":"http://blog.itcodai.com"}
可以看出，map 中不管是什么數(shù)據(jù)類型，都可以轉(zhuǎn)成相應(yīng)的 json 格式，這樣就非常方便。
1.4 jackson 中對(duì)null的處理
在實(shí)際項(xiàng)目中，我們難免會(huì)遇到一些 null 值出現(xiàn)，我們轉(zhuǎn) json 時(shí)，是不希望有這些 null 出現(xiàn)的，比如我們期望所有的 null 在轉(zhuǎn) json 時(shí)都變成 "" 這種空字符串，那怎么做呢？在 Spring Boot 中，我們做一下配置即可，新建一個(gè) jackson 的配置類：
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
import java.io.IOException;
@Configuration
public class JacksonConfig {
@Bean
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
ObjectMapper objectMapper = builder.createXmlMapper(false).build();
objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
@Override
public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeString("");
}
});
return objectMapper;
}
}
然后我們修改一下上面返回 map 的接口，將幾個(gè)值改成 null 測(cè)試一下：
@RequestMapping("/map")
public Map<String, Object> getMap() {
Map<String, Object> map = new HashMap<>(3);
User user = new User(1, "倪升武", null);
map.put("作者信息", user);
map.put("博客地址", "http://blog.itcodai.com");
map.put("CSDN地址", null);
map.put("粉絲數(shù)量", 4153);
return map;
}
重啟項(xiàng)目，再次輸入：localhost:8080/json/map，可以看到 jackson 已經(jīng)將所有 null 字段轉(zhuǎn)成了空字符串了。
{"作者信息":{"id":1,"username":"倪升武","password":""},"CSDN地址":"","粉絲數(shù)量":4153,"博客地址":"http://blog.itcodai.com"}
2. 使用阿里巴巴FastJson的設(shè)置
2.1 jackson 和 fastJson 的對(duì)比
有很多朋友習(xí)慣于使用阿里巴巴的 fastJson 來做項(xiàng)目中 json 轉(zhuǎn)換的相關(guān)工作，目前我們項(xiàng)目中使用的就是阿里的 fastJson，那么 jackson 和 fastJson 有哪些區(qū)別呢？根據(jù)網(wǎng)上公開的資料比較得到下表。
| 選項(xiàng) | fastJson | jackson |
|---|---|---|
| 上手難易程度 | 容易 | 中等 |
| 高級(jí)特性支持 | 中等 | 豐富 |
| 官方文檔、Example支持 | 中文 | 英文 |
| 處理json速度 | 略快 | 快 |
關(guān)于 fastJson 和 jackson 的對(duì)比，網(wǎng)上有很多資料可以查看，主要是根據(jù)自己實(shí)際項(xiàng)目情況來選擇合適的框架。從擴(kuò)展上來看，fastJson 沒有 jackson 靈活，從速度或者上手難度來看，fastJson 可以考慮，我們項(xiàng)目中目前使用的是阿里的 fastJson，挺方便的。
2.2 fastJson依賴導(dǎo)入
使用 fastJson 需要導(dǎo)入依賴，本課程使用 1.2.35 版本，依賴如下：
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.35</version>
</dependency>
2.2 使用 fastJson 處理 null
使用 fastJson 時(shí)，對(duì) null 的處理和 jackson 有些不同，需要繼承 WebMvcConfigurationSupport 類，然后覆蓋 configureMessageConverters 方法，在方法中，我們可以選擇對(duì)要實(shí)現(xiàn) null 轉(zhuǎn)換的場(chǎng)景，配置好即可。如下：
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
@Configuration
public class fastJsonConfig extends WebMvcConfigurationSupport {
/**
* 使用阿里 FastJson 作為JSON MessageConverter
* @param converters
*/
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
FastJsonConfig config = new FastJsonConfig();
config.setSerializerFeatures(
// 保留map空的字段
SerializerFeature.WriteMapNullValue,
// 將String類型的null轉(zhuǎn)成""
SerializerFeature.WriteNullStringAsEmpty,
// 將Number類型的null轉(zhuǎn)成0
SerializerFeature.WriteNullNumberAsZero,
// 將List類型的null轉(zhuǎn)成[]
SerializerFeature.WriteNullListAsEmpty,
// 將Boolean類型的null轉(zhuǎn)成false
SerializerFeature.WriteNullBooleanAsFalse,
// 避免循環(huán)引用
SerializerFeature.DisableCircularReferenceDetect);
converter.setFastJsonConfig(config);
converter.setDefaultCharset(Charset.forName("UTF-8"));
List<MediaType> mediaTypeList = new ArrayList<>();
// 解決中文亂碼問題，相當(dāng)于在Controller上的@RequestMapping中加了個(gè)屬性produces = "application/json"
mediaTypeList.add(MediaType.APPLICATION_JSON);
converter.setSupportedMediaTypes(mediaTypeList);
converters.add(converter);
}
}
3. 封裝統(tǒng)一返回的數(shù)據(jù)結(jié)構(gòu)
以上是 Spring Boot 返回 json 的幾個(gè)代表的例子，但是在實(shí)際項(xiàng)目中，除了要封裝數(shù)據(jù)之外，我們往往需要在返回的 json 中添加一些其他信息，比如返回一些狀態(tài)碼 code ，返回一些 msg 給調(diào)用者，這樣調(diào)用者可以根據(jù) code 或者 msg 做一些邏輯判斷。所以在實(shí)際項(xiàng)目中，我們需要封裝一個(gè)統(tǒng)一的 json 返回結(jié)構(gòu)存儲(chǔ)返回信息。
3.1 定義統(tǒng)一的 json 結(jié)構(gòu)
由于封裝的 json 數(shù)據(jù)的類型不確定，所以在定義統(tǒng)一的 json 結(jié)構(gòu)時(shí)，我們需要用到泛型。統(tǒng)一的 json 結(jié)構(gòu)中屬性包括數(shù)據(jù)、狀態(tài)碼、提示信息即可，構(gòu)造方法可以根據(jù)實(shí)際業(yè)務(wù)需求做相應(yīng)的添加即可，一般來說，應(yīng)該有默認(rèn)的返回結(jié)構(gòu)，也應(yīng)該有用戶指定的返回結(jié)構(gòu)。如下：
public class JsonResult<T> {
private T data;
private String code;
private String msg;
/**
* 若沒有數(shù)據(jù)返回，默認(rèn)狀態(tài)碼為0，提示信息為：操作成功！
*/
public JsonResult() {
this.code = "0";
this.msg = "操作成功！";
}
/**
* 若沒有數(shù)據(jù)返回，可以人為指定狀態(tài)碼和提示信息
* @param code
* @param msg
*/
public JsonResult(String code, String msg) {
this.code = code;
this.msg = msg;
}
/**
* 有數(shù)據(jù)返回時(shí)，狀態(tài)碼為0，默認(rèn)提示信息為：操作成功！
* @param data
*/
public JsonResult(T data) {
this.data = data;
this.code = "0";
this.msg = "操作成功！";
}
/**
* 有數(shù)據(jù)返回，狀態(tài)碼為0，人為指定提示信息
* @param data
* @param msg
*/
public JsonResult(T data, String msg) {
this.data = data;
this.code = "0";
this.msg = msg;
}
// 省略get和set方法
}
3.2 修改 Controller 中的返回值類型及測(cè)試
由于 JsonResult 使用了泛型，所以所有的返回值類型都可以使用該統(tǒng)一結(jié)構(gòu)，在具體的場(chǎng)景將泛型替換成具體的數(shù)據(jù)類型即可，非常方便，也便于維護(hù)。在實(shí)際項(xiàng)目中，還可以繼續(xù)封裝，比如狀態(tài)碼和提示信息可以定義一個(gè)枚舉類型，以后我們只需要維護(hù)這個(gè)枚舉類型中的數(shù)據(jù)即可（在本課程中就不展開了）。根據(jù)以上的 JsonResult，我們改寫一下 Controller，如下：
@RestController
@RequestMapping("/jsonresult")
public class JsonResultController {
@RequestMapping("/user")
public JsonResult<User> getUser() {
User user = new User(1, "倪升武", "123456");
return new JsonResult<>(user);
}
@RequestMapping("/list")
public JsonResult<List> getUserList() {
List<User> userList = new ArrayList<>();
User user1 = new User(1, "倪升武", "123456");
User user2 = new User(2, "達(dá)人課", "123456");
userList.add(user1);
userList.add(user2);
return new JsonResult<>(userList, "獲取用戶列表成功");
}
@RequestMapping("/map")
public JsonResult<Map> getMap() {
Map<String, Object> map = new HashMap<>(3);
User user = new User(1, "倪升武", null);
map.put("作者信息", user);
map.put("公眾號(hào)", "武哥聊編程");
map.put("CSDN地址", null);
map.put("粉絲數(shù)量", 4153);
return new JsonResult<>(map);
}
}
我們重新在瀏覽器中輸入：localhost:8080/jsonresult/user 返回 json 如下：
{"code":"0","data":{"id":1,"password":"123456","username":"倪升武"},"msg":"操作成功！"}
輸入：localhost:8080/jsonresult/list，返回 json 如下：
{"code":"0","data":[{"id":1,"password":"123456","username":"倪升武"},{"id":2,"password":"123456","username":"達(dá)人課"}],"msg":"獲取用戶列表成功"}
輸入：localhost:8080/jsonresult/map，返回 json 如下：
{"code":"0","data":{"作者信息":{"id":1,"password":"","username":"倪升武"},"CSDN地址":null,"粉絲數(shù)量":4153,"公眾號(hào)":"武哥聊編程"},"msg":"操作成功！"}
通過封裝，我們不但將數(shù)據(jù)通過 json 傳給前端或者其他接口，還帶上了狀態(tài)碼和提示信息，這在實(shí)際項(xiàng)目場(chǎng)景中應(yīng)用非常廣泛。
4. 總結(jié)
本節(jié)主要對(duì) Spring Boot 中 json 數(shù)據(jù)的返回做了詳細(xì)的分析，從 Spring Boot 默認(rèn)的 jackson 框架到阿里巴巴的 fastJson 框架，分別對(duì)它們的配置做了相應(yīng)的講解。另外，結(jié)合實(shí)際項(xiàng)目情況，總結(jié)了實(shí)際項(xiàng)目中使用的 json 封裝結(jié)構(gòu)體，加入了狀態(tài)碼和提示信息，使得返回的 json 數(shù)據(jù)信息更加完整。
該文已收錄到我寫的《10萬字Springboot經(jīng)典學(xué)習(xí)筆記》中，歡迎掃描下方二維碼領(lǐng)取全套筆記。
關(guān)注武哥聊編程
回復(fù)：筆記
點(diǎn)贊是最大的支持
