1. pom引入

  1. <dependency>
  2.             <groupId>org.springframework.boot</groupId>
  3.             <artifactId>spring-boot-starter-validation</artifactId>
  4.         </dependency>
  5.         <dependency>
  6.             <groupId>org.springframework.boot</groupId>
  7.             <artifactId>spring-boot-starter-web</artifactId>
  8.         </dependency>
  10.         <dependency>
  11.             <groupId>org.projectlombok</groupId>
  12.             <artifactId>lombok</artifactId>
  13.             <optional>true</optional>
  14.         </dependency>

image.png

2. 异常处理

  1. 全局异常拦截处理 ```java package com.afei.unified.handler;

import com.afei.unified.common.ResultVO; import com.afei.unified.common.enums.ResultCodeEnum; import lombok.extern.slf4j.Slf4j; import org.springframework.http.HttpStatus; import org.springframework.validation.ObjectError; import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.ArrayList; import java.util.List;

/**

  • @author shihengfei
  • @date 2020/8/7 15:39

  • @description: 全局异常处理类 */ @RestControllerAdvice @Slf4j public class GlobalExceptionHandler {

    /**

    • 自定义异常CustomException */ @ExceptionHandler(CustomException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public ResultVO CustomExceptionHandler(CustomException e) { log.error(“api异常”); return new ResultVO<>(ResultCodeEnum.FAILED, e.getMsg()); }

      /**

    • 方法参数错误异常
    • @param e

    • @return */ @ExceptionHandler(MethodArgumentNotValidException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public ResultVO MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) { log.error(“方法参数错误异常”); List list=new ArrayList<>(); // 从异常对象中拿到ObjectError对象 if (!e.getBindingResult().getAllErrors().isEmpty()){

      1.  for(ObjectError error:e.getBindingResult().getAllErrors()){
      2.      list.add(error.getDefaultMessage().toString());
      3.  }

      } // 提取错误提示信息进行返回 return new ResultVO<>(ResultCodeEnum.VALIDATE_FAILED, list); }

      /**

    • 全局未知异常
    • @param e
    • @return */ @ExceptionHandler(Exception.class) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) public ResultVO ExceptionHandler(Exception e) { log.error(“未知异常”); // 返回未知异常 return new ResultVO<>(ResultCodeEnum.ERROR); } } b. 自定义异常java package com.afei.unified.handler;

      import com.afei.unified.common.enums.ResultCodeEnum; import lombok.Getter;

      /**

      • 自定义异常处理

      • @author shihengfei */ @Getter public class CustomException extends RuntimeException { private int code; private String msg;

        public CustomException() {

        1.  this(ResultCodeEnum.FAILED);

        }

        public CustomException(ResultCodeEnum failed) {

        1.  this.code=failed.getCode();
        2.  this.msg=failed.getMsg();

        } } ```

        3. 统一响应

        a. 响应体 ```java package com.afei.unified.common;

      import com.afei.unified.common.enums.ResultCodeEnum; import lombok.Getter; import lombok.Setter;

      /**

      • @author shihengfei

      • @description: 自定义统一响应体 / @Getter @Setter public class ResultVO { /*

        • 状态码，比如1000代表响应成功 / private int code; /*
        • 响应信息，用来说明响应情况 / private String msg; /*

        • 响应的具体数据 */ private T data;

          public ResultVO(T data) { this(ResultCodeEnum.SUCCESS, data); }

          public ResultVO(ResultCodeEnum resultCode, T data) { this.code = resultCode.getCode(); this.msg = resultCode.getMsg(); this.data = data; } } b. 响应枚举java package com.afei.unified.common.enums;

      import lombok.Getter;

      /**

      • 响应码枚举

      • @author shihengfei */ @Getter public enum ResultCodeEnum {

        1.  /** 1*** 通用错误 */
        2.  SUCCESS(1000, "操作成功"),
        3.  FAILED(1001, "接口错误"),
        4.  VALIDATE_FAILED(1002, "参数校验失败"),
        5.  ERROR(1003, "未知错误"),
        7.  /** 2*** 用户错误 */
        8.  USER_NOT_EXIST(2000,"用户不存在"),
        9.  USER_LOGIN_FAIL(2001,"用户名或密码错误"),
        10.  USER_NOT_LOGIN(2002,"用户还未登录,请先登录"),
        11.  NO_PERMISSION(2003,"权限不足,请联系管理员");
        13.  private int code;
        14.  private String msg;

        ResultCodeEnum(int code, String msg) {

        1.      this.code = code;
        2.      this.msg = msg;
        3.  }

        }

      1. c. 全局响应拦截包装
      2. ```java
      3. package com.afei.unified.handler;
      5. import com.afei.unified.common.ResultVO;
      6. import com.fasterxml.jackson.core.JsonProcessingException;
      7. import com.fasterxml.jackson.databind.ObjectMapper;
      8. import org.springframework.core.MethodParameter;
      9. import org.springframework.http.MediaType;
      10. import org.springframework.http.converter.HttpMessageConverter;
      11. import org.springframework.http.server.ServerHttpRequest;
      12. import org.springframework.http.server.ServerHttpResponse;
      13. import org.springframework.web.bind.annotation.RestControllerAdvice;
      14. import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
      16. /**
      17.  * @author shihengfei
      18.  * @description: 全局处理增强版Controller，避免Controller里返回数据每次都要用响应体来包装
      19.  */
      20. @RestControllerAdvice(basePackages = {"com.afei.unified.controller"})
      21. public class ResponseControllerAdvice implements ResponseBodyAdvice<Object> {
      24.     @Override
      25.     public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> aClass) {
      26.         // 如果接口返回的类型本身就是ResultVO那就没有必要进行额外的操作，返回false
      27.         return !returnType.getGenericParameterType().equals(ResultVO.class);
      28.     }
      31.     @Override
      32.     public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
      33.         // String类型不能直接包装，所以要进行些特别的处理
      34.         if (returnType.getGenericParameterType().equals(String.class)) {
      35.             ObjectMapper objectMapper = new ObjectMapper();
      36.             try {
      37.                 // 将数据包装在ResultVO里后，再转换为json字符串响应给前端
      38.                 return objectMapper.writeValueAsString(new ResultVO<>(data));
      39.             } catch (JsonProcessingException e) {
      40.                 throw new CustomException();
      41.             }
      42.         }
      43.         // 将原本的数据包装在ResultVO里
      44.         return new ResultVO<>(data);
      45.     }
      46. }

      4. 参数校验

      1. package com.afei.unified.model;
      3. import lombok.Builder;
      4. import lombok.Data;
      5. import lombok.NoArgsConstructor;
      6. import lombok.ToString;
      8. import javax.validation.constraints.Email;
      9. import javax.validation.constraints.NotNull;
      10. import javax.validation.constraints.Size;
      12. /**
      13.  * @author shihengfei
      14.  * @description: 用户
      15.  */
      16. @Data
      17. @ToString
      18. @NoArgsConstructor
      19. public class User {
      21.     @NotNull(message = "用户id不能为空")
      22.     private Long id;
      24.     @NotNull(message = "用户账号不能为空")
      25.     @Size(min = 11, max = 20, message = "账号长度必须是11-20个字符")
      26.     private String account;
      28.     @NotNull(message = "用户密码不能为空")
      29.     @Size(min = 8, max = 16, message = "密码长度必须是8-16个字符")
      30.     private String password;
      32.     @NotNull(message = "用户邮箱不能为空")
      33.     @Email(message = "邮箱格式不正确")
      34.     private String email;
      35. }

      5. 测试controller

      1. package com.afei.unified.controller;
      3. import com.afei.unified.common.enums.ResultCodeEnum;
      4. import com.afei.unified.handler.CustomException;
      5. import com.afei.unified.model.User;
      6. import org.springframework.web.bind.annotation.GetMapping;
      7. import org.springframework.web.bind.annotation.PostMapping;
      8. import org.springframework.web.bind.annotation.RequestBody;
      9. import org.springframework.web.bind.annotation.RestController;
      11. import javax.validation.Valid;
      13. /**
      14.  * @author shihengfei
      15.  * @description: 测试controller
      16.  */
      17. @RestController
      18. public class DemoController {
      20.     @GetMapping("/getUser")
      21.     public User getUser() {
      22.         try {
      23. //            int i = 1/0;
      24.             User user = new User();
      25.             user.setId(1L);
      26.             user.setAccount("12345678");
      27.             user.setPassword("12345678");
      28.             user.setEmail("12345678@qq.com");
      29.             return user;
      30.         }catch (Exception e){
      31.             e.printStackTrace();
      32.             throw new CustomException(ResultCodeEnum.FAILED);
      33.         }
      34.     }
      36.     @PostMapping("/addUser")
      37.     public void addUser(@Valid @RequestBody User user){
      38.     }
      39. }

      6. 单元测试

      1. package com.afei.unified.controller;
      3. import com.afei.unified.model.User;
      4. import org.junit.jupiter.api.Test;
      5. import org.springframework.beans.factory.annotation.Autowired;
      6. import org.springframework.boot.test.context.SpringBootTest;
      8. @SpringBootTest
      9. public class DemoControllerTest {
      11.     @Autowired
      12.     private DemoController demoController;
      14.     @Test
      15.     public void getUser(){
      16.         User user = demoController.getUser();
      17.         System.out.println(user);
      18.     }
      20.     @Test
      21.     public void addUser(){
      22.         User user = new User();
      23.         user.setId(2L);
      24.         user.setAccount("1111111");
      25.         user.setPassword("545425");
      26.         user.setEmail("4456454@qq.com");
      27.         demoController.addUser(user);
      28.     }
      29. }