Spring?Boot統(tǒng)一接口返回及全局異常處理
更新時(shí)間：2022年04月20日 17:20:38 作者：劍圣無痕?
這篇文章主要介紹了Spring?Boot統(tǒng)一接口返回及全局異常處理，文章圍繞主題展開相關(guān)資料，具有一定的參考價(jià)值需要的小伙伴可以參考一下
前言：
前段時(shí)間接手了一個(gè)老項(xiàng)目，現(xiàn)在需要在此項(xiàng)目中添加一些新的需求，同事在開發(fā)過程中遇到了一些問題？
- 1.成功的狀態(tài)到底是200還是0啊，訂單系統(tǒng)200代表成功，而會(huì)員系統(tǒng)卻是0代表成功。
- 2.接口返回的結(jié)果中，有些是用msg字段表示描述，有些又是用desc字段描述，前段處理起來比較麻煩能不能統(tǒng)一。
- 3.錯(cuò)誤提示信息需要支持國(guó)際化。
其實(shí)這些問題，歸根究底還是代碼規(guī)范問題，我們需要將接口定義和全局異常統(tǒng)一處理，歷史項(xiàng)目10多個(gè)工程，難道每個(gè)工程都去實(shí)現(xiàn)一遍，答案可定是不可能的。
1、解決方案
定義公共模塊，實(shí)現(xiàn)統(tǒng)一接口定義規(guī)范和異常處理，其他的系統(tǒng)進(jìn)行依賴和擴(kuò)展即可。
2、具體實(shí)現(xiàn)
2.1 定義狀態(tài)碼統(tǒng)一接口
public interface BaseResultCode
{
/**
* 狀態(tài)碼
* @return
*/
int getCode();
/**
* 提示信息
* @return
*/
String getMsg();
}2.2 公共模塊狀態(tài)碼枚舉類
public enum ResultCode implements BaseResultCode
{
OK(200, "成功"),
ERROR(300,"系統(tǒng)異常"),
NEED_AUTH(301, "非法請(qǐng)求,請(qǐng)重新登錄"),
PARAMTER_ERROR(302, "參數(shù)錯(cuò)誤");
//省略其他定義錯(cuò)誤碼
private int code;
private String msg;
private ResultCode(int code, String msg)
{
this.code = code;
this.msg = msg;
}
public static ResultCode getValue(int code)
{
for (ResultCode errorCode : values())
{
if (errorCode.getCode() == code)
{
return errorCode;
}
}
return null;
}
//省略Get、Set方法
}2.3 定義全局自定義異常
public class SysException extends RuntimeException
{
private static final long serialVersionUID = 5225171867523879342L;
private int code;
private String msg;
private Object[] params;
private BaseResultCode errorCode;
public SysException()
{
super();
}
public SysException(String message)
{
super(message);
}
public SysException(Throwable cause)
{
super(cause);
}
public SysException(int code ,String message)
{
this.code = code;
this.msg = message;
}
public SysException(int code ,String message, Object[] params)
{
this(code, message);
this.params= params;
}
public SysException(String message, Throwable cause)
{
super(message, cause);
}
public SysException(BaseResultCode errorCode)
{
this.errorCode = errorCode;
}
public SysException(String message, Object[] params)
{
super(message);
this.params = params;
}
public SysException(BaseResultCode errorCode, String message, Object[] params)
{
this(message, params);
this.errorCode = errorCode;
}
/**
* Construct by default
*
* @param message
* message
* @param parameters
* parameters
* @param cause
* cause
*/
public SysException(String message, Object[] params, Throwable cause)
{
super(message, cause);
this.params = params;
}
public int getCode()
{
return code;
}
public void setCode(int code)
{
this.code = code;
}
public String getMsg()
{
return msg;
}
public void setMsg(String msg)
{
this.msg = msg;
}
/**
* @return the params
*/
public Object[] getParams()
{
return params;
}
/**
* @param params
* the params to set
*/
public void setParams(Object[] params)
{
this.params = params;
}
public BaseResultCode getErrorCode()
{
return errorCode;
}
public void setErrorCode(BaseResultCode errorCode)
{
this.errorCode = errorCode;
}
}2.4 定義統(tǒng)一接口格式輸出類
public class Result implements Serializable
{
private static final long serialVersionUID = -1773941471021475043L;
private Object data;
private int code;
private String msg;
public Result()
{
}
public Result(int code, Object data, String msg)
{
this.code = code;
this.data = data;
this.msg = msg;
}
public Result(int code, String desc)
{
this(code, null, desc);
}
public Result(BaseResultCode errorCode)
{
this(errorCode.getCode(), null, errorCode.getMsg());
}
public static Result success()
{
return success(null);
}
public static Result success(Object data)
{
Result result = new Result();
result.setData(data);
result.setCode(ResultCode.OK.getCode());
return result;
}
public static Result error(String msg)
{
Result result = new Result();
result.setCode(ResultCode.ERROR.getCode());
result.setMsg(msg);
return result;
}
public static Result error(BaseResultCode baseCode)
{
Result result = new Result();
result.setCode(baseCode.getCode());
result.setMsg(baseCode.getMsg());
return result;
}
}個(gè)人建議：統(tǒng)一接口輸出類不要定義為泛型類型
2.5 定義統(tǒng)一接口格式輸出類
@RestControllerAdvice
public class SysExceptionHandler
{
public static Log logger = LogManager.getLogger(SysExceptionHandler.class);
@ExceptionHandler(Exception.class)
public Result handleException(HttpServletRequest request,
Exception ex)
{
logger.error("Handle Exception Request Url:{},Exception:{}",request.getRequestURL(),ex);
Result result = new Result();
//系統(tǒng)異常
if (ex instanceof SysException)
{
SysException se = (SysException) ex;
BaseResultCode resultCode =se.getErrorCode();
if(resultCode==null)
{
result = Result.error(se.getMessage());
}
else
{
result = new Result(resultCode.getCode(),
StringUtil.isNotEmpty(se.getMessage())?se.getMessage():resultCode.getMsg());
}
}
//參數(shù)錯(cuò)誤
else if (ex instanceof ConstraintViolationException)
{
ConstraintViolationException v = (ConstraintViolationException) ex;
String message = v.getConstraintViolations().iterator().next()
.getMessage();
result.setCode(ResultCode.PARAMTER_ERROR.getCode());
result.setMsg(ResultCode.PARAMTER_ERROR.getMsg() + ":" + message);
}
//參數(shù)錯(cuò)誤
else if (ex instanceof BindException)
{
BindException v = (BindException) ex;
String message = v.getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(","));
result.setCode(ResultCode.PARAMTER_ERROR.getCode());
result.setMsg(ResultCode.PARAMTER_ERROR.getMsg() + ":" + message);
}
//參數(shù)錯(cuò)誤
else if (ex instanceof MethodArgumentNotValidException)
{
MethodArgumentNotValidException v = (MethodArgumentNotValidException) ex;
String message = v.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining(","));
result.setCode(ResultCode.PARAMTER_ERROR.getCode());
result.setMsg(ResultCode.PARAMTER_ERROR.getMsg() + ":" + message);
}
else
{
result = new Result(ResultCode.ERROR.getCode(),ExceptionUtil.getErrorMsg(ex));
}
logger.info("exception handle reuslt:" + result);
return result;
}
}上述定義已經(jīng)可以實(shí)現(xiàn)全局接口和異常的統(tǒng)一處理，但是存在的如下問題
每個(gè)controller都需要返回Reesult類型，且每個(gè)方法都需要返回Result.success()或者Result.success(data)的結(jié)果，有點(diǎn)重復(fù)，需要進(jìn)行優(yōu)化。
@GetMapping("addUser")
public Result add()
{
for(int i=0;i<10;i++)
{
TUser user = new TUser();
//user.setOid(IdWorker.getId());
user.setName("shareing_"+i);
user.setAge(i);
userService.addUser(user);
}
return Result.success();
}2.6 接口統(tǒng)一輸出優(yōu)化
實(shí)現(xiàn)方式只需要實(shí)現(xiàn)ResponseBodyAdvice接口，重寫beforeBodyWrite方法接口。
@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice<Object>
{
private Logger logger = LoggerFactory.getLogger(ResponseAdvice.class);
@Override
public boolean supports(MethodParameter returnType,
Class<? extends HttpMessageConverter<?>> converterType)
{
return true;
}
@Override
public Object beforeBodyWrite(Object o, MethodParameter returnType,
MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType,
ServerHttpRequest request, ServerHttpResponse response)
{
logger.info("before body write param:{}",o);
if(o instanceof String)
{
//序列化結(jié)果輸出
return FastJsonUtil.toJSONString(Result.success(o));
}
else if (o instanceof Result)
{
return o;
}
return Result.success(o);
}
}經(jīng)過優(yōu)化后，controller輸出可以根據(jù)業(yè)務(wù)的需求定義輸出對(duì)象。
@GetMapping("getUserByName")
public TUser getUserByName1(@RequestParam String name)
{
logger.info("getUserByName paramter name:"+name);
return userService.getUserByName(name);
}2.7 子系統(tǒng)如何實(shí)現(xiàn)
子系統(tǒng)引入common的jar包，
<dependency> <groupId>com.xx</groupId> <artifactId>xx-common</artifactId> <version>2.0</version> </dependency>
3、子系統(tǒng)定義狀態(tài)碼，實(shí)現(xiàn)BaseResultCode接口
public enum OrderModelErrorCode implements BaseResultCode
{
ORDER_STATUS_ERROR(1000, "訂單狀態(tài)不正確");
private int code;
private String msg;
private UserModelErrorCode(int code, String msg)
{
this.code = code;
this.msg = msg;
}
@Override
public int getCode()
{
return code;
}
@Override
public String getMsg()
{
return msg;
}
}定義異常處理類，繼承公共異常處理類SysExceptionHandler
@RestControllerAdvice
public class OrderModalExceptionHandle extends SysExceptionHandler
{
@Override
public Result handleException(HttpServletRequest request, Exception ex)
{
return super.handleException(request, ex);
//子系統(tǒng)可以擴(kuò)展異常處理
}
}子系統(tǒng)使用示例：
@Override
public Order getOrder(String orderId)
{
Order order =getOrder(orderId);
//相關(guān)偽代碼
if(order.getStatus()>120)
{
throw new SysException(OrderModelErrorCode.ORDER_STATUS_ERROR);
}
return order;
}
經(jīng)過相關(guān)項(xiàng)目的重構(gòu)，已經(jīng)解決了第一個(gè)和第二問題，關(guān)于第三個(gè)國(guó)際化問題，將在后續(xù)的文章中講解。
到此這篇關(guān)于Spring Boot統(tǒng)一接口返回以及全局異常處理的文章就介紹到這了,更多相關(guān)Spring Boot異常處理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Java實(shí)現(xiàn)字符串轉(zhuǎn)為駝峰格式的方法詳解
這篇文章主要介紹了如何利用Java語言實(shí)現(xiàn)字符串轉(zhuǎn)為駝峰格式,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2022-07-07
Java UUID 五個(gè)版本的區(qū)別及使用場(chǎng)景小結(jié)
在Java中,UUID是一個(gè)128位的唯一標(biāo)識(shí)符,廣泛應(yīng)用于生成唯一標(biāo)識(shí)符、分布式系統(tǒng)唯一鍵等場(chǎng)景,Java提供的java.util.UUID類支持五種UUID版本,每種具有不同的生成方式和使用場(chǎng)景,本文就來介紹一下如何使用,感興趣的可以了解一下2024-11-11
Java?語言擁有許多隱藏而強(qiáng)大的特性,其中之一是雙括號(hào)初始化,這篇文章將詳細(xì)介紹雙括號(hào)初始化的概念、用法和示例代碼,希望對(duì)大家有所幫助2023-12-12
SpringBoot實(shí)現(xiàn)本地文件存儲(chǔ)及預(yù)覽過程
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)本地文件存儲(chǔ)及預(yù)覽過程，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-11-11
在Spring MVC中處理請(qǐng)求參數(shù)的方法總結(jié)
在Spring MVC中處理請(qǐng)求參數(shù)是通過使用各種注解來實(shí)現(xiàn)的,本文給大家介紹了在Spring MVC中處理不同類型請(qǐng)求參數(shù)的方法,并通過代碼講解的非常詳細(xì),需要的朋友可以參考下2024-08-08
Java調(diào)用echarts提供的地圖壓縮方法來壓縮地圖
今天小編就為大家分享一篇關(guān)于Java調(diào)用echarts提供的地圖壓縮方法來壓縮地圖，小編覺得內(nèi)容挺不錯(cuò)的，現(xiàn)在分享給大家，具有很好的參考價(jià)值，需要的朋友一起跟隨小編來看看吧2018-12-12
這篇文章主要為大家介紹了如何利用Java實(shí)現(xiàn)帶GUI的氣泡詩詞效果，文中的示例代碼講解詳細(xì)，對(duì)我們學(xué)習(xí)Java有一定幫助，感興趣的可以了解一下2022-12-12
JavaWeb servlet實(shí)現(xiàn)下載與上傳功能的方法詳解
這篇文章主要介紹了JavaWeb servlet實(shí)現(xiàn)下載與上傳功能的方法,結(jié)合實(shí)例形式詳細(xì)分析了JavaWeb servlet實(shí)現(xiàn)下載與上傳功能的原理、實(shí)現(xiàn)方法與操作注意事項(xiàng),需要的朋友可以參考下2020-04-04
jdk21下載、安裝詳細(xì)教程(Windows、Linux、macOS)
本文介紹了OpenJDK 21的下載地址和安裝步驟,包括Windows、Linux和macOS平臺(tái),下載后解壓并設(shè)置環(huán)境變量,最后驗(yàn)證安裝,感興趣的朋友一起看看吧2025-03-03
這篇文章主要介紹了MyBatis 多表操作的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09