SpringBoot內(nèi)嵌tomcat處理有特殊字符轉義

前段時間在發(fā)生了前端調(diào)后臺接口失敗，原因是url中存在特殊字符，SpringBoot自帶的tomcat無法正常解析，返回400 bad Request。

網(wǎng)上搜了一下，發(fā)現(xiàn)是因為tomcat高版本中，更加嚴格按照 RFC 3986規(guī)范進行訪問解析，而 RFC 3986規(guī)范規(guī)定Url中只允許包含英文字母（a-zA-Z）、數(shù)字（0-9）、-_.~4個特殊字符以及所有保留字符(RFC3986中指定了以下字符為保留字符：! * ’ ( ) ; : @ & = + $ , / ? # [ ])。。

在這里記錄一下解決過程。

SpringBoot版本為 2.2.5release（不同版本的解決方式可能不同）。

實際解決方式（針對于使用SpringBoot內(nèi)置的Tomcat）

添加下面的配置Bean。

? ? /**
? ? ?* 配置轉義字符,解決當請求路徑中特殊字符，高版本tomcat解析失敗的問題
? ? ?*/
? ? @Bean
? ? public ServletWebServerFactory webServerFactory() {
? ? ? ? TomcatServletWebServerFactory fa = new TomcatServletWebServerFactory();
? ? ? ? fa.addConnectorCustomizers(connector -> {
? ? ? ? ? ? connector.setProperty("relaxedQueryChars", "(),/:;<=>?@[\\]{}");
? ? ? ? ? ? connector.setProperty("rejectIllegalHeader", "false");
? ? ? ? });
? ? ? ? return fa;
? ? }

（該內(nèi)容只是用于記錄，具體是否有效沒有測試過）如果你不是使用SpringBoot的tomcat啟動項目，那你就需要在tomcat的配置文件中添加以下配置信息，并重新啟動。

org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true

Springboot2中修改tomcat參數(shù)支持請求特殊符號

解決：java.lang.IllegalArgumentException: Invalid character found in ...

使用Springboot2中內(nèi)置的tomcat啟動項目時候，前端發(fā)來的請求報錯：

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:488) ~[tomcat-embed-core-9.0.33.jar:9.0.33]     
at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:260) ~[tomcat-embed-core-9.0.33.jar:9.0.33]     
at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65) [tomcat-embed-core-9.0.33.jar:9.0.33]     
at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:868) [tomcat-embed-core-9.0.33.jar:9.0.33]     
at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1594) [tomcat-embed-core-9.0.33.jar:9.0.33]     
at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49) [tomcat-embed-core-9.0.33.jar:9.0.33]     
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149) [na:1.8.0_144]     
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624) [na:1.8.0_144]     
at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61) [tomcat-embed-core-9.0.33.jar:9.0.33]     
at java.lang.Thread.run(Thread.java:748) [na:1.8.0_144]

這段報錯的意思是：請求中含有無效字符，有效的字符在RFC 7230和RFC 3986中定義

出現(xiàn)這個錯誤的原因是：我們在前后臺交互的時候請求的參數(shù)，其中含有“{}”“[]”這些特殊符號，在高版本的tomcat中含有這些字符的請求會被攔截。

例如：http://localhost:8080/sendMail?content=[1007]...

解決方法

springboot項目中增加一個配置，將webServerFactory方法加入到springboot啟動類中，配置文件代碼如下：

import org.apache.catalina.connector.Connector;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class TomcatConfig {
? ? @Bean
? ? public TomcatServletWebServerFactory webServerFactory() {
? ? ? ? TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
? ? ? ? factory.addConnectorCustomizers((Connector connector) -> {
? ? ? ? ? ? connector.setProperty("relaxedPathChars", "\"<>[\\]^`{|}");
? ? ? ? ? ? connector.setProperty("relaxedQueryChars", "\"<>[\\]^`{|}");
? ? ? ? });
? ? ? ? return factory;
? ? }
}

這樣就解決問題啦！

總結

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論