评论者 [(${author.name})] 评论了您的文章 [(${subject.title})]，内容如下：
[(${props.comment})]
``` 参考 [Halo 默认通知模板 YAML](https://github.com/halo-dev/halo/blob/58fbb339d49511e221ec760478490e1c880f7d2a/application/src/main/resources/extensions/notification-templates.yaml) #### 通知模板设计小技巧与最佳实践 ##### 合理使用占位符 在通知模板中，使用占位符来动态插入事件数据是提高模板灵活性的关键。占位符的设计应遵循以下规则： - 使用清晰的命名：占位符应具有明确的含义，例如 `[(${quoteReplyName})]` 表示引用回复的名称，让代码更具可读性，建议使用 `CamelCase` 命名规范，不要使用嵌套对象作为变量如 `subject.title`。 - 避免嵌套复杂表达式：为了避免通知生成的内容过于复杂，建议在模板中尽量使用简单的占位符。复杂逻辑应在事件触发时处理，尽量保持模板的简洁。 - 确保属性完整性：占位符应与 ReasonType 中定义的属性一致，避免由于属性缺失导致的通知发送错误。 ##### 提供多种格式的内容 在 Halo 中，不同的通知渠道可能支持不同格式的内容，建议模板中同时提供纯文本和 HTML 格式，以便适应各类通知渠道需求。 - 纯文本格式：适合即时通讯类应用消息和短信通知，尽量简洁明了，关注重点信息。 - HTML 格式：适合富文本展示渠道，如邮件通知。HTML 模板可使用简单的样式和链接，帮助用户更好地理解通知内容。 - 适配不同渠道的内容：对于可能发送到多渠道的通知，可以在不同格式中包含适合该渠道的具体内容，如 HTML 中使用 `` 标签提供链接，而纯文本只展示简洁的链接地址。 - 如果在模板中需要用到日期，建议提前将其格式化为带时区的日期字符串，避免在模板中使用复杂的日期格式化。 ##### 模板语法 Halo 使用 Thymeleaf 模板引擎来渲染通知模板，开发者可以在模板中使用 Thymeleaf 的语法来处理模板中的逻辑和数据。 - 对于纯文本如标题和 `rawBody`，使用 Thymeleaf 的 [Textual syntax](https://www.thymeleaf.org/doc/tutorials/3.1/usingthymeleaf.html#textual-syntax) 语法来引用变量和表达式。 其取值格式为：`[(${expression})]`，例如 `[(${title})]`。 - 对于 HTML 内容如 `htmlBody`，使用 Thymeleaf 的 [Standard syntax](https://www.thymeleaf.org/doc/tutorials/3.1/usingthymeleaf.html#standard-syntax) 语法。 其取值格式为：`${expression}`，例如 `${title}`。 #### 模板渲染与发送 在通知事件触发时，Halo 通知中心会查找与该事件 `ReasonType` 匹配的 `NotificationTemplate`，并将事件数据填充到模板中生成最终通知内容。 没有定义模板的事件将无法发送通知，因此为每个 `ReasonType` 定义模板是保证通知发送成功的前提。 可以有多个相同的 `reasonSelector` 绑定到同一个事件类型，比如 `reasonType=new-comment-on-post`且 `language=default` 的模板存在多个，Halo 会**选择最近创建的模板**。 根据这个特点，**插件或主题开发者可以提供自己的通知模板以覆盖默认的通知模板**。 在生成通知内容时，系统还会提供一些额外的全局属性（如 `site.title` 等），这些属性可以在模板中直接使用： | 字段名 | 类型 | 说明 | | ------------------------ | -------- | -------------- | | `site.title` | `string` | 站点标题 | | `site.subtitle` | `string` | 站点副标题 | | `site.logo` | `string` | 站点 Logo URL | | `site.url` | `string` | 站点外部访问地址 | | `subscriber.displayName` | `string` | 订阅者显示名称 | | `subscriber.id` | `string` | 订阅者唯一标识符 | | `unsubscribeUrl` | `string` | 退订地址，用于取消订阅的链接 | ## 触发通知事件 在 Halo 系统中，通知功能的核心是通过触发特定的事件，生成相应的 Reason 实例，然后通过系统的通知机制将该事件通知给订阅者。 Halo 提供了 `NotificationReasonEmitter` 接口，开发者可以通过它轻松触发通知事件，将业务逻辑与通知机制结合起来。 ### 工作机制 `NotificationReasonEmitter` 的作用是简化事件触发和通知的处理流程，它的主要职责是： - 接收业务事件的参数，生成 `Reason` 实例。 - 将 `Reason` 实例与 `ReasonType` 进行匹配，触发事件。 - 通过 Halo 的通知系统，将事件推送给订阅了该事件的用户。 定义参考 [NotificationReasonEmitter](https://docs.halo.run/developer-guide/plugin/basics/server/object-management.md#notificationreasonemitter) - `reasonType`：事件类型的名称，对应于 `ReasonType` 的 `metadata.name` 字段。 - `reasonData`：事件数据的构建器，用于构建 `Reason` 实例的属性。 Reason 数据的构建器有以下属性： ```java public class ReasonPayloadBuilder { private Reason.Subject subject; private UserIdentity author; private Map