将 map 作为请求参数发送到 Spring 启动应用程序中的 GET 请求

Question

Basically I need to accept a map along with other request parameters in a GET request.

Controller:

@GetMapping
public Page<Users> search(@Valid final UsersParams params) {
    return userService.search(params);
}

My params object looks like this:

public class UserParams {
    private String age;
    private String gender;
    private MultiValuedMap<String, String> names;
}

So, if I pass a request with these param values:

users?age=20&gender=Male&names={"john,doe","Harry,Potter","James,Bond"}

Is this even possible to pass a map in a request and make it work in a GET REST call?

With whatever minute knowledge I have, the only other option I could think of is, instead of the map use a list with comma-separated values and do some deserialization hack.

Answer 1

The best way you can try is make this request a post request. Then you can use as,

Request Object

{
    "age" : 20,
    "gender" : "Male",
    "names" : {
        "john" : "doe"
    }
}

DTO

@AllArgsConstructor
@NoArgsConstructor
@Data
class UserParams {
    String age;
    String gender;
    Map<String, String> names;
}

@PostMapping("/test2")
    public void search2(@RequestBody UserParams params) {
        log.info("This is the object we got", params);
    }

If you want it to be GET than you can use like this,

/test?age=20&gender=Male&john=doe&Harry=Potter

    @GetMapping("/test")
    public void search(UserParams params, @RequestParam Map<String, String> names) {
        log.info("This is the object we got", params);
    }

where you will get the age and gender inside UserParams and all the pair inside names Map, You need to ignore first two entries inside names requestparam as age and gender will also come inside this.

You can keep only Map rather than Userparam object

Answer 2

Put server.tomcat.relaxed-query-chars=[,] in application.properties file

Then you can use a url like the one below to send params in the map

users?age=20&gender=Male&names[john]=doe&names[Harry]=Potter&names[James]=Bond