??平時(shí)開發(fā)過程中,無可避免我們需要處理各類異常羊苟,所以這里我們?cè)诠材K中自定義統(tǒng)一異常乘盖,Spring Boot 提供 @RestControllerAdvice 注解統(tǒng)一異常處理,我們?cè)贕itEgg_Platform中新建gitegg-platform-boot子工程多柑,此工程主要用于Spring Boot相關(guān)功能的自定義及擴(kuò)展论衍。
1瑞佩、修改gitegg-platform-boot的pom.xml,添加spring-boot-starter-web和swagger依賴坯台,設(shè)置optional為true炬丸,讓這個(gè)包在項(xiàng)目之間依賴不傳遞。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.gitegg.platform</groupId>
<artifactId>gitegg-platform-swagger</artifactId>
<optional>true</optional>
</dependency>
2蜒蕾、自定義通用響應(yīng)消息類稠炬,Result和PageResult,一個(gè)是普通響應(yīng)消息咪啡,一個(gè)是分頁響應(yīng)消息首启。
Result類:
package com.gitegg.platform.boot.common.base;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.*;
/**
* @ClassName: Result
* @Description: 自定義通用響應(yīng)類
* @author GitEgg
* @date 2020年09月19日 下午9:24:50
*/
@ApiModel(description = "通用響應(yīng)類")
@Getter
@ToString
public class Result<T> {
@ApiModelProperty(value = "是否成功", required = true)
private boolean success;
@ApiModelProperty(value ="響應(yīng)代碼", required = true)
private int code;
@ApiModelProperty(value ="提示信息", required = true)
private String msg;
@ApiModelProperty(value ="響應(yīng)數(shù)據(jù)")
private T data;
/**
*
* @param code
* @param data
* @param msg
*/
private Result(int code, T data, String msg) {
this.success = ResultCodeEnum.SUCCESS.code == code;
this.code = code;
this.msg = msg;
this.data = data;
}
/**
*
* @param resultCodeEnum
*/
private Result(ResultCodeEnum resultCodeEnum ) {
this(resultCodeEnum.code, null, resultCodeEnum.msg);
}
/**
*
* @param resultCodeEnum
* @param msg
*/
private Result(ResultCodeEnum resultCodeEnum , String msg) {
this(resultCodeEnum, null, msg);
}
/**
*
* @param resultCodeEnum
* @param data
*/
private Result(ResultCodeEnum resultCodeEnum , T data) {
this(resultCodeEnum, data, resultCodeEnum.msg);
}
/**
*
* @param resultCodeEnum
* @param data
* @param msg
*/
private Result(ResultCodeEnum resultCodeEnum , T data, String msg) {
this(resultCodeEnum.code, data, msg);
}
/**
*
*
* @param data 數(shù)據(jù)
* @param <T> T 響應(yīng)數(shù)據(jù)
* @
*/
public static <T> Result<T> data(T data) {
return data(data, ResultCodeEnum.SUCCESS.msg);
}
/**
*
*
* @param data 數(shù)據(jù)
* @param msg 消息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @
*/
public static <T> Result<T> data(T data, String msg) {
return data(ResultCodeEnum.SUCCESS.code, data, msg);
}
/**
*
*
* @param code 狀態(tài)碼
* @param data 數(shù)據(jù)
* @param msg 消息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @
*/
public static <T> Result<T> data(int code, T data, String msg) {
return new Result<>(code, data, msg);
}
/**
* 返回Result
*
* @param
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> success() {
return new Result<>(ResultCodeEnum.SUCCESS);
}
/**
* 返回Result
*
* @param msg 消息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> success(String msg) {
return new Result<>(ResultCodeEnum.SUCCESS, msg);
}
/**
* 返回Result
*
* @param
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> success(ResultCodeEnum resultCodeEnum ) {
return new Result<>(resultCodeEnum);
}
/**
* 返回Result
*
* @param
* @param msg 提示信息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> success(ResultCodeEnum resultCodeEnum , String msg) {
return new Result<>(resultCodeEnum, msg);
}
/**
* 返回Result
*
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> error() {
return new Result<>(ResultCodeEnum.ERROR, ResultCodeEnum.ERROR.msg);
}
/**
* 返回Result
*
* @param msg 消息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> error(String msg) {
return new Result<>(ResultCodeEnum.ERROR, msg);
}
/**
* 返回Result
*
* @param code 狀態(tài)碼
* @param msg 消息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> error(int code, String msg) {
return new Result<>(code, null, msg);
}
/**
* 返回Result
*
* @param
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> error(ResultCodeEnum resultCodeEnum ) {
return new Result<>(resultCodeEnum);
}
/**
* 返回Result
*
* @param
* @param msg 提示信息
* @param <T> T 響應(yīng)數(shù)據(jù)
* @返回Result
*/
public static <T> Result<T> error(ResultCodeEnum resultCodeEnum , String msg) {
return new Result<>(resultCodeEnum, msg);
}
/**
*
* @param <T>
* @param flag
* @return
*/
public static <T> Result<T> result(boolean flag) {
return flag ? Result.success("操作成功") : Result.error("操作失敗");
}
}
PageResult類:
package com.gitegg.platform.boot.common.base;
import java.util.List;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
* @ClassName: PageResult
* @Description: 通用分頁返回
* @author GitEgg
* @date
* @param <T>
*/
@Data
@ApiModel("通用分頁響應(yīng)類")
public class PageResult<T> {
@ApiModelProperty(value = "是否成功", required = true)
private boolean success;
@ApiModelProperty(value ="響應(yīng)代碼", required = true)
private int code;
@ApiModelProperty(value ="提示信息", required = true)
private String msg;
@ApiModelProperty(value ="總數(shù)量", required = true)
private long count;
@ApiModelProperty(value ="分頁數(shù)據(jù)")
private List<T> data;
public PageResult(long total, List<T> rows) {
this.count = total;
this.data = rows;
this.code = ResultCodeEnum.SUCCESS.code;
this.msg = ResultCodeEnum.SUCCESS.msg;
}
}
3、自定義通用響應(yīng)消息枚舉類ResultCodeEnum瑟匆。
package com.gitegg.platform.boot.common.enums;
/**
* @ClassName: ResultCodeEnum
* @Description: 自定義返回碼枚舉
* @author GitEgg
* @date 2020年09月19日 下午11:49:45
*/
public enum ResultCodeEnum {
/**
* 成功
*/
SUCCESS(200, "操作成功"),
/**
* 系統(tǒng)錯(cuò)誤
*/
ERROR(500, "系統(tǒng)錯(cuò)誤"),
/**
* 操作失敗
*/
FAILED(101, "操作失敗"),
/**
* 未登錄/登錄超時(shí)
*/
UNAUTHORIZED(102, "登錄超時(shí)"),
/**
* 參數(shù)錯(cuò)誤
*/
PARAM_ERROR(103, "參數(shù)錯(cuò)誤"),
/**
* 參數(shù)錯(cuò)誤-已存在
*/
INVALID_PARAM_EXIST(104, "請(qǐng)求參數(shù)已存在"),
/**
* 參數(shù)錯(cuò)誤
*/
INVALID_PARAM_EMPTY(105, "請(qǐng)求參數(shù)為空"),
/**
* 參數(shù)錯(cuò)誤
*/
PARAM_TYPE_MISMATCH(106, "參數(shù)類型不匹配"),
/**
* 參數(shù)錯(cuò)誤
*/
PARAM_VALID_ERROR(107, "參數(shù)校驗(yàn)失敗"),
/**
* 參數(shù)錯(cuò)誤
*/
ILLEGAL_REQUEST(108, "非法請(qǐng)求"),
/**
* 驗(yàn)證碼錯(cuò)誤
*/
INVALID_VCODE(204, "驗(yàn)證碼錯(cuò)誤"),
/**
* 用戶名或密碼錯(cuò)誤
*/
INVALID_USERNAME_PASSWORD(205, "賬號(hào)或密碼錯(cuò)誤"),
/**
*
*/
INVALID_RE_PASSWORD(206, "兩次輸入密碼不一致"),
/**
* 用戶名或密碼錯(cuò)誤
*/
INVALID_OLD_PASSWORD(207, "舊密碼錯(cuò)誤"),
/**
* 用戶名重復(fù)
*/
USERNAME_ALREADY_IN(208, "用戶名已存在"),
/**
* 用戶不存在
*/
INVALID_USERNAME(209, "用戶名不存在"),
/**
* 角色不存在
*/
INVALID_ROLE(210, "角色不存在"),
/**
* 角色不存在
*/
ROLE_USED(211, "角色使用中闽坡,不可刪除"),
/**
* 沒有權(quán)限
*/
NO_PERMISSION(403, "當(dāng)前用戶無該接口權(quán)限");
public int code;
public String msg;
ResultCodeEnum(int code, String msg) {
this.code = code;
this.msg = msg;
}
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;
}
}
4栽惶、自定義異常類BusinessException和SystemException
package com.gitegg.platform.boot.common.exception;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.Getter;
import lombok.Setter;
/**
* @ClassName: BusinessException
* @Description: 業(yè)務(wù)處理異常
* @author GitEgg
* @date
*/
@Getter
@Setter
public class BusinessException extends RuntimeException {
private int code;
private String msg;
public BusinessException() {
this.code = ResultCodeEnum.FAILED.code;
this.msg = ResultCodeEnum.FAILED.msg;
}
public BusinessException(String message) {
this.code = ResultCodeEnum.FAILED.code;
this.msg = message;
}
public BusinessException(int code, String msg) {
this.code = code;
this.msg = msg;
}
public BusinessException(Throwable cause) {
super(cause);
}
public BusinessException(String message, Throwable cause) {
super(message, cause);
}
}
package com.gitegg.platform.boot.common.exception;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import lombok.Getter;
/**
* @ClassName: SystemException
* @Description: 系統(tǒng)處理異常
* @author GitEgg
* @date
*/
@Getter
public class SystemException extends RuntimeException {
private int code;
private String msg;
public SystemException() {
this.code = ResultCodeEnum.ERROR.code;
this.msg = ResultCodeEnum.ERROR.msg;
}
public SystemException(String message) {
this.code = ResultCodeEnum.ERROR.code;
this.msg = message;
}
public SystemException(int code, String msg) {
this.code = code;
this.msg = msg;
}
public SystemException(Throwable cause) {
super(cause);
}
public SystemException(String message, Throwable cause) {
super(message, cause);
}
}
5愁溜、自定義統(tǒng)一異常處理類GitEggControllerAdvice.java
package com.gitegg.platform.boot.common.advice;
import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.platform.boot.common.enums.ResultCodeEnum;
import com.gitegg.platform.boot.common.exception.BusinessException;
import com.gitegg.platform.boot.common.exception.SystemException;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.ui.Model;
import org.springframework.web.HttpMediaTypeNotAcceptableException;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingPathVariableException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import org.springframework.web.servlet.NoHandlerFoundException;
import javax.annotation.PostConstruct;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;
@Slf4j
@RestControllerAdvice
public class GitEggControllerAdvice {
/**
* 服務(wù)名
*/
@Value("${spring.application.name}")
private String serverName;
/**
* 微服務(wù)系統(tǒng)標(biāo)識(shí)
*/
private String errorSystem;
@PostConstruct
public void init() {
this.errorSystem = new StringBuffer()
.append(this.serverName)
.append(": ").toString();
}
/**
* 應(yīng)用到所有@RequestMapping注解方法,在其執(zhí)行之前初始化數(shù)據(jù)綁定器
*/
@InitBinder
public void initBinder(WebDataBinder binder) {
}
/**
* 把值綁定到Model中外厂,使全局@RequestMapping可以獲取到該值
*/
@ModelAttribute
public void addAttributes(Model model) {
}
/**
* 全局異常捕捉處理
*/
@ExceptionHandler(value = {Exception.class})
public Result handlerException(Exception exception, HttpServletRequest request) {
log.error("請(qǐng)求路徑uri={},系統(tǒng)內(nèi)部出現(xiàn)異常:{}", request.getRequestURI(), exception);
Result result = Result.error(ResultCodeEnum.ERROR, errorSystem + exception.toString());
return result;
}
/**
* 非法請(qǐng)求異常
*/
@ExceptionHandler(value = {
HttpMediaTypeNotAcceptableException.class,
HttpMediaTypeNotSupportedException.class,
HttpRequestMethodNotSupportedException.class,
MissingServletRequestParameterException.class,
NoHandlerFoundException.class,
MissingPathVariableException.class,
HttpMessageNotReadableException.class
})
public Result handlerSpringAOPException(Exception exception) {
Result result = Result.error(ResultCodeEnum.ILLEGAL_REQUEST, errorSystem + exception.getMessage());
return result;
}
/**
* 非法請(qǐng)求異常-參數(shù)類型不匹配
*/
@ExceptionHandler(value = MethodArgumentTypeMismatchException.class)
public Result handlerSpringAOPException(MethodArgumentTypeMismatchException exception) {
Result result = Result.error(ResultCodeEnum.PARAM_TYPE_MISMATCH, errorSystem + exception.getMessage());
return result;
}
/**
* 非法請(qǐng)求-參數(shù)校驗(yàn)
*/
@ExceptionHandler(value = {MethodArgumentNotValidException.class})
public Result handlerMethodArgumentNotValidException(MethodArgumentNotValidException methodArgumentNotValidException) {
//獲取異常字段及對(duì)應(yīng)的異常信息
StringBuffer stringBuffer = new StringBuffer();
methodArgumentNotValidException.getBindingResult().getFieldErrors().stream()
.map(t -> t.getField()+"=>"+t.getDefaultMessage()+" ")
.forEach(e -> stringBuffer.append(e));
String errorMessage = stringBuffer.toString();
Result result = Result.error(ResultCodeEnum.PARAM_VALID_ERROR, errorSystem + errorMessage);
return result;
}
/**
* 非法請(qǐng)求異常-參數(shù)校驗(yàn)
*/
@ExceptionHandler(value = {ConstraintViolationException.class})
public Result handlerConstraintViolationException(ConstraintViolationException constraintViolationException) {
String errorMessage = constraintViolationException.getLocalizedMessage();
Result result = Result.error(ResultCodeEnum.PARAM_VALID_ERROR, errorSystem + errorMessage);
return result;
}
/**
* 自定義業(yè)務(wù)異常-BusinessException
*/
@ExceptionHandler(value = {BusinessException.class})
public Result handlerCustomException(BusinessException exception) {
String errorMessage = exception.getMsg();
Result result = Result.error(exception.getCode(), errorSystem + errorMessage);
return result;
}
/**
* 自定義系統(tǒng)異常-SystemException
*/
@ExceptionHandler(value = {SystemException.class})
public Result handlerCustomException(SystemException exception) {
String errorMessage = exception.getMsg();
Result result = Result.error(exception.getCode(), errorSystem + errorMessage);
return result;
}
}
6冕象、重新將GitEgg-Platform進(jìn)行install,在GitEgg-Cloud中的gitegg-service引入gitegg-platform-boot
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>GitEgg-Cloud</artifactId>
<groupId>com.gitegg.cloud</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>gitegg-service</artifactId>
<packaging>pom</packaging>
<modules>
<module>gitegg-service-base</module>
<module>gitegg-service-bigdata</module>
<module>gitegg-service-system</module>
</modules>
<dependencies>
<!-- gitegg Spring Boot自定義及擴(kuò)展 -->
<dependency>
<groupId>com.gitegg.platform</groupId>
<artifactId>gitegg-platform-boot</artifactId>
</dependency>
<!-- gitegg數(shù)據(jù)庫驅(qū)動(dòng)及連接池 -->
<dependency>
<groupId>com.gitegg.platform</groupId>
<artifactId>gitegg-platform-db</artifactId>
</dependency>
<!-- gitegg mybatis-plus -->
<dependency>
<groupId>com.gitegg.platform</groupId>
<artifactId>gitegg-platform-mybatis</artifactId>
</dependency>
<!-- gitegg swagger2-knife4j -->
<dependency>
<groupId>com.gitegg.platform</groupId>
<artifactId>gitegg-platform-swagger</artifactId>
</dependency>
<!-- spring boot web核心包 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- spring boot 健康監(jiān)控 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
</dependencies>
</project>
7汁蝶、修改SystemController.java渐扮、ISystemService.java和SystemServiceImpl.java增加異常處理的測(cè)試代碼
SystemController.java:
package com.gitegg.service.system.controller;
import com.gitegg.platform.boot.common.base.Result;
import com.gitegg.platform.boot.common.exception.BusinessException;
import com.gitegg.service.system.service.ISystemService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.AllArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping(value = "system")
@AllArgsConstructor
@Api(tags = "gitegg-system")
public class SystemController {
private final ISystemService systemService;
@GetMapping(value = "list")
@ApiOperation(value = "system list接口")
public Object list() {
return systemService.list();
}
@GetMapping(value = "page")
@ApiOperation(value = "system page接口")
public Object page() {
return systemService.page();
}
@GetMapping(value = "exception")
@ApiOperation(value = "自定義異常及返回測(cè)試接口")
public Result<String> exception() {
return Result.data(systemService.exception());
}
}
ISystemService.java:
package com.gitegg.service.system.service;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.gitegg.service.system.entity.SystemTable;
import java.util.List;
public interface ISystemService {
List<SystemTable> list();
Page<SystemTable> page();
String exception();
}
SystemServiceImpl.java:
package com.gitegg.service.system.service.impl;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.gitegg.platform.boot.common.exception.BusinessException;
import com.gitegg.service.system.entity.SystemTable;
import com.gitegg.service.system.mapper.SystemTableMapper;
import com.gitegg.service.system.service.ISystemService;
import lombok.AllArgsConstructor;
import org.springframework.stereotype.Service;
import java.util.List;
/**
*
*/
@Service
@AllArgsConstructor
public class SystemServiceImpl implements ISystemService {
private final SystemTableMapper systemTableMapper;
@Override
public List<SystemTable> list() {
return systemTableMapper.list();
}
@Override
public Page<SystemTable> page() {
Page<SystemTable> page = new Page<>(1, 10);
List<SystemTable> records = systemTableMapper.page(page);
page.setRecords(records);
return page;
}
@Override
public String exception() {
throw new BusinessException("自定義異常");
// return "成功獲得數(shù)據(jù)";
}
}
8、運(yùn)行GitEggSystemApplication掖棉,打開瀏覽器訪問:http://127.0.0.1:8001/doc.html墓律,然后點(diǎn)擊左側(cè)的異常處理接口,使用Swagger2進(jìn)行測(cè)試幔亥,即可看到結(jié)果
本文源碼在https://gitee.com/wmz1930/GitEgg 的chapter-07分支耻讽。
GitEgg-Cloud是一款基于SpringCloud整合搭建的企業(yè)級(jí)微服務(wù)應(yīng)用開發(fā)框架,開源項(xiàng)目地址:
Gitee: https://gitee.com/wmz1930/GitEgg
GitHub: https://github.com/wmz1930/GitEgg
歡迎感興趣的小伙伴Star支持一下帕棉。