如何处理Spring Boot应用中的异常和错误-java教程-PHP中文网

如何处理Spring Boot应用中的异常和错误

WBOY

发布： 2023-06-23 08:38:29

原创

1748 人浏览过

在开发 Spring Boot 应用程序时，难免会遇到各种异常和错误，如数据库连接异常、代码逻辑错误、用户权限异常、网络连接断开等等。这些异常和错误对于应用程序的稳定性和可靠性都有很大的影响，因此我们需要及时的对这些异常进行处理，以保证应用程序能够持续运行。

本文将介绍如何处理 Spring Boot 应用程序中的异常和错误，包括异常的捕获、错误的调试和解决、异常的日志记录等方面。以下是具体内容：

异常的捕获和处理

try-catch 语句

在代码中加入 try-catch 语句用来捕获程序运行中的异常。当程序发生异常时，会进入到 catch 语句块中，可以在该块中添加逻辑来处理异常，例如将异常信息打印到日志中，或返回给前端用户等。

示例代码：

try {
    // 可能发生异常的代码块
} catch (Exception e) {
    // 异常处理逻辑
}

登录后复制

@ControllerAdvice 注解

@ControllerAdvice 是 Spring 框架提供的一个注解，用来全局处理 Spring MVC 中的异常。通过该注解，我们可以定义全局的异常处理逻辑，对所有的异常进行统一处理。

示例代码：

@ControllerAdvice
public class GlobalExceptionHandler {
 
    @ExceptionHandler(value = Exception.class)
    public ResponseEntity<Object> handleException(Exception e) {
        // 异常处理逻辑
        return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

登录后复制

以上代码中，handleException 方法可以处理所有的 Exception 异常，返回一个带有错误信息和 HTTP 状态码的 ResponseEntity 对象。在应用程序中，发生任何 Exception 异常时，都会调用该方法进行异常处理。

自定义异常类

在处理异常时，我们也可以自定义异常类来表示特定类型的异常。通过自定义异常类，我们可以在程序中抛出异常对象，使得程序更加清晰易懂，同时也可以在全局异常处理器中进行针对性的异常处理。

示例代码：

// 自定义异常类
public class MyException extends Exception {
 
    public MyException(String message) {
        super(message);
    }
}

// 抛出自定义异常
if (someCondition) {
    throw new MyException("发生了 MyException 异常");
}

// 异常处理逻辑
@ControllerAdvice
public class GlobalExceptionHandler {
 
    @ExceptionHandler(value = MyException.class)
    public ResponseEntity<Object> handleMyException(MyException e) {
        // 自定义异常处理逻辑
        return new ResponseEntity<>(e.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

登录后复制

以上代码中，我们定义了一个 MyException 异常类，当程序满足某些条件时就会抛出该异常。在全局异常处理器中，我们使用 @ExceptionHandler(value = MyException.class) 注解来表示该方法可以处理 MyException 类型的异常。

错误的调试和解决

Debug 模式调试

调试是解决应用程序错误的关键。通过调试程序，我们可以查看程序状态、变量值和执行路径等信息，从而找到错误出现的原因。在 Spring Boot 应用程序中，我们可以通过设置日志级别为 DEBUG 来进行调试。

在 application.properties 文件中添加以下代码：

logging.level.root=DEBUG

登录后复制

以上代码中，将日志级别 root 设置为 DEBUG，在运行程序时，程序日志将会输出更多调试信息。

日志记录

记录错误日志是寻找错误的有效手段。Spring Boot 应用程序自带了一个日志框架 —— logback，我们可以通过它来记录错误日志。在 logback.xml 文件中，我们可以配置日志输出格式、日志文件存储路径等。

示例代码：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="fileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/springbootdemo.log</file>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/springbootdemo.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>10MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>10GB</totalSizeCap>
        </rollingPolicy>
    </appender>
 
    <logger name="com.yourpackage" level="INFO"/>
 
    <root level="INFO">
        <appender-ref ref="fileAppender"/>
    </root>
</configuration>

登录后复制

以上代码中，我们添加了一个名为 fileAppender 的 appender，用来将日志输出到指定的文件中。其中，rollingPolicy 用来配置文件滚动策略，maxFileSize 设置单个日志文件大小，maxHistory 设置日志文件保存的天数，totalSizeCap 设置日志文件总大小。