How to return 404 response status in Spring Boot @ResponseBody - method return type is Response?

Question

I'm using Spring Boot with @ResponseBody based approach like the following:

@RequestMapping(value = VIDEO_DATA_PATH, method = RequestMethod.GET) public @ResponseBody Response getData(@PathVariable(ID_PARAMETER) long id, HttpServletResponse res) { Video video = null; Response response = null; video = videos.get(id - 1); if (video == null) { // TODO how to return 404 status } serveSomeVideo(video, res); VideoSvcApi client = new RestAdapter.Builder() .setEndpoint("http://localhost:8080").build().create(VideoSvcApi.class); response = client.getData(video.getId()); return response; } public void serveSomeVideo(Video v, HttpServletResponse response) throws IOException { if (videoDataMgr == null) { videoDataMgr = VideoFileManager.get(); } response.addHeader("Content-Type", v.getContentType()); videoDataMgr.copyVideoData(v, response.getOutputStream()); response.setStatus(200); response.addHeader("Content-Type", v.getContentType()); }

I tried some typical approaches as:

res.setStatus(HttpStatus.NOT_FOUND.value());
new ResponseEntity(HttpStatus.BAD_REQUEST);

but I need to return Response.

How to return here 404 status code if video is null?

dur · Accepted Answer · 2021-05-20 09:47:33Z

186

This is very simply done by throwing org.springframework.web.server.ResponseStatusException:

throw new ResponseStatusException( HttpStatus.NOT_FOUND, "entity not found" );

It's compatible with @ResponseBody and with any return value. Requires Spring 5+

edited May 20, 2021 at 9:47

dur

17.3k26 gold badges93 silver badges146 bronze badges

answered Feb 5, 2019 at 17:08

andrej

4,8132 gold badges41 silver badges40 bronze badges

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

5 Comments

GreenAsJade Over a year ago

Is there some way of doing this without causing Springboot to issue a warning? I get ` WARN 27604 --- [nio-8081-exec-9] .w.s.m.a.ResponseStatusExceptionResolver : Resolved [org.springframework.web.server.ResponseStatusException: 404 NOT_FOUND ` which finds its way into alerts etc unreasonably: this is not a problem.

andrej Over a year ago

@GreenAsJade I am not sure where is this warning logged (I have not seen this warning in my logs) but maybe you can play with log4j settings or talk to your alert system to avoid this.

BuffK Over a year ago

This is not the best, your visitors will see the error stack information.

andrej Over a year ago

@BuffK this is for web services (talking to machines)

Mindaugas Bernatavičius Over a year ago

This requires overring the /error endpoint.

chrylis -cautiouslyoptimistic- · Accepted Answer · 2018-06-29 19:27:20Z

110

Create a NotFoundException class with an @ResponseStatus(HttpStatus.NOT_FOUND) annotation and throw it from your controller.

@ResponseStatus(code = HttpStatus.NOT_FOUND, reason = "video not found") public class VideoNotFoundException extends RuntimeException { }

edited Jun 29, 2018 at 19:27

answered Aug 21, 2014 at 9:17

chrylis -cautiouslyoptimistic-

77.5k21 gold badges127 silver badges167 bronze badges

4 Comments

Jean-Marc Astesana Over a year ago

Need the standard imports means:import org.springframework.http.HttpStatus;

chrylis -cautiouslyoptimistic- Over a year ago

@andrej That's a good solution some of the time, but (1) ResponseStatusException was not added until Spring 5; (2) A NotFoundException can be useful for either being caught or for a dual-stack HTML UI with an @ExceptionHandler.

Stefan Haberl Over a year ago

This solution tightly couples the Exception to your REST-Controller layer. Something I would want to avoid. I'd use an @ExceptionHandler in an @AroundAdvice component instead

George Pantazes Over a year ago

If someone wants to use a preexisting exception that comes with Spring, org.springframework.data.rest.webmvc.ResourceNotFoundException already is annotated with @ResponseStatus(HttpStatus.NOT_FOUND)

Ege Kaan Gürkan · Accepted Answer · 2024-09-28 16:00:50Z

40

Your original method can return ResponseEntity (doesn't change your method behavior):

@RequestMapping(value = VIDEO_DATA_PATH, method = RequestMethod.GET) public ResponseEntity getData(@PathVariable(ID_PARAMETER) long id, HttpServletResponse res) { ... }

and return the following:

return new ResponseEntity(HttpStatus.NOT_FOUND);

edited Sep 28, 2024 at 16:00

Ege Kaan Gürkan

2,9132 gold badges15 silver badges24 bronze badges

answered Aug 21, 2014 at 9:24

Amazia Gur

1,72217 silver badges17 bronze badges

4 Comments

Vince Over a year ago

To be precise, you should return ResponseEntity<T>, where T is for example Response (first case in question). And you'll return new ResponseEntity(myResponse, HttpStatus.OK) when it is a correct response.

rogerdpack Over a year ago

This way allows you to set headers as well, ResponseStatus doesn't, woot!

GreenAsJade Over a year ago

Another good thing about this is it doesn't result in warnings in the log, which throwing the ResponseStatusException does.

cs94njw Over a year ago

But then you lose the type on the Response, which won't work well with Swagger generated documentation.

Michał · Accepted Answer · 2018-01-17 21:22:59Z

You can just set responseStatus on res like this:

@RequestMapping(value = VIDEO_DATA_PATH, method = RequestMethod.GET) public ResponseEntity getData(@PathVariable(ID_PARAMETER) long id, HttpServletResponse res) { ... res.setStatus(HttpServletResponse.SC_NOT_FOUND); // or res.setStatus(404) return null; // or build some response entity ... }

Collectives™ on Stack Overflow

How to return 404 response status in Spring Boot @ResponseBody - method return type is Response?

4 Answers 4

5 Comments

4 Comments

4 Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

5 Comments

4 Comments

4 Comments

Comments

Linked

Related