SpringBoot异常处理

SpringBoot异常处理

一、认识异常

异常分类：

• Error: 代表编译和系统错误，不允许捕获
• Exception: 标准Java库的方法所激发的异常，包含运行异常Runtime_Exception和非运行异常 Non_RuntimeException 的子类
• Runtime_Exception: 运行时异常。
• Non_RuntimeException: 非运行时可检测的异常，Java 编译器利用分析方法或构造方法中可能产生的结果来检测程序中是否含有检测异常的处理程序，每个可能的可检测异常、方法或构造方法的 throws 子句必须列出该异常对应的类。
• Throw: 用户自定义异常

异常处理用于解决一些程序无法掌控， 但又必须面对的情况。例如，程序需要读取文件、连接网络、使用数据库等，但可能文件不存在、网络不畅通、数据库无效等情况。为了程序能继续运行，此时就需要把这些情况进行异常处理。异常处理的方法通常有以下几种:

• 将异常通知给开发人员、运维人员或用户。
• 使因为异常中断的程序以适当的方式继续运行，或者退出。
• 保存用户的当前操作，或者进行数据回滚。
• 释放资源。

二、SpringBoot默认的异常处理机制

默认情况下，Spring Boot为两种情况提供了不同的响应方式。

• 一种是浏览器客户端请求一个不存在的页面或服务端处理发生异常时，一般情况下浏览器默认发送的请求头中Accept: text/html，所以Spring Boot默认会响应一个html文档内容，称作“Whitelabel Error Page”。

• 使用Postman等调试工具发送请求一个不存在的url或服务端处理发生异常时，Spring Boot会返回类似如下的Json格式字符串信息

Sping Boot会根据消费者发送的**Content-Type来返回相应的异常内容，如果Content-Type是application/json，则返回 JSON 文件; 如果Content-Type** 是**text/html**, 则返回 HTML 文件。

Spring Boot 默认提供了程序出错的结果映射路径**/error。这个/error请求会在BasicErrorController**中处理，其内部是通过判断请求头中的Accept的内容是否为text/html来区分请求是来自客户端浏览器（浏览器通常默认自动发送请求头内容Accept:text/html）还是客户端接口的调用，以此来决定返回页面视图还是 JSON 消息内容。

三、异常处理方式

1、使用 @ExceptionHandler 注解处理局部异常

只能处理使用@ExceptionHandler注解的方法的Controller的异常。

package com.gcxy.demo11.controller;import com.gcxy.demo11.dto.OrderDTO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/order")
public class OrderController {@GetMapping("/getOrderInfo")public String getOrderInfo(){if (true){throw new NullPointerException("fsdfs");}return "Success";}@ExceptionHandler(NullPointerException.class)public ResponseEntity<String> handlerException(NullPointerException ex){return new ResponseEntity<>("Specific error for this controller:" + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);}
}

优点：可以自定义存储异常信息的key，和跳转视图的名称。

缺点：需要编写大量的异常方法，不能跨controller，如果两个controller中出现同样的异常，需要重新编写异常处理方法。

2、使用 @ControllerAdvice + @ExceptionHandler 注解处理全局异常

使用 @ControllerAdvice + @ExceptionHandler 注解能够处理全局异常，这种方式推荐使用，可以根据不同的异常对不同的异常进行处理。

使用方式：定义一个类，使用 @ControllerAdvice 注解该类，使用 @ExceptionHandler 注解方法，此处定义了一个 GlobalExceptionHandler 类表示来处理全局异常，代码如下：

package com.gcxy.demo11.exception;import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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.context.request.WebRequest;@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)@ResponseBodypublic ResponseEntity<String> handleGeneralException(Exception ex, WebRequest request) {// 这里可以记录日志，或者做其他处理return new ResponseEntity<>("A general error occurred: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);}@ExceptionHandler(NullPointerException.class)@ResponseBodypublic ResponseEntity<String> handleNullPointerException(NullPointerException ex, WebRequest request) {return new ResponseEntity<>("Null pointer exception occurred: " + ex.getMessage(), HttpStatus.BAD_REQUEST);}
}

// 你可以继续添加更多的 @ExceptionHandler 方法来处理其他类型的异常  

缺点：编写大量的异常处理方法，代码冗余。

3、配置 SimpleMappingExceptionResolver 处理异常

package com.gcxy.demo11.exception;import org.springframework.context.annotation.Bean;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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.context.request.WebRequest;
import org.springframework.web.servlet.handler.SimpleMappingExceptionResolver;import java.util.Properties;@ControllerAdvice
public class GlobalExceptionHandler {@Beanpublic SimpleMappingExceptionResolver getSimpleMappingExceptionResolver(){SimpleMappingExceptionResolver resolver = new SimpleMappingExceptionResolver();Properties properties = new Properties();properties.setProperty("java.lang.NullPointerException", "error");properties.setProperty("java.lang.RuntimeException", "error");// 设置异常与视图的映射信息resolver.setExceptionMappings(properties);return resolver;}
}

**注意：**该方法必须要有返回值。返回值类型必须是：SimpleMappingExceptionResolver

缺点:不显示具体异常信息 ，不能在跳转页面的同时携带异常信息，这样不利于排错 。

4、自定义 HandlerExceptionResolver 类处理异常

自定义异常的常见应用场景：

• 更好地表示业务逻辑错误：自定义异常可以根据具体业务需求来定义，并提供更有意义和准确描述的错误信息，以便于程序员和其他开发人员理解问题所在。
• 区分不同类型的错误：通过创建多个不同类型的自定义异常类，可以区分并捕获不同类型的错误。例如，如果某个系统需要处理多个网络连接相关的问题，就可以创建一个NetworkConnectionException和TimeoutException等不同类型的自定义异常。
• 提供更详细的上下文信息：自定义异常可以携带额外的上下文信息，使得异常处理过程更具可读性和可理解性。例如，在数据库操作过程中出现问题时，可以使用自定义异常来携带有关数据库表、字段或查询条件等相关信息。
• 异常处理策略：通过捕获对应的自定义异常，我们可以实施针对不同类型问题的特定处理策略。这有助于提高程序容错性和系统稳定性。
• API设计：当我们编写库或框架时，通过使用自定义异常来抛出合适的错误信息给客户端用户能够更好地使用API，并能快速诊断和解决问题。

在使用自定义异常时应遵循一些最佳实践：

• 选择有意义且与问题相关的名称来命名自定义异常类。
• 继承现有合适的Java标准库中已存在的基础异常类（如RuntimeException或Exception）。
• 提供必要且恰当描述错误情况或原因的构造函数、方法和属性。

通过合理使用自定义异常，我们能够更好地管理代码中可能发生的非正常情况，并提供清晰明确、易于调试和维护的代码结构。

4.1、创建自定义异常及全局异常处理器

1、创建异常接口，提供获取编码和描述方法

package com.gcxy.demo11.exception;public interface BaseErrorInfoInterface {/*** 错误码* @return*/String getResultCode();/*** 错误描述* @return*/String getResultMsg();
}

2、创建异常枚举类，实现异常服务接口类的方法，并且定义数据操作异常的类型

package com.gcxy.demo11.exception;public enum ExceptionEnum implements BaseErrorInfoInterface {// 数据操作异常定义SUCCESS("2000", "请求成功!"),BODY_NOT_MATCH("4000", "请求的数据格式不符!"),SIGNATURE_NOT_MATCH("4001", "请求的数字签名不匹配!"),DATA_EMPTY("4002","数据为空！"),DATA_NOT_ENOUGH("4003", "数据不足！"),NOT_FOUND("4004", "数据不存在或已删除!"),DATA_FOUND("4005", "数据已存在！"),CODE_NOT_MATCH("4006", "验证码错误!"),CODE_TIME_OUT("4007", "验证码已过期!"),PASSWORD_NOT_MATCH("4008", "密码不一致!"),INTERNAL_SERVER_ERROR("5000", "服务器内部错误!"),SERVER_BUSY("5003", "服务器正忙，请稍后再试!");/*** 错误码*/private final String resultCode;/*** 错误描述*/private final String resultMsg;ExceptionEnum(String resultCode, String resultMsg) {this.resultCode = resultCode;this.resultMsg = resultMsg;}@Overridepublic String getResultCode() {return resultCode;}@Overridepublic String getResultMsg() {return resultMsg;}
}

3、创建自定义异常，继承RuntimeException类

package com.gcxy.demo11.exception;
public class MyException extends RuntimeException {private static final long serialVersionUID = 1L;/*** 错误码*/protected String errorCode;/*** 错误信息*/protected String errorMsg;public MyException() {super();}public MyException(BaseErrorInfoInterface errorInfoInterface) {super(errorInfoInterface.getResultCode());this.errorCode = errorInfoInterface.getResultCode();this.errorMsg = errorInfoInterface.getResultMsg();}public MyException(BaseErrorInfoInterface errorInfoInterface, Throwable cause) {super(errorInfoInterface.getResultCode(), cause);this.errorCode = errorInfoInterface.getResultCode();this.errorMsg = errorInfoInterface.getResultMsg();}public MyException(String errorMsg) {super(errorMsg);this.errorMsg = errorMsg;}public MyException(String errorCode, String errorMsg) {super(errorCode);this.errorCode = errorCode;this.errorMsg = errorMsg;}public MyException(String errorCode, String errorMsg, Throwable cause) {super(errorCode, cause);this.errorCode = errorCode;this.errorMsg = errorMsg;}public String getErrorCode() {return errorCode;}public void setErrorCode(String errorCode) {this.errorCode = errorCode;}public String getErrorMsg() {return errorMsg;}public void setErrorMsg(String errorMsg) {this.errorMsg = errorMsg;}@Overridepublic Throwable fillInStackTrace() {return this;}}

4、创建返回响应实体类： 属于规范方法返回值结构体的类，也有利于一致化后端所有接口的返回结构，方便前端（客户端）读取所需要的数据；异常处理返回客户端的数据将采用该类的数据结构;

package com.gcxy.demo11.utils;import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResponseHelper<T> {private String code;private String msg;public T data;public static <T> ResponseHelper<T> success() {return new ResponseHelper<T>("200", "success", null);}public static <T> ResponseHelper<T> success(String msg) {return new ResponseHelper<T>("200", msg, null);}public static <T> ResponseHelper<T> success(String code, String msg) {return new ResponseHelper<T>(code, msg, null);}public static <T> ResponseHelper<T> success(T data) {return new ResponseHelper<T>("200", "success", data);}public static <T> ResponseHelper<T> success(String code, String msg, T data) {return new ResponseHelper<T>(code, msg, data);}public static <T> ResponseHelper<T> fail() {return new ResponseHelper<>("500", "Fail", null);}public static <T> ResponseHelper<T> fail(String code, String msg) {return new ResponseHelper<>(code, msg, null);}}

5、 创建全局异常处理控制类： 处理各类异常的业务（即根据不同的异常类型向客户端返回相应的信息）

package com.gcxy.demo11.exception;import com.gcxy.demo11.utils.ResponseHelper;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(value={Exception.class})public ResponseHelper exceptionHandler(Exception e){return ResponseHelper.fail(e.errorCode, e.getErrorMsg());}@ExceptionHandler(value = {MyException.class})public @ResponseBody ResponseHelper myExceptionHandler(MyException e) {return ResponseHelper.fail(e.errorCode, e.getErrorMsg());}}

6、创建测试接口

  @GetMapping("/test")public ResponseHelper test(){if (true){throw new MyException(ExceptionEnum.CODE_NOT_MATCH.getResultCode(),ExceptionEnum.CODE_NOT_MATCH.getResultMsg());}return ResponseHelper.success("Success");}