Springboot設置統一的返回格式的方法步驟
更新時間：2024年01月12日 10:25:23 作者：博大的Java世界
在我們應用中我們通常與前端交互使用json格式,設置統一的返回json 格式是非常必要的,本文主要介紹了Springboot設置統一的返回格式的方法步驟,具有一定的參考價值,感興趣的可以了解一下
在我們應用中我們通常與前端交互使用json 格式，設置統一的返回json 格式是非常必要的，可以減少開發(fā)人員的工作量。
第一個使用統一的消息轉換器，這里使用jackson 的相關功能，引入jar
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>創(chuàng)建一個全局配置類（GlobalConfig）并使用
@Configuration注解標記該類為配置類。然后，在該類上使用@EnableWebMvc注解開啟對MVC的支持。- 在該配置類中重寫
configureMessageConverters()方法，將Jackson消息轉換器添加到默認的消息轉換器列表中。示例如下所示：
@Configuration
@EnableWebMvc
public class GlobalConfig extends WebMvcConfigurerAdapter {
@Override
public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
ObjectMapper objectMapper = new ObjectMapper();
// 設置日期序列化/反序列化格式
JavaTimeModule javaTimeModule = new JavaTimeModule();
javaTimeModule.addSerializer(LocalDateTime.class, LocalDateTimeSerializer.INSTANCE);
javaTimeModule.addDeserializer(LocalDateTime.class, LocalDateTimeDeserializer.INSTANCE);
objectMapper.registerModule(javaTimeModule);
// 其他自定義配置...
Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder()
.serializationInclusion(JsonInclude.Include.NON_NULL)
.featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter(builder.build());
converters.add(converter);
}
}二、聲明統一格式的返回類型，一般包含code、message、data 三部分
1）定義一個返回結果 IResultStatus
public interface IResultStatus {
/**
* 業(yè)務狀態(tài)碼
* @return Integer
*/
Integer code();
/**
* 業(yè)務信息描述
* @return String
*/
String message();
}
2)創(chuàng)建一個枚舉實體
public enum ResultStatus implements IResultStatus {
/**
* 成功
*/
SUCCESS(200, "OK"),
/**
* 錯誤的請求，參數異常
*/
BAD_REQUEST(400, "Bad Request params exception"),
/**
* 服務器異常
*/
INTERNAL_SERVER_ERROR(500, "Internal Server Error"),
/**
* 401 未認證異常
*/
UNAUTHORIZED(401, "認證異常"),
/**
* 業(yè)務異常
*/
BUSINESS_ERR(10000, "業(yè)務異常");
/**
* 業(yè)務狀態(tài)碼
*/
private Integer code;
/**
* 業(yè)務信息描述
*/
private String message;
ResultStatus (Integer code, String message) {
this.code = code;
this.message = message;
}
/**
* 業(yè)務狀態(tài)碼
*
* @return Integer
*/
@Override
public Integer code() {
return code;
}
/**
* 業(yè)務信息描述
*
* @return String
*/
@Override
public String message() {
return message;
}
}3)引入lamada 定義返回實體
@Data
public class Result<T> {
/**
* 業(yè)務錯誤碼
*/
private Integer code;
/**
* 信息描述
*/
private String message;
/**
* 返回參數
*/
private T data;
private Result(IResultStatus resultStatus, T data) {
this.code = resultStatus.code();
this.message = resultStatus.message();
this.data = data;
}
private Result(Integer code, String message, T data) {
this.code = code;
this.message = message;
this.data = data;
}
/**
* 業(yè)務成功返回業(yè)務代碼和描述信息
*/
public static Result<Void> success() {
return new Result<Void>(ResultStatus.SUCCESS, null);
}
/**
* 業(yè)務成功返回業(yè)務代碼,描述和返回的參數
*/
public static <T> Result<T> success(T data) {
return new Result<T>(ResultStatus.SUCCESS, data);
}
/**
* 業(yè)務成功返回業(yè)務代碼,描述和返回的參數
*/
public static <T> Result<T> success(IResultStatus resultStatus, T data) {
if (resultStatus == null) {
return success(data);
}
return new Result<T>(resultStatus, data);
}
/**
* 業(yè)務成功返回業(yè)務代碼,描述和返回的參數
*/
public static <T> Result<T> success(Integer code, String message, T data) {
return new Result<T>(code, message, data);
}
/**
* 業(yè)務異常返回業(yè)務代碼和描述信息
*/
public static <T> Result<T> fail() {
return new Result<T>(ResultStatus.BUSINESS_ERR, null);
}
/**
* 業(yè)務異常返回業(yè)務代碼和描述信息
*/
public static <T> Result<T> fail(String message) {
return new Result<T>(ResultStatus.BUSINESS_ERR.code(), message, null);
}
/**
* 業(yè)務異常返回業(yè)務代碼,描述和返回的參數
*/
public static <T> Result<T> fail(IResultStatus resultStatus) {
return fail(resultStatus, null);
}
/**
* 業(yè)務異常返回業(yè)務代碼,描述和返回的參數
*/
public static <T> Result<T> fail(IResultStatus resultStatus, String message) {
if (resultStatus == null) {
return new Result<T>(ResultStatus.BUSINESS_ERR, null);
}
return new Result<T>(resultStatus.code(), message, null);
}
}上述實體我們都定義好了，可以結合我們的上述jackson 包進行配置json 配置
@Configuration
public class JsonSerializeConfig {
@Bean
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
ObjectMapper objectMapper = builder.createXmlMapper(false).build();
.....這里省去自定義格式類型
}
}那么在使用時通過創(chuàng)建我們的返回實體進行接口返回。
public Result<> call((){
.......省去業(yè)務
return new Result();//根據構造函數返回
}到此這篇關于Springboot設置統一的返回格式的方法步驟的文章就介紹到這了,更多相關Springboot設置統一返回格式內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
Java虛擬機棧溢出是指在Java程序中,當線程調用的方法層級過深,導致?？臻g溢出的情況,本文就詳細的介紹了下產生的原因以及優(yōu)化,具有一定的參考價值,感興趣的可以了解一下2023-08-08
goto在Java中是一個保留字，但在語言中并沒有用到它；Java沒有goto。接下來通過本文給大家介紹Java的“Goto”與標簽，感興趣的朋友跟隨小編一起看看吧2018-10-10
這篇文章主要給大家介紹了關于Java實現矩陣乘法以及優(yōu)化的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-02-02
這篇文章主要介紹了SpringBoot+Vue項目打包部署的相關資料,包括Vue項目的打包設置、SpringBoot的配置修改、跨域問題處理、使用Nginx配置反向代理以及最終的項目啟動,教程假定開發(fā)者已具備完整的前后端分離項目和配置好環(huán)境的服務器,需要的朋友可以參考下2024-10-10
Spring Boot 是一個簡化的 Spring 應用開發(fā)框架,它以 “約定優(yōu)于配置” 的理念,為開發(fā)者提供了開箱即用的功能,本文將詳細剖析其內部實現,幫助你深入理解 Spring Boot 的啟動機制,感興趣的朋友跟隨小編一起看看吧2024-12-12
Java在ElasticSearch中使用LocalDatetime類型
最近在開發(fā)一個搜索功能的需求的時候,遇到了LocalDatetime類型不能保存到ElasticSearch中的問題,這篇文章主要介紹了Java在ElasticSearch中使用LocalDatetime類型2023-10-10
這篇文章主要介紹了java如何強制刪除java程序占用的文件問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
這篇文章主要介紹了Nacos配置的多文件加載與共享配置方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-11-11
這篇文章主要介紹了java8?時間日期的使用與格式化,本文通過示例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-06-06
這篇文章主要介紹了SpringBoot2.7.14整合redis7的詳細過程,本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友參考下吧2023-10-10