Spring boot 2.0 升级到 3.3.1 的相关问题（九）

文章目录

[Spring boot 2.0 升级到 3.3.1 的相关问题（九）](#Spring boot 2.0 升级到 3.3.1 的相关问题（九）)
- [Spring Doc 自定义`authorization` 请求头的处理](#Spring Doc 自定义authorization 请求头的处理)
- [Spring Doc 访问 Swagger UI 异常的问题](#Spring Doc 访问 Swagger UI 异常的问题)
- - 问题描述
  - 问题解决
- 通过URL参数传入数组序列参数导致请求异常的BUG
- - 问题描述
  - 解决方案
  - [1、修改为GET 请求为POST 请求，Body的参数没限制（不推荐）](#1、修改为GET 请求为POST 请求，Body的参数没限制（不推荐）)
  - 2、前端进行编码转换
  - 相关资料

Spring boot 2.0 升级到 3.3.1 的相关问题（九）

Spring Doc 自定义`authorization` 请求头的处理

直接通过addOperationCustomizer的 addParametersItem 处理添加的authorization的请求头在swagger UI的页面上是不会提交这个请求头的，authorization的请求头这个是作为Security的一部分。因此需要通过自定义SecurityScheme 来实现。

添加一个自定义的 Authorization SecurityScheme

java 复制代码

/**
 * 自定义的Spring Doc Authorization 配置
 */
@Configuration
@SecurityScheme(
    type = SecuritySchemeType.APIKEY,
    description = "Custom token authentication",
    name = FrameConstant.HTTP_HEADER_AUTHORIZATION,
    in = SecuritySchemeIn.HEADER
)
public class SpringDocAuthorizationConfig {
}

修改OpenApi的配置

java 复制代码

    @Bean @Profile("!prod") public GroupedOpenApi customOpenAPI() {
        log.info("自定义SpringDoc配置");
        return GroupedOpenApi.builder().group(applicationName).packagesToScan(controllerPackages)
            .addOperationCustomizer((operation, handlerMethod) -> {
	            //添加自定义的SecurityScheme
                operation.addSecurityItem(new SecurityRequirement().addList(FrameConstant.HTTP_HEADER_AUTHORIZATION));
                //添加其他的参数请求头
                operation.addParametersItem(
                    new HeaderParameter().name(FrameConstant.HTTP_HEADER_CLIENT_TYPE).description("客户端版本类型")
                        .required(true));
                operation.addParametersItem(
                    new HeaderParameter().name(FrameConstant.HTTP_HEADER_CLIENT_VERSION).description("客户端版本号")
                        .required(true));
                return operation;
            }).addOpenApiCustomizer(openApi -> openApi.info(
                new Info().title(applicationName).description(applicationDescription).version(applicationVersion)))
            .build();
    }

Spring Doc 访问 Swagger UI 异常的问题

问题描述

访问项目的Swagger UI显示Swagger Petstore 的一个demo 页面

原因是/v3/api-docs/swagger-config 这个请求没有正常返回，大概率是项目的拦截器拦截掉这个请求，比如鉴权

问题解决

降这个URL添加到过滤器的白名单中就可以了。

通过URL参数传入数组序列参数导致请求异常的BUG

问题描述

例如GET请求/page-info/list?keywordGroupList[0].keyword=abc&keywordGroupList[0].searchType=10&keywordGroupList[0].isExclude=false&limit=10&offset=0

会出现错误，导致请求直接报错,Socket 层的直接被拦截掉了，都进入不到Servlet。

通过跟踪请求链，在org.apache.coyote.http11.Http11Processor#service 中发现了下面这个异常信息的异常
Invalid character found in the request target [/page-info/list?keywordGroupList[0].keyword=abc&keywordGroupList[0].searchType=10&keywordGroupList[0].isExclude=false&limit=10&offset=0 ]. The valid characters are defined in RFC 7230 and RFC 3986

查询关键字 The valid characters are defined in RFC 7230 and RFC 3986 发现是Tomcat的执行了更严格的规范，导致[和] 这种符号不允许出现在URL中。

解决方案

1、修改为GET 请求为POST 请求，Body的参数没限制（不推荐）

2、前端进行编码转换

将/page-info/list?keywordGroupList[0].keyword=abc&keywordGroupList[0].searchType=10&keywordGroupList[0].isExclude=false&limit=10&offset=0 中的中括号[和] 转换成%5B 和 %5D。

使用qs的stringify进行转换就可以了qs.stringify(params,'comma');。

以axios 为例，配置paramsSerializer 就可以了。

javascript 复制代码

import axios from 'axios';
import qs from 'qs';

  return axios(Object.assign({
    baseURL,
    headers,
    url,
    data,
    params,
    paramsSerializer: (params: any) => {
      if(params){
        return qs.stringify(params,'comma');
      }
      return "";
    },
    timeout
  }, options))
    .then((res) => {
      //
    })
    .catch(err => {
      //
    });

Spring boot 2.0 升级到 3.3.1 的相关问题 （九）

文章目录