素敵なサムシングを独断と偏見で一方的に紹介するブログ(´・ω・`)

IT

【SpringBoot2】レスポンスヘッダーに独自の項目を追加する方法【X-Request-ID】

投稿日:

スポンサーリンク

336×280




カスタムヘッダーも簡単に設定可能

SpringBootを使ってAPI開発をしている場合、簡単にレスポンスヘッダーへ独自項目を追加する事が可能です。

今回は以前の記事でログに含めるために発行したX-Request-IDを、全リクエスト時のレスポンスヘッダーに自動で追加する方法をご紹介致します。

例えば、アプリから呼ばれるAPIなどのシステムの場合は、お問い合わせ時やシステムエラーのフィードバック時サーバーから返ってきたX-Request-IDを含ませる事で、容易にサーバーログを絞る事が出来るためよりスピーディーにログ調査が行えます。

手順

OncePerRequestFilterを継承したFilterクラスを実装

まずは、前回のフィルターで発行されたX-Request-IdMDCから取得し、レスポンスヘッダーに追加するFilterクラスを実装しましょう。

ConfigurationクラスでBean定義

次に、前回作ったConfigurationクラスにて新たにBeanとして追加しましょう。

準備はこれだけです!

確認

では、実際に確認してみましょう。

サーバーログX-Request-IDレスポンスヘッダーX-Request-IDの値が同じになっていますね♪

もちろん、独自エラーのスロー時やシステムエラー時にもレスポンスヘッダーに追加されているので調査が捗りそうです。

オススメの商品

Spring Boot 2 プログラミング入門

日清 カップヌードル 77g×20個

終わりに

以上のように、簡単なクラスを追加するだけでログ調査が何倍もやりやすくなります。

何も仕込んでないログを漁るのは地獄なので、是非X-Request-IDを仕込んでみてください♪

336×280




336×280




CATEGORIES & TAGS

IT, , , , , , , , ,

blogenist

Author: blogenist