What to return if Spring MVC controller method doesn't return value?

Question

I am using jQuery's $.getJSON() to make asynchronous calls to my simple Spring MVC backend. Most of the Spring controller methods look like this:

@RequestMapping(value = "/someURL", method = RequestMethod.POST)
public @ResponseBody SomePOJO getSomeData(@ModelAttribute Widget widget,
    @RequestParam("type") String type) {
    return someDAO.getSomeData(widget, type);
}

I have things set up so that each controller returns the @ResponseBody as JSON, which is what the client-side expects.

But what happens when a request isn't supposed to return any content to the client-side? Can I have:

@RequestMapping(value = "/updateSomeData" method = RequestMethod.POST)
public @ResponseBody void updateDataThatDoesntRequireClientToBeNotified(...) {
    ...
}

If not, what's the appropriate syntax to use here?

I assume if you don't return anything, there will not be any content sent back? — arahant
– arahant, Commented Oct 11, 2012 at 11:28
I think I'd still return a POJO of some sort, even if in Version 1 of your solution it just wraps a "success" boolean or something similar. Then you've got a consistent pattern in all your AJAX methods, and something that's easier to build on when it turns out you do need to return something! — millhouse
– millhouse, Commented Oct 11, 2012 at 11:32
Contrary to what the answers are suggestion, what you first had in your second snippet is perfectly fine and the correct way to handle POST data. — Brett Ryan
– Brett Ryan, Commented Dec 19, 2013 at 4:36

Gonzalo.- · Accepted Answer · 2018-04-20 18:50:11Z

284

you can return void, then you have to mark the method with @ResponseStatus(value = HttpStatus.OK) you don't need @ResponseBody

@RequestMapping(value = "/updateSomeData" method = RequestMethod.POST)
@ResponseStatus(value = HttpStatus.OK)
public void updateDataThatDoesntRequireClientToBeNotified(...) {
    ...
}

Only get methods return a 200 status code implicity, all others you have do one of three things:

Return void and mark the method with @ResponseStatus(value = HttpStatus.OK)
Return An object and mark it with @ResponseBody
Return an HttpEntity instance

edited Apr 20, 2018 at 18:50

Gonzalo.-

12.7k5 gold badges53 silver badges84 bronze badges

answered Oct 11, 2012 at 12:43

ams

63.3k74 gold badges213 silver badges297 bronze badges

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

7 Comments

Brett Ryan Over a year ago

Actually, you do not need to set @ResponseStatus and shouldn't. Simply having @ResponseBody on a void handler is fine enough.

raspacorp Over a year ago

I think it will be better to return a 204 No Content instead of a 200 for void methods

Brett Ryan Over a year ago

@raspacorp 200 is correct for POST as it's not meant to have a body.

raspacorp Over a year ago

@BrettRyan just as a comment, at least for a REST API it is a common practice that a POST will be used for creating content in which case it usually returns the id of the created enity(s), the full created entities or a link to the read operation. A 200 status return with no content could be confusing from a REST API perspective.

Sagar Gangwal Over a year ago

@ams If i am not using both (@ResponseBody AND @ResponseStatus(value = HttpStatus.OK)) the option then what would be happen???

|

Biju Kunjummen · Accepted Answer · 2012-10-11 12:42:26Z

46

You can simply return a ResponseEntity with the appropriate header:

@RequestMapping(value = "/updateSomeData" method = RequestMethod.POST)
public ResponseEntity updateDataThatDoesntRequireClientToBeNotified(...){
....
return new ResponseEntity(HttpStatus.OK)
}

answered Oct 11, 2012 at 12:42

Biju Kunjummen

50.1k14 gold badges117 silver badges126 bronze badges

4 Comments

sauce Over a year ago

Incase anyone ran into the same problem I did, this didn't work on an older version of spring (4.1.1) I would get 500 errors. I upgraded to 4.2.0 and this works great

GreenTurtle Over a year ago

That's my prefered way of returning empty 200 as well. Since Spring 4.1 use the builder pattern instead: return ResponseEntity.ok().build();

Gonzalo.- Over a year ago

Although seems to compile, it gives the following warning ResponseEntity is a raw type. References to generic type ResponseEntity<T> should be parameterized

tequilacat Over a year ago

I use ResponseEntity<?> as return type. No warnings, any response type can be returned

Harley · Accepted Answer · 2015-08-13 18:41:01Z

10

You can return "ResponseEntity" object. Using "ResponseEntity" object is very convenient both at the time of constructing the response object (that contains Response Body and HTTP Status Code) and at the time of getting information out of the response object.

Methods like getHeaders(), getBody(), getContentType(), getStatusCode() etc makes the work of reading the ResponseEntity object very easy.

You should be using ResponseEntity object with a http status code of 204(No Content), which is specifically to specify that the request has been processed properly and the response body is intentionally blank. Using appropriate Status Codes to convey the right information is very important, especially if you are making an API that is going to be used by multiple client applications.

answered Aug 13, 2015 at 18:41

Harley

5625 silver badges8 bronze badges

1 Comment

aliopi Over a year ago

setting @ResponseStatus(HttpStatus.NO_CONTENT) solved XML Parsing Error: no root element found for me in the browser

user1338062 · Accepted Answer · 2015-05-19 05:53:14Z

5

Yes, you can use @ResponseBody with void return type:

@RequestMapping(value = "/updateSomeData" method = RequestMethod.POST)
@ResponseBody
public void updateDataThatDoesntRequireClientToBeNotified(...) {
    ...
}

answered May 19, 2015 at 5:53

user1338062

13k4 gold badges77 silver badges67 bronze badges

2 Comments

Sandeep Pandey Over a year ago

so what will be the return type.. is it HTTP status code?

Lakatos Gyula Over a year ago

@techBeginner In this case 200 (OK).

Victor · Accepted Answer · 2013-09-12 15:36:19Z

But as your system grows in size and functionality... i think that returning always a json is not a bad idea at all. Is more a architectural / "big scale design" matter.

You can think about returing always a JSON with two know fields : code and data. Where code is a numeric code specifying the success of the operation to be done and data is any aditional data related with the operation / service requested.

Come on, when we use a backend a service provider, any service can be checked to see if it worked well.

So i stick, to not let spring manage this, exposing hybrid returning operations (Some returns data other nothing...).. instaed make sure that your server expose a more homogeneous interface. Is more simple at the end of the day.

Brett Ryan · Accepted Answer · 2013-12-19 04:35:11Z

2

There is nothing wrong with returning a void @ResponseBody and you should for POST requests.

Use HTTP status codes to define errors within exception handler routines instead as others are mentioning success status. A normal method as you have will return a response code of 200 which is what you want, any exception handler can then return an error object and a different code (i.e. 500).

answered Dec 19, 2013 at 4:35

Brett Ryan

28.4k35 gold badges135 silver badges172 bronze badges

Comments

Abe · Accepted Answer · 2023-03-06 16:57:26Z

0

HttpStatus is required.

@ResponseStatus(value = HttpStatus.OK)
public void update(...) {
    ...
}

or ResponseEntity with null body and null header.

public ResponseEntity<Void> delete(@PathVariable Long id) {
    return new ResponseEntity<>(HttpStatus.NO_CONTENT);
}

answered Mar 6, 2023 at 16:57

Abe

71611 silver badges24 bronze badges

Comments

selllami · Accepted Answer · 2023-03-16 23:45:57Z

0

You can use Void class:

The Void class is an uninstantiable placeholder class to hold a reference to the Class object representing the Java keyword void.

@GetMapping
public ResponseEntity<Void> method() {
   return ResponseEntity.status(HttpStatus.OK)
          .build();
}

answered Mar 16, 2023 at 23:45

selllami

3374 silver badges17 bronze badges

Collectives™ on Stack Overflow

What to return if Spring MVC controller method doesn't return value?

8 Answers 8

7 Comments

4 Comments

1 Comment

2 Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

8 Answers 8

7 Comments

4 Comments

1 Comment

2 Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related