我已经不用 try catch 处理异常了!太辣鸡了!
# 背景
# 什么是统一异常处理
# 目标
# 统一异常处理实战
用 Assert(断言) 替换 throw exception
@Testpublic void test1() {...User user = userDao.selectById(userId);Assert.notNull(user, "用户不存在.");...}public void test2() {// 另一种写法User user = userDao.selectById(userId);if (user == null) {throw new IllegalArgumentException("用户不存在.");}}
public abstract class Assert {public Assert() {}public static void notNull(@Nullable Object object, String message) {if (object == null) {throw new IllegalArgumentException(message);}}}
Assertpublic interface Assert {/*** 创建异常* @param args* @return*/BaseException newException(Object... args);/*** 创建异常* @param t* @param args* @return*/BaseException newException(Throwable t, Object... args);/***断言对象
obj非空。如果对象obj为空,则抛出异常** @param obj 待判断对象*/default void assertNotNull(Object obj) {if (obj == null) {throw newException(obj);}}/***断言对象
obj非空。如果对象obj为空,则抛出异常*异常信息
message支持传递参数方式,避免在判断之前进行字符串拼接操作** @param obj 待判断对象* @param args message占位符对应的参数列表*/default void assertNotNull(Object obj, Object... args) {if (obj == null) {throw newException(args);}}}
善解人意的Enum
public interface IResponseEnum {int getCode();String getMessage();}/***业务异常
*业务处理时,出现异常,可以抛出该异常
*/public class BusinessException extends BaseException {private static final long serialVersionUID = 1L;public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {super(responseEnum, args, message);}public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {super(responseEnum, args, message, cause);}}public interface BusinessExceptionAssert extends IResponseEnum, Assert {default BaseException newException(Object... args) {String msg = MessageFormat.format(this.getMessage(), args);return new BusinessException(this, args, msg);}default BaseException newException(Throwable t, Object... args) {String msg = MessageFormat.format(this.getMessage(), args);return new BusinessException(this, args, msg, t);}}@Getter@AllArgsConstructorpublic enum ResponseEnum implements BusinessExceptionAssert {/*** Bad licence type*/BAD_LICENCE_TYPE(7001, "Bad licence type."),/*** Licence not found*/LICENCE_NOT_FOUND(7002, "Licence not found.");/*** 返回码*/private int code;/*** 返回消息*/private String message;}
/*** 校验{@link Licence}存在* @param licence*/private void checkNotNull(Licence licence) {ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);}
private void checkNotNull(Licence licence) {if (licence == null) {throw new LicenceNotFoundException();// 或者这样throw new BusinessException(7001, "Bad licence type.");}}
注:上面举的例子是针对特定的业务,而有部分异常情况是通用的,比如:服务器繁忙、网络异常、服务器异常、参数校验异常、404等,所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum,其中 ServletResponseEnum 会在后文详细说明。
定义统一异常处理器类
4j@Component@ControllerAdvice@ConditionalOnWebApplication(UnifiedExceptionHandler.class)public class UnifiedExceptionHandler {/*** 生产环境*/private final static String ENV_PROD = "prod";private UnifiedMessageSource unifiedMessageSource;/*** 当前环境*/("${spring.profiles.active}")private String profile;/*** 获取国际化消息** @param e 异常* @return*/public String getMessage(BaseException e) {String code = "response." + e.getResponseEnum().toString();String message = unifiedMessageSource.getMessage(code, e.getArgs());if (message == null || message.isEmpty()) {return e.getMessage();}return message;}/*** 业务异常** @param e 异常* @return 异常结果*/(value = BusinessException.class)public ErrorResponse handleBusinessException(BaseException e) {log.error(e.getMessage(), e);return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));}/*** 自定义异常** @param e 异常* @return 异常结果*/(value = BaseException.class)public ErrorResponse handleBaseException(BaseException e) {log.error(e.getMessage(), e);return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));}/*** Controller上一层相关异常** @param e 异常* @return 异常结果*/({NoHandlerFoundException.class,HttpRequestMethodNotSupportedException.class,HttpMediaTypeNotSupportedException.class,MissingPathVariableException.class,MissingServletRequestParameterException.class,TypeMismatchException.class,HttpMessageNotReadableException.class,HttpMessageNotWritableException.class,// BindException.class,// MethodArgumentNotValidException.classHttpMediaTypeNotAcceptableException.class,ServletRequestBindingException.class,ConversionNotSupportedException.class,MissingServletRequestPartException.class,AsyncRequestTimeoutException.class})public ErrorResponse handleServletException(Exception e) {log.error(e.getMessage(), e);int code = CommonResponseEnum.SERVER_ERROR.getCode();try {ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());code = servletExceptionEnum.getCode();} catch (IllegalArgumentException e1) {log.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());}if (ENV_PROD.equals(profile)) {// 当为生产环境, 不适合把具体的异常信息展示给用户, 比如404.code = CommonResponseEnum.SERVER_ERROR.getCode();BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);String message = getMessage(baseException);return new ErrorResponse(code, message);}return new ErrorResponse(code, e.getMessage());}/*** 参数绑定异常** @param e 异常* @return 异常结果*/(value = BindException.class)public ErrorResponse handleBindException(BindException e) {log.error("参数绑定校验异常", e);return wrapperBindingResult(e.getBindingResult());}/*** 参数校验异常,将校验失败的所有异常组合成一条错误信息** @param e 异常* @return 异常结果*/(value = MethodArgumentNotValidException.class)public ErrorResponse handleValidException(MethodArgumentNotValidException e) {log.error("参数绑定校验异常", e);return wrapperBindingResult(e.getBindingResult());}/*** 包装绑定异常结果** @param bindingResult 绑定结果* @return 异常结果*/private ErrorResponse wrapperBindingResult(BindingResult bindingResult) {StringBuilder msg = new StringBuilder();for (ObjectError error : bindingResult.getAllErrors()) {msg.append(", ");if (error instanceof FieldError) {msg.append(((FieldError) error).getField()).append(": ");}msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());}return new ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2));}/*** 未定义异常** @param e 异常* @return 异常结果*/(value = Exception.class)public ErrorResponse handleException(Exception e) {log.error(e.getMessage(), e);if (ENV_PROD.equals(profile)) {// 当为生产环境, 不适合把具体的异常信息展示给用户, 比如数据库异常信息.int code = CommonResponseEnum.SERVER_ERROR.getCode();BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);String message = getMessage(baseException);return new ErrorResponse(code, message);}return new ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage());}}
进入Controller前的异常: handleServletException、handleBindException、handleValidException 自定义异常: handleBusinessException、handleBaseException 未知异常: handleException
# 异常处理器说明
handleServletException
handleBindException
handleValidException
handleBusinessException、handleBaseException
handleException
注:上面的handleServletException、handleException 这两个处理器,返回的异常信息,不同环境返回的可能不一样,以为这些异常信息都是框架自带的异常信息,一般都是英文的,不太好直接展示给用户看,所以统一返回SERVER_ERROR代表的异常信息。
# 异于常人的404


spring.mvc.throw-exception-if-no-handler-found=truespring.resources.add-mappings=false
# 统一返回结果
# 验证统一异常处理
# 主要代码
@Servicepublic class LicenceService extends ServiceImpl<LicenceMapper, Licence> {private OrganizationClient organizationClient;/*** 查询{@link Licence} 详情* @param licenceId* @return*/public LicenceDTO queryDetail(Long licenceId) {Licence licence = this.getById(licenceId);checkNotNull(licence);OrganizationDTO org = ClientUtil.execute(() -> organizationClient.getOrganization(licence.getOrganizationId()));return toLicenceDTO(licence, org);}/*** 分页获取* @param licenceParam 分页查询参数* @return*/public QueryDatagetLicences(LicenceParam licenceParam) {String licenceType = licenceParam.getLicenceType();LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum.parseOfNullable(licenceType);// 断言, 非空ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);LambdaQueryWrapperwrapper = new LambdaQueryWrapper<>(); wrapper.eq(Licence::getLicenceType, licenceType);IPagepage = this.page(new QueryPage<>(licenceParam), wrapper); return new QueryData<>(page, this::toSimpleLicenceDTO);}/*** 新增{@link Licence}* @param request 请求体* @return*/(rollbackFor = Throwable.class)public LicenceAddRespData addLicence(LicenceAddRequest request) {Licence licence = new Licence();licence.setOrganizationId(request.getOrganizationId());licence.setLicenceType(request.getLicenceType());licence.setProductName(request.getProductName());licence.setLicenceMax(request.getLicenceMax());licence.setLicenceAllocated(request.getLicenceAllocated());licence.setComment(request.getComment());this.save(licence);return new LicenceAddRespData(licence.getLicenceId());}/*** entity -> simple dto* @param licence {@link Licence} entity* @return {@link SimpleLicenceDTO}*/private SimpleLicenceDTO toSimpleLicenceDTO(Licence licence) {// 省略}/*** entity -> dto* @param licence {@link Licence} entity* @param org {@link OrganizationDTO}* @return {@link LicenceDTO}*/private LicenceDTO toLicenceDTO(Licence licence, OrganizationDTO org) {// 省略}/*** 校验{@link Licence}存在* @param licence*/private void checkNotNull(Licence licence) {ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);}}
-- licenceINSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES (1, 1, 'user','CustomerPro', 100,5);INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES (2, 1, 'user','suitability-plus', 200,189);INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES (3, 2, 'user','HR-PowerSuite', 100,4);INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)VALUES (4, 2, 'core-prod','WildCat Application Gateway', 16,16);-- organizationsINSERT INTO organization (id, name, contact_name, contact_email, contact_phone)VALUES (1, 'customer-crm-co', 'Mark Balster', 'mark.balster@custcrmco.com', '823-555-1212');INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)VALUES (2, 'HR-PowerSuite', 'Doug Drewry','doug.drewry@hr.com', '920-555-1212');
# 开始验证
捕获自定义异常



















捕获未知异常



# 小结
# 扩展


# 总结

4jpublic class GlobalExceptionHandler {/*** 没有登录* @param request* @param response* @param e* @return*/(NoLoginException.class)public Object noLoginExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e){log.error("[GlobalExceptionHandler][noLoginExceptionHandler] exception",e);JsonResult jsonResult = new JsonResult();jsonResult.setCode(JsonResultCode.NO_LOGIN);jsonResult.setMessage("用户登录失效或者登录超时,请先登录");return jsonResult;}/*** 业务异常* @param request* @param response* @param e* @return*/(ServiceException.class)public Object businessExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e){log.error("[GlobalExceptionHandler][businessExceptionHandler] exception",e);JsonResult jsonResult = new JsonResult();jsonResult.setCode(JsonResultCode.FAILURE);jsonResult.setMessage("业务异常,请联系管理员");return jsonResult;}/*** 全局异常处理* @param request* @param response* @param e* @return*/(Exception.class)public Object exceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e){log.error("[GlobalExceptionHandler][exceptionHandler] exception",e);JsonResult jsonResult = new JsonResult();jsonResult.setCode(JsonResultCode.FAILURE);jsonResult.setMessage("系统错误,请联系管理员");return jsonResult;}}
评论
