Passing multiple variables in RequestBody to a Spring MVC controller using Ajax

Question

Is it necessary to wrap in a backing object  I want to do this    RequestMapping value     Test   method   RequestMethod POST   ResponseBody public boolean getTest  RequestBody String str1   RequestBody String str2       And use a JSON like this          str1    test one        str2    two test      But instead I have to use     RequestMapping value     Test   method   RequestMethod POST   ResponseBody public boolean getTest  RequestBody Holder holder       And then use this JSON          holder              str1    test one            str2    two test            Is that correct  My other option would be to change the RequestMethod to GET and use  RequestParam in query string or use  PathVariable with either RequestMethod

User · Answer

While it s true that  RequestBody must map to a single object  that object can be a Map  so this gets you a good way to what you are attempting to achieve  no need to write a one off backing object     RequestMapping value     Test   method   RequestMethod POST   ResponseBody public boolean getTest  RequestBody Map lt String  String gt  json         json get  str1       test one      You can also bind to Jackson s ObjectNode if you want a full JSON tree   public boolean getTest  RequestBody ObjectNode json         json get  str1   asText       test one

User · Answer

The easy solution is to create a payload class that has the str1 and the str2 as attributes      Getter  Setter public class ObjHolder   String str1  String str2       And after you can pass   RequestMapping value     Test   method   RequestMethod POST   ResponseBody public boolean getTest  RequestBody ObjHolder Str       and the body of your request is          str1    test one        str2    two test

User · Answer

You can also use a MultiValue Map to hold the requestBody in   here is the example for it        foosId - gt  pathVariable     user - gt  extracted from the Map of request Body    unlike the  RequestBody annotation when using a Map to hold the request body we need to annotate with  RequestParam  and send the user in the Json RequestBody     RequestMapping value    v1 test foos  foosId    method   RequestMethod POST  headers    Accept application                  json               consumes   MediaType APPLICATION JSON UTF8 VALUE               produces   MediaType APPLICATION JSON UTF8 VALUE       ResponseBody     public String postFoos  PathVariable final Map lt String  String gt  pathParam               RequestParam final MultiValueMap lt String  String gt  requestBody            return  Post some Foos     pathParam get  foosId           requestBody get  user

User · Answer

request parameter exist for both GET and POST  For Get it will get appended as query string to URL but for POST it is within Request Body

User · Answer

Good  I suggest creating a Value Object  Vo  that contains the fields you need  The code is simpler  we do not change the functioning of Jackson and it is even easier to understand  Regards

User · Answer

I have adapted the solution of Biju   import java io IOException   import javax servlet http HttpServletRequest   import org apache commons io IOUtils  import org springframework core MethodParameter  import org springframework web bind support WebDataBinderFactory  import org springframework web context request NativeWebRequest  import org springframework web method support HandlerMethodArgumentResolver  import org springframework web method support ModelAndViewContainer   import com fasterxml jackson databind JsonNode  import com fasterxml jackson databind ObjectMapper    public class JsonPathArgumentResolver implements HandlerMethodArgumentResolver       private static final String JSONBODYATTRIBUTE    JSON REQUEST BODY        private ObjectMapper om   new ObjectMapper          Override     public boolean supportsParameter MethodParameter parameter            return parameter hasParameterAnnotation JsonArg class               Override     public Object resolveArgument MethodParameter parameter  ModelAndViewContainer mavContainer  NativeWebRequest webRequest  WebDataBinderFactory binderFactory  throws Exception           String jsonBody   getRequestBody webRequest            JsonNode rootNode   om readTree jsonBody           JsonNode node   rootNode path parameter getParameterName                  return om readValue node toString    parameter getParameterType                 private String getRequestBody NativeWebRequest webRequest           HttpServletRequest servletRequest   webRequest getNativeRequest HttpServletRequest class            String jsonBody    String  webRequest getAttribute JSONBODYATTRIBUTE  NativeWebRequest SCOPE REQUEST           if  jsonBody  null               try                   jsonBody   IOUtils toString servletRequest getInputStream                     webRequest setAttribute JSONBODYATTRIBUTE  jsonBody  NativeWebRequest SCOPE REQUEST                 catch  IOException e                    throw new RuntimeException e                                   return jsonBody              What s the different    I m using Jackson to convert json I don t need a value in the annotation  you can read the name of the parameter out of the MethodParameter I also read the type of the parameter out of the Methodparameter    so the solution should be generic  i tested it with string and DTOs    BR

User · Answer

Instead of using json  you can do simple thing     post    pageContext servletContext contextPath  Test                                      str1    test one                    str2    two test                             lt other form data gt                                     function j                                             lt j is the string you will return from the controller function  gt                        Now in the controller you need to map the ajax request as below     RequestMapping value   Test   method RequestMethod POST       ResponseBody     public String calculateTestData  RequestParam  str1   String str1   RequestParam  str2   String str2  HttpServletRequest request  HttpServletResponse response                lt perform the task here and return the String result  gt               return  xyz       Hope this helps you

User · Answer

Not sure where you add the json but if i do it like this with angular it works without the requestBody  angluar       const params  HttpParams   new HttpParams   set  str1   val1   set  str2    val2        return this http post lt any gt   this urlMatch   params     observe   response         java    PostMapping URL MATCH  public ResponseEntity lt Void gt  match Long str1  Long str2      log debug  found     and      str1  str2

User · Answer

For passing multiple object  params  variable and so on  You can do it dynamically using ObjectNode from jackson library as your param  You can do it like this way    RequestMapping value     Test   method   RequestMethod POST   ResponseBody public boolean getTest  RequestBody ObjectNode objectNode          And then you can call parameters from objectNode    String strOne   objectNode get  str1   asText       String strTwo   objectNode get  str2   asText           When you using ObjectNode  you can pas other data such as        instance object  array list  nested object  etc      I hope this help

User · Answer

You are correct   RequestBody annotated parameter is expected to hold the entire body of the request and bind to one object  so you essentially will have to go with your options   If you absolutely want your approach  there is a custom implementation that you can do though   Say this is your json          str1    test one        str2    two test      and you want to bind it to the two params here    RequestMapping value     Test   method   RequestMethod POST  public boolean getTest String str1  String str2    First define a custom annotation  say  JsonArg  with the JSON path like path to the information that you want   public boolean getTest  JsonArg   str1   String str1   JsonArg   str2   String str2    Now write a Custom HandlerMethodArgumentResolver which uses the JsonPath defined above to resolve the actual argument   import java io IOException   import javax servlet http HttpServletRequest   import org apache commons io IOUtils  import org springframework core MethodParameter  import org springframework http server ServletServerHttpRequest  import org springframework web bind support WebDataBinderFactory  import org springframework web context request NativeWebRequest  import org springframework web method support HandlerMethodArgumentResolver  import org springframework web method support ModelAndViewContainer   import com jayway jsonpath JsonPath   public class JsonPathArgumentResolver implements HandlerMethodArgumentResolver       private static final String JSONBODYATTRIBUTE    JSON REQUEST BODY        Override     public boolean supportsParameter MethodParameter parameter            return parameter hasParameterAnnotation JsonArg class               Override     public Object resolveArgument MethodParameter parameter  ModelAndViewContainer mavContainer  NativeWebRequest webRequest  WebDataBinderFactory binderFactory  throws Exception           String body   getRequestBody webRequest           String val   JsonPath read body  parameter getMethodAnnotation JsonArg class  value             return val             private String getRequestBody NativeWebRequest webRequest           HttpServletRequest servletRequest   webRequest getNativeRequest HttpServletRequest class           String jsonBody    String  servletRequest getAttribute JSONBODYATTRIBUTE           if  jsonBody  null               try                   String body   IOUtils toString servletRequest getInputStream                     servletRequest setAttribute JSONBODYATTRIBUTE  body                   return body                catch  IOException e                    throw new RuntimeException e                                   return                Now just register this with Spring MVC  A bit involved  but this should work cleanly

User · Answer

you can also user  RequestBody Map lt String  String gt  params then use params get  key   to get the value of parameter

User · Answer

You can mix up the post argument by using body and path variable for simpler data types    RequestMapping value    new-trade portfolio  portfolioId    method   RequestMethod POST      public ResponseEntity lt List lt String gt  gt  newTrade  RequestBody Trade trade   PathVariable long portfolioId

User · Answer

You can achieve what you want by using  RequestParam  For this you should do the following    Declare the RequestParams parameters that represent your objects and set the required option to false if you want to be able to send a null value  On the frontend  stringify the objects that you want to send and include them as request parameters  On the backend turn the JSON strings back into the objects they represent using Jackson ObjectMapper or something like that  and voila    I know  its a bit of a hack but it works

User · Answer

RequestParam is the HTTP GET or POST parameter sent by client  request mapping is a segment of URL which s variable   http  host form edit param1 val1 amp param2 val2   var1  amp  var2 are request params   http  host form  params     params  is a request mapping  you could call your service like   http  host form user or http  host form firm where firm  amp  user are used as Pathvariable

[java] Passing multiple variables in @RequestBody to a Spring MVC controller using Ajax

Examples related to java

Examples related to spring

Examples related to http

Examples related to spring-mvc