AtomUI/docs/controls/desktop/feedback/watermark/implementation.md

Watermark 桌面版实现原理

本文档描述 Watermark 桌面版的内部实现范围、源码职责、状态流、生命周期、资源边界和维护规则。公共设计与 API 契约见 Watermark 桌面版架构设计，变化记录见 Watermark Changelog。Watermark 没有独立 Token 文档；涉及主题变量时应回到 overview 的视觉与主题模型。

1. 实现定位

本文档覆盖 Watermark 的控件实现、主题接入、状态同步和 Gallery 可见维护边界。具体属性注册、默认值、绘制细节和 AXAML selector 仍应直接阅读源码；本文只记录维护者必须理解的稳定结构和不变量。

2. 源码文件结构

主要源码文件：

• src/AtomUI.Controls/Watermark/Glyphs/ImageGlyph.cs
• src/AtomUI.Controls/Watermark/Glyphs/ImageGlyphExtension.cs
• src/AtomUI.Controls/Watermark/Glyphs/TextGlyph.cs
• src/AtomUI.Controls/Watermark/Glyphs/TextGlyphExtension.cs
• src/AtomUI.Controls/Watermark/Glyphs/WatermarkGlyph.cs
• src/AtomUI.Controls/Watermark/Glyphs/WatermarkGlyphExtension.cs
• src/AtomUI.Controls/Watermark/Watermark.cs

职责边界：

• 控件主文件保留 public/protected API、Avalonia 属性注册、事件和主要生命周期入口。
• Theme 文件负责静态视觉结构、template part、selector 和资源绑定。
• Token 文件只提供组件视觉变量，不保存实例状态。
• Gallery 文件只展示用法和示例，不作为运行时逻辑 owner。

3. 核心类职责

• ImageGlyph：控件核心或内部协作类型，维护 public surface 与主题可观察行为。
• ImageGlyphExtension：控件核心或内部协作类型，维护 public surface 与主题可观察行为。
• TextGlyph：控件核心或内部协作类型，维护 public surface 与主题可观察行为。
• TextGlyphExtension：控件核心或内部协作类型，维护 public surface 与主题可观察行为。
• WatermarkGlyph：控件核心或内部协作类型，维护 public surface 与主题可观察行为。
• WatermarkGlyphExtension：控件核心或内部协作类型，维护 public surface 与主题可观察行为。

核心协作规则：

• 控件实例是 public API 和运行时状态 owner。
• Template part 是视觉协作对象，生命周期必须受 OnApplyTemplate 或模板加载流程管理。
• 数据对象、选项对象、任务对象或节点对象只保存业务数据，不应反向持有不可释放的视觉对象。
• 弹层、窗口、计时器、异步 loader 和全局管理器必须有明确关闭、解绑或释放路径。

4. 状态与数据流

Watermark 的状态流遵循下面路径：

Public API / ItemsSource / Command / Event
  -> 控件实例状态
  -> internal state / effective state / pseudo-class
  -> template part property / AXAML selector
  -> renderer / popup / adorner / Gallery observable behavior

源码中的状态入口按以下语义维护：

• 内容与数据：Source、Text。
• 交互与状态：IsCrossUsed、IsMirrorUsed。
• 视觉与布局：FontSize、Foreground、Height、HorizontalOffset、HorizontalSpace、VerticalOffset、VerticalSpace。
• 其他稳定入口：Opacity、Rotate。

维护要求：

• 外部设置的 Avalonia 属性必须在模板应用前后保持一致。
• 集合、选择、展开、过滤、分页、上传任务或异步 loader 必须能处理 reset、replace 和 clear。
• 伪类和 internal state 必须从单一 owner 推导，避免双向同步导致循环更新。
• overview.md 的 API 契约说明应与源码实际状态流一致。

5. 生命周期与模板接入

生命周期规则：

• 构造阶段只注册必要状态，不依赖 template part。
• 模板应用时获取 part、建立事件订阅和绑定，并先释放旧 part 订阅。
• 控件卸载、弹层关闭、窗口关闭、集合替换或 container recycle 时释放事件订阅和资源宿主。
• DynamicResource、TokenResourceBinder 或 C# binding 必须有明确 owner 和释放点。
• WatermarkGlyph 通过 [GenerateScopedResourceHost] 获得资源与主题宿主实现。Watermark 挂入视觉树时挂载目标 资源作用域并订阅 Glyph 变化；脱离、清除 Glyph 或目标迁移时释放对应 attachment 与订阅。
• 共享 Glyph 只有一套属性值，使用最后挂载且仍活动的目标资源。移除当前 owner 后恢复最后一个存活 owner； 移除非当前 owner 不改变当前作用域。生成器仍是宿主事件订阅与解绑的唯一实现，不复制资源转发逻辑。
• 资源解析会同步发布属性变化，owner 在调用 Attach 前保存单次赋值释放槽；同步清除或再次挂载时，外层返回的 token 仍归对应代次释放，不能覆盖内层接管的宿主。装饰层在挂载视觉子级前记录退出所需的层。
• Browser 和 Desktop 宿主下的主题加载顺序不得影响 public API 语义。

稳定 template part 接入点：

• 当前没有显式 template part；维护时仍需检查 ControlTheme key、资源 key 和继承模板契约。

6. 交互与事件处理

Watermark 的交互事件应从输入源收敛到控件级语义事件：

• Pointer、keyboard、focus 和 command 事件不应绕过 Avalonia 基础控件语义。
• 没有弹层职责的路径不应引入额外 popup 或全局输入捕获。
• 集合类路径必须稳定处理 container prepare、clear、过滤、分组和虚拟化回收。
• 输入类路径必须保持 Form、validation、clear、placeholder 和键盘行为一致。

当前没有抽取到控件专属 public 事件；交互语义主要通过继承事件、命令、属性变化和 Gallery 可观察行为体现。

7. 内部算法与关键流程

维护者需要重点关注以下流程：

• API 默认值到 effective state 的归一。
• Template part 重新应用时的状态回放。
• 主题资源、Token 和 SharedToken 计算后的视觉更新。
• ItemsSource、selection、checked、expanded、filter、paging 或 upload task 的集合同步。
• 状态变化时避免创建不必要的视觉对象、订阅或动画对象。

实现文档不逐行解释私有方法。若某个私有算法成为稳定维护入口，应在本节补充算法不变量，而不是把代码复述为说明书。

8. 资源、性能与 AOT 边界

资源和 AOT 约束：

• 不通过运行时反射扫描 public API、Token 或 Gallery 示例数据。
• 不把可静态声明的模板结构迁移到 C# 动态创建。
• 异步加载、上传、弹层和窗口生命周期必须能取消或释放。
• 缓存对象必须与控件、窗口、弹层或数据 owner 生命周期一致。
• Source generator 生成文件不手工编辑；需要修改时改输入源或 generator。
• 非 Visual Glyph 的语言资源、DynamicResource 和 Token 绑定以 Glyph 自身的作用域资源宿主为目标；目标资源优先， Application 仅作为回退。资源或语言变化重新生成 TextGlyph 的格式化文本并使水印失效，不使用静态文本代替动态资源。

性能边界：

• 平铺仅接受有限、正尺寸及正的实际行列步长；负间距仍可叠印，但步长必须能在浮点运算中前进。

• 仅对确切内置 TextGlyph/ImageGlyph，根据字形真实墨迹边界或图片目标矩形的正反旋转并集定位首个可能可见的 行列；用周期余数与布尔相位保持交错/镜像，避免巨大索引的浮点精度损失。自定义 Glyph/子类可在布局尺寸外绘制， 不推断其绘制边界。极密的合法负间距叠印仍按真实图案绘制，不悄悄截断或钳制密度。

• 控件应优先复用 Avalonia 原生虚拟化、模板绑定和资源系统。

• 避免为每次状态变化创建不必要的视觉对象、订阅或动画对象。

• 大集合控件必须保证 container recycle 后不会泄漏旧 item 状态。

9. 维护不变量

维护 Watermark 时不得破坏：

• Public API、默认值、事件顺序和 Gallery 可观察行为。
• Template part 名称、ControlTheme key、伪类和资源 key。
• 旧 template part、事件订阅、Popup/Flyout/Window host 和 collection view 的释放路径。
• Light/Dark、Browser/Desktop 和不同 SizeType 下的主题一致性。
• 控件文档、源码 public surface、Token 类型或生成数据与源码契约的一致性。

10. 测试与验证

推荐验证：

• 纯文档改动运行 git diff --check 并检查相对链接。
• 控件 API 或行为变更运行对应 tests/AtomUI.Desktop.Controls.Tests 或专用包测试。
• DataGrid 相关变更运行 tests/AtomUI.Desktop.Controls.DataGrid.Tests。
• Gallery 示例或源码片段变更运行 tests/AtomUIGallery.Tests。
• AOT、生成器或动态数据路径变更按 Gallery NativeAOT 发布流程验证。