Mule SDK 開発のベストプラクティス
このドキュメントの目的は、Mule Runtime Engine (Mule) の機能を最大限に活用し、MuleSoft の UX と品質のガイドラインに沿ってモジュールやコネクタを開発するためのベストプラクティスを Mule SDK のユーザーに提供することです。
用語
このドキュメントでは次の用語を使用します。
- Connector (コネクタ)
-
外部システムとの接続を確立するモジュール。コネクタはモジュールです。
- 大きな文字列
-
サイズが 4 KB を超える文字列。
- Module (モジュール)
-
Mule SDK で開発し、Mule 4 の機能を拡張するプラグイン。
- Mule 言語
-
XML ベースのドメイン特有言語 (DSL) で、Mule アプリケーションの開発で使用し、操作の内部でモジュールを呼び出します。
- 「しなければなりません」/「してはなりません」
-
「しなければなりません」/「してはなりません」は厳密なルールを意味します。つまり、ベストプラクティスに準拠するためには、「する必要がある」と指示されているすべてのプラクティスを実践しなければなりません。
- 「するべきです」/「するべきではありません」
-
「するべきです」/「するべきではありません」は、推奨されるルールではあるものの、場合によっては省略することも可能で、省略した場合でもベストプラクティスには準拠できることを意味します。
対象システム:: コネクタがアクセスするリソース。
- ユーザー
-
「ユーザー」は、Mule SDK (モジュールを開発するためのシステム) のユーザーではなく、開発されたモジュールを消費するエンドユーザーを指します。すべてのベストプラクティスは、エンドユーザーのエクスペリエンスを改善することを最終的な目的としています。
MuleSoft のコーディングプラクティス
SDK を使用して新しいモジュールやコネクタを作成する場合は、API、ライブラリ、または機能の断片を Mule が理解できるコンポーネントに単純にラップするというアプローチを採るべきではありません。
その代わりに「Mule というプログラミング言語を拡張する」というアプローチを採るべきです。
C プログラミング言語や自分の Java フレームワークで新しいライブラリを作成する場合であれば、ライブラリを消費する C または Java の開発者が、ライブラリに一貫性があってエコシステム特有のすべてのルールやガイドラインに準拠していることを実感できるように、ライブラリの API、構文、セマンティクスを設計するでしょう。これを怠ると、一貫性や明確さが期待通りではなくなり、ライブラリのユーザーを失望させることになります。
カスタム Mule モジュールやコネクタの開発でも同じことが言えます。モジュールやコネクタは、単に Mule ブリッジを作成することで開発するのではなく、一貫性があり、使いやすく、他の要素と相互に関連性を持つ方法で機能を追加する、Mule 言語の拡張として開発する必要があります。