SpringBoot определяет элегантную глобальную унифицированную структуру ответов Restful API 2.

Здесь решать проблемы, оставленные ранее, когда программа не возвращается нормально

Это результат работы программы из-за исключений во время выполнения.Мы можем или не можем предсказать некоторые исключения заранее и не можем перейти к нашему возвращаемому объекту R для нормального возврата. Как справиться с этим временем

В SpringBoot @ControllerAdviceаннотации можно использовать для включения глобальной обработки исключений. С помощью аннотации @ControllerAdvice можно перехватывать все исключения в приложении для достижения унифицированной обработки исключений. Если вы хотите настроить метод обработки исключений, вы можете использовать @ExceptionHandlerаннотации и указать тип исключения, которое нужно перехватить. Таким образом, указанное исключение может быть обработано единообразно. Таким образом, глобальная обработка исключений может быть достигнута с помощью комбинации аннотаций @ControllerAdvice и @ExceptionHandler.

пример кода

package cn.soboys.springbootrestfulapi.common.exception;


import cn.soboys.springbootrestfulapi.common.resp.R;
import cn.soboys.springbootrestfulapi.common.resp.ResultCodeEnum;
import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.stream.Collectors;


/**
 * @author 公众号 程序员三时
 * @version 1.0
 * @date 2023/4/29 00:21
 * @webSite https://github.com/coder-amiao
 * 统一异常处理器
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 通用异常处理方法
     **/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.INTERNAL_SERVER_ERROR);
    }

    /**
     * 指定异常处理方法
     **/
    @ExceptionHandler(NullPointerException.class)
    @ResponseBody
    public R error(NullPointerException e) {
        e.printStackTrace();
        return R.setResult(ResultCodeEnum.NULL_POINT);
    }


    /**
     * 处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常
     */
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public R BindExceptionHandler(BindException e) {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        return R.failure().code(ResultCodeEnum.PARAM_ERROR.getCode()).message(message);
    }

    /**
     * 处理Get请求中  使用@Validated 验证路径中 单个参数请求失败抛出异常
     * @param e
     * @return
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public R ConstraintViolationExceptionHandler(ConstraintViolationException e) {
        String message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());
        return R.failure().code(ResultCodeEnum.PARAM_ERROR.getCode()).message(message);
    }



    /**
     * 自定义异常处理方法
     *
     * @param e
     * @return
     */
    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    public R error(BusinessException e) {
        e.printStackTrace();
        return R.failure().message(e.getMessage()).code(e.getCode());
    }

}

Обработка исключений может уменьшить повторение кода и его сложность, облегчить обслуживание кода и быстро найти ошибки, что значительно повышает эффективность нашей разработки.

Возвращая @ControllerAdviceсоответствующую страницу просмотра ошибок, @RestControllerAdviceвозвращайте API ошибок в формате json или добавляйте @ControllerAdviceметод для @ResponseBodyвозврата соответствующего формата json, аналогия, возврат в контроллере такой же

Это временно решено, мы оставили проблему в прошлой статье

думать

На самом деле, писать таким образом еще не идеально, мы знаем, что есть много типов ошибок, а также много ошибок параметров, проверка параметров еще не достигла уровня фреймворка.

Например, это ошибка Alibaba Cloud ECS.

{
	"RequestId": "5E571499-13C5-55E3-9EA6-DEFA0DBC85E4",
	"HostId": "ecs-cn-hangzhou.aliyuncs.com",
	"Code": "InvalidOperation.NotSupportedEndpoint",
	"Message": "The specified endpoint can't operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.",
	"Recommend": "https://next.api.aliyun.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs"
}

Это Сина API

{
	"request": "/statuses/home_timeline.json",
	"error_code": "20502",
	"error": "Need you follow uid."
}

или так

{
  "result": false,
  "error": {"code": 102, "message": "Validation failed: Wrong NAME."}
}

Как мы можем еще улучшить,

В следующей статье продолжу делиться, оставляйте свои мысли

Приготовьтесь сделать с нуля набор собственных шаблонов скаффолдинга и уделите внимание общедоступным программистам в течение трех часов.

рекомендация

отblog.csdn.net/u011738045/article/details/130475379