处理Spring Boot中嵌入式Tomcat异常

Question

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

我们需要处理异常并采取一些措施（具体而言，将其作为400发送）。

典型的@ExceptionHandler（IllegalArgumentException.class）似乎不会被触发，Google似乎只会给出处理Spring Boot特定异常的结果。

---

示例：

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

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捕获，因此将生成包含DemoControllerAdvice定义的信息的JSON字符串。 - http://localhost:8080/not-working?demo=test^123 Tomcat抛出IllegalArgumentException异常，因为请求参数无法解析（因为存在无效字符“^”）。但是，异常未被ControllerAdvice捕获。它显示Tomcat提供的默认HTML页面，并提供与DemoControllerAdvice中定义不同的错误代码。

日志中显示以下消息：

o.apache.coyote.http11.Http11Processor : Error parsing HTTP request header Note: further occurrences of HTTP request parsing errors will be logged at DEBUG level. java.lang.IllegalArgumentException: Invalid character found in the request target. The valid characters are defined in RFC 7230 and RFC 3986 at org.apache.coyote.http11.Http11InputBuffer.parseRequestLine(Http11InputBuffer.java:467) ~[tomcat-embed-core-9.0.19.jar:9.0.19]

- samanime

---

@Imran 字符串不能像那样比较！ - Eugene

也许你找不到答案，是因为你没有提供一个简单的 MCVE 让别人重现问题。 - kriegaex

无法拦截。此异常在任何与Servlet API相关的内容处理之前被抛出，因此没有任何servlet过滤器、监听器或DispatcherServlet参与。这只是Tomcat在内部非常早期就崩溃了。 - M. Deinum

@ssc-hrep3 奇怪的是，我无法在我的环境中复制相同的行为 http://localhost:8080/not-working?demo=test^123，它给了我200。你能否告知你使用的Java版本以及是否启用了任何特殊属性？一个完整的Github仓库样例可以帮助我们尝试一些选项。 - Imran

@ssc-hrep3，你看到MCVE的用处了吗？新人——不一定是我最初请求MCVE的人，因为我是一个AOP专家，但对容器知之甚少——参与讨论并贡献有价值的信息，重提一个2.5年前的问题。:-) - kriegaex

Answer 1

这是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.";
}

}

你可能还想参考这个答案来决定是否真的需要此修复。 这里是答案链接。

- Rahul kalivaradarajalu

---

谢谢您的回复，这很有趣。然而，我不想允许那些字符。我只想以相同的方式响应所有异常：通过返回一个带有JSON的HTTP包（和自定义标头）。允许这些字符，然后再每个控制器中处理它们似乎不是一个好的解决方案。而且它实际上并不能防止Tomcat抛出其他异常（我假设除了特殊字符之外，Tomcat还会有其他情况会抛出异常）。 - ssc-hrep3

允许每个控制器中的这些字符只是此场景的一个示例。您可以构建一个HTTP拦截器并检查带有特殊字符的参数，然后从拦截器中抛出IllegalArgumentException以进行通用实现。 - Rahul kalivaradarajalu

虽然问题已经转向询问查询参数，但最初的问题实际上是关于 cookie 中的奇怪值，而不是查询参数。这个答案是否适用于这两种情况？ - samanime

Answer 2

尝试在您的过滤器中捕获IllegalArgumentException，然后调用HttpServletResponse.sendError(int sc, String msg);。这可能会捕获不来自Tomcat的IllegalArgumentException。但我想您已经适当地处理它们了。

- user20097595