URI的path中特殊符号支持（GET请求400问题）

问题

在使用Get请求，存在方括号[]符号时，Spring中的Tomcat报400错误。

原因

URI中path部分存在方括号符号：[和]。这两个符号在Nginx URI编码过程中，没有进行百分号编码。

解决

在Spring中指定忽略Path中的方括号字符。

  @Bean
  public ConfigurableServletWebServerFactory webServerFactory() {
    TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
    factory.addConnectorCustomizers(connector -> connector.setProperty("relaxedPathChars", "[]"));
    return factory;
  }

排查过程

启用Nginx调试模式

源码编译nginx时，使用下面配置：

/configure --with-debug ...

然后，在配置文件中配置debug日志：

http {
    server {
        error_log  logs/api_error.log  debug;
        ...

通过api_error.log日志文件，可以知道Nginx会自动编码一边url，再转发给spring。这里Nginx使用upstream方式进行代理的，这里方括号符号，被Nginx从百分号编码还原成了原始方括号符合，造成Spring Tomcat 400了。

总结

需要前端排除的符号：
%#:;/\?
需要Spring兼容Nginx的uri的path特殊符号：
[]{}^
即Spring中配置：

  @Bean
  public ConfigurableServletWebServerFactory webServerFactory() {
    TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
    factory.addConnectorCustomizers(connector -> connector.setProperty("relaxedPathChars", "[]{}^`"));
    return factory;
  }

这个问题，不要使用PostMan（Version 9.1.1 (9.1.1)）进行接口调试，PostMan调试不出来这个问题，要用curl命令行进行接口调试。

参考：

• spring boot 处理请求参数的非法字符
• Are square brackets permitted in URLs?
• 400 bad request returned in spring boot even before the request reaches filter
• Disabling URL decoding in nginx proxy
• 统一资源标志符
• get请求的参数包含中括号[]时，报错400
• A debugging log