教你玩转 统一异常处理(2)

* @ Modified By：

* @Version: 1

*/

public class MyException extends RuntimeException{

//错误码

private Integer code;

public Integer getCode() {

return code;

}

public void setCode(Integer code) {

this.code = code;

}

public MyException(String message) {

super(message);

}

/**

* 构造器重载，主要是自己考虑某些异常自定义一些返回码

* @param code

* @param message

*/

public MyException(Integer code,String message) {

super(message);

this.code = code;

}

}

创建消息返回的包装实体

---

分析：对于后台返回给前端的数据来说，我们很多情况都是返回的JSON格式的数据（当然，并不是局限于这一种），那么JSON是一种格式化的形式，所以，我们应该有效的针对这样的形式来给予一定的返回规范，这样也方便前端对于我们返回数据的解析。

比如：很多情况一般是如下的格式：

{

“retCode”: 200,  //通过状态码可以得到消息是否返回正常，然后再决定是否去解析data域的内容

“data”: {        //返回的数据内容

}

“retMes”: success  //返回的提示内容

}

所以，我们可以定义如下的类：

package com.hnu.csapp.exception;

/**

* @ Author     ：scw

* @ Description：异常处理实体包装类，自己用泛型进行写，扩展性强点

* @ Modified By：

* @Version: 1

*/

public class Result {

//返回码

private Integer code;

//返回消息

private String msg;

//返回数据

private T data;

public Integer getCode() {

return code;

}

public void setCode(Integer code) {

this.code = code;

}

public String getMsg() {

return msg;

}

public void setMsg(String msg) {

this.msg = msg;

}

public T getData() {

return data;

}

public void setData(T data) {

this.data = data;

}

}

定义一系列的枚举返回信息

---

分析：在系统中，我们应该有统一的某些编码对应某些内容，这样能够方便开发人员进行及时的处理。

package com.hnu.csapp.exception;

/**

* @ Author     ：scw

* @ Description：自定义一些返回状态码，便于本系统的使用，自己先定义如下的，有需要就后续补充

* @ Modified By：

* @Version: 1

*/

public enum ResultEnum {

/**

* 成功.: 200 (因为http中的状态码200一般都是表示成功)

*/

SUCCESS(200,“成功”),

/**

* 系统异常. ErrorCode : -1

*/

SystemException(-1,“系统异常”),

/**

* 未知异常. ErrorCode : 01

*/

UnknownException(01,“未知异常”),

/**

* 服务异常. ErrorCode : 02

*/

ServiceException(02, “服务异常”),

/**

* 业务错误. ErrorCode : 03

*/

MyException(03,“业务错误”),

/**

* 提示级错误. ErrorCode : 04

*/

InfoException(04, “提示级错误”),

/**

* 数据库操作异常. ErrorCode : 05

*/

DBException(05,“数据库操作异常”),

/**

* 参数验证错误. ErrorCode : 06

*/

ParamException(06,“参数验证错误”);

private Integer code;

private String msg;

ResultEnum(Integer code, String msg) {

this.code = code;

this.msg = msg;

}

public Integer getCode() {

return code;

}

public String getMsg() {

return msg;

}

}

定义消息返回工具类

---

分析：对于消息的返回，这是一个非常普通的工作，所以，我们可以将其封装一个工具类，能够进行有效代码的封装，减少多余的代码。

package com.hnu.csapp.exception;

/**

* @ Author     ：scw

* @ Description：返回消息处理的工具类，主要是处理操作成功和失败的一些内容

* @ Modified By：

* @Version: 1

*/

public class ResultUtil {

/**

* 操作成功的处理流程

* @param object

* @return

*/

public static Result getSuccess(Object object){

Result result = new Result();

//设置操作成功的返回码

result.setCode(200);

//设置操作成功的消息

result.setMsg(“成功”);

result.setData(object);

return result;

}

/**

* 重载返回成功的方法，因为有时候我们不需要任何的消息数据被返回

* @return

*/

public static Result getSuccess(){

return getSuccess(null);

}

/**

* 操作失败的处理流程

* @param code 错误码

* @param msg 错误消息

* @param o   错误数据（其实这个一般都不需要的，因为都已经返回失败了，数据都没必要返回）

* @return

*/

public static Result getError(Integer code, String msg, Object o){

Result result = new Result();

result.setCode(code);

result.setMsg(msg);

result.setData(o);

return result;

}

/**

* 重载，操作失败的方法（因为操作失败一般都不需要返回数据内容）

* @param code

* @param msg

* @return

*/

public static Result getError(Integer code, String msg){

return getError(code, msg, null);

}

}

定义异常统一处理类（重点）

---

分析：这是如何实现异常统一处理的关键地方，而且我也将不同的处理情形，进行了分开注释，所以，大家一定可以认真的看代码，我相信你一定能够明白。

package com.hnu.csapp.exception;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.springframework.web.bind.annotation.ControllerAdvice;

import org.springframework.web.bind.annotation.ExceptionHandler;

import org.springframework.web.bind.annotation.ResponseBody;

import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

/**

* @ Author     ：scw

* @ Description：异常统一处理类，方便用户可以更加友好的看到错误信息

* @ Modified By：

* @Version: 1

*/

@ControllerAdvice

public class ExceptionHandle {

//增加异常日志打印

private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);

//设置异常错误的页面

public static final String DEFAULT_ERROR_VIEW = “error”;

/**

* 以json的格式进行返回内容(开发环境一般个人是用这个比较好)

* @param e

* @return

*/

@ExceptionHandler(Exception.class)

@ResponseBody

public Object handle(HttpServletRequest req, Exception e){

//如果是自定义的异常

if(e instanceof MyException){

MyException myException = (MyException)e;

return ResultUtil.getError(myException.getCode(),myException.getMessage());

}else{

//如果是系统的异常，比如空指针这些异常

logger.error(“【系统异常】={}”,e);

return ResultUtil.getError(ResultEnum.SystemException.getCode(),ResultEnum.SystemException.getMsg());

}

}

/**

* 判断是否是Ajax的请求

* @param request

* @return

*/

public boolean isAjax(HttpServletRequest request){

return (request.getHeader(“X-Requested-With”) != null

&&

“XMLHttpRequest”.equals(request.getHeader(“X-Requested-With”).toString()));

}

/*

//备注:

面试准备+复习分享：

为了应付面试也刷了很多的面试题与资料，现在就分享给有需要的读者朋友，资料我只截取出来一部分哦

n.getMessage());

}else{

//如果是系统的异常，比如空指针这些异常

logger.error(“【系统异常】={}”,e);

return ResultUtil.getError(ResultEnum.SystemException.getCode(),ResultEnum.SystemException.getMsg());

}

}

/**

* 判断是否是Ajax的请求

* @param request

* @return

*/

public boolean isAjax(HttpServletRequest request){

return (request.getHeader(“X-Requested-With”) != null

&&

“XMLHttpRequest”.equals(request.getHeader(“X-Requested-With”).toString()));

}

/*

//备注:

面试准备+复习分享：

为了应付面试也刷了很多的面试题与资料，现在就分享给有需要的读者朋友，资料我只截取出来一部分哦

[外链图片转存中…(img-kWi9wb72-1714718758163)]

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录