Dapr 入門チュートリアル - ミドルウェア

Dapr を使用すると、一連のミドルウェア コンポーネントを連鎖させることで、カスタム処理パイプラインを定義できます。リクエストは、ユーザー コードにルーティングされる前に、定義されたすべてのミドルウェア コンポーネントを通過し、その後、定義されたミドルウェアを逆の順序で通過してから、クライアントに戻ります。

Dapr ミドルウェア

Dapr ミドルウェア

Dapr サイドカーは起動すると、ミドルウェア処理パイプラインを構築します。デフォルトでは、パイプラインはトレース ミドルウェアと CORS ミドルウェアで構成されます。 Dapr 構成を介して追加されたミドルウェアは、定義された順序でパイプラインに追加され、このパイプラインは、ステータス、pub/sub、サービス呼び出し、バインディング、セキュリティなど、すべての Dapr API エンドポイントに適用されます。

次の構成例では、OAuth 2.0 ミドルウェアと大文字のミドルウェア コンポーネントを使用するカスタム パイプラインを定義します。この場合、すべてのリクエストは OAuth 2.0 プロトコルを介して承認され、ユーザー コードに転送される前に大文字に変換されます。

 apiバージョン: dapr .io / v1alpha1
 種類: 構成
メタデータ:
 名前: パイプライン
名前空間: デフォルト
仕様:
 httpパイプライン:
 ハンドラー:
 - 名前: oauth2
 タイプ: ミドルウェア。 http://www.youtube.com/watch?v=vUyQyYyxc oauth2
 - 名前: 大文字
タイプ: ミドルウェア。 http://www.youtube.com/watch?v=vUyQyYyxc 大文字

他のビルディング ブロック コンポーネントと同様に、ミドルウェア コンポーネントも拡張可能です。 Dapr で現在サポートされているミドルウェアを次の表に示します。

これらのミドルウェア実装のソース コードは、Github リポジトリ https://github.com/dapr/components-contrib/tree/master/middleware/http にあります。

カスタムミドルウェア

Dapr は FastHTTP を使用して HTTP サーバーを実装するため、カスタム HTTP ミドルウェアは FastHTTP ハンドラーとして記述する必要があります。ミドルウェアは、以下に示すようにミドルウェア インターフェイスを実装する必要があります。

 パッケージミドルウェア
輸入（
 「github.com/valyala/fasthttp」
 ）
 タイプミドルウェアインターフェース{
 GetHandler ( メタデータメタデータ) ( func ( h fasthttp . RequestHandler ) fasthttp . RequestHandler , error )
 }

このインターフェースは、fasthttp.RequestHandler とエラーを返す GetHandler メソッドを定義します。カスタム ミドルウェア ハンドラーの実装には、任意のインバウンド ロジックとアウトバウンド ロジックを含めることができます。

 func ( m * customMiddleware ) GetHandler ( metadata メタデータ) ( func ( fasthttp.RequestHandler ) fasthttp.RequestHandler , error ) {
 var err エラー
func ( h fasthttp.RequestHandler ) を返します。 fasthttp . リクエストハンドラ{
 戻り値 func ( ctx * fasthttp . RequestCtx ) {
 h ( ctx )
 }
 }, エラー
}

その後、カスタム ミドルウェア コンポーネントを components-contrib リポジトリに提供できます。 components-contrib があなたの提出を承認したら、Dapr ランタイム リポジトリの https://github.com/dapr/dapr/tree/master/cmd/daprd/components の下にミドルウェア登録ファイルを追加する必要があります。

ミドルウェアの登録

たとえば、大文字ミドルウェアの登録は次のコードに示されています。

 パッケージコンポーネント

輸入（
 「文字列」

 「github.com/valyala/fasthttp」

 「github.com/dapr/components-contrib/middleware」
 httpMiddlewareLoader "github.com/dapr/dapr/pkg/components/middleware/http"
 httpミドルウェア「github.com/dapr/dapr/pkg/middleware/http」
 「github.com/dapr/kit/logger」
 ）
 関数init () {
 ミドルウェアローダー。 デフォルトレジストリ。 RegisterComponent ( func ( log logger . Logger ) httpMiddlewareLoader . FactoryMethod {
 return func ( メタデータミドルウェア.Metadata ) ( httpMiddleware.Middleware , error ) {
 func ( h fasthttp.RequestHandler ) を返します。 fasthttp . リクエストハンドラ{
 戻り値 func ( ctx * fasthttp . RequestCtx ) {
 本文: = 文字列( ctx . PostBody ())
 ctx 。 リクエスト。 SetBody ([] byte ( 文字列.ToUpper ( 本文)))
 h ( ctx )
 }
 }, なし
 }
 }, "大文字" )
 }

しかし、Dapr がミドルウェアの拡張を完全に開放していないこともわかります。ユーザーがメインリポジトリ内のコードを更新するという特定のニーズを持っている場合、必然的に柔軟性は低下しますが、低品質のミドルウェアによって引き起こされる Dapr のさまざまな問題を回避することもできます。

OAuth ミドルウェアの例

次に、Dapr でミドルウェアを使用する方法を説明するために、OAuth ミドルウェアを構成します。 OAuth ミドルウェアを構成することで、アプリケーションを変更せずに Web API で OAuth 認証を有効にします。この設計により、認証/承認の問題がアプリケーションから分離されるため、アプリケーション オペレーターはアプリケーション コードに影響を与えることなく、認証/承認プロバイダーを採用および構成できます。

dapr oauth ミドルウェア

ここでは、K8s クラスターの Ingress コントローラーとして ingress-nginx を使用します。インストールされていない場合は、次の Helm チャートを使用して簡単にインストールできます。

 helm リポジトリにingress - nginx を追加しますhttps://kubernetes.github.io/ingress-nginx
 helm をインストール- リリースingress - nginx / ingress - nginx

まず、以下に示すように、Node.js を使用して開発された echoapp を作成しました。

 express は、 次の例のように機能します。
 const bodyParser = require ( "ボディパーサー" );
 const app = express ();
 アプリ。 bodyParser.json () を使用します。
 ポート= 3000 ;
 アプリ。 取得( "/echo" 、 ( req 、 res ) => {
 var テキスト= req 。 クエリ。 文章;
 console .log ( "エコー中: " + テキスト);
 解像度。 send ( "アクセストークン: " + 要求ヘッダー[ "authorization" ] + " テキスト: " + テキスト);
 });

 アプリ。 listen ( port , () => console . log ( `Node App はポート$ { port } でリッスンしています! ` ));

次に、リクエスト ヘッダー内の認証情報とクライアントのリクエスト テキスト情報を取得するための /echo インターフェイスを作成しました。

次に、Github を使用して認証と承認を実装します。まず、https://github.com/settings/developers にアクセスして、以下に示すように OAuth アプリケーションを登録します。

新しいOAuthアプリケーションを作成する

ここでは、アプリケーションの URL を http://echo.dapr.local として指定します。新しいアプリケーションを登録するには、「アプリケーションの登録」をクリックします。登録後、アプリケーションの詳細ページで clientId 情報を取得できます。 「新しいクライアント シークレットを生成」ボタンをクリックして、clientSecret 情報を手動で取得する必要があります。後で使用するので、2 つのパラメータ値を記録します。

クライアントシークレットを取得する

次に、echoapp アプリケーションを Kubernetes クラスターにデプロイします。対応するリソース リストは次のとおりです。

 apiバージョン: アプリ/ v1
 種類: デプロイメント
メタデータ:
 名前: echoapp
 ラベル:
 アプリ: エコー
仕様:
 セレクター:
 マッチラベル:
 アプリ: エコー
テンプレート：
 メタデータ:
 ラベル:
 アプリ: エコー
注釈:
 ダップル。 io / 有効: "true"
 dapr .io / アプリ- ID : "echoapp"
 dapr .io / アプリ- ポート: "3000"
 dapr .io / config : 「パイプライン」
 仕様:
 コンテナ:
 - 名前: エコー
画像: dapriosamples / ミドルウェア- echoapp : 最新
ポート:
 - コンテナポート: 3000
 imagePullPolicy : 常に
---
 apiバージョン: ネットワーク。 k8s 。 io / v1
 種類: イングレス
メタデータ:
 名前: echo - イングレス
仕様:
 イングレスクラス名: nginx
 ルール:
 - ホスト: エコー。 ダップル。 地元
http://www.google.com/dp ...
 パス:
 - バックエンド:
 サービス：
 名前: echoapp - dapr
 ポート:
 番号： 80
 パス： /
 パスタイプ: プレフィックス

echoapp アプリケーションを公開するために、上記で Ingress オブジェクトを作成したことに注意してください。サービス オブジェクトを積極的に作成するのではなく、echoapp-dapr サービスを直接関連付けたことに注意してください。このサービスのポート 80 は、echoapp アプリケーションの dapr サイドカーのポート 3500 にマップされています。

また、上記のアプリケーションに追加された注釈にも注意してください。これには、使用する構成オブジェクトを指定するために使用される dapr.io/config: "pipeline" が含まれるため、pipeline という名前の構成オブジェクトも作成する必要があります。

 apiバージョン: dapr .io / v1alpha1
 種類: 構成
メタデータ:
 名前: パイプライン
仕様:
 トレース:
 サンプリングレート: "1"
 ジプキン:
 エンドポイントアドレス: "http://zipkin.default.svc.cluster.local:9411/api/v2/spans"
 httpパイプライン:
 ハンドラー:
 - タイプ: ミドルウェア。 http://www.youtube.com/watch?v=vUyQyYyxc oauth2
 名前: oauth2

ここでは、echoapp アプリケーション用に middleware.http.oauth2 タイプのミドルウェアを構成します。対応するプロセッサ名は oauth2 で、これは以下に示すように、Dapr のコンポーネント コンポーネントに対応します。

 apiバージョン: dapr .io / v1alpha1
 種類: コンポーネント
メタデータ:
 名前: oauth2
 仕様:
 タイプ: ミドルウェア。 http://www.youtube.com/watch?v=vUyQyYyxc oauth2
 バージョン: v1
 メタデータ:
 - 名前: クライアントID
 値: "<クライアントID>"
 - 名前: クライアントシークレット
値: "<クライアントシークレット>"
 - 名前: スコープ
価値： ""
 - 名前: authURL
 値: "https://github.com/login/oauth/authorize"
 - 名前: トークンURL
 値: "https://github.com/login/oauth/access_token"
 - 名前: リダイレクトURL
 値: "http://echo.dapr.local"
 - 名前: authHeaderName
 値: "承認"

Dapr OAuth ミドルウェアを使用するには、次の情報を構成する必要があります。

• クライアントID
• クライアントシークレット
• スコープ
• 認証URL
• トークンURL

次の表は、いくつかの一般的な認可サーバーの認可/トークン URL を示しています。

ここでは GitHub の認証サーバー構成を使用します。最後に追加された authHeaderName: authorization プロパティにも注意してください。上記のコードでは、認証値は Header ヘッダーから取得されます。

次に、上記のすべてのリソース オブジェクトを作成します。作成が完了したら、echo.dapr.local ドメイン名を Ingress コントローラーにマップすることを忘れないでください。

 $ kubectl ポッドを取得する
名前準備完了ステータス再起動年齢
echoapp - b7f5469cb - hzvth 2 / 2 実行中0 51 秒
$ kubectl svc を取得します
名前タイプクラスタ- IP 外部- IP ポート( S ) 年齢
echoapp - dapr ClusterIP なし< なし> 80 / TCP 、 50001 / TCP 、 50002 / TCP 、 9090 / TCP 69 m
 $ kubectl get ingress echo - イングレス
名前クラスホストアドレスポート年齢
echo - イングレスnginx echo 。 ダップル。 ローカル192.168 .0 .52 80 59 m

次に、ブラウザに http://echo.dapr.local/v1.0/invoke/echoapp/method/echo?text=hello と入力して、アプリケーションの echo メソッドにアクセスします。通常のアクセス中に、予想外の 502 エラーが発生します。

502 エラー

これは、Dapr 1.4 以降、セキュリティ対策として daprd プロセスがロックダウンされ、ポッド境界内からの接続のみを受け入れるようになっているためです。 Dapr への外部呼び出しを有効にする場合は、アプリケーションに次のアノテーションを追加する必要があります。

 dapr .io / サイドカー- listen - アドレス: "0.0.0.0"

この注釈をデプロイメントに追加します。更新後、http://echo.dapr.local/v1.0/invoke/echoapp/method/echo?text=hello に再度アクセスすると、正常に動作します。最初は、認証のために GitHub にジャンプします。

GitHub 認証

承認後、ページは自動的に戻り、アクセス トークン データやテキスト パラメータの値など、エコー インターフェイスによって返されたデータが通常どおり表示されます。

echo メソッド

この時点で、元のアプリケーションに侵入することなく、Dapr 内のアプリケーションに対して OAuth ミドルウェアが有効になりました。