概要
Spring Cloud Gatewayの紹介をしようと思って書いてたら高輪ゲートウェイ開通の記事が目に入って勢いでタイトルを決めました。
品川ー田町間に新しく出来たTakanawa GatewayをSpring Cloud GatewayのRoute Predicate Factoriesを使って実装していきます。
Spring Cloud Gatewayとは
Spring Projectが提供しているAPI Gatewayになります。application.yamlを設定するだけでわりと自由なルーティングが実現できたり、通過するリクエストのヘッダーをカスタマイズしたり、サーキットブレーカーを利用できたりと色々な機能が提供できます。
プロジェクトの作成
Spring Initializrから作ります。
DependenciesにGatewayを入れる以外はお好きな設定をお選びください。
Routingの実装
プロジェクトを作成してダウンロードしたら、src/main/resources/application.yamlファイルを作成し、Takanawa Gatewayにふさわしいルーティング設定を入れていきます。
田町駅へルーティングする
まずは田町へのルートを確保します。Spring Cloud Gatewayではpredicatesという項目にルーティングする条件を書いていきます。条件なしは作れないので、ここではMethod Route Predicate Factorを使いGETメソッドを対象として田町へルーティングします。
spring:
cloud:
gateway:
routes:
- id: tamachi
uri: http://tamachi:8081
predicates:
- Method=GET
idとuriはご自身の環境に合わせたものをお選びください。この例では盛り上げるためにlocalhostのHostsを各種書き換えています。
この状態でアプリケーションを起動し、呼び出してあげます。
$ curl http://takanawa-gateway:8080/
Tamachi Station.⏎
これで田町駅と繋がることができました。
駅が開業する2020/3/14以降しか通さない
高輪ゲートウェイが開業したのは2020/03/14です。なので、それより前の時間帯で駅が使えてはいけません。
After Route Predicate Factoryを使って制限をかけます。
spring:
cloud:
gateway:
routes:
- id: tamachi
uri: http://tamachi:8081
predicates:
- Method=GET
- After=2020-03-14T00:00:00.000+09:00[Asia/Tokyo]
これで、3/14以前のリクエストは弾くことができるようになります。この記事を書いている時間ではすでに高輪ゲートウェイが開業してしまっているので、システム日付をいじって3/13にしてからTakanawaGatewayを呼び出してみます。
$ curl http://takanawa-gateway:8080/
{"timestamp":"2020-03-13T13:31:36.812+0000","path":"/","status":404,"error":"Not Found","message":null,"requestId":"05652ab6-1"}⏎
日付を戻して3/14以降にすると通過することが出来ます。
$ date;curl http://takanawa-gateway:8080/
2020年 3月18日 水曜日 22時33分01秒 JST
Tamachi Station.⏎
JR山手線しか通さないようにする
高輪ゲートウェイは山手線の駅なので、山手線以外の路線から使えてはいけません。
そこで、JR-Yamanote-LineというHTTPヘッダーが含まれていなければTakanawa Gatewayを通過させないようにします。
HTTPヘッダーによる制御はHeader Route Predicate Factoryにて実現できます。
spring:
cloud:
gateway:
routes:
- id: tamachi
uri: http://tamachi:8081
predicates:
- Method=GET
- After=2020-03-14T00:00:00.000+09:00[Asia/Tokyo]
- Header=JR-Yamanote-Line
これにより、山手線占用のヘッダーがない場合アクセスは弾かれてしまいます。
# JR-Yamanote-Lineヘッダーが無い
$ curl http://takanawa-gateway:8080/
{"timestamp":"2020-03-18T13:37:22.660+0000","path":"/","status":404,"error":"Not Found","message":null,"requestId":"83ea59d6-1"}⏎
# JR-Yamanote-Lineヘッダーがある(値問わず)
$ curl -H "JR-Yamanote-Line:true" http://takanawa-gateway:8080/
Tamachi Station.⏎
品川駅にも行けるようにする
山手線に問わず、終点以外のほとんどの駅には上りと下りがあります。今は田町にしか行けない片道状態ですが、当然品川にも行けるようにしてあげないといけません。
そこで、Hostヘッダーを見てルーティング先を品川か田町か決めてあげます。
ここではHost Route Predicate Factoryを利用します。
spring:
cloud:
gateway:
routes:
- id: tamachi
uri: http://tamachi:8081
predicates:
- Method=GET
- After=2020-03-14T00:00:00.000+09:00[Asia/Tokyo]
- Header=JR-Yamanote-Line
- Host=tamachi
- id: shinagawa
uri: http://shinagawa:8082
predicates:
- Method=GET
- After=2020-03-14T00:00:00.000+09:00[Asia/Tokyo]
- Header=JR-Yamanote-Line
- Host=shinagawa,**
これで品川駅にも行けるようになりました！今回はワイルドカードも入れているので、田町以外のHostヘッダーの場合は行き先がすべて品川になります。
$ curl -H "JR-Yamanote-Line:true" -H "Host:tamachi" http://takanawa-gateway:8080/
Tamachi Station.⏎ $ curl -H "JR-Yamanote-Line:true" -H "Host:shinagawa" http://takanawa-gateway:8080/
Shinagawa Station.⏎ $ curl -H "JR-Yamanote-Line:true" http://takanawa-gateway:8080/
Shinagawa Station.⏎
まとめ
Spring Cloud GatwayのRoute Predicate Factoriesを使った簡単なルーティング例を上げてみました。紹介した以外にも様々な機能を持っており、自前の認証ヘッダーを挟むためにGlobal Filterを実装してあげるなど、独自の実装を求められる場面などでも活躍します。興味を持った人は是非使ってみてください。
そして、高輪ゲートウェイ開業おめでとうございます！！
リファレンス