characters are defined in RFC 7230 and RFC 3986

背景

公司使用springboot，最近內置的tomcat版本從7升級到了8.5,發現請求參數帶{、}、[、]等字符，報以下錯誤。

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)
    at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:667)
    at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:66)
    at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:789)
    at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1455)
    at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
    at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
    at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
    at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
    at java.lang.Thread.run(Thread.java:745)

緣由

Tomcat的新版本中增長了一個新特性，就是嚴格按照 RFC 3986規範進行訪問解析，而 RFC 3986規範定義了Url中只容許包含英文字母（a-zA-Z）、數字（0-9）、-_.~4個特殊字符以及全部保留字符(RFC3986中指定了如下字符爲保留字符：! * ’ ( ) ; : @ & = + $ , / ? # [ ])。

解決辦法

• 客戶端發出的請求進行url encode編碼處理。encodeURIComponent("msg=name|id|")，可是須要每一個相關的請求都須要改。
• 下降tomcat的版本到7.0。
• 修改tomcat的配置。

1. 若是tomcat版本是7.0.76, 8.0.42, 8.5.12以後，(這個版本我也不是很清楚，在研究)
   在catalina.properties文件添加：

tomcat.util.http.parser.HttpParser.requestTargetAllow=|{}

2. 另外一種說法，參數tomcat.util.http.parser.HttpParser.requestTargetAllow is deprecated since Tomcat 8.5,應該使用relaxedQueryChars / relaxedPathChars。 我也是使用這個方式成功的。

//springboot 版本是1.5.x
@Component
public class PortalTomcatWebServerCustomizer implements EmbeddedServletContainerCustomizer {

    @Override
    public void customize(ConfigurableEmbeddedServletContainer container) {
        if(container instanceof TomcatEmbeddedServletContainerFactory) {
            TomcatEmbeddedServletContainerFactory containerFactory = (TomcatEmbeddedServletContainerFactory) container;
            containerFactory.addConnectorCustomizers(new TomcatConnectorCustomizer() {
                @Override
                public void customize(Connector connector) {
                    connector.setAttribute("relaxedQueryChars", "[]|{}^\`"<>");
                    connector.setAttribute("relaxedPathChars", "[]|");
                }
            });
        }
    }
}