spring bootアプリケーションで処理に失敗した場合の戻り値を設定したい

Question

前提・実現したいこと

spring bootを使ったWebApiの勉強をしています。
ファイルの中身を書き換えるという機能を作っているのですが、その途中で一つわからないことがあります。

@GetMapping("/test")
	public ResponseEntity<String> test(@RequestBody String str) {
		
		log.debug("ファイル書き換え：開始");
		try {
			// ファイルを書き換える処理
		}catch (Exception e) {
			return ResponseEntity.ok(str + "の書き換えに失敗しました");
			// 本当は失敗した場合のステータスコードを返す処理を書きたい
		}
		log.debug("ファイル書き換え：終了");
		return ResponseEntity.ok(str + "に書き換えました");
		
	}

今作っているのがこんな感じです。

ファイルの書き換えに成功した場合はこの通り書き換えが完了したメッセージを受け取るので良いのですが、
何らかの例外が発生し、ファイルの書き換えに失敗した場合に今はStringのメッセージを受け取ってでしか処理がうまくいったのかどうかが判別できません。

調べたらステータスコードで処理の成否を判定するのが一般的とあったのですがどうすれば200以外のステータスコードが返せるでしょうか？(Advanced REST clientを使って動作を見ていますが今は200 OKと返した文字列が返ってきています)

また、こういう場合にどんなステータスコードを返すべきなのかも教えていただけるとありがたいです。

Answer 1

調べたらステータスコードで処理の成否を判定するのが一般的とあったのですがどうすれば200以外のステータスコードが返せるでしょうか？

たとえば、HTTPステータス 500を返したい場合は

return new ResponseEntity<String>(str + "の書き換えに失敗しました", HttpStatus.INTERNAL_SERVER_ERROR);

とします。

詳しくは

• ResponseEntity
• HttpStatus

をご確認ください。

こちらの記事も分かりやすく解説されています。

Spring Boot のデフォルトエラーメッセージを制御したい

また、こういう場合にどんなステータスコードを返すべきなのかも教えていただけるとありがたいです。

エラーの原因がサーバー側にある場合、Statusコードは5xx番台を使うことが一般的だと思いますが、この質問の例（ファイルの書き込み先が存在しない、書き込み権限が無い等の理由で失敗した）で言えば、HTTP Statusコード 500 (Internal Server Error)を返すのが適切だと思います。

また、Rest APIではHTTP Statusコードの他に、クライアント側へ詳細なエラー情報を伝えるために、アプリケーションの仕様として決めたエラーレスポンスを返すこともあります。

下記は一例になりますが、ResponseEntity<ResponseMessage>のインスタンスを返すと

@Data
@Builder
class ResponseMessage {
	private String code;
	private String message;
}

return new ResponseEntity<ResponseMessage>(
	ResponseMessage.builder().code("メッセージコード").message("メッセージ詳細").build(),
	HttpStatus.INTERNAL_SERVER_ERROR);

クライアントにこのようなJSONがHTTP Status 500で返ります。

{"code":"エラーコード","message":"メッセージ詳細"}