Springフレームワークを使用してカスタム応答フレーズを設定するにはどうすればよいですか？

Question

私はSpringフレームワークを使用してJavaでRESTfulなサービスを開発しています。私のサービス層で例外が発生した場合は、Httpステータスコードにバインドされた例外がスローされます。たとえば、ユーザーの認証が失敗すると、401のステータスコードで応答を送信します。

return new ResponseEntity<>(HttpStatus.valueOf(statusCode)); 

私は、RESTfulサービスの消費者に対して、コードだけでなくテキストの説明を送信する彼の要求に間違っていることを説明したいと思います。レスポンスボディにカスタムメッセージを追加するか、デフォルトのレスポンスフレーズを置き換えることで、これを行うことができます。たとえば、401の場合はUnauthorizedをUser does not existまたはIncorrect passwordに置き換えます。

問題はHttpStatusからorg.springframework.httpまでです。エラーコードはテキスト応答フレーズにバインドされています。

どういうわけかそれらの応答フレーズを無効にすることができますか、別の方法が必要ですか？

デフォルトのレスポンスフレーズを置き換えることをお勧めしますか、説明メッセージをレスポンスボディに入れる方が良いでしょうか？

Answer 1

これは動作するはずです：

まず、あなたはそれがのMediaTypeがjavax.ws.rs.core.MediaTypeこれは、テキスト、プレーンな応答を生成しますインポートからであるあなたの@RequestMappingに produces = {MediaType.TEXT_PLAIN}を追加することによって生成型にリクエストメソッドをバインドすることができます。

次に、返信することができます。 return new ResponseEntity<>(message, HttpStatus.UNAUTHORIZED);ここで、メッセージは表示するテキストメッセージです。