8.6 KiB
Carousel 桌面版实现原理
本文档描述 Carousel 桌面版的内部实现范围、源码职责、状态流、生命周期、资源边界和维护规则。公共设计与 API 契约见 Carousel 桌面版架构设计,变化记录见 Carousel Changelog。涉及控件 Token 的实现应同时阅读 Carousel Token 设计。
1. 实现定位
本文档覆盖 Carousel 的控件实现、主题接入、状态同步和 Gallery 可见维护边界。具体属性注册、默认值、绘制细节和 AXAML selector 仍应直接阅读源码;本文只记录维护者必须理解的稳定结构和不变量。
2. 源码文件结构
主要源码文件:
src/AtomUI.Desktop.Controls/Carousel/Carousel.cssrc/AtomUI.Desktop.Controls/Carousel/CarouselEnums.cssrc/AtomUI.Desktop.Controls/Carousel/CarouselNavButton.cssrc/AtomUI.Desktop.Controls/Carousel/CarouselPage.cssrc/AtomUI.Desktop.Controls/Carousel/CarouselPageIndicator.cssrc/AtomUI.Desktop.Controls/Carousel/CarouselPagination.cssrc/AtomUI.Desktop.Controls/Carousel/CarouselToken.cssrc/AtomUI.Desktop.Controls/Carousel/Themes/CarouselNavButtonTheme.axamlsrc/AtomUI.Desktop.Controls/Carousel/Themes/CarouselPageIndicatorTheme.axamlsrc/AtomUI.Desktop.Controls/Carousel/Themes/CarouselPageTheme.axamlsrc/AtomUI.Desktop.Controls/Carousel/Themes/CarouselPaginationTheme.axamlsrc/AtomUI.Desktop.Controls/Carousel/Themes/CarouselTheme.axamlsrc/AtomUI.Desktop.Controls/Carousel/VirtualizingCarouselPanel.cs
职责边界:
- 控件主文件保留 public/protected API、Avalonia 属性注册、事件和主要生命周期入口。
- Theme 文件负责静态视觉结构、template part、selector 和资源绑定。
- Token 文件只提供组件视觉变量,不保存实例状态。
- Gallery 文件只展示用法和示例,不作为运行时逻辑 owner。
3. 核心类职责
Carousel:控件核心或内部协作类型,维护 public surface 与主题可观察行为。CarouselNavButton:动作触发类型,负责点击、导航或局部操作状态。CarouselPage:控件核心或内部协作类型,维护 public surface 与主题可观察行为。CarouselPageIndicator:控件核心或内部协作类型,维护 public surface 与主题可观察行为。CarouselPagination:控件核心或内部协作类型,维护 public surface 与主题可观察行为。CarouselToken:控件 Token scope,负责从全局 token 派生控件语义变量。VirtualizingCarouselPanel:布局面板,负责测量、排列、虚拟化或集合内容布局。
核心协作规则:
- 控件实例是 public API 和运行时状态 owner。
- Template part 是视觉协作对象,生命周期必须受
OnApplyTemplate或模板加载流程管理。 - 数据对象、选项对象、任务对象或节点对象只保存业务数据,不应反向持有不可释放的视觉对象。
- 弹层、窗口、计时器、异步 loader 和全局管理器必须有明确关闭、解绑或释放路径。
4. 状态与数据流
Carousel 的状态流遵循下面路径:
Public API / ItemsSource / Command / Event
-> 控件实例状态
-> internal state / effective state / pseudo-class
-> template part property / AXAML selector
-> renderer / popup / adorner / Gallery observable behavior
源码中的状态入口按以下语义维护:
- 内容与数据:继承 ItemsControl 的
Items/ItemsSource与CarouselPage容器。 - 选择与集合:
IsSelected、PageInEasing、PageOutEasing、PageTransitionDuration。 - 交互与状态:
IsAutoPlay、IsInfinite、IsMotionEnabled、IsShowNavButtons、IsShowPagination、IsShowTransitionProgress、IsSwipeEnabled。 - 视觉与布局:
PaginationPosition。 - 动效与异步:
AutoPlaySpeed、TransitionEffect。
维护要求:
- 外部设置的 Avalonia 属性必须在模板应用前后保持一致。
- 集合、选择、展开、过滤、分页、上传任务或异步 loader 必须能处理 reset、replace 和 clear。
- 伪类和 internal state 必须从单一 owner 推导,避免双向同步导致循环更新。
- overview.md 的 API 契约说明应与源码实际状态流一致。
5. 生命周期与模板接入
生命周期规则:
- 构造阶段只注册必要状态,不依赖 template part。
- 模板应用时获取 part、建立事件订阅和绑定,并先释放旧 part 订阅。
- 控件卸载、弹层关闭、窗口关闭、集合替换或 container recycle 时释放事件订阅和资源宿主。
- DynamicResource、TokenResourceBinder 或 C# binding 必须有明确 owner 和释放点。
- Browser 和 Desktop 宿主下的主题加载顺序不得影响 public API 语义。
稳定 template part 接入点:
PART_Frame:承载根视觉、边框、背景或尺寸基线。PART_ItemsPresenter:展示用户内容、文本、图标或模板化数据。PART_NextButton:承载用户触发入口、导航或关闭动作。PART_Pagination:稳定模板协作入口,重命名前必须同步主题和实现。PART_PreviousButton:承载用户触发入口、导航或关闭动作。PART_ScrollViewer:稳定模板协作入口,重命名前必须同步主题和实现。
6. 交互与事件处理
Carousel 的交互事件应从输入源收敛到控件级语义事件:
- Pointer、keyboard、focus 和 command 事件不应绕过 Avalonia 基础控件语义。
- 没有弹层职责的路径不应引入额外 popup 或全局输入捕获。
- 集合类路径必须稳定处理 container prepare、clear、过滤、分组和虚拟化回收。
- 值提交或命令触发必须保持继承控件的事件顺序。
当前没有抽取到控件专属 public 事件;交互语义主要通过继承事件、命令、属性变化和 Gallery 可观察行为体现。
7. 内部算法与关键流程
维护者需要重点关注以下流程:
- API 默认值到 effective state 的归一。
- Template part 重新应用时的状态回放。
- 主题资源、Token 和 SharedToken 计算后的视觉更新。
- ItemsSource、selection、checked、expanded、filter、paging 或 upload task 的集合同步。
- 动效启停、初始加载阶段 transition 抑制和卸载取消。
AutoPlay 由 Carousel 持有的单个 DispatcherTimer 驱动,选中页的进度由 CarouselPageIndicator 的 Avalonia animation 驱动。Carousel attach 后跟踪自身及 Visual 祖先链;有效不可见时停止 autoplay timer。PageIndicator 同时取消并把 progress 归零;重新可见后 timer 与 progress 从同一周期重新启动,避免页面恢复时进度条与实际切页时机错位。detach 时释放 timer 可见性订阅、progress cancellation 和 animation 状态。
实现文档不逐行解释私有方法。若某个私有算法成为稳定维护入口,应在本节补充算法不变量,而不是把代码复述为说明书。
8. 资源、性能与 AOT 边界
资源和 AOT 约束:
- 不通过运行时反射扫描 public API、Token 或 Gallery 示例数据。
- 不把可静态声明的模板结构迁移到 C# 动态创建。
- 异步加载、上传、弹层和窗口生命周期必须能取消或释放。
- 缓存对象必须与控件、窗口、弹层或数据 owner 生命周期一致。
- Source generator 生成文件不手工编辑;需要修改时改输入源或 generator。
性能边界:
- 控件应优先复用 Avalonia 原生虚拟化、模板绑定和资源系统。
- 避免为每次状态变化创建不必要的视觉对象、订阅或动画对象。
- 隐藏祖先下的 Carousel 不推进 autoplay timer 或选中页 progress animation。
- 大集合控件必须保证 container recycle 后不会泄漏旧 item 状态。
9. 维护不变量
维护 Carousel 时不得破坏:
- 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 发布流程验证。