Spring REST Controller 在具有空格或逗号等特殊字符时理解字符串数组

Question

我正在尝试编写一个 Spring REST 控制器，将字符串数组作为 HTTP GET 请求的输入参数。

问题出现在GET请求中，在数组的某些字符串中，我使用了逗号,、空格或正斜杠/等特殊字符，不管我URL 编码 URL HTTP GET 请求的查询部分。

这意味着字符串“1/4 cup ricotta, yogurt”（edit 需要被视为作为输入数组的字符串元素包含的唯一成分）采用以下任一格式：

http://127.0.0.1:8080/[...]/parseThis?[...]&ingredients=1/4 cup ricotta, yogurt

这种格式（请注意空格编码为+加号，而不是十六进制代码）：

http://127.0.0.1:8080/[...]/parseThis?[...]&ingredients=1%2F4+cup+ricotta%2C+yogurt

或者这种格式（请注意空格编码为十六进制代码%20）：

http://127.0.0.1:8080/[...]/parseThis?[...]&ingredients=1%2F4%20cup%20ricotta%2C%20yogurt

没有正确渲染。

• 系统无法将输入字符串识别为数组的单个元素。
• 在第 2 种和第 3 种情况下，系统以逗号分隔输入字符串并返回一个由 2 个元素而不是 1 个元素组成的数组。我希望这里有 1 个元素。

控制器的相关代码为：

@RequestMapping(
        value = "/parseThis",
        params = {
                "language",
                "ingredients"

        }, method = RequestMethod.GET, headers = HttpHeaders.ACCEPT + "=" + MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public HttpEntity<CustomOutputObject> parseThis(
        @RequestParam String language,
        @RequestParam String[] ingredients){

    try {

        CustomOutputObject responseFullData = parsingService.parseThis(ingredients, language);

        return new ResponseEntity<>(responseFullData, HttpStatus.OK);

    } catch (Exception e) {
        // TODO
    }

}

我需要对这个 Spring 控制器执行 HTTP GET 请求，这是一个要求（所以这里不能使用 HTTP POST）。

编辑 1：

如果我将HttpServletRequest request 添加到控制器中方法的签名中，然后我添加一个类似log.debug("The query string is: '" + request.getQueryString() + "'"); 的日志语句，然后我会在日志中看到类似The query string is: '&language=en&ingredients=1%2F4+cup+ricotta%2C+yogurt' 的行（所以仍然是URL 编码）。

编辑 2：

另一方面，如果我将WebRequest request 添加到方法的签名中，日志为log.debug("The query string is: '" + request.getParameter("ingredients") + "'");，那么我在日志中得到一个字符串为The query string is: '1/4 cup ricotta, yogurt'（因此URL 被解码）。

我使用 Apache Tomcat 作为服务器。

我需要在 Spring/webapp 配置文件中添加/查看任何过滤器或其他内容吗？

编辑 3：

主要问题在于逗号的解释：

@ResponseBody
@RequestMapping(value="test", method=RequestMethod.GET)
public String renderTest(@RequestParam("test") String[] test) {
    return test.length + ": " + Arrays.toString(test);
    // /app/test?test=foo,bar => 2: [foo, bar]
    // /app/test?test=foo,bar&test=baz => 2: [foo,bar, baz]
}

可以防止这种行为吗？

Answer 1

请求参数到你的方法参数的路径经过参数值提取然后参数值转换。现在发生的事情是：

提取：

参数为extracted as a single String value。这可能是为了让简单的属性可以作为简单的字符串值传递给以后的值转换。

转化率：

Spring 使用ConversionService 进行值转换。在其默认设置StringToArrayConverter is used 中，不幸的是，它将字符串作为逗号分隔列表处理。

做什么：

您对 Spring 处理单值请求参数的方式感到非常困惑。所以我会手动进行绑定：

// Method annotations
public HttpEntity<CustomOutputObject> handlerMethod(WebRequest request) {
    String[] ingredients = request.getParameterValues("ingredients");
    // Do other stuff 
}

---

您还可以查看Spring guys have to say about this.. 和related SO question 的内容。

Answer 2

好吧，您可以注册一个custom conversion service（来自this SO answer），但这似乎需要做很多工作。 :) 如果是我，我会忽略方法签名中的 @RequestParam 声明，并使用传入的 request 对象解析值。

Answer 3

我建议您尝试以下格式：

ingredients=egg&ingredients=milk&ingredients=butter

将&ingredients 附加到末尾将处理数组只有一个值的情况。

ingredients=egg&ingredients=milk&ingredients=butter&ingredients
ingredients=milk,skimmed&ingredients   

需要从数组中删除额外的条目，使用List<String> 会使这更容易。

或者，如果您尝试使用 spring-data-jpa 实现 REST 控制器以通过管道直接进入数据库，您应该查看 spring-data-rest。这是example。

你基本上用 @RepositoryRestResource 注释你的存储库，其余的由 spring 完成 :)

Answer 4

来自here的解决方案

public String get(WebRequest req) {
    String[] ingredients = req.getParameterValues("ingredients");
    for(String ingredient:ingredients ) {
        System.out.println(ingredient);
    }
    ...
}

这适用于您有一个包含逗号的单一成分的情况