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

时间:2016-09-07 18:08:46

标签: java spring tomcat spring-boot

我们遇到一个问题,即嵌入式Tomcat从IllegalArgumentException投掷LegacyCookieProcessor。它会抛出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请求标头时出错    注意:将在DEBUG级别记录更多出现的HTTP请求解析错误。

     

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]

1 个答案:

答案 0 :(得分:6)

这是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的答案来确定您是否确实需要此修复程序。