溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章主要介紹“SpringBoot怎么返回Json數據格式”的相關知識，小編通過實際案例向大家展示操作過程，操作方法簡單快捷，實用性強，希望這篇“SpringBoot怎么返回Json數據格式”文章能幫助大家解決問題。
在 Spring Boot 中的 Controller 中使用 @RestController 注解即可返回 JSON 格式的數據。
@RestController 注解包含了 @Controller 和 @ResponseBody 注解。
@ResponseBody 注解是將返回的數據結構轉換為 JSON 格式。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
String value() default "";
}在 Spring Boot 中默認使用的 JSON 解析技術框架是 Jackson。
點開 pom.xml 中的 spring-boot-starter-web 依賴，可以看到 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-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 中默認使用的 JSON 解析框架是 Jackson。
創建實體類：
public class User {
private Long id;
private String username;
private String password;
/* 省略get、set和帶參構造方法 */
}Controller 層
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");
//返回 {"id":1,"username":"倪升武","password":"123456"}
}
@RequestMapping("/list")
public List<User> getUserList() {
List<User> userList = new ArrayList<>();
User user1 = new User(1, "倪升武", "123456");
User user2 = new User(2, "達人課", "123456");
userList.add(user1);
userList.add(user2);
return userList;
//返回 [{"id":1,"username":"倪升武","password":"123456"},{"id":2,"username":"達人課","password":"123456"}]
}
@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("粉絲數量", 4153);
return map;
//返回 {"作者信息":{"id":1,"username":"倪升武","password":"123456"},"CSDN地址":"http://blog.csdn.net/eson_15","粉絲數量":4153,"博客地址":"http://blog.itcodai.com"}
}
}在轉 JSON 格式的時候將所有的 null 轉換為 “” 的配置
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 的接口，將幾個值改成 null 測試一下：
@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("粉絲數量", 4153);
return map;
// 返回 {"作者信息":{"id":1,"username":"倪升武","password":""},"CSDN地址":"","粉絲數量":4153,"博客地址":"http://blog.itcodai.com"}
// 可以看到 Jackson 已經將所有 null 字段轉成空字符串了。
}Fastjson 是阿里巴巴開源的。
Jackson 和 fastjson 有哪些區別？
從擴展上來看，fastjson 沒有 Jackson 靈活，從速度或者上手難度來看，fastjson 可以考慮，它也比較方便。
fastjson 的依賴
<dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.35</version> </dependency>
使用 fastjson 時，對 null 的處理和 Jackson 有些不同，需要繼承 WebMvcConfigurationSupport 類，然后覆蓋 configureMessageConverters 方法。
在方法中，我們可以選擇要實現 null 轉換的場景，代碼如下：
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 {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
FastJsonConfig config = new FastJsonConfig();
config.setDateFormat("yyyy-MM-dd");
config.setSerializerFeatures(
// 保留 Map 空的字段
SerializerFeature.WriteMapNullValue,
// 將 String 類型的 null 轉成""
SerializerFeature.WriteNullStringAsEmpty,
// 將 Number 類型的 null 轉成 0
SerializerFeature.WriteNullNumberAsZero,
// 將 List 類型的 null 轉成 []
SerializerFeature.WriteNullListAsEmpty,
// 將 Boolean 類型的 null 轉成 false
SerializerFeature.WriteNullBooleanAsFalse,
// 生成的JSON格式化
SerializerFeature.PrettyFormat,
// 避免循環引用
SerializerFeature.DisableCircularReferenceDetect);
converter.setFastJsonConfig(config);
converter.setDefaultCharset(Charset.forName("UTF-8"));
List<MediaType> mediaTypeList = new ArrayList<>();
// 解決中文亂碼問題，相當于在 Controller 上的 @RequestMapping 中加了個屬性 produces = "application/json"
mediaTypeList.add(MediaType.APPLICATION_JSON);
converter.setSupportedMediaTypes(mediaTypeList);
converters.add(converter);
}
}除了要封裝數據之外，我們往往需要在返回的 JSON 中添加一些其他信息，比如返回狀態碼 Code，返回 Msg 給調用者，調用者可以根據 Code 或者 Msg 進行一些邏輯判斷。
統一的 JSON 結構中屬性包括數據、狀態碼、提示信息即可。
public class JsonResult<T> {
private T data;
private String code;
private String msg;
/**
* 若沒有數據返回，默認狀態碼為 0，提示信息為“操作成功！”
*/
public JsonResult() {
this.code = "0";
this.msg = "操作成功！";
}
/**
* 若沒有數據返回，可以人為指定狀態碼和提示信息
* @param code
* @param msg
*/
public JsonResult(String code, String msg) {
this.code = code;
this.msg = msg;
}
/**
* 有數據返回時，狀態碼為 0，默認提示信息為“操作成功！”
* @param data
*/
public JsonResult(T data) {
this.data = data;
this.code = "0";
this.msg = "操作成功！";
}
/**
* 有數據返回，狀態碼為 0，人為指定提示信息
* @param data
* @param msg
*/
public JsonResult(T data, String msg) {
this.data = data;
this.code = "0";
this.msg = msg;
}
// 省略 get 和 set 方法
}修改 Controller 中的返回值類型，測試
@RestController
@RequestMapping("/jsonresult")
public class JsonResultController {
@RequestMapping("/user")
public JsonResult<User> getUser() {
User user = new User(1, "倪升武", "123456");
return new JsonResult<>(user);
// {"code":"0","data":{"id":1,"password":"123456","username":"倪升武"},"msg":"操作成功！"}
}
@RequestMapping("/list")
public JsonResult<List> getUserList() {
List<User> userList = new ArrayList<>();
User user1 = new User(1, "倪升武", "123456");
User user2 = new User(2, "達人課", "123456");
userList.add(user1);
userList.add(user2);
return new JsonResult<>(userList, "獲取用戶列表成功");
// {"code":"0","data":[{"id":1,"password":"123456","username":"倪升武"},{"id":2,"password":"123456","username":"達人課"}],"msg":"獲取用戶列表成功"}
}
@RequestMapping("/map")
public JsonResult<Map> 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("粉絲數量", 4153);
return new JsonResult<>(map);
// {"code":"0","data":{"作者信息":{"id":1,"password":"","username":"倪升武"},"CSDN地址":null,"粉絲數量":4153,"博客地址":"http://blog.itcodai.com"},"msg":"操作成功！"}
}
}關于“SpringBoot怎么返回Json數據格式”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識，可以關注億速云行業資訊頻道，小編每天都會為大家更新不同的知識點。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
