在 Spring Boot 中处理嵌入式 Tomcat 异常

Question

我们遇到了嵌入式 Tomcat 从 LegacyCookieProcessor 抛出 IllegalArgumentException 的问题。它会抛出一个 500 HTTP 响应代码。

我们需要处理异常并对其进行处理（具体而言，将其作为 400 发送）。

典型的@ExceptionHandler(IllegalArgumentException.class) 似乎没有被触发，Google 似乎只给出了处理 Spring Boot 特定异常的结果。

---

示例：

这是重现该行为的示例。您可以通过下载 2.1.5.RELEASE 版本中包含 spring-web (https://start.spring.io/) 的初始项目来执行该示例。然后将以下两个类添加到您的项目中。

DemoControllerAdvice.java

package com.example.demo;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class DemoControllerAdvice {

    @ExceptionHandler(IllegalArgumentException.class)
    @ResponseStatus(HttpStatus.FORBIDDEN)
    public Map<String, String> forbiddenHandler() {
        Map<String, String> map = new HashMap<>();
        map.put("error", "An error occurred.");
        map.put("status", HttpStatus.FORBIDDEN.value() + " " + HttpStatus.FORBIDDEN.name());
        return map;
    }

}

---

DemoRestController.java

package com.example.demo;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoRestController {

    @GetMapping(value = "/working")
    public void working() {
        throw new java.lang.IllegalArgumentException();
    }

    @GetMapping(value = "/not-working")
    public String notWorking(@RequestParam String demo) {
        return "You need to pass e.g. the character ^ as a request param to test this.";
    }

}

---

然后，启动服务器并在浏览器中请求以下 URL：

• http://localhost:8080/working IllegalArgumentException 在控制器中手动抛出。然后它被 ControllerAdvice 捕获，因此将生成一个 JSON 字符串，其中包含DemoControllerAdvice 中定义的信息
• http://localhost:8080/not-working?demo=test^123 Tomcat 抛出 IllegalArgumentException，因为请求参数无法解析（因为无效字符 ^）。但是，ControllerAdvice 不会捕获该异常。它显示了 Tomcat 提供的默认 HTML 页面。它还提供了不同于DemoControllerAdvice 中定义的错误代码。

在日志中显示以下消息：

o.apache.coyote.http11.Http11Processor：解析 HTTP 请求标头时出错 注意：进一步出现的 HTTP 请求解析错误将记录在 DEBUG 级别。

java.lang.IllegalArgumentException：在请求目标中发现无效字符。有效字符在 RFC 7230 和 RFC 3986 中定义 在 org.apache.coyote.http11.Http11InputBuffer.parseRequestLine(Http11InputBuffer.java:467) ~[tomcat-embed-core-9.0.19.jar:9.0.19]

Answer 1

这是this 回答中提到的Tomcat 本身的一个功能。

但是，您可以通过允许将您期望的特殊字符作为请求的一部分并自己处理它们来执行此类操作。

首先，您需要通过像这样设置 relaxedQueryChars 来允许您需要处理的特殊字符。

import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.stereotype.Component;

@Component
public class TomcatCustomizer implements 
WebServerFactoryCustomizer<TomcatServletWebServerFactory> {

@Override
public void customize(TomcatServletWebServerFactory factory) {
    factory.addConnectorCustomizers((connector) -> {
        connector.setAttribute("relaxedQueryChars", "^");
    });
 }
}

然后处理每个请求中的特殊字符，或者创建一个拦截器并在一个公共位置处理它。

要在请求中单独处理它，您可以执行以下操作。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoRestController {

@GetMapping(value = "/working")
public void working() {
    throw new java.lang.IllegalArgumentException();
}

@GetMapping(value = "/not-working")
public String notWorking(@RequestParam String demo) {

    if (demo.contains("^")) {
        throw new java.lang.IllegalArgumentException("^");
    }
    return "You need to pass e.g. the character ^ as a request param to test this.";
}

}

您可能还想参考this 的答案来决定您是否真的需要此修复程序。