Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

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>
  <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 元素是可选的，可以省略。

影响范围
复制链接

如以下提取所示，replaces 元素可以选择性地显示为 apis 元素和/或作为 api 元素子元素的子级： 

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

您可以在以下范围中定义 replaces 元素：

  • 作为 api 元素的子级 ，替换 只应用于由 api 元素指定的 API 类。
  • 作为 apis 元素的子级 ，默认情况下，替换 适用于所有 API 类，但可以在 api 级别被覆盖。

子元素
复制链接

每个 替换 元素可使用以下子元素定义：

方法
指定正则表达式(java.util.regex 语法)，以匹配 Java API 的方法名称。
argName
指定正则表达式(java.util.regex 语法)，以匹配匹配方法中的参数名称，其中模式通常包含捕获组。
argType
（可选） 指定正则表达式(java.util.regex 语法)以匹配参数的类型。如果将 replaceWithType 选项设置为 true，则通常使用捕获此正则表达式中的组。
replacement
假设 方法 模式、argName 模式和 （可选） argType 模式的特定匹配，则 替换 元素定义替换参数名称（用于 URI）。可以使用从 argName 正则表达式模式捕获的字符串构建替换文本（使用语法 $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

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat