异常处理解决方案

在service方法中有很多的参数合法性校验，当参数不合法则抛出异常：

http://localhost:63040/content/course

HTTP/1.1 500 
Content-Type: application/json
Transfer-Encoding: chunked
Date: Wed, 07 Sep 2022 11:40:29 GMT
Connection: close

{
    
    
  "timestamp": "2022-09-07T11:40:29.677+00:00",
  "status": 500,
  "error": "Internal Server Error",
  "message": "",
  "path": "/content/course"
}

问题：并没有输出我们抛出异常时指定的异常信息。
所以，现在我们的需求是当正常操作时按接口要求返回数据，当非正常流程时要获取异常信息进行记录，并提示给用户。
异常处理除了输出在日志中，还需要提示给用户，前端和后端需要作一些约定：
1、错误提示信息统一以json格式返回给前端。
2、以HTTP状态码决定当前是否出错，非200为操作异常。
如何规范异常信息？
代码中统一抛出项目的自定义异常类型，这样可以统一去捕获这一类或几类的异常。
规范了异常类型就可以去获取异常信息。
如果捕获了非项目自定义的异常类型统一向用户提示“执行过程异常，请重试”的错误信息。
如何捕获异常？
代码统一用try/catch方式去捕获代码比较臃肿，可以通过SpringMVC提供的控制器增强类统一由一个类去完成异常的捕获。
如下图：
在这里插入图片描述

统一异常处理实现

根据上边分析的方案，统一在base基础工程实现统一异常处理，各模块依赖了base基础工程都可以使用。
首先在base基础工程添加需要依赖的包：


```java
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

1、定义一些通用的异常信息

/**
 * @description 通用错误信息
 * @author Mr.M
 * @date 2022/9/6 11:29
 * @version 1.0
 */
public enum CommonError {
    
    

   UNKOWN_ERROR("执行过程异常，请重试。"),
   PARAMS_ERROR("非法参数"),
   OBJECT_NULL("对象为空"),
   QUERY_NULL("查询结果为空"),
   REQUEST_NULL("请求参数为空");

   private String errMessage;

   public String getErrMessage() {
    
    
      return errMessage;
   }

   private CommonError( String errMessage) {
    
    
      this.errMessage = errMessage;
   }

}

2、自定义异常类型

/**
 * @description 项目异常类
 * @author Mr.M
 * @date 2022/9/6 11:29
 * @version 1.0
 */
public class XueChengPlusException extends RuntimeException {
    
    

   private String errMessage;

   public XueChengPlusException() {
    
    
      super();
   }

   public XueChengPlusException(String errMessage) {
    
    
      super(errMessage);
      this.errMessage = errMessage;
   }

   public String getErrMessage() {
    
    
      return errMessage;
   }

   public static void cast(CommonError commonError){
    
    
       throw new XueChengPlusException(commonError.getErrMessage());
   }
   public static void cast(String errMessage){
    
    
       throw new XueChengPlusException(errMessage);
   }

}

响应用户的统一类型

import java.io.Serializable;

/**
 * 错误响应参数包装
 */
public class RestErrorResponse implements Serializable {
    
    

    private String errMessage;

    public RestErrorResponse(String errMessage){
    
    
        this.errMessage= errMessage;
    }

    public String getErrMessage() {
    
    
        return errMessage;
    }

    public void setErrMessage(String errMessage) {
    
    
        this.errMessage = errMessage;
    }
}

全局异常处理器

•@ExceptionHandler
•Spring3.0提供的标识在方法上或类上的注解，用来表明方法的处理异常类型。
•@ControllerAdvice
•Spring3.2提供的新注解，从名字上可以看出大体意思是控制器增强，        在项目中来增强SpringMVC中的Controller。通常和@ExceptionHandler 结合使用，来处理SpringMVC的异常信息。
•@ResponseStatus
•Spring3.0提供的标识在方法上或类上的注解，用状态代码和应返回的原因标记方法或异常类。
调用处理程序方法时，状态代码将应用于HTTP响应。
通过上面的两个注解便可实现微服务端全局异常处理，具体代码如下：

```java
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
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.bind.annotation.ResponseStatus;

/**
 * @description 全局异常处理器
 * @author Mr.M
 * @date 2022/9/6 11:29
 * @version 1.0
 */
@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {

   @ResponseBody
   @ExceptionHandler(XueChengPlusException.class)
   @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
   public RestErrorResponse customException(XueChengPlusException e) {
      log.error("【系统异常】{}",e.getErrMessage(),e);
      return new RestErrorResponse(e.getErrMessage());

   }

   @ResponseBody
   @ExceptionHandler(Exception.class)
   @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
   public RestErrorResponse exception(Exception e) {

      log.error("【系统异常】{}",e.getMessage(),e);

      return new RestErrorResponse(CommonError.UNKOWN_ERROR.getErrMessage());

   }
}

异常处理测试

在内容管理的api工程添加base工程的依赖

     <dependency>
            <groupId>com.xuecheng</groupId>
            <artifactId>xuecheng-plus-base</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

在异常处理测试之前首先在代码中抛出自定义类型的异常，这里以新增课程的service方法为例进行代码修改。

@Override
 public CourseBaseInfoDto createCourseBase(Long companyId,AddCourseDto dto) {
    
    
 ...
//合法性校验
  if (StringUtils.isBlank(dto.getName())) {
    
    
   throw new XueChengPlusException("课程名称为空");
  }

  if (StringUtils.isBlank(dto.getMt())) {
    
    
   throw new XueChengPlusException("课程分类为空");
  }

  if (StringUtils.isBlank(dto.getSt())) {
    
    
   throw new XueChengPlusException("课程分类为空");
  }

  if (StringUtils.isBlank(dto.getGrade())) {
    
    
   throw new XueChengPlusException("课程等级为空");
  }

  if (StringUtils.isBlank(dto.getTeachmode())) {
    
    
   throw new XueChengPlusException("教育模式为空");
  }

  if (StringUtils.isBlank(dto.getUsers())) {
    
    
   throw new XueChengPlusException("适应人群");
  }

  if (StringUtils.isBlank(dto.getCharge())) {
    
    
   throw new XueChengPlusException("收费规则为空");
  }
  。。。
    if ("201001".equals(charge)) {
    
    
   BigDecimal price = dto.getPrice();
   if (ObjectUtils.isEmpty(price)) {
    
    
    throw new XueChengPlusException("收费课程价格不能为空");
   }
   courseMarketNew.setPrice(dto.getPrice().floatValue());
  }
  。。。

1、首先使用httpclient测试

请求新增课程接口，故意将必填项课程名称设置为空。
测试结果与预期一致，可以捕获异常并响应异常信息，如下：

http://localhost:63040/content/course

HTTP/1.1 500 
Content-Type: application/json
Transfer-Encoding: chunked
Date: Wed, 07 Sep 2022 13:17:14 GMT
Connection: close

{
    
    
  "errMessage": "课程名称为空。"
}

2、前后端调试
仍然测试新增课程接口，当课程收费的时候必须填写价格，这里设置课程为收费，价格设置为空。
在这里插入图片描述
通过测试发现，前端正常提示代码中抛出的异常信息。