Spring ReST controller: how to avoid methods with same RequestParams

Question

In a Spring ReST Controller class, there are three methods with identical @RequestParams, but different RequestMappings and behavior, like in the following (simplified) example:

@RequestMapping(method = GET, value = "/search")
    public MySearchResponse findAll(
            @RequestParam(required = false, value = "foo") String foo,
            @RequestParam(required = false, value = "bar") String bar,
            @RequestParam(required = false, value = "baz") Long baz,
            @RequestParam(required = false, value = "fooBar") Long fooBar
    ) { ...}

@RequestMapping(method = GET, value = "/export")
    public MyExportResponse exportAll(
            @RequestParam(required = false, value = "foo") String foo,
            @RequestParam(required = false, value = "bar") String bar,
            @RequestParam(required = false, value = "baz") Long baz,
            @RequestParam(required = false, value = "fooBar") Long fooBar
    ) { ...}

Is there a way to avoid code duplication concerning the @RequestParam's?

Use an object to bind to.

M. Deinum
– M. Deinum

2016-11-07 13:54:13 +00:00
Commented Nov 7, 2016 at 13:54 — M. Deinum
– M. Deinum, Commented Nov 7, 2016 at 13:54

Community · Accepted Answer · 2017-05-23 12:07:17Z

1

Replace them with a single object.

static class MyParmeters {
    String foo;
    String bar;
    Long baz;
    Long fooBar;
}

@RequestMapping(method = GET, value = "/search")
public MySearchResponse findAll(MyParmeters params) { ... }

@RequestMapping(method = GET, value = "/export")
public MyExportResponse exportAll(MyParameters params) { ... }

See also How to bind @RequestParam to object in Spring MVC.

edited May 23, 2017 at 12:07

CommunityBot

11 silver badge

answered Nov 7, 2016 at 13:54

OrangeDog

39.3k18 gold badges141 silver badges227 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Mr.Radar Over a year ago

That seems to be quite a nice solution :-) Is there a way to conveniently check if the required-Constraint is fulfilled (in case there are @RequestParams with attribute required=true)

OrangeDog Over a year ago

Spring MVC: How to perform validation?

Vasu · Accepted Answer · 2016-11-07 13:57:31Z

You can define parent type called MyResponse and then you can use ResponseEntity as shown below:

@RequestMapping(method = GET, value = "/searchOrExport")
public ResponseEntity<MyResponse> exportAll(@RequestParam(required = false, value = "foo") String foo,
            @RequestParam(required = false, value = "bar") String bar,
            @RequestParam(required = false, value = "baz") Long baz,
            @RequestParam(required = false, value = "fooBar") Long fooBar) {
      //code to handle search and Export
}

Bean class API shown below:

public abstract class MyResponse  {
    //any common properties add here
}


public class MySearchResponse implements MyResponse {
   //add MySearchResponse properties
}

public class MyExportResponse implements MyResponse {
   //add MyExportResponse properties
}

Collectives™ on Stack Overflow

Spring ReST controller: how to avoid methods with same RequestParams

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related