KnowForge架构
端点注解
师成· 更新于 2026-09-28· 阅读 2 分钟· 0 次阅读登录后可跨设备保存划线和私人笔记登录
组件端点注解
你可以为 Endpoint 和 Component 类添加注解，从而让 Maven 工具通过 Camel Component Maven Plugin 自动生成它们的配置文档，并存放到 src/main/generated 目录中。
随后，这些文档会以 JSON 模式文件的形式被打包进 jar 中。
Camel 项目利用这一机制，自动使网站文档与 Camel 组件中所有最新的选项保持同步。
支持的注解
| 注解 | 说明 |
|---|---|
@UriEndpoint | 指明一个端点使用了 @UriParam 和/或 @UriParams 注解。同时指定生成文档中使用的默认 scheme 以及其他信息。 |
@UriParam | 用于标注参数值；在 Camel 的 URI 字符串中通常通过 ?foo=bar 语法指定。目前仅用于字段声明，但将来也可能用于 setter 方法。如果未指定名称，则使用该字段/setter 属性的名称。 |
@UriParams | 指明某个字段是一个或多个配置参数的嵌套对象；此时该字段所属的类应标注一个或多个 @UriParam 或 @UriParams 注解。 |
@Metadata | 用于特殊场景，提供额外信息。 |
例如，可以参考 camel-timer 组件中的 TimerEndpoint，看看它是如何使用这些注解的。
这些注解不仅对自动生成文档有用；我们还可以利用它们在配置期间对代码进行更精细的校验，同时也有助于工具提供商，使其能更方便地内省（introspect）配置选项。
评论
登录后参与评论
正在加载评论…