Is it possible to bind path variable and request param into a single object?

Question

I'm creating an endpoint with path variable and request params. How do I combine both path variable and request params into a single object? I'm using springboot 2 with java 8

@RequestMapping(path = "/schedules")
public class SchedulesController {

    @GetMapping("/{area}/{subarea}")
    public MyObject getFlight(@PathVariable("area") String area, @PathVariable("subarea") String subarea,
                           MyModel model) {

        ...
        return new MyObject();
    }
}

@Data
public class MyModel {
    LocalDate datestamp,
    String leadName,
    String viceLeadName
}

I've looked at the spring documentation and I can't seems to find how to combine PathVariable into MyModel.

Here is my controller without the object.

@RequestMapping(path = "/schedules")
public class SchedulesController {

    @GetMapping("/{area}/{subarea}")
    public MyObject getFlight(@PathVariable("area") String area, @PathVariable("subarea") String subarea,
                            @RequestParam(value = "datestamp", required = false) @DateTimeFormat(pattern = "yyyy-MM-dd") LocalDate datestamp,
                            @RequestParam(value = "leadName", required = false) String leadName,
                            @RequestParam(value = "viceLeadName", required = false) String viceLeadName) {

        ...
        return new MyObject();
    }
}

Is it possible to do the following? Where the path variables and request params are in MyModel object?

@RequestMapping(path = "/schedules")
public class SchedulesController {

    @GetMapping("/{area}/{subarea}")
    public MyObject getFlight(MyModel model) {

        ...
        return new MyObject();
    }
}

@Data
public class MyModel {
    String area,
    String subArea,
    LocalDate datestamp,
    String leadName,
    String viceLeadName
}

Thanks, but I saw that post and it's only binding the path variables. While I'm looking to bind both path variable and request params into 1 single object. — user293655, Apr 22 '19 at 10:03

score 9 · Accepted Answer · answered Apr 22 '19 at 10:37

9

Create a Model MyModel

  class MyModel {
    String area;
    String subarea;
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    LocalDate datestamp;
    String leadname;
    String viceleadname;
    @Override
    public String toString() {
        return "MyModel [area=" + area + ", subarea=" + subarea + ", datestamp=" + datestamp + ", leadname=" + leadname
                + ", viceneadname=" + viceleadname + "]";
    }
    public String getArea() {
        return area;
    }
    public void setArea(String area) {
        this.area = area;
    }
    public String getSubarea() {
        return subarea;
    }
    public void setSubarea(String subarea) {
        this.subarea = subarea;
    }
    public LocalDate getDatestamp() {
        return datestamp;
    }
    public void setDatestamp(LocalDate datestamp) {
        this.datestamp = datestamp;
    }
    public String getLeadname() {
        return leadname;
    }
    public void setLeadname(String leadname) {
        this.leadname = leadname;
    }
    public String getViceneadname() {
        return viceleadname;
    }
    public void setViceneadname(String viceleadname) {
        this.viceleadname = viceleadname;
    }

And the Request mapping will be same as you mentioned.

  @GetMapping("/{area}/{subarea}")
    public String getFlight(MyModel model) {
      System.out.println(model);

        return "success";
    }

And the Request look like this:

http://localhost:8080/us/ny?datestamp=2019-05-01&leadname=abc&viceleadname=xyz

answered Apr 22 '19 at 10:37

ArunKumar M N

1,256
1
10
22

this will results MyModel attributes to be null. – user293655 Apr 22 '19 at 10:45
Checked working fine. – Srinivasan Sekar Apr 22 '19 at 10:48
@user29365 what is your request url? – ArunKumar M N Apr 22 '19 at 10:49
http://localhost:8080/us/ny?datestamp=2019-05-01&leadname=abc&viceleadname=xyz same hit via postman – Srinivasan Sekar Apr 22 '19 at 10:50
Request url: http://localhost:8080/schedules ```http://localhost:8080/schedules/us/ny?datestamp=2019-05-01&leadname=abc&viceleadname=xyz``` – user293655 Apr 22 '19 at 10:52
@user293655 the spellings of attributes of MyModel in the answer is slight difference have updated in your code? – ArunKumar M N Apr 22 '19 at 10:55
I think there's something wrong with MyModel. I'm using Lombok and when I just use a normal getter and setter your answer is working. Maybe I need something extra that can work with lombok? – user293655 Apr 22 '19 at 11:11
Already did accept your answer. – user293655 Apr 22 '19 at 11:24

Ismail Raju · Answer 2 · 2019-04-22T10:42:04.480

-1

public class Location {

    private String area;
    private String subarea;

    public String getArea() {
        return area;
    }

    public void setArea(String area) {
        this.area = area;
    }

    public String getSubarea() {
        return subarea;
    }

    public void setSubarea(String subarea) {
        this.subarea = subarea;
    }

}





@Controller
@RequestMapping("schedules")
public class SchedulesController {

    @GetMapping("{area}/{subarea}")

    public String getFlight(Location location ) {
        String msg = String.format("location request. area: %s, subarea: %s",
                location.getArea(), location.getSubarea());


        ..............................

        return new MyObject();

    }
}

do like this way. it will work.

edited Apr 22 '19 at 10:42

answered Apr 22 '19 at 10:36

Ismail Raju

154
2
8

What about the request params? – user293655 Apr 22 '19 at 10:44
http://localhost:8080/schedules/Bangladesh/Dhaka – Ismail Raju Apr 22 '19 at 10:52
lombok 1.18.6 also work – Ismail Raju Apr 22 '19 at 11:35

Is it possible to bind path variable and request param into a single object?

2 Answers2

Linked