AtomUI/docs/controls/desktop/data-display/empty/implementation.md

Empty 桌面版实现原理

本文档描述 Empty 桌面版的内部实现范围、源码职责、状态流、生命周期、资源边界和维护规则。公共设计与 API 契约见 Empty 桌面版架构设计，公开主题区域见 Empty Semantic Part 契约，变化记录见 Empty Changelog。涉及控件 Token 的实现应同时阅读 Empty Token 设计。

1. 实现定位

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

2. 源码文件结构

主要源码文件：

• src/AtomUI.Controls/Empty/AbstractEmpty.cs
• src/AtomUI.Controls/Empty/BuiltInImageBuilder.cs
• src/AtomUI.Controls/Empty/PresetEmptyImage.cs
• src/AtomUI.Desktop.Controls/Empty/Empty.cs
• src/AtomUI.Desktop.Controls/Empty/Empty.SemanticParts.cs
• src/AtomUI.Desktop.Controls/Empty/EmptyToken.cs
• src/AtomUI.Desktop.Controls/Empty/Themes/EmptyTheme.axaml

职责边界：

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

3. 核心类职责

• AbstractEmpty：跨平台或共享基类，承载公共 API、状态归一和模板生命周期。
• Empty：控件核心或内部协作类型，维护 public surface 与主题可观察行为。
• EmptyToken：控件 Token scope，负责从全局 token 派生控件语义变量。

核心协作规则：

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

4. 状态与数据流

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

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

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

• 内容与数据：Description、Footer、FooterTemplate、ImagePath、ImageSource、IsDescriptionVisible、PresetImage。
• 视觉与布局：SizeType、StrokeDashArray 以及继承的 root 表面属性。

维护要求：

• 外部设置的 Avalonia 属性必须在模板应用前后保持一致。
• Footer 与 FooterTemplate 替换由 ContentPresenter 原生内容生命周期管理，不保留旧 Control 或 DataTemplate 产物。
• 图片来源互斥检查和 _svg 更新仍由 AbstractEmpty 单一 owner 管理。
• overview.md 的 API 契约说明应与源码实际状态流一致。

5. 生命周期与模板接入

生命周期规则：

• 构造阶段只注册必要状态，不依赖 template part。
• 模板应用时获取 part、建立事件订阅和绑定，并先释放旧 part 订阅。
• 控件卸载、弹层关闭、窗口关闭、集合替换或 container recycle 时释放事件订阅和资源宿主。
• DynamicResource、TokenResourceBinder 或 C# binding 必须有明确 owner 和释放点。
• Browser 和 Desktop 宿主下的主题加载顺序不得影响 public API 语义。

稳定 template part 接入点：

• PART_SvgImage：稳定模板协作入口，重命名前必须同步主题和实现。

Semantic marker 与真实节点映射：

Part	Marker 节点	创建方式	可见性/内容状态
root	Empty owner	控件实例	由 owner 属性控制，不使用 .semantic-root。
image	PART_SvgImage	ControlTemplate 静态创建	始终存在；图片来源变化只更新 renderer。
description	描述 TextBlock	ControlTemplate 静态创建	IsDescriptionVisible 通过 TemplateBinding 控制可见性。
footer	Footer ContentPresenter	ControlTemplate 静态创建	Footer=null 时隐藏，非空时展示内容。

三个非 root marker 均使用静态 Classes.semantic-*="True"。默认主题不能用这些 class 驱动自身样式；生成的 EmptyImageStyle、EmptyDescriptionStyle 和 EmptyFooterStyle 只供应用侧定制。

ControlTemplate 使用一个不带 Semantic marker 的表面 DashedBorder 投影 owner 的 Background、BorderBrush、 BorderThickness、CornerRadius、Padding 和 StrokeDashArray，内部 StackPanel 只负责纵向排列三个非 root 区域。两者都属于 Composition Model，不是额外 Semantic Part。

6. 交互与事件处理

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

• Pointer、keyboard、focus 和 command 事件不应绕过 Avalonia 基础控件语义。
• 没有弹层职责的路径不应引入额外 popup 或全局输入捕获。
• 集合类路径必须稳定处理 container prepare、clear、过滤、分组和虚拟化回收。
• 值提交或命令触发必须保持继承控件的事件顺序。

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

7. 内部算法与关键流程

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

1. OnApplyTemplate 获取新的 PART_SvgImage，执行图片来源互斥检查，并把当前来源与主题颜色应用到新 renderer。
2. PresetImage、ImagePath、ImageSource 或图形颜色变化时，更新同一个 renderer，不更换 image Semantic target。
3. IsDescriptionVisible 由 AXAML TemplateBinding 直接投影到 description 节点，避免 C# 可见性同步状态。
4. Footer 与 FooterTemplate 由 AXAML ContentPresenter 直接消费，Footer 的显示状态由 Footer != null 决定。
5. root 的标准背景、边框、圆角、Padding 和虚线节奏由模板表面 DashedBorder 直接投影，不需要 C# 状态同步。
6. SizeType selector 只更新 image 高度和 description margin；Footer 使用独立稳定间距 Token。

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

8. 资源、性能与 AOT 边界

资源和 AOT 约束：

• 不通过运行时反射扫描 public API、Token 或 Gallery 示例数据。
• 不把可静态声明的模板结构迁移到 C# 动态创建。
• 异步加载、上传、弹层和窗口生命周期必须能取消或释放。
• 缓存对象必须与控件、窗口、弹层或数据 owner 生命周期一致。
• Source generator 生成文件不手工编辑；需要修改时改输入源或 generator。

性能边界：

• 控件应优先复用 Avalonia 原生虚拟化、模板绑定和资源系统。
• 避免为每次状态变化创建不必要的视觉对象、订阅或动画对象。
• Footer 内容替换依赖 Avalonia ContentPresenter 的标准 logical/visual ownership，不额外缓存内容 Control。

9. 维护不变量

维护 Empty 时不得破坏：

• Public API、默认值、事件顺序，以及新增 Footer/FooterTemplate 的内容语义。
• 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 发布流程验证。

Empty 专项测试必须覆盖 descriptor 字段、静态 marker、三种图片来源、描述可见性、Footer 内容/模板替换、三档 SizeType、 re-template 和应用级生成 Style 命中。Empty 不涉及 Popup、跨 VisualRoot、运行时 marker 或反射发现，单控件阶段不要求额外 NativeAOT publish；批次收尾仍执行 Gallery NativeAOT 验证。