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 形式で返すか、対応する JSON 形式を返す@ControllerAdviceメソッドを追加する@ResponseBodyことで、コントローラーでの戻り値は同じになります。

これは一時的に解決されましたが、前回の記事で問題が残ったままになっています。

考え

実は、このように書いてもまだ完璧ではなく、エラーの種類も多く、パラメータのエラーも多く、パラメータの検証もまだフレームワークレベルに達していません。

たとえば、これは 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."}
}

どうすればさらに改善できるか、

次の記事でも引き続き共有していきますので、ご意見を残してください

独自の開発足場テンプレートのセットを一から作成する準備をし、公開プログラマーに 3 時間注意を払う

おすすめ

転載: blog.csdn.net/u011738045/article/details/130475379