Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

47.5. 引数名の置換

概要
リンクのコピー

API コンポーネントフレームワークでは、URI オプション名が 各プロキシークラス (Java API クラス) 内で一意 である必要があります。しかし、メソッドの引数名の場合は、必ずしもそうとは限りません。たとえば、API クラスの以下の Java メソッドを考えてみましょう。 

public void doSomething(int id, String name);
public void doSomethingElse(int id, String name);
Copy to Clipboard Toggle word wrap

Maven プロジェクトのビルド時、camel-api-component-maven-plugin は設定クラス ProxyClassEndpointConfiguration を生成します。これには、ProxyClass クラスの すべて の引数の getter および setter メソッドが含まれます。たとえば、上記のメソッドを指定すると、プラグインは設定クラスに以下の getter メソッドと setter メソッドを生成します。 

public int  getId();
public void setId(int id);
public String getName();
public void   setName(String name);
Copy to Clipboard Toggle word wrap

ただし、以下の例のように、id 引数が異なるタイプとして複数回表示された場合はどうなるでしょうか。 

public void doSomething(int id, String name);
public void doSomethingElse(int id, String name);
public String lookupByID(String id);
Copy to Clipboard Toggle word wrap

この場合、コードの生成に失敗します。これは、int を返す getId メソッドと、String を返す getId メソッドを同じスコープで定義できないためです。この問題に対する解決策は、引数名の置換 を使用して、引数名と URI オプション名のマッピングをカスタマイズすることです。

構文
リンクのコピー

substitutions 要素は、以下のように 1 つ以上の substitution 子要素で定義できます。 

<substitutions>
  <substitution>
    <method>MethodPattern</method>
    <argName>ArgumentNamePattern</argName>
    <argType>TypeNamePattern</argType>
    <replacement>SubstituteArgName</replacement>
    <replaceWithType>[true|false]</replaceWithType>
  </substitution>
  ...
</substitutions>
Copy to Clipboard Toggle word wrap

argType 要素と replaceWithType 要素は任意であり、省略できます。

Scope
リンクのコピー

以下の抜粋で示されているように、substitutions 要素は、任意で apis 要素の子や api 要素の子として表示できます。 

<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
      <substitutions>...</substitutions>
    </api>
    <substitutions>...</substitutions>
    ...
  </apis>
</configuration>
Copy to Clipboard Toggle word wrap

以下のスコープで substitutions 要素を定義できます。

  • api 要素の子として: substitutions は、api 要素で指定された API クラスにのみ適用されます。
  • apis 要素の子として: substitutions は、デフォルトですべての API クラスに適用されますが、api レベルで上書きできます。

子要素
リンクのコピー

各 substitution 要素は以下の子要素で定義できます。

method
Java API のメソッド名と一致する正規表現 (java.util.regex 構文) を指定します。
argName
正規表現 (java.util.regex 構文) を指定して、一致したメソッドの引数名とマッチさせます。通常、パターンにはキャプチャーグループが含まれます。
argType
(任意) 引数の型に一致する正規表現 (java.util.regex 構文) を指定します。replaceWithType オプションを true に設定した場合、通常はこの正規表現でキャプチャーグループを使用します。
replacement
method パターン、argName パターン、および (任意の) argType パターンに一致する場合、replacement 要素は代替の引数名を定義します (URI で使用)。代替テキストは、argName 正規表現パターンから取得した文字列を使用して作成できます (構文 $1、$2、$3 を使用して、それぞれ第 1、第 2、第 3 のキャプチャーグループを挿入します)。または、replaceWithType オプションを true に設定した場合は、argType 正規表現パターンから取得した文字列を使用して代替テキストを作成することもできます。
replaceWithType
true の場合、代替テキストが argType 正規表現から取得した文字列を使用して作成されるように指定します。デフォルトは false です。

例
リンクのコピー

以下の置換例は、接尾辞 Param を引数名に追加して、java.lang.String タイプのすべての引数を変更します。 

<substitutions>
  <substitution>
    <method>^.+$</method>
    <argName>^.+$</argName>
    <argType>java.lang.String</argType>
    <replacement>$1Param</replacement>
    <replaceWithType>false</replaceWithType>
  </substitution>
</substitutions>
Copy to Clipboard Toggle word wrap

たとえば、次のようなメソッドの署名があるとします。 

public String greetUs(String name1, String name2);
Copy to Clipboard Toggle word wrap

このメソッドの引数は、エンドポイント URI でオプション name1Param および name2Param で指定されます。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat