概要
Muleの例外処理についてまとめてみました。とはいってもエラーレベルとOn Error Continue、On Error Propagateの組み合わせによる動きの違いについての簡単な説明のみになります。
エラーレベル
-
Muleディフォルトのディフォルトエラーハンドラー
Muleのディフォルトのエラーハンドラー。アプリケーションで処理されないエラーを処理します。カスタマイズ不可。 -
アプリケーションレベル
アプリケーションの共通のエラーハンドラー。共通のMule設定ファイル(global.xml)に例外処理を指定することで、各フロー共通のエラーの指定が可能となります。 -
フローレベル
フロー単位の共通エラーハンドラー。 -
プロセッサーレベル
フローの処理内にTry-Catchの形で埋め込まれるエラーハンドラーです。
On Error ContinueとOn Error Propagate
-
On Error Continue
payloadを返します。親フローには正常な結果として戻され、以降の処理が行われます。 -
On Error Propagate
Errorオブジェクトを返します。親フローには例外がスローされ、以降の処理は行われません。
動かしてみて確認
準備
検証用に簡単なMuleアプリケーションを作成します。こんな感じ。
- HTTP Listnerコネクターを配置
- Connector Configurationはディフォルトのまま、新規作成
- General→Pathは「/errorhandling/」と指定
- Loggerを配置してください。
- Validation is Numberを配置
- General > Valueに「attributes.queryParams.value」と指定
- Error option > Messageに「error message」
- Set payloadを配置。Setting > Valueに「no error」と設定します。
- 以下のURLにアクセスして動作確認。
http://localhost:8081/errorhandling?value=1
以下が返却されればOKです。- status：200 OK
- body：no error
動作確認
Muleディフォルトのディフォルト
- パラメーター「Value」の値を「a」に変更してアクセス。
http://localhost:8081/errorhandling?value=a - 以下で応答が戻ってきます。
- status：500 server error
- body：error message
アプリケーションで何のエラー処理もしないと、Muleディフォルトのエラーハンドラーによって処理されます。
アプリケーションレベル
- アプリケーション共通のエラーハンドラーを追加します。
- フロー以外のところにError Handlerを配置します。（通常は共通用の別XMLファイル（global.xml）に配置します。）
- 配置したError HandlerをGlobal Elements > ConfigurationでDefault Error Handlerに指定します。
- 配置したError Handler内にOn Error Propagateを配置します。
- On Error Propagate内にSet Payloadを配置します。Setting > Valueに「global error propagate」と指定します。
- Set Payloadの横にLoggerを配置します。
- 先ほどと同じURLでアクセス。以下が返却されます。
-
status：500 server error
-
body：error message
**先ほどと同じ結果となります。**が、これは作成したアプリケーションレベルのエラーハンドラーで処理した結果となります。（ブレークポイントを貼ってデバッグすれば確かにこの処理を行っています。）戻ってくる結果が変わらないのは、On Error Propagateの動作によるものです。詳しい理由はOn Error Continueの動作確認後に説明します。
続いてOn Error Continueエラーハンドラーの動作を確認します。
- On Error Propagateの下にOn Error Propagateと同じ感じでOn Error Continueを配置します。Payloadの値は「global error continue」としてください。また、On Error PropagateのSettings > Typeで「EXPRESSION」などを指定してください。（「VALIDATION:INVALID_NUMBER」をキャッチしないような指定をしてください。）
- 先ほどと同じURLでアクセス。以下が返却されます。
-
status：200 OK
-
body：global error continue
結果が変わります。これはOn Error Continueの場合、正常な結果をpalyoadとして返却するためです。一方、On Error Propagateの場合は、エラーとしてErrorオブジェクトが返却されます。そのため、On Error Propagateのset payloadで値を変更しても結果に反映されないまま、エラーステータスが返却されます。
エラーオブジェクトの内容はこんな感じです。is Numberで指定したmessageがdescriptionとして設定されています。
フローレベル
続いてフローレベルの動作確認です。flowにエラーハンドラーを追加します。
- フロー内のError HandlerにOn Error Propagateを配置します。
- On Error Propagate内にSet Payloadを配置します。Setting > Valueに「flow error propagate」と指定します。
- Set Payloadの横にLoggerを配置します。
- 先ほどと同じURLでアクセス。以下が返却されます。
- status：500 server error
- body：error message
debugモードで実施してみてください。フローレベルのOn Error Propagateで処理がされ、アプリケーションレベルのError処理では処理されていないことがわかります。
さらに、フローレベルのOn Error Continueの動きを見てみましょう。
- フローレベルのOn Error Propagateの下にOn Error Propagateと同じ感じにOn Error Continueを配置します。Payloadの値は「flow error continue」としてください。また、On Error PropagateのSettings > Typeで「EXPRESSION」などを指定してください。（「VALIDATION:INVALID_NUMBER」をキャッチしないような指定をしてください。）
- 先ほどと同じURLでアクセス。以下が返却されます。
- status：200 OK
- body：flow error continue
フローレベルのOn Error Continueの処理の結果が返却されることが確認できるかと思います。
プロセッサーレベル
最後にプロセッサーレベルのエラー処理になります。
- Tryをis Numberの前に配置し、is NumberをTry内に移動します。
- Set PayloadをTryのError Handling内に配置します。Payloadの値は「processor error propagate」としてください。
- Set Payloadに横にLoggerを配置します。
- 先ほどと同じURLでアクセス。以下の応答が返却されます。
- status：200 OK
- body：flow error continue
これまでの流れからすると、プロセッサーレベルのOn Error Propagateで処理が終了しそうですが、プロセッサーレベルのOn Error Propagateだと、一つ上のエラー処理に処理がスローされます。ここではフローレベルのOn Error ContinueがプロセッサーレベルのOn Error Propagateの結果をキャッチして処理をします。
では、プロセッサーレベルのOn Error Continueの動きを確認してみましょう。
- プロセッサーレベルのOn Error Propagateの下にOn Error Propagateと同じ感じでOn Error Continueを配置します。Payloadの値は「processor error continue」としてください。また、On Error PropagateのSettings > Typeで「EXPRESSION」などを指定してください。（「VALIDATION:INVALID_NUMBER」をキャッチしないような指定をしてください。）
- 先ほどと同じURLでアクセス。以下が返却されます。
- status：200 OK
- body：no error
そうです。Is Numberの例外をプロセッサーレベルのOn Error Continueでキャッチし、On Error Continue内の処理を行った後、そのまま正常な処理として次の処理（Set Payload）へ流れます。
以上でMuleの例外処理のまとめとなります。特に複雑な動きをするわけではないですが、組み合わせによって、「あれ？」となりがちだったりしたので、基本的なところをまとめてみました。