Global exception handlers and unified return results

1、 Unified return result class

/** * @author * @ClassName: Result * @Description:  Unified return result class   Guaranteed serialization json When , If it is null The object of ,key Will disappear  * @date 2021/9/18 15:32 */
@Data
public class Result<T> implements Serializable {
    

    private Boolean success;
    private Integer code;
    private String message;
    private T data;

    public Result() {
    
    }

    private Result(Boolean success, Integer code) {
    
        this.success = success;
        this.code = code;
    }

    private Result(Boolean success, Integer code, T data) {
    
        this.success = success;
        this.code = code;
        this.data = data;
    }

    private Result(Boolean success, Integer code, String message, T data) {
    
        this.success = success;
        this.code = code;
        this.message = message;
        this.data = data;
    }

    private Result(Boolean success, Integer code, String message) {
    
        this.success = success;
        this.code = code;
        this.message = message;
    }

    public static <T> Result<T> success() {
    
        return new Result<T>(true, ResponseEnum.SUCCESS.getCode(),ResponseEnum.SUCCESS.getMessage());
    }

    public static <T> Result<T> successMessage(String message) {
    
        return new Result<T>(true, ResponseEnum.SUCCESS.getCode(), message);
    }

    public static <T> Result<T> success(T data) {
    
        return new Result<T>(true, ResponseEnum.SUCCESS.getCode(),ResponseEnum.SUCCESS.getMessage(),data);
    }

    public static <T> Result<T> success(String message, T data) {
    
        return new Result<T>(true, ResponseEnum.SUCCESS.getCode(), message, data);
    }

    public static <T> Result<T> error() {
    
        return new Result<T>(false, ResponseEnum.ERROR.getCode(), ResponseEnum.ERROR.getMessage());
    }

    public static <T> Result<T> errorMessage(String errorMessage) {
    
        return new Result<T>(false, ResponseEnum.ERROR.getCode(), errorMessage);
    }

    public static <T> Result<T> errorCodeMessage(Integer errorCode, String errorMessage) {
    
        return new Result<T>(false, errorCode, errorMessage);
    }
}

2、 Error code enumeration class

/** * @author * @ClassName: ResponseEnum * @Description:  Response status code and enumeration type of prompt message  * @date 2021/9/17 15:07 */
@Getter
public enum  ResponseEnum {
    

    SUCCESS(200," Successful operation "),

    ERROR(500," operation failed "),

    INVALID_PARAM_ERROR(400," Invalid request parameter "),
    ;

    private Integer code;
    private String message;

    ResponseEnum(Integer code, String message) {
    
        this.code = code;
        this.message = message;
    }
}

3、 Custom exception handling class

/** * @author * @ClassName: CustomException * @Description:  Custom exception  * @date 2021/9/18 15:43 */
@Data
public class CustomException extends RuntimeException {
    

    private Integer code;

    public CustomException(ResponseEnum responseEnum) {
    
        super(responseEnum.getMessage());
        this.code = responseEnum.getCode();
    }

    public CustomException(ResponseEnum responseEnum, Throwable throwable) {
    
        super(responseEnum.getMessage(), throwable);
        this.code = responseEnum.getCode();
    }
}

4、 Global exception handling class

/** * @author * @ClassName: GlobalUniformException * @Description:  Globally unified exception handling class  * @date 2021/9/18 15:48 */
@RestControllerAdvice
@Slf4j
public class GlobalUniformException {
    

    /** *  Handle custom exceptions --------> Specify the exception type to be handled by the so and so method  * @param e * @return */
    @ExceptionHandler(CustomException.class)
    public Result personalException(CustomException e){
    
        e.printStackTrace();
        return Result.errorCodeMessage(e.getCode(),e.getMessage());
    }

    /** *  Handle exceptions other than custom exceptions  * @param e * @return */
    @ExceptionHandler(Exception.class)
    public Result handlerOtherException(Exception e){
    
        e.printStackTrace();
        return Result.errorCodeMessage(ResponseEnum.ERROR.getCode(),ResponseEnum.ERROR.getMessage());
    }
}

5、 The test returns a uniform result

/** * @ * @ClassName: HelloController * @Description:  test result  * @date 2021/9/18 15:48 */
@RestController
@RequestMapping("/say")
public class HelloController {
    

    @PostMapping("/hello")
    public Result sayHello(User user){
    
    
		if (StringUtils.isEmpty(user.getName())) {
    
            return Result.errorMessage(ResponseEnum.ERROR.getMessage());
        }
        user.setName(" Xiao Ming ");
        user.setAge(20);
        
        return Result.success(user);
    }
}

Browser test results ：

postman Browser test results ：

6. The test throws an exception ：

@RestController
@PostMapping("/say")
public class HelloController {
    

    @RequestMapping("/hello")
    public Result sayHello(User user){
    

		User user = new User();
        if (user.getName() == null) {
    
            throw new CustomException(ResponseEnum.INVALID_PARAM_ERROR);
        }
        user.setName(" Xiao Ming ");
        user.setAge(20);
        return Result.success(user);
    }
}

postman Test failure results ：

Browser test failure results ：