springboot項目controller統(tǒng)一返回對象格式以及全局自定義異常方式
一、需求背景
1.在web接口開發(fā)時,每個模塊接口返回數(shù)據(jù)格式需做封裝,如果每個模塊的返回格式不同,前端需要最不同數(shù)據(jù)格式的適配,使得整個項目很雜亂。如果對接口的返回數(shù)據(jù)做統(tǒng)一封裝就解決此類問題。
2.項目的運行時異常,例如用戶名錯誤此類的提示性異常,需要對此類異常做統(tǒng)一性封裝。
二、方法
解決方法
問題一:使用@ControllerAdvice注解,以及實現(xiàn)ResponseBodyAdvice接口,從而實現(xiàn)攔截后再封裝邏輯
問題二:使用@ControllerAdvice和@ExceptionHandler注解配合使用,從而捕獲自定義異常類,實現(xiàn)邏輯的再處理。
三、具體實現(xiàn)
/**
*封裝的接口統(tǒng)一返回對象
*/
@Data
public class ResultPo<T> {
private int code;
private String msg;
private T data;
public static<T> ResultPo<T> success(T t){
ResultPo<T> resultPo = new ResultPo<>();
resultPo.setCode(ResponseCodeEnum.SUCCESS.getCode());
resultPo.setMsg(ResponseCodeEnum.SUCCESS.getMessage());
resultPo.setData(t);
return resultPo;
}
public static ResultPo error(int code,String msg){
ResultPo resultPo = new ResultPo();
resultPo.setCode(code);
resultPo.setMsg(msg);
return resultPo;
}
}
// 自定義異常類
@Getter
public class BusinessException extends RuntimeException{
private String msg;
private int code;
public BusinessException(String msg){
super(msg);
this.msg =msg;
this.code = ResponseCodeEnum.FAIL.getCode();
}
public BusinessException(String msg,int code){
super(msg);
this.msg =msg;
this.code = code;
}
}
@ResponseBody
@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice<Object> {
Logger log = LoggerFactory.getLogger(ResponseAdvice.class);
// 自定義異常捕獲
@ExceptionHandler(BusinessException.class)
public ResultPo customException(BusinessException bs){
ResultPo resultPo = new ResultPo();
resultPo.setCode(bs.getCode());
resultPo.setMsg(bs.getMsg());
resultPo.setData(null);
return resultPo;
}
/**
*return turn 代表此接口會進入beforeBodyWrite方法,進行邏輯處理
*/
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return !returnType.getDeclaringClass().getName().contains("springfox");
// return true;
}
@Nullable
@Override
public Object beforeBodyWrite(@Nullable Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
// 如果接口返回為string類型,則需要單獨處理
if(returnType.getGenericParameterType().equals(String.class)){
ObjectMapper objectMapper = new ObjectMapper();
try {
HttpHeaders headers = response.getHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
return objectMapper.writeValueAsString(ResultPo.success(body));
} catch (JsonProcessingException e) {
e.printStackTrace();
}
}
// 接口出現(xiàn)自定義異常,已被customException方法捕獲,則無需再次封裝
if(returnType.getGenericParameterType().equals(ResultPo.class)){
return body;
}
return ResultPo.success(body);
}
}
四、遇到的問題
當項目中使用swagger時,會攔截swagger的相關請求
出現(xiàn)的原因:@ControllerAdvice注解會攔截@Controller以及@RestController標記的接口,而swagger的接口是web接口,也是帶有@RestController相關接口
解決方法:
1.對swagger進行放行,就是上面代碼中那樣,放行帶有springfox字樣的接口
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
return !returnType.getDeclaringClass().getName().contains("springfox");
// return true;
}
2.自定義一個注解,在需要統(tǒng)一返回值的接口上添加上自定義注解,然后@ControllerAdvice根據(jù)自定義注解進行攔截
// ResponseResult為自定義注解 @ControllerAdvice(annotations = ResponseResult.class)
總結
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
- SpringBoot @RestController注解用法及說明
- SpringBoot controller接收txt文本文件實現(xiàn)方式
- SpringBoot攔截器執(zhí)行后,Controller層不執(zhí)行的問題及解決
- SpringBoot中@RestControllerAdvice 全局異常處理的實現(xiàn)
- Springboot Controller接口默認自動填充業(yè)務實體參數(shù)值詳解
- SpringBoot之@Controller和@RequestMapping的實現(xiàn)原理解讀
- SpringBoot和MybatisPlus實現(xiàn)通用Controller示例
相關文章
淺談SpringMVC之視圖解析器(ViewResolver)
本篇文章主要介紹了淺談SpringMVC之視圖解析器(ViewResolver),具有一定的參考價值,有興趣的可以了解一下2017-08-08
Spring Bean生命周期之Bean元信息的配置與解析階段詳解
這篇文章主要為大家詳細介紹了Spring Bean生命周期之Bean元信息的配置與解析階段,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助2022-03-03
Spring集成MyBatis和PageHelper分頁插件整合過程詳解
Spring?整合?MyBatis?是將?MyBatis?數(shù)據(jù)訪問框架與?Spring?框架進行集成,以實現(xiàn)更便捷的開發(fā)和管理,在集成過程中,Spring?提供了許多特性和功能,如依賴注入、聲明式事務管理、AOP?等,這篇文章主要介紹了Spring集成MyBatis和PageHelper分頁插件整合,需要的朋友可以參考下2023-08-08
最新Spring Security的基于內(nèi)存用戶認證方式
本文講解SpringSecurity內(nèi)存認證配置,適用于開發(fā)、測試等場景,通過代碼創(chuàng)建用戶及權限管理,支持密碼加密,雖簡單但不持久化,生產(chǎn)環(huán)境推薦使用數(shù)據(jù)庫或JWT等認證方式,感興趣的朋友一起看看吧2025-07-07

