spring項(xiàng)目自定義全局響應(yīng)處理器統(tǒng)一處理響應(yīng)結(jié)果的實(shí)現(xiàn)步驟
實(shí)現(xiàn)方式
使用@ControllerAdvice注解和實(shí)現(xiàn)ResponseBodyAdvice接口自定義全局響應(yīng)處理器
實(shí)現(xiàn)步驟
自定義統(tǒng)一返回類
定義統(tǒng)一返回類,包裝返回結(jié)果
@Data
@JsonInclude(JsonInclude.Include.NON_NULL)//過濾null,提高性能
@ApiModel(value = "返回類")
public class Wrapper<T> implements Serializable {
/**
* 成功碼
*/
public static final int SUCCESS_CODE = 200;
/**
* 成功信息
*/
public static final String SUCCESS_MESSAGE = "操作成功";
/**
* 錯(cuò)誤碼
*/
public static final int ERROR_CODE = 500;
/**
* 錯(cuò)誤信息
*/
public static final String ERROR_MESSAGE = "內(nèi)部異常";
/**
* 編號(hào)
*/
@ApiModelProperty("編號(hào)")
private int code;
/**
* 信息
*/
@ApiModelProperty("信息")
private String message;
/**
* 結(jié)果數(shù)據(jù)
*/
@ApiModelProperty("結(jié)果數(shù)據(jù)")
private T result;
/** 為什么使用this替代new類名
* 代碼簡(jiǎn)潔:使用 this 可以使得代碼更加簡(jiǎn)潔,因?yàn)槟悴恍枰看味贾貜?fù)使用類的名稱。
* 明確性:通過使用 this,你清楚地表明你正在調(diào)用當(dāng)前類的另一個(gè)構(gòu)造函數(shù)或方法,而不是其他類的構(gòu)造函數(shù)或方法。
* 減少重復(fù):在多構(gòu)造函數(shù)的類中,如果每個(gè)構(gòu)造函數(shù)都需要設(shè)置相同的屬性,那么使用 this 可以避免重復(fù)代碼。
* 提高可讀性:當(dāng)一個(gè)構(gòu)造函數(shù)調(diào)用了另一個(gè)構(gòu)造函數(shù)時(shí),使用 this 可以讓讀者更容易理解正在發(fā)生的事情,尤其是當(dāng)構(gòu)造函數(shù)的參數(shù)不同,但都包含某些共同參數(shù)時(shí)。
*/
//默認(rèn)構(gòu)造函數(shù),它直接調(diào)用第二個(gè)構(gòu)造函數(shù),并傳遞 SUCCESS_CODE 和 SUCCESS_MESSAGE 作為參數(shù)。
Wrapper() {
this(SUCCESS_CODE, SUCCESS_MESSAGE);
}
//不需要返回?cái)?shù)據(jù) 帶有兩個(gè)參數(shù)的構(gòu)造函數(shù),它調(diào)用第三個(gè)構(gòu)造函數(shù),并傳遞相同的參數(shù)。
Wrapper(int code, String message) {
this(code, message, null);
}
//需要返回?cái)?shù)據(jù)
Wrapper(int code, String message, T result) {
super();
this.code(code).message(message).result(result);
}
private Wrapper<T> code(int code) {
this.setCode(code);
return this;
}
private Wrapper<T> message(String message) {
this.setMessage(message);
return this;
}
public Wrapper<T> result(T result) {
this.setResult(result);
return this;
}
@JsonIgnore
public boolean success() {
return Wrapper.SUCCESS_CODE == this.code;
}
@JsonIgnore
public boolean error() {
return !success();
}
}定義 統(tǒng)一返回包裝類
public class WrapMapper {
/**
* 在 `WrapMapper` 類中,私有構(gòu)造函數(shù)的設(shè)計(jì)是為了防止外部實(shí)例化這個(gè)類。這是一個(gè)常見的做法,有以下幾個(gè)原因:
* 1. **單一職責(zé)原則**:`WrapMapper` 類被設(shè)計(jì)為一個(gè)工具類,只提供一系列靜態(tài)方法,用于創(chuàng)建和處理 `Wrapper` 對(duì)象。它不包含任何實(shí)例變量,因此它沒有必要被實(shí)例化。
* 2. **減少依賴**:如果 `WrapMapper` 類可以被實(shí)例化,那么任何使用這個(gè)類的代碼都需要導(dǎo)入這個(gè)類的引用。通過將構(gòu)造函數(shù)設(shè)為私有,你可以限制它的使用,只允許通過靜態(tài)方法來使用這個(gè)類。
* 3. **提高效率**:工具類通常不需要?jiǎng)?chuàng)建多個(gè)實(shí)例,因?yàn)樗鼈儾灰蕾囉谕獠繝顟B(tài),而且它們的操作通常可以通過靜態(tài)方法完成。因此,設(shè)計(jì)為不可實(shí)例化可以提高效率。
* 4. **清晰意圖**:通過將構(gòu)造函數(shù)設(shè)為私有,明確地表明這個(gè)類不應(yīng)該被實(shí)例化,這有助于其他開發(fā)者理解這個(gè)類的用途和設(shè)計(jì)意圖。
* 總之,將 `WrapMapper` 類的構(gòu)造函數(shù)設(shè)為私有是為了遵循單一職責(zé)原則,減少依賴,提高效率,并提高代碼的可讀性和可維護(hù)性。這樣的設(shè)計(jì)有助于確保 `WrapMapper` 類只作為工具類被使用,而不被誤用或?yàn)E用。
*/
private WrapMapper() {
}
public static <E> Wrapper<E> wrap(int code) {
return wrap(code, null);
}
public static <E> Wrapper<E> wrap(int code, String message) {
return wrap(code, message, null);
}
public static <E> Wrapper<E> wrap(int code, String message, E o) {
return new Wrapper<>(code, message, o);
}
public static <E> Wrapper<E> wrap(Exception e) {
return new Wrapper<>(Wrapper.ERROR_CODE, e.getMessage());
}
public static <E> E unWrap(Wrapper<E> wrapper) {
return wrapper.getResult();
}
public static <E> Wrapper<E> error() {
return wrap(Wrapper.ERROR_CODE, Wrapper.ERROR_MESSAGE);
}
public static <E> Wrapper<E> error(int code,String message) {
return wrap(code, message);
}
public static <E> Wrapper<E> error(String message) {
return wrap(Wrapper.ERROR_CODE, StringUtils.isBlank(message) ? Wrapper.ERROR_MESSAGE : message);
}
public static <E> Wrapper<E> ok() {
return new Wrapper<>();
}
public static <E> Wrapper<E> ok(E o) {
return new Wrapper<>(Wrapper.SUCCESS_CODE, Wrapper.SUCCESS_MESSAGE, o);
}
}定義啟用全局響應(yīng)注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface EnableResponseHandler {
}定義忽略全局響應(yīng)注解
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreResponseHandler {
}定義全局響應(yīng)處理器
//@Component標(biāo)記的類,Spring 容器會(huì)自動(dòng)掃描這個(gè)類,并將它作為一個(gè) bean 創(chuàng)建和注冊(cè)到 Spring 容器中。
//可以被其他類通過 @Autowired 注解自動(dòng)裝配,你不需要顯式地定義 bean 的依賴關(guān)系,Spring 容器會(huì)自動(dòng)處理。
@Component
@ControllerAdvice//全局控制器增強(qiáng)
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {
@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
if (methodParameter.getMethod().isAnnotationPresent(IgnoreResponseHandler.class)) {
return false;
}
//只有EnableResponseHandler注解標(biāo)識(shí)的類才會(huì)去調(diào)用beforeBodyWrite方法
if (methodParameter.getMethod().isAnnotationPresent(EnableResponseHandler.class)) {
return true;
}
if (methodParameter.getDeclaringClass().isAnnotationPresent(EnableResponseHandler.class)) {
return true;
}
return false;
}
/**
*beforeBodyWrite方法在 Spring MVC 將返回的對(duì)象寫入 HTTP 響應(yīng)之前被調(diào)用,它提供了一個(gè)機(jī)會(huì)來增強(qiáng)或修改響應(yīng)體。
* 作用
* 1.增強(qiáng)響應(yīng):在返回對(duì)象被寫入響應(yīng)之前,允許你對(duì)響應(yīng)進(jìn)行增強(qiáng)或修改。
* 自定義格式化:如果你需要對(duì)返回的對(duì)象進(jìn)行特殊的格式化,比如添加額外的頭信息,或者修改對(duì)象的屬性,beforeBodyWrite 提供了這種能力。
* 全局應(yīng)用:你可以定義多個(gè) ResponseBodyAdvice 實(shí)現(xiàn)類,并將它們應(yīng)用于整個(gè)應(yīng)用程序,或者針對(duì)特定的 Controller 或請(qǐng)求類型進(jìn)行過濾。
*/
@Nullable
@Override
public Object beforeBodyWrite(@Nullable Object o,
MethodParameter methodParameter,
MediaType mediaType,
Class<? extends HttpMessageConverter<?>> aClass,
ServerHttpRequest serverHttpRequest,
ServerHttpResponse serverHttpResponse) {
//如果返回的不是自己定義的包裝類
if (o instanceof Wrapper) {
return o;
}
//使用WrapMapper包裝后返回
return WrapMapper.ok(o);
}
}到此這篇關(guān)于spring項(xiàng)目自定義全局響應(yīng)處理器,統(tǒng)一處理響應(yīng)結(jié)果的文章就介紹到這了,更多相關(guān)spring自定義全局響應(yīng)處理器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
SpringBoot實(shí)現(xiàn)接口數(shù)據(jù)的加解密功能
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)接口數(shù)據(jù)的加解密功能,對(duì)接口的加密解密操作主要有兩種實(shí)現(xiàn)方式,文中給大家詳細(xì)介紹,需要的朋友可以參考下2019-10-10
Mybatis?selectKey 如何返回新增用戶的id值
這篇文章主要介紹了Mybatis?selectKey 如何返回新增用戶的id值,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-01-01
Java中使用數(shù)組實(shí)現(xiàn)棧數(shù)據(jù)結(jié)構(gòu)實(shí)例
這篇文章主要介紹了Java中使用數(shù)組實(shí)現(xiàn)棧數(shù)據(jù)結(jié)構(gòu)實(shí)例,本文先是講解了實(shí)現(xiàn)棧至少應(yīng)該包括以下幾個(gè)方法等知識(shí),然后給出代碼實(shí)例,需要的朋友可以參考下2015-01-01
簡(jiǎn)單總結(jié)Java的反射機(jī)制的運(yùn)用
這篇文章主要介紹了Java的反射機(jī)制的運(yùn)用,對(duì)一些常用的類作了一些說明,需要的朋友可以參考下2015-11-11
Java實(shí)現(xiàn)批量修改txt文件名稱的方法示例
這篇文章主要介紹了Java實(shí)現(xiàn)批量修改txt文件名稱的方法,結(jié)合實(shí)例形式分析了Java針對(duì)目錄文件遍歷及文件讀寫、屬性操作等相關(guān)實(shí)現(xiàn)技巧,需要的朋友可以參考下2019-03-03
SpringBoot整合BootStrap實(shí)戰(zhàn)
這篇文章主要介紹了SpringBoot整合BootStrap實(shí)戰(zhàn),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-09-09
Java在數(shù)組中存放多個(gè)對(duì)象實(shí)現(xiàn)方式
文章介紹了如何通過數(shù)組存儲(chǔ)多個(gè)對(duì)象,以計(jì)算三部手機(jī)的平均價(jià)格為例,展示了如何創(chuàng)建類、定義屬性、編寫方法以及如何進(jìn)行數(shù)組擴(kuò)容2026-03-03
SpringBoot處理大量請(qǐng)求數(shù)據(jù)的傳輸問題的方法小結(jié)
在Spring?Boot項(xiàng)目常常需要中處理大量請(qǐng)求數(shù)據(jù)的傳輸問題,這篇文章主要為大家整理了一些常用的方法,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-01-01
詳解SpringBoot+Mybatis實(shí)現(xiàn)動(dòng)態(tài)數(shù)據(jù)源切換
這篇文章主要介紹了詳解SpringBoot+Mybatis實(shí)現(xiàn)動(dòng)態(tài)數(shù)據(jù)源切換,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-05-05

