Question

假设我有一个列出表中对象的页面，我需要放置一个表单来过滤表。过滤器作为Ajax GET发送到类似以下的URL：http://foo.com/system/controller/action?page=1&prop1=x&prop2=y&prop3=z

而不是在我的控制器上有很多参数，如：

@RequestMapping(value = "/action")
public @ResponseBody List<MyObject> myAction(
    @RequestParam(value = "page", required = false) int page,
    @RequestParam(value = "prop1", required = false) String prop1,
    @RequestParam(value = "prop2", required = false) String prop2,
    @RequestParam(value = "prop3", required = false) String prop3) { ... }

假设我有MyObject：

public class MyObject {
    private String prop1;
    private String prop2;
    private String prop3;

    //Getters and setters
    ...
}

我想做类似的事情：

@RequestMapping(value = "/action")
public @ResponseBody List<MyObject> myAction(
    @RequestParam(value = "page", required = false) int page,
    @RequestParam(value = "myObject", required = false) MyObject myObject,) { ... }

有可能吗？我怎么能这样做？

Answer 1

你绝对可以这样做，只需删除@RequestParam注释，Spring会将你的请求参数干净地绑定到你的类实例：

public @ResponseBody List<MyObject> myAction(
    @RequestParam(value = "page", required = false) int page,
    MyObject myObject)

Answer 2

我将添加一些简短的例子。

DTO课程：

public class SearchDTO {
    private Long id[];

    public Long[] getId() {
        return id;
    }

    public void setId(Long[] id) {
        this.id = id;
    }
    // reflection toString from apache commons
    @Override
    public String toString() {
        return ReflectionToStringBuilder.toString(this, ToStringStyle.SHORT_PREFIX_STYLE);
    }
}

控制器类内的请求映射：

@RequestMapping(value="/handle", method=RequestMethod.GET)
@ResponseBody
public String handleRequest(SearchDTO search) {
    LOG.info("criteria: {}", search);
    return "OK";
}

查询：

http://localhost:8080/app/handle?id=353,234

结果：

[http-apr-8080-exec-7] INFO  c.g.g.r.f.w.ExampleController.handleRequest:59 - criteria: SearchDTO[id={353,234}]

我希望它有所帮助：）

UPDATE / KOTLIN

因为目前我和Kotlin一起工作很多，如果有人想要定义类似的DTO，Kotlin的课程应该有以下形式：

class SearchDTO {
    var id: Array<Long>? = arrayOf()

    override fun toString(): String {
        // to string implementation
    }
}

使用像这样的data类：

data class SearchDTO(var id: Array<Long> = arrayOf())

Spring（在Boot中测试）为回答中提到的请求返回以下错误：

“无法将'java.lang.String []'类型的值转换为所需类型 'java.lang.Long中[]';嵌套异常是 java.lang.NumberFormatException：对于输入字符串：\“353,234 \”“

数据类仅适用于以下请求参数形式：

http://localhost:8080/handle?id=353&id=234

请注意这一点！

Answer 3

我有一个非常类似的问题。实际上问题是我想的更深。我正在使用jquery $.post，它使用Content-Type:application/x-www-form-urlencoded; charset=UTF-8作为默认值。不幸的是，我的系统基于此，当我需要一个复杂的对象@RequestParam时，我无法实现它。

在我的情况下，我尝试发送用户首选项，例如;

 $.post("/updatePreferences",  
    {id: 'pr', preferences: p}, 
    function (response) {
 ...

在客户端，发送到服务器的实际原始数据是;

...
id=pr&preferences%5BuserId%5D=1005012365&preferences%5Baudio%5D=false&preferences%5Btooltip%5D=true&preferences%5Blanguage%5D=en
...

解析为;

id:pr
preferences[userId]:1005012365
preferences[audio]:false
preferences[tooltip]:true
preferences[language]:en

，服务器端是;

@RequestMapping(value = "/updatePreferences")
public
@ResponseBody
Object updatePreferences(@RequestParam("id") String id, @RequestParam("preferences") UserPreferences preferences) {

    ...
        return someService.call(preferences);
    ...
}

我尝试@ModelAttribute，添加了setter / getters，构造函数具有UserPreferences的所有可能性但没有机会，因为它将发送的数据识别为5个参数，但实际上映射的方法只有2个参数。我也尝试过Biju的解决方案，但是会发生的是，spring使用默认构造函数创建一个UserPreferences对象，并且不会填充数据。

我通过从客户端发送首选项的JSon字符串来解决问题，并将其处理为服务器端的字符串;

客户端：

 $.post("/updatePreferences",  
    {id: 'pr', preferences: JSON.stringify(p)}, 
    function (response) {
 ...

服务器：

@RequestMapping(value = "/updatePreferences")
public
@ResponseBody
Object updatePreferences(@RequestParam("id") String id, @RequestParam("preferences") String preferencesJSon) {


        String ret = null;
        ObjectMapper mapper = new ObjectMapper();
        try {
            UserPreferences userPreferences = mapper.readValue(preferencesJSon, UserPreferences.class);
            return someService.call(userPreferences);
        } catch (IOException e) {
            e.printStackTrace();
        }
}

简要介绍一下，我在REST方法中手动完成了转换。在我看来，spring没有识别发送数据的原因是内容类型。

Answer 4

由于在每个帖子下都出现了关于如何强制设置字段的问题，所以我写了一个小例子，说明如何根据需要设置字段：

public class ExampleDTO {
@NotNull
private String mandatoryParam;

private String optionalParam;

@DateTimeFormat(iso = ISO.DATE) //accept Dates only in YYYY-MM-DD
@NotNull
private LocalDate testDate;

public String getMandatoryParam() {
    return mandatoryParam;
}
public void setMandatoryParam(String mandatoryParam) {
    this.mandatoryParam = mandatoryParam;
}
public String getOptionalParam() {
    return optionalParam;
}
public void setOptionalParam(String optionalParam) {
    this.optionalParam = optionalParam;
}
public LocalDate getTestDate() {
    return testDate;
}
public void setTestDate(LocalDate testDate) {
    this.testDate = testDate;
}
}

@RequestMapping(value = "/test", method = RequestMethod.GET)
public String testComplexObject (@Valid ExampleDTO e){
        System.out.println(e.getMandatoryParam() + " " + e.getTestDate());
        return "Does this work?";
}

Answer 5

虽然涉及@ModelAttribute，@RequestParam，@PathParam之类的答案是有效的，但我遇到了一个小陷阱。结果方法参数是Spring环绕DTO的代理。因此，如果尝试在需要您自己的自定义类型的上下文中使用它，则可能会得到一些意外的结果。

以下内容无效：

@GetMapping(produces = APPLICATION_JSON_VALUE)
public ResponseEntity<CustomDto> request(@ModelAttribute CustomDto dto) {
    return ResponseEntity.ok(dto);
}

就我而言，尝试在Jackson绑定中使用它会导致com.fasterxml.jackson.databind.exc.InvalidDefinitionException。

您将需要从dto创建一个新对象。

Answer 6

是的，您可以通过一种简单的方式来做到这一点。请参见下面的代码行。

URL- http://localhost:8080/get/request/multiple/param/by/map?name='abc'＆id ='123'

 @GetMapping(path = "/get/request/header/by/map")
    public ResponseEntity<String> getRequestParamInMap(@RequestParam Map<String,String> map){
        // Do your business here 
        return new ResponseEntity<String>(map.toString(),HttpStatus.OK);
    }

Answer 7

接受的答案就像一个咒语，但是如果该对象具有对象列表，将无法按预期工作，所以这是我进行一些挖掘后的解决方案。

按照this thread的建议，这是我的工作方式。

前端：将您的对象字符串化，而不是使用base64对其进行编码以进行提交。
后端：解码base64字符串，然后将字符串json转换为所需对象。

用邮递员调试您的API并不是最好的方法，但它对我来说可以正常工作。

原始对象： {页面：1，大小：5，过滤器：[{字段：“ id”，值：1，比较：“ EQ”}

编码对象： eyJwYWdlIjoxLCJzaXplIjo1LCJmaWx0ZXJzIjpbeyJmaWVsZCI6ImlkUGFyZW50IiYYY29tcGFyaXNvbiI6Ik5VTEwifV19

@GetMapping
fun list(@RequestParam search: String?): ResponseEntity<ListDTO> {
    val filter: SearchFilterDTO = decodeSearchFieldDTO(search)
    ...
}

private fun decodeSearchFieldDTO(search: String?): SearchFilterDTO {
    if (search.isNullOrEmpty()) return SearchFilterDTO()
    return Gson().fromJson(String(Base64.getDecoder().decode(search)), SearchFilterDTO::class.java)
}

这里是SearchFilterDTO和FilterDTO

class SearchFilterDTO(
    var currentPage: Int = 1,
    var pageSize: Int = 10,
    var sort: Sort? = null,
    var column: String? = null,
    var filters: List<FilterDTO> = ArrayList<FilterDTO>(),
    var paged: Boolean = true
)

class FilterDTO(
    var field: String,
    var value: Any,
    var comparison: Comparison
)

Spring MVC：复杂对象为GET @RequestParam

7 个答案: