Question

如果您的端点描述如下：

@GetMapping("/hello")
public String sayHello(@RequestParam(name= "my_id", required=false) myId, @RequestParam(name= "my_name") myName){
    // return something
}

问题：

此端点的使用者可以在请求中发送无效的参数名称；

/hello?my_name=adam&a=1&b=2，它将正常工作。

目标：

能够使用适当的方法来验证可选的请求参数名称。

实际解决方案：

我已经实现了一个解决方案（对我来说，这不是正确的解决方案），其中我扩展了HandlerInterceptorAdapter并将其注册到WebMvcConfigurer中：

/**
 *
 * Interceptor for unknown request parameters
 *
 */
public class MethodParamNamesHandler extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        ArrayList<String> queryParams = Collections.list(request.getParameterNames());

        MethodParameter[] methodParameters = ((HandlerMethod) handler).getMethodParameters();
        Map<String, String> methodParametersMap = new HashMap<>();
        if(Objects.nonNull(methodParameters)){
            methodParametersMap = Arrays.stream(methodParameters)
                    .map(m -> m.getParameter().getName())
                    .collect(Collectors.toMap(Function.identity(),Function.identity()));
        }
        Set<String> unknownParameters = collectUnknownParameters(methodParametersMap, queryParams);
        if(!CollectionUtils.isEmpty(unknownParameters)){
            throw new InvalidParameterNameException("Invalid parameters names", unknownParameters);
        }

        return super.preHandle(request,response,handler);
    }

    /**
     * Extract unknown properties from a list of parameters
     * @param allParams
     * @param queryParam
     * @return
     */
    private Set<String> collectUnknownParameters(Map<String, String> allParams, List<String> queryParam){
        return queryParam.stream()
                .filter(param -> !allParams.containsKey(param))
                .collect(Collectors.toSet());
    }
}

缺点：

该解决方案的缺点是它基于方法参数，它将使用名称myId而不是my_id，这可以通过将大写单词转换为蛇形来解决。但这不是一个好的解决方案，因为您可以使用以下内容：sayHello(@RequestParam(name= "my_id", required=false) anotherName)。

问题： 有适当的方法来实现这一目标吗？

验证可选字段的请求参数名称-Spring Boot

0 个答案: