Spring Boot 全局异常处理与日志监控实战_程序员社区_IDEA激活码,IDEA破解教程,PyCharm激活码

Spring Boot 全局异常处理与日志监控实战

- 1. 背景与目的
- 2. 设计思路（要点）
- 3. 项目依赖（Maven）
- 4. 通用错误响应DTO
- 5. 自定义业务异常示例
- 6. 全局异常处理实现（日志 + 指标）
- 7. 请求 ID 与 MDC 过滤器（确保每条请求均有 requestId）
- 8. 日志配置及示例输出
- application.properties（关键项）
- logback-spring.xml（pattern 示例）
- 日志示例（一条报错请求）
- 9. 将异常计数暴露至监控（Actuator + Micrometer）
- 10. 常见场景与处理建议
- 11. 小结与部署建议

代码以 Spring Boot 3 / Java 17 风格示例（可适配 Spring Boot 2.x 做少量改动）

目标：构建一套稳健的全局异常处理方案，实现统一错误响应 、可追溯的日志（含 requestId/MDC） ，并将异常上报为监控指标（借助 Micrometer），便于在生产环境中定位与统计异常。

1. 背景与目的

在生产环境中，异常无处不在。我们需解决以下三个问题：
* 对外提供统一的 JSON 错误格式，方便前端或客户端解析与展示；
* 在日志中携带可追溯的 requestId（通过 MDC），以便从日志中串联一条请求的所有操作；
* 对异常进行指标统计（例如按异常类型、状态码计数），可在监控平台（如 Prometheus/Grafana）上进行报警与分析。

2. 设计思路（要点）

运用 @RestControllerAdvice 结合 @ExceptionHandler 进行全局异常捕获；
返回标准的 ErrorResponse，包含时间戳、HTTP 状态码、业务错误码、具体信息、请求路径、requestId；
在异常处理器中，既记录日志（log.error(...)），又将异常计数交由 MeterRegistry（Micrometer）处理；
通过 OncePerRequestFilter 在每个请求开始时生成 requestId，并将其放入 SLF4J 的 MDC 中（MDC.put("requestId", id)）；
配置 logback-spring.xml，使日志 pattern 能输出 %X{requestId}，建议也可输出 JSON 格式（根据需求）。

3. 项目依赖（Maven）

<!-- pom.xml 依赖片段 -->
<dependencies>
    <!-- Spring Boot Web 启动器 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- 日志相关 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-logging</artifactId>
    </dependency>

    <!-- 验证相关 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

    <!-- Actuator 与 Micrometer（Prometheus） -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-registry-prometheus</artifactId>
    </dependency>
</dependencies>

4. 通用错误响应 DTO

src/main/java/com/example/demo/api/ErrorResponse.java

package com.example.demo.api;

import java.time.Instant;
import java.util.Map;

public class ErrorResponse {
    private Instant timestamp;
    private int status;
    private String error;
    private String message;
    private String path;
    private String requestId;
    private Map<String, Object> details; // 可选扩展字段

    public ErrorResponse() {}

    public ErrorResponse(int status, String error, String message, String path, String requestId) {
        this.timestamp = Instant.now();
        this.status = status;
        this.error = error;
        this.message = message;
        this.path = path;
        this.requestId = requestId;
    }

    // getters & setters 省略以简化代码
}

5. 自定义业务异常示例

src/main/java/com/example/demo/exception/BusinessException.java

package com.example.demo.exception;

public class BusinessException extends RuntimeException {
    private final String code;

    public BusinessException(String code, String message) {
        super(message);
        this.code = code;
    }

    public String getCode() {
        return code;
    }
}

6. 全局异常处理实现（日志 + 指标）

src/main/java/com/example/demo/exception/GlobalExceptionHandler.java

package com.example.demo.exception;

import com.example.demo.api.ErrorResponse;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Counter;
import jakarta.servlet.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.stream.Collectors;

@RestControllerAdvice
public class GlobalExceptionHandler {

    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    private final MeterRegistry meterRegistry;

    // 简单的异常计数器前缀，可根据异常类、路径、状态码等构造标签
    private final Counter genericExceptionCounter;

    public GlobalExceptionHandler(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
        this.genericExceptionCounter = Counter.builder("exceptions.total")
                .description("已处理异常的总数")
                .register(meterRegistry);
    }

    // 处理业务异常
    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<ErrorResponse> handleBusiness(BusinessException ex, HttpServletRequest request) {
        String requestId = MDC.get("requestId");
        log.warn("BusinessException - requestId={}, path={}, code={}, msg={}",
                requestId, request.getRequestURI(), ex.getCode(), ex.getMessage());

        // 按业务码增加监控计数
        meterRegistry.counter("exceptions.by_code", "code", ex.getCode()).increment();

        ErrorResponse err = new ErrorResponse(
                HttpStatus.BAD_REQUEST.value(),
                "Business Error",
                ex.getMessage(),
                request.getRequestURI(),
                requestId
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(err);
    }

    // 处理参数校验异常
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<ErrorResponse> handleValidation(MethodArgumentNotValidException ex, HttpServletRequest request) {
        String requestId = MDC.get("requestId");
        String msg = ex.getBindingResult().getFieldErrors().stream()
                .map(fe -> fe.getField() + ":" + fe.getDefaultMessage())
                .collect(Collectors.joining("; "));
        log.info("Validation failed - requestId={}, path={}, errors={}", requestId, request.getRequestURI(), msg);

        meterRegistry.counter("exceptions.validation").increment();

        ErrorResponse err = new ErrorResponse(
                HttpStatus.BAD_REQUEST.value(),
                "Validation Error",
                msg,
                request.getRequestURI(),
                requestId
        );
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(err);
    }

    // 处理通用异常
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleGeneric(Exception ex, HttpServletRequest request) {
        String requestId = MDC.get("requestId");
        log.error("Unhandled exception - requestId={}, path={}", requestId, request.getRequestURI(), ex);

        // 总量计数
        genericExceptionCounter.increment();
        // 按异常类计数标签
        meterRegistry.counter("exceptions.by_type", "type", ex.getClass().getSimpleName()).increment();

        ErrorResponse err = new ErrorResponse(
                HttpStatus.INTERNAL_SERVER_ERROR.value(),
                "Internal Server Error",
                "服务器繁忙，请稍后重试",
                request.getRequestURI(),
                requestId
        );

        // 开发环境可将 ex.getMessage() 或堆栈信息放入 details 中（生产环境慎用）
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(err);
    }
}

说明：
* 在处理器中，同时进行日志记录和计数器递增操作，实现日志记录与监控功能；
* MDC.get("requestId") 用于将请求的 requestId 写入返回体，方便客户端回查日志。

7. 请求 ID 与 MDC 过滤器（确保每条请求均有 requestId）

src/main/java/com/example/demo/filter/RequestIdFilter.java

package com.example.demo.filter;

import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;

import java.io.IOException;
import java.util.UUID;

@Component
public class RequestIdFilter extends OncePerRequestFilter {

    private static final String REQUEST_ID_HEADER = "X-Request-Id";

    @Override
    protected void doFilterInternal(HttpServletRequest request,
                                    HttpServletResponse response,
                                    FilterChain filterChain) throws ServletException, IOException {

        try {
            String requestId = request.getHeader(REQUEST_ID_HEADER);
            if (requestId == null || requestId.isBlank()) {
                requestId = UUID.randomUUID().toString();
            }
            MDC.put("requestId", requestId);
            // 将 requestId 放回响应头，便于前端或网关追踪
            response.setHeader(REQUEST_ID_HEADER, requestId);

            filterChain.doFilter(request, response);
        } finally {
            MDC.remove("requestId");
        }
    }
}

说明：
* 每次请求都会生成（或沿用上游）X-Request-Id，并放入 MDC，日志 pattern 可输出 %X{requestId}；
* 响应中返回该 header，有助于客户端或运维人员进行串联。

8. 日志配置及示例输出

application.properties（关键项）

# 暴露 Actuator prometheus 端点
management.endpoints.web.exposure.include=health,info,prometheus,metrics
management.endpoint.prometheus.enabled=true

# 日志级别（根据环境调整）
logging.level.root=INFO
logging.level.com.example=DEBUG

logback-spring.xml（pattern 示例）

放置于 src/main/resources/logback-spring.xml：

<configuration>
    <springProfile name="prod">
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <!-- 输出包含 requestId -->
                <pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} [%thread] %-5level %logger{36} - %msg - requestId=%X{requestId}%n</pattern>
            </encoder>
        </appender>
        <root level="INFO">
            <appender-ref ref="STDOUT"/>
        </root>
    </springProfile>

    <springProfile name="!prod">
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg - requestId=%X{requestId}%n</pattern>
            </encoder>
        </appender>
        <root level="DEBUG">
            <appender-ref ref="STDOUT"/>
        </root>
    </springProfile>
</configuration>

日志示例（一条报错请求）

2025-08-10T18:34:10.123+03:00 [http-nio-8080-exec-1] ERROR com.example.demo.exception.GlobalExceptionHandler - Unhandled exception - requestId=2f1a8c7f-1d2b-4f0a-9b2a-123456789abc, path=/api/orders
java.lang.NullPointerException: ...
    at com.example.demo.service.OrderService.create(OrderService.java:45)
    ...

可见 requestId 出现在每条日志中，便于通过 grep 或日志平台（ELK/EFK）依据 requestId 过滤整条调用链。

9. 将异常计数暴露至监控（Actuator + Micrometer）

前文 GlobalExceptionHandler 已将计数器注册至 Micrometer：
* exceptions.total
* exceptions.by_code{code=...}
* exceptions.by_type{type=...}

在 Prometheus 中抓取 Spring Boot 的 /actuator/prometheus 指标，便可在 Grafana 中依据 exceptions.by_type 设置报警规则。例如：若 exceptions.by_type{type="NullPointerException"} 在 5 分钟内增幅过大，即触发报警。

10. 常见场景与处理建议

参数校验失败（MethodArgumentNotValidException）
- 建议将字段错误拼成单行消息（示例中已实现），并返回 400 状态码。
业务异常（自定义 BusinessException）
- 业务异常可携带 code，前端可依据 code 进行差异化提示或重试策略；监控中也可依据 code 作为标签进行统计。
第三方超时/HTTP 错误（RestTemplate/WebClient）
- 在调用处抛出有意义的自定义异常或将原异常包装后抛出；在全局异常处理器中依据异常类型映射为 502/504 等状态码，并进行计数。
链路追踪（可选）
- 若有分布式追踪需求，可接入 OpenTelemetry/Zipkin/Jaeger，但仍需保留 requestId 用于本地快速查找。
安全注意
- 生产环境切勿在 API 返回中包含完整堆栈或敏感字段（示例中仅返回通用消息）。开发环境可添加 details 字段。

11. 小结与部署建议

统一异常处理 可显著提升前后端协作效率与错误可观察性；
MDC + requestId 是生产排查的关键要素，务必确保上游（网关）能传递 X-Request-Id，否则服务端生成并回传；
监控计数 （Micrometer）使异常不再是“偶发的黑盒”，可在 Grafana/Prometheus 上设置阈值与报警；
日志集中化 建议配合 ELK/EFK（或云日志）保存结构化日志（JSON），以便依据 requestId、code、type 进行聚合查询；
对外返回 应保持稳定的 JSON 格式与明确的状态码，避免泄露内部实现细节。

文章整理自互联网，只做测试使用。发布者：Lomu，转转请注明出处：https://www.it1024doc.com/13547.html

Spring Boot 全局异常处理与日志监控实战