[springbootフレームワークの機能強化]ネットワーク全体で最新のエレガントなカスタム例外をキャプチャ

I.はじめに

日常のプロジェクト開発では、例外が一般的ですが、バグをすばやく特定できるように例外情報をより効率的に処理する方法は非常に重要です。開発効率を向上させるだけでなく、コードの見栄えを良くすることもできます。SpringBootプロジェクトはすでにいくつかの例外を処理していますが、開発者には適していない可能性があるため、これらの例外を均一にキャプチャして処理する必要があります。

例外処理を行わない場合、エラーが発生すると、返される情報は次のようになります。

2.異常分類

1.定義の観点からの異常分類

（1）。エラー

実行中にプログラムが遭遇したハードウェアまたはオペレーティングシステムのエラー。エラーはプログラムにとって致命的であり、プログラムの実行を妨げます。よくある間違いには、メモリオーバーフロー、jvm仮想マシン自体の異常な動作、およびcalssファイルにメインメソッドがないことが含まれます。プログラム自体はエラーを処理できず、外部の介入にのみ依存できます。エラーはシステムの内部エラーであり、jvmによってスローされ、処理のためにシステムに渡されます。

（2）例外。

プログラムの通常の動作で予想される予期しない状況です。たとえば、データベース接続が中断され、nullポインターがあり、配列の添え字が範囲外です。例外は、プログラムの異常終了につながる可能性があります。または、プログラムを実行し続けることができるように、事前に検出してキャッチして処理することができます。EXCEPTION（例外）は、その性質に応じて、コンパイル例外（検出可能）と実行時例外（検出不能）に分けられます。

a。コンパイル時の例外

チェック可能な例外とも呼ばれる例外は、通常、構文エラーと環境要因（外部リソース）によって発生します。入出力例外IOException、データベース操作SQLExceptionなど。その特徴は、Java言語では、実行時以外のすべての例外をキャッチして処理することを義務付けていることです。行動規範を通じてプログラムの堅牢性とセキュリティを強化します。

b。ランタイム例外

未チェックの例外RuntimeExceptionとも呼ばれるこれらの例外は、通常、プログラムロジックエラー、つまりセマンティックエラーによって発生します。たとえば、算術例外、nullポインタ例外NullPointerException、範囲外の添え字IndexOutOfBoundsException。ランタイム例外は、キャッチされるのではなく、プログラムのテスト中に公開され、プログラマーによってデバッグされる必要があります。

2.開発の観点から例外を分類します

我们也可以把异常分类已知异常和未知异常。

(1). 已知异常

代表我们可以控制的异常，比如当一个资源没找到的时候，要返回给前端，抛出资源没有找到。 当校验参数的时候，参数缺失，抛出参数缺失给前端。

(2). 未知异常

代表我们也不知道什么时候程序可能会报错，可能某个地方判断不严谨，导致空指针或下标越界等。

三、如何优雅的进行异常捕获（重点是已知异常的处理）

我们知道，使用springboot的时候，我们可以使用@ControllerAdvice和@ExceptionHandler对异常进行全局异常捕获，但如何做，才能使异常捕获更加的优雅呢？

我们可以从已知异常和未知异常进行自定义的异常处理。

1. 未知异常的处理

1. 新建一个GlobalExceptionAdvice全局异常处理的类，加上@ControllerAdvice注解
2. 捕获Exception.class

    @ExceptionHandler(Exception.class)
    @ResponseBody
    @ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR)
    public ReturnMsgEntity handlerException(HttpServletRequest request, Exception e) {
        String uri = request.getRequestURI();
        String method = request.getMethod();
        ReturnMsgEntity message = new ReturnMsgEntity(9999, codeConfiguration.getMessage(9999), null, method + "  " + uri);
        return message;
    }
复制代码

解释: 为了防止硬编码，写了一个codeConfiguration配置类，作用是读取某个路径下的文件，封装成一个map

@Component
@ConfigurationProperties(prefix="aisino")
@PropertySource("classpath:config/exception-code.properties")
public class ExceptionCodeConfiguration {
    private Map<Integer,String> codes = new HashMap<>();

    public  String getMessage(int code){
        return codes.get(code);
    }

    public Map<Integer, String> getCodes() {
        return codes;
    }

    public void setCodes(Map<Integer, String> codes) {
        this.codes = codes;
    }
}
复制代码

exception-code.properties配置文件如下:

aisino.codes[9999] = 服务器未知异常

aisino.codes[10000] = 通用异常

aisino.codes[10001] = 通用参数错误

aisino.codes[0] = ok

aisino.codes[10002] = 资源未找到

复制代码

3. 以上对于未知异常的处理就完事了，看看效果，模拟一个空指针异常的接口，访问结果如下

2. 已知异常的处理（重点）

已知异常有很多种，比如禁止访问，参数缺失，没有找到资源，没有认证，难道我们要把每个错误都写在GlobalExceptionAdvice类中吗？这样写是不是不容易维护，比如当资源不存在该如何抛出呢？

上記の問題に対応して、GlobalExceptionAdviceで自己定義のHttpExceptionをキャプチャできます。他のエラークラスはHttpExceptionであり、HttpExceptionはRuntimeExceptionクラスを継承するため、独自に定義したエラーのスローを実装できます。特定のHttpExceptionクラスは次のとおりです。次のとおりです。

public class HttpException extends RuntimeException{
    //自定义错误码
    protected Integer code;
    // 默认的状态码
    protected Integer httpStatusCode = 500;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public Integer getHttpStatusCode() {
        return httpStatusCode;
    }

    public void setHttpStatusCode(Integer httpStatusCode) {
        this.httpStatusCode = httpStatusCode;
    }
}

复制代码

また、上記のクラスを継承する他の特定のサブクラスを定義する必要があります。たとえばNotFoundException、次のコードです。

public class NotFoundException extends HttpException {
    public NotFoundException(int code){
        this.httpStatusCode = 404;
        this.code = code;
    }
}
复制代码

クラスは、次のようにコードGlobalExceptionAdviceに取り込むことができます。HttpException

  @ExceptionHandler(HttpException.class)
    @ResponseBody
    public ResponseEntity<ReturnMsgEntity> handlerHttpException(HttpServletRequest request, HttpException e) {
        // 获得请求路径
        String requestUrl = request.getRequestURI();
        // 获得请求方法
        String method = request.getMethod();
        // e.getcode 根据我们自定义的状态码获取具体的错误信息
        ReturnMsgEntity message = new ReturnMsgEntity(e.getCode(), codeConfiguration.getMessage(e.getCode()), null, method + "  " + requestUrl);
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        // 设置我们自定义的http状态码，比如404对应资源没找到，前端收到的状态码不是200，是404了
        HttpStatus httpStatus = HttpStatus.resolve(e.getHttpStatusCode());
        ResponseEntity<ReturnMsgEntity> responseEntity = new ResponseEntity<>(message, headers, httpStatus);
        return responseEntity;

    }
复制代码

最後に、たとえば次のように使用します。

ユーザー情報が見つからない場合、返される情報は次のとおりです。

このことから、ステータスコードは自分で定義した404であり、返されたコードは渡したものであることがわかります。

---

この記事の最後に、次の記事で統一された例外処理のパラメータ検証を紹介します。お読みいただきありがとうございます。