SpringBootグローバル例外処理+ Slf4jログファイルの構成

プログラミングが好きなあなたのように！
SpringBoot実用的なコースは学習https://edu.csdn.net/course/detail/31433
SpringCloud入門コースを学びhttps://edu.csdn.net/course/detail/31451を

---

概要概要

プロジェクト開発を行う場合、例外処理を行う必要がありますが、各メソッドがtry-catchを書き込むと、コードの冗長性と保守性の低下につながります。SpringBootは、この問題を解決するための非常に洗練されたグローバル例外処理メソッドを提供します。

グローバル例外処理

1）関連する依存関係

 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
 </dependency>
 <dependency>
     <groupId>org.projectlombok</groupId>
     <artifactId>lombok</artifactId>
     <optional>true</optional>
 </dependency>

2）Jsonデータパッケージングクラス

@Data
@AllArgsConstructor
@NoArgsConstructor
public class JsonResult {

    private Integer code;
    private String msg;
    private String url;
}

3）グローバル例外処理クラス

/**
 * 全局异常处理
 */
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHanlder {

    @ExceptionHandler(Exception.class)
    public ResponseEntity handleException(Exception ex, HttpServletRequest request){
        log.error("Exception ",ex);
        return ResponseEntity.ok(new JsonResult(500,ex.getMessage(),request.getRequestURL().toString()));
    }
}

コードの説明：

@Slf4j 是注入日志对象log
@RestControllerAdvice 注解将当前类作为全局异常处理类，Rest表示里面所有方法都直接返回JSON数据，
如果需要页面跳转可以使用@ControllerAdvice 
@ExceptionHandler配置异常处理方法，value是处理的异常类型，Exception.class就是处理所有异常了
处理方法中进行了日志输出，并将异常信息以JSON方法发送给客户端。

4）テスト

@RestController
@RequestMapping("/test")
public class TestController {

    @GetMapping("/{id}")
    public ResponseEntity findUser(@PathVariable("id") Long id){
        int n = 10 / 0;
        return ResponseEntity.ok("查询到用户" + id);
    }
}

カスタム例外処理

上記のケースは一般的な例外を扱っています。開発を行う場合、ビジネスニーズに応じて例外をカスタマイズする必要があります。カスタム例外の処理も一般的な例外の処理とは異なる必要があります。
1）カスタム例外を追加する

/**
 * 自定义业务异常
 */
@Data
@NoArgsConstructor
public class BizException extends RuntimeException {

    private Integer code;
    private String msg;

    public BizException(Integer code,String msg) {
        super(msg);
        this.code = code;
        this.msg = msg;
    }
}

2）グローバル例外処理クラスに新しいメソッドを追加します

@ExceptionHandler(BizException.class)
public ResponseEntity handleBizException(BizException ex, HttpServletRequest request){
    log.error("BizException ",ex);
    return ResponseEntity.ok(new JsonResult(ex.getCode(),ex.getMessage(),request.getRequestURL().toString()));
}

3）テスト

@RestController
@RequestMapping("/test")
public class TestController {

    @GetMapping("/{id}")
    public ResponseEntity findUser(@PathVariable("id") Long id){
//        int n = 10 / 0;
        if(id > 100){
            throw new BizException(404,"没有此用户");
        }
        return ResponseEntity.ok("查询到用户" + id);
    }
}

ログファイルの構成

SpringBootは、デフォルトでslf4j + logbackを使用してログ処理を完了します。
@ Slf4jアノテーションは、ログオブジェクトをそれが属するクラスに挿入でき、低レベルから高レベルまでのさまざまなレベルのログを出力できます。trace
<debug <info <warn <error。
デフォルトでは、ログはコンソールにのみ出力できます。

プロジェクトがオンラインになった後。ログファイルが必ず必要です。実行中のプロセスを記録するには、ログを構成する必要があります。
リソースの下にlogback-spring.xml構成ファイルを追加するだけです。内容は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<!--每隔10秒，扫描当前配置-->
<configuration  scan="true" scanPeriod="10 seconds">
    <contextName>logback</contextName>
    <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
    <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
    <!-- 定义日志存储的路径，不要配置相对路径 -->
    <property name="FILE_PATH" value="C:/oa-log/spring-log.%d{yyyy-MM-dd}.%i.log" />
    <!-- 控制台输出日志 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 日志级别过滤INFO以下 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
        <encoder>
            <!-- 按照上面配置的LOG_PATTERN来打印日志 -->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!--每天生成一个日志文件，保存30天的日志文件。rollingFile用来切分文件的 -->
    <appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${FILE_PATH}</fileNamePattern>
            <!-- 保留30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 最大大小 -->
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 超出删除文件 -->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 配置日志默认级别 -->
    <logger name="com.xray.oa.exception" level="ERROR" />
    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="console" />
        <appender-ref ref="rollingFile" />
    </root>
</configuration>

終わり

私はたくさん書くつもりです、私があなたを助けることができれば、私はとても幸せになります:)

---

他のJavaの知識を学ぶ必要がある場合は、ここでJavaの概要に関する非常に詳細な知識を調べてください。