web-dev-qa-db-ja.com

Spring Boot @ResponseBodyで404応答ステータスを返す方法-メソッドの戻り値のタイプはResponseですか?

次のような@ResponseBodyベースのアプローチでSpring Bootを使用しています。

@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());
}

私はいくつかの典型的なアプローチを試しました:

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

しかし、私は Response を返す必要があります。

ビデオがnullの場合、ここに404ステータスコードを返す方法は?

25
nazar_art

@ResponseStatus(HttpStatus.NOT_FOUND)アノテーションを使用してNotFoundExceptionクラスを作成し、コントローラーからスローします。

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

これはorg.springframework.web.server.ResponseStatusException:をスローすることで非常に簡単に実行されます。

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

@ResponseBodyおよび任意の戻り値と互換性があります。 Spring 5以降が必要

23
andrej

元のメソッドはResponseEntityを返すことができます(メソッドの動作を変更しません):

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

そして次を返します:

return new ResponseEntity(HttpStatus.NOT_FOUND);
23
amazia

次のようにresにresponseStatusを設定するだけです。

@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
 ...
}
3
Michał