> For the complete documentation index, see [llms.txt](https://docs.zongsoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zongsoft.com/framework.md).

# 框架指南

- [核心类库](https://docs.zongsoft.com/framework/core.md): Zongsoft.Core 核心类库的职责和主要命名空间。
- [Zongsoft.Caching](https://docs.zongsoft.com/framework/core/caching.md): Zongsoft.Caching 命名空间的职责和主要类型。
- [缓存](https://docs.zongsoft.com/framework/core/caching/memory-cache.md): MemoryCache 进程内缓存、过期策略、依赖令牌和淘汰事件。
- [缓冲器](https://docs.zongsoft.com/framework/core/caching/spooler.md): 从框架日志实现和现有测试理解批量缓冲、触发条件、并发刷新与数据消费。
- [Zongsoft.Collections](https://docs.zongsoft.com/framework/core/collections.md): Zongsoft.Collections 命名空间的职责和主要类型。
- [分层类](https://docs.zongsoft.com/framework/core/collections/category.md): Category 分类树及 CategoryBase、CategoryCollection、CategoryCollectionBase 的用法。
- [层次化](https://docs.zongsoft.com/framework/core/collections/hierarchical.md): Hierarchical 层级节点、节点集合、路径查找和层级表达式。
- [参数集](https://docs.zongsoft.com/framework/core/collections/parameters.md): Parameters 参数包、类型键、字符串键、链式构建和 JSON 序列化。
- [同步集合](https://docs.zongsoft.com/framework/core/collections/synchronized.md): SynchronizedList 和 SynchronizedDictionary 同步集合。
- [集合扩展](https://docs.zongsoft.com/framework/core/collections/extensions.md): Enumerable、CollectionUtility、DictionaryUtility 以及集合扩展方法。
- [Zongsoft.Common](https://docs.zongsoft.com/framework/core/common.md): Zongsoft.Common 命名空间的职责和主要类型。
- [聚合异常](https://docs.zongsoft.com/framework/core/common/aggregate-exception-utility.md): AggregateExceptionUtility 聚合异常处理工具。
- [注解工具](https://docs.zongsoft.com/framework/core/common/annotation-utility.md): AnnotationUtility 成员注解读取工具。
- [位向量](https://docs.zongsoft.com/framework/core/common/bit-vector.md): BitVector32 和 BitVector64 位标记结构。
- [缓冲工具](https://docs.zongsoft.com/framework/core/common/buffer.md): Buffer 内存租赁、编码解码和二进制读取工具。
- [校验码](https://docs.zongsoft.com/framework/core/common/checksum.md): Checksum 校验和结构的计算、解析和验证。
- [类型转换](https://docs.zongsoft.com/framework/core/common/convert.md): Convert 类型转换和十六进制转换工具。
- [枚举工具](https://docs.zongsoft.com/framework/core/common/enum-utility.md): EnumUtility 和 EnumEntry 枚举元数据工具。
- [分层向量](https://docs.zongsoft.com/framework/core/common/hierarchy-vector32.md): HierarchyVector32 四级层级编码结构。
- [异步锁](https://docs.zongsoft.com/framework/core/common/locker.md): Locker 同步和异步互斥锁。
- [通知](https://docs.zongsoft.com/framework/core/common/notification.md): Notification 变更令牌工具。
- [操作异常](https://docs.zongsoft.com/framework/core/common/operation-exception.md): OperationException 操作异常。
- [断言](https://docs.zongsoft.com/framework/core/common/predication.md): 从安全模块事件与日志过滤说明可组合的条件断言。
- [随机器](https://docs.zongsoft.com/framework/core/common/randomizer.md): 以 Discussions 的正文文件名说明随机字符串的真实用途。
- [序号器](https://docs.zongsoft.com/framework/core/common/sequence.md): 以 Discussions 映射中的外部序号和站点分域说明生成责任。
- [计时器](https://docs.zongsoft.com/framework/core/common/timer.md): 通过框架已有 TimerTest 理解周期回调、取消、停止与释放。
- [时间戳](https://docs.zongsoft.com/framework/core/common/timestamp.md): 以 Discussions 附件命名理解纪元与经过时间。
- [验证器](https://docs.zongsoft.com/framework/core/common/validator.md): 从框架安全模块的密码策略验证器理解结果、失败信息和调用上下文。
- [类型别名](https://docs.zongsoft.com/framework/core/common/type-alias.md): TypeAlias 类型别名、泛型类型、可空类型和数组类型解析。
- [常用扩展](https://docs.zongsoft.com/framework/core/common/extensions.md): ArrayExtension、StringExtension、DateTimeExtension、TimeSpanUtility、TypeExtension、UriExtension 常用扩展。
- [Zongsoft.Communication](https://docs.zongsoft.com/framework/core/communication.md): Zongsoft.Communication 命名空间的职责和主要类型。
- [常规通讯](https://docs.zongsoft.com/framework/core/communication/general.md): ISender、IReceiver、Listener、Channel 和 IPacketizer 常规通讯抽象。
- [请求应答](https://docs.zongsoft.com/framework/core/communication/request-response.md): IRequest、IRequester 和 IResponse、IResponder 请求应答抽象。
- [通知器](https://docs.zongsoft.com/framework/core/communication/notifier.md): INotifier 通知激发器接口和实现状态。
- [发射器](https://docs.zongsoft.com/framework/core/communication/transmitter.md): ITransmitter、TransmitterDescriptor、TransmitterHandler 和模板通知发送。
- [Zongsoft.Components](https://docs.zongsoft.com/framework/core/components.md): Zongsoft.Components 命名空间及其子命名空间的职责。
- [标识](https://docs.zongsoft.com/framework/core/components/identifier.md): 从 Discussions 用户身份理解类型和值共同组成的标识。
- [别名](https://docs.zongsoft.com/framework/core/components/alias-attribute.md): Zongsoft.Components AliasAttribute 别名声明和读取。
- [命令](https://docs.zongsoft.com/framework/core/components/commands.md): 以 Discussions 的 MessageSendCommand 理解参数、选项、服务依赖和执行。
- [事件](https://docs.zongsoft.com/framework/core/components/events.md): 从 Discussions 的事件注册表入口理解模块事件的装配边界。
- [工作器](https://docs.zongsoft.com/framework/core/components/worker.md): Zongsoft.Components Worker 工作器模型与工作器命令。
- [处理器](https://docs.zongsoft.com/framework/core/components/handler.md): Zongsoft.Components Handler 处理器抽象、定位和选择。
- [过滤器](https://docs.zongsoft.com/framework/core/components/filter.md): 从 Discussions 查询后正文处理理解过滤器时机、生命周期与权限。
- [监视器](https://docs.zongsoft.com/framework/core/components/superviser.md): 采用框架 SuperviserTest 的真实对象与并发测试说明监测生命周期。
- [均衡器](https://docs.zongsoft.com/framework/core/components/weighter.md): Zongsoft.Components Weighter 平滑加权轮询选择器。
- [鉴别器](https://docs.zongsoft.com/framework/core/components/discriminator.md): Zongsoft.Components Discriminator 识别器和插件构件装配。
- [尝试器](https://docs.zongsoft.com/framework/core/components/attempter.md): Zongsoft.Components Attempter 失败尝试统计和锁定窗口。
- [转换器](https://docs.zongsoft.com/framework/core/components/converters.md): Zongsoft.Components.Converters 常用类型转换器。
- [状态机](https://docs.zongsoft.com/framework/core/components/states.md): 结合 Discussions 的状态动作与框架状态机实现理解迁移、处理器和完成阶段。
- [执行管线](https://docs.zongsoft.com/framework/core/components/executor.md): Zongsoft.Components Executor 执行器、上下文、Feature 特性和执行管线。
- [Zongsoft.Configuration](https://docs.zongsoft.com/framework/core/configuration.md): 从 Discussions 选项读取出发，理解配置源、对象绑定、连接设置、Profile、Models 和 Options。
- [Zongsoft.Data](https://docs.zongsoft.com/framework/core/data.md): Zongsoft.Data 命名空间及其子命名空间在核心类库中的职责。
- [Transactions](https://docs.zongsoft.com/framework/core/data/transactions.md): Zongsoft.Data.Transaction 类与 Zongsoft.Data.Transactions 命名空间的职责和主要类型。
- [Zongsoft.Diagnostics](https://docs.zongsoft.com/framework/core/diagnostics.md): 采用 Hangfire 处理器和框架日志测试说明日志入口、上下文与落盘。
- [Telemetry](https://docs.zongsoft.com/framework/core/diagnostics/telemetry.md): 从框架安全模块的真实认证指标理解计量器、仪表、标签和导出。
- [Zongsoft.Expressions](https://docs.zongsoft.com/framework/core/expressions.md): Zongsoft.Expressions 的表达式求值抽象、词法分析器、token 模型和 tokenizer 扩展方式。
- [Zongsoft.IO](https://docs.zongsoft.com/framework/core/io.md): 以 Discussions 长正文与附件上传说明虚拟文件系统和路径。
- [Zongsoft.Messaging](https://docs.zongsoft.com/framework/core/messaging.md): Zongsoft.Messaging 的消息队列抽象、确认模型、配置发现和守护订阅机制。
- [Zongsoft.Reflection](https://docs.zongsoft.com/framework/core/reflection.md): Zongsoft.Reflection 的反射访问、动态访问器和成员表达式求值能力。
- [Zongsoft.Resources](https://docs.zongsoft.com/framework/core/resources.md): 以 Discussions 的资源键和框架现有测试说明本地化资源、定位回退与组件标题。
- [Zongsoft.Scheduling](https://docs.zongsoft.com/framework/core/scheduling.md): 以框架 Hangfire 样例串联调度契约、处理器和宿主生命周期。
- [Zongsoft.Security](https://docs.zongsoft.com/framework/core/security.md): Zongsoft.Core 中 Zongsoft.Security 命名空间的声明身份、凭证、密钥、验证码与安全基础模型。
- [Privileges](https://docs.zongsoft.com/framework/core/security/privileges.md): Zongsoft.Core 中 Zongsoft.Security.Privileges 的权限模型、认证器、授权器和默认实现。
- [Zongsoft.Serialization](https://docs.zongsoft.com/framework/core/serialization.md): 从 Discussions 用户归档筛选与模型属性理解序列化边界。
- [Zongsoft.Services](https://docs.zongsoft.com/framework/core/services.md): 理解 Zongsoft.Services 的应用上下文、服务注册、服务解析和插件服务发现。
- [服务定位与所有权](https://docs.zongsoft.com/framework/core/services/locating.md): 从 Discussions 服务之间的依赖解释定位范围与生命周期。
- [分布式锁](https://docs.zongsoft.com/framework/core/services/distributed-lock.md): 通过 Redis 多进程范例理解锁竞争、租约、续期、栅栏令牌与失去所有权后的处理。
- [Zongsoft.Terminals](https://docs.zongsoft.com/framework/core/terminals.md): Zongsoft.Terminals 终端抽象、命令执行器和交互式控制台程序。
- [终端](https://docs.zongsoft.com/framework/core/terminals/terminal.md): Zongsoft.Terminals 终端抽象、控制台终端和交互式命令模式。
- [命令](https://docs.zongsoft.com/framework/core/terminals/commands.md): Zongsoft.Terminals.Commands 终端内置命令。
- [Zongsoft.Text](https://docs.zongsoft.com/framework/core/text.md): Zongsoft.Text 文本模板接口、正则验证器和常用文本匹配用法。
- [Zongsoft.Versioning](https://docs.zongsoft.com/framework/core/version.md): Zongsoft.Versioning 命名空间中的语义化版本与数值版本号。
- [插件框架](https://docs.zongsoft.com/framework/plugins.md): Zongsoft.Plugins 插件框架的职责和核心概念。
- [插件应用模型](https://docs.zongsoft.com/framework/plugins/application-model.md): 理解插件式应用中的宿主、应用上下文、模块和服务。
- [插件文件与加载](https://docs.zongsoft.com/framework/plugins/plugin-file.md): 以 Discussions 清单解释程序集、依赖、扩展路径与构件。
- [宿主集成](https://docs.zongsoft.com/framework/plugins/hosting.md): 在 .NET Host 中启动插件式应用并加载插件目录。
- [构件与服务](https://docs.zongsoft.com/framework/plugins/builtins-and-services.md): 从 Discussions 模块实例、验证器和命令依赖理解插件构件与容器服务。
- [数据引擎](https://docs.zongsoft.com/framework/data.md): Zongsoft.Data 数据引擎的设计目标、能力和阅读入口。
- [对象关系与数据访问](https://docs.zongsoft.com/framework/data/concepts.md): 理解对象关系映射、实体、导航、数据形状、访问器与数据库驱动的协作。
- [完成首次数据查询](https://docs.zongsoft.com/framework/data/quickstart.md): 沿 Discussions 论坛查询核对映射、身份、连接和结果。
- [数据模式](https://docs.zongsoft.com/framework/data/schema.md): 从用户归档、浏览记录和主题审核理解 schema 对字段与导航的控制。
- [映射文件](https://docs.zongsoft.com/framework/data/mapping.md): 以 Discussions 的论坛复合键、主题正文关系和序号配置解释映射。
- [连接配置](https://docs.zongsoft.com/framework/data/connections.md): 配置数据连接、驱动和读写分离。
- [数据访问接口](https://docs.zongsoft.com/framework/data/data-access.md): 以 Discussions 模块访问器和真实服务调用解释访问器、结果生命周期与业务边界。
- [条件与操作元](https://docs.zongsoft.com/framework/data/conditions-and-operands.md): 从版主审核与浏览量递增理解条件组合和数据库端表达式。
- [查询与导航](https://docs.zongsoft.com/framework/data/querying.md): 以论坛置顶主题、浏览记录和投票统计说明条件、模式、分页与聚合。
- [写入操作](https://docs.zongsoft.com/framework/data/writing.md): 以帖子投票、主题审核和浏览记录说明真实写入及其副作用。
- [事务与一致性](https://docs.zongsoft.com/framework/data/transactions.md): 从发表主题与更新统计理解事务边界、提交和外部副作用。
- [数据服务](https://docs.zongsoft.com/framework/data/services.md): 通过 ThreadService、DataValidator 和查询过滤器理解业务服务边界。
- [按驱动阅读](https://docs.zongsoft.com/framework/data/drivers.md): 选择、部署和扩展 Zongsoft.Data 数据库驱动。
- [MySQL (mysql)](https://docs.zongsoft.com/framework/data/drivers/mysql.md): MySQL 数据驱动的部署、连接配置与专项验证。
- [SQL Server (mssql)](https://docs.zongsoft.com/framework/data/drivers/mssql.md): SQL Server 数据驱动的部署、连接配置与专项验证。
- [PostgreSQL (postgres)](https://docs.zongsoft.com/framework/data/drivers/postgres.md): PostgreSQL 数据驱动的部署、连接配置与专项验证。
- [SQLite (sqlite)](https://docs.zongsoft.com/framework/data/drivers/sqlite.md): SQLite 数据驱动的部署、连接配置与专项验证。
- [DuckDB (duckdb)](https://docs.zongsoft.com/framework/data/drivers/duckdb.md): DuckDB 数据驱动的部署、连接配置与专项验证。
- [ClickHouse (clickhouse)](https://docs.zongsoft.com/framework/data/drivers/clickhouse.md): ClickHouse 数据驱动的部署、连接配置与专项验证。
- [TDengine (tdengine)](https://docs.zongsoft.com/framework/data/drivers/tdengine.md): TDengine 数据驱动的部署、连接配置与专项验证。
- [InfluxDB (influx)](https://docs.zongsoft.com/framework/data/drivers/influx.md): InfluxDB 数据驱动的部署、连接配置与专项验证。
- [Web 基础](https://docs.zongsoft.com/framework/web.md): 以插件组织 ASP.NET Core 应用，连接控制器、数据服务、请求管线和协议扩展。
- [部署控制器插件](https://docs.zongsoft.com/framework/web/controllers.md): 构建并部署 Discussions Web 类库，检查控制器发现和请求前提。
- [请求与数据服务接口](https://docs.zongsoft.com/framework/web/data-services.md): 以 Discussions 的主题审核控制器说明 Web 与业务服务的分工。
- [OpenAPI 与 gRPC](https://docs.zongsoft.com/framework/web/protocols.md): 为插件 Web 应用启用 OpenAPI/Scalar 与 gRPC，区分文档生成、服务注册和实际协议端点。
- [安全](https://docs.zongsoft.com/framework/security.md): 连接 核心类库 安全契约、持久化身份权限、Web 接口与验证码，建立完整的安全调用链。
- [认证与授权](https://docs.zongsoft.com/framework/security/authentication.md): 从 Discussions 的身份质询、声明转换和 SiteId 验证理解认证边界。
- [验证码与确认令牌](https://docs.zongsoft.com/framework/security/captcha.md): 使用 Authencode 图片挑战和短期确认令牌，理解两阶段核验、缓存及重放边界。
- [诊断](https://docs.zongsoft.com/framework/diagnostics.md): 以框架随包选项说明指标与追踪的过滤和导出配置。
- [OTLP 协议接入](https://docs.zongsoft.com/framework/diagnostics/otlp.md): 接入 OTLP gRPC 客户端和 Listener 服务端，核对处理器装配、数据转换及可靠性限制。
- [智能化](https://docs.zongsoft.com/framework/intelligences.md): 配置 AI 助手，连接模型服务，并通过终端或 Web 使用聊天能力。
- [会话与流式响应](https://docs.zongsoft.com/framework/intelligences/sessions.md): 理解聊天历史、流式枚举、会话隔离和中断后的状态。
- [机器学习](https://docs.zongsoft.com/framework/learning.md): 认识机器学习模块的数据集、估计器目录与训练管线，以及当前实现范围。
- [网络通讯](https://docs.zongsoft.com/framework/net.md): 使用网络通讯组件时理解 TCP 分包、处理器生命周期和资源所有权。
- [硬件信息](https://docs.zongsoft.com/framework/hardwares.md): 采集当前运行环境的硬件信息，并理解设备标识的稳定性与使用范围。
- [报表](https://docs.zongsoft.com/framework/reporting.md): 组织报表描述、模板资源与数据加载，并辨别报表契约和具体引擎的能力。
- [消息队列](https://docs.zongsoft.com/framework/messaging.md): Zongsoft 消息队列插件的选型、配置、实现差异和使用范例。
- [发布订阅与投递概念](https://docs.zongsoft.com/framework/messaging/concepts.md): 从消息、主题、消费者到确认与幂等，理解统一接口背后的不同投递模型。
- [可靠投递与消息存储](https://docs.zongsoft.com/framework/messaging/reliability.md): 核对消息接纳与确认的边界，为 ZeroMQ 配置数据库存储并设计业务幂等。
- [按项目阅读](https://docs.zongsoft.com/framework/messaging/projects.md): 按 Kafka、RabbitMQ、MQTT、ZeroMQ 与 .storages 源码项目查找消息实现。
- [Kafka (kafka)](https://docs.zongsoft.com/framework/messaging/projects/kafka.md): Kafka 消息项目的部署、连接、协议映射与可靠性边界。
- [RabbitMQ (rabbit)](https://docs.zongsoft.com/framework/messaging/projects/rabbit.md): RabbitMQ 消息项目的部署、连接、协议映射与可靠性边界。
- [MQTT (mqtt)](https://docs.zongsoft.com/framework/messaging/projects/mqtt.md): MQTT 消息项目的部署、连接、协议映射与可靠性边界。
- [ZeroMQ (zero)](https://docs.zongsoft.com/framework/messaging/projects/zero.md): ZeroMQ 消息项目的部署、连接、协议映射与可靠性边界。
- [消息存储 (.storages)](https://docs.zongsoft.com/framework/messaging/projects/storages.md): .storages 数据库消息存储项目的部署产物、Broker 连接匹配与恢复条件。
- [自动升级](https://docs.zongsoft.com/framework/upgrading.md): 理解升级包、发现通道、应用内升级器与进程外部署器的协作。
- [升级接入与故障恢复](https://docs.zongsoft.com/framework/upgrading/workflow.md): 配置升级发现与部署交接，验证发布状态，并按阶段定位升级失败。
- [扩展插件](https://docs.zongsoft.com/framework/externals.md): 按应用场景选择第三方适配器，理解公共契约、插件部署和外部运行环境的关系。
- [缓存与分布式协作](https://docs.zongsoft.com/framework/externals/caching.md): 配置 Redis 缓存、etcd 序号与租约锁，并理解 Garnet 服务器和可靠消息存储。
- [脚本与表达式](https://docs.zongsoft.com/framework/externals/scripting.md): 通过表达式契约选择 Lua、Python 或 Scriban，并管理语法、变量和运行时隔离。
- [任务调度与弹性执行](https://docs.zongsoft.com/framework/externals/execution.md): 通过框架 Hangfire 样例说明处理器注册、作业执行和重试边界。
- [表格与模板扩展](https://docs.zongsoft.com/framework/externals/documents.md): 以 Discussions 用户归档提供者和 user-list.xlsx 解释模板数据装配。
- [云服务与回调](https://docs.zongsoft.com/framework/externals/cloud.md): 接入对象存储、云通信与微信服务，并正确处理回调验证和重复通知。
- [OPC UA 设备协议](https://docs.zongsoft.com/framework/externals/integration.md): 理解 OPC UA 的节点、会话、订阅与证书，并规划工业设备接入。
- [按项目阅读](https://docs.zongsoft.com/framework/externals/projects.md): 按 externals 源码项目查找扩展包、配置入口与相关主题文档。
- [Aliyun (aliyun)](https://docs.zongsoft.com/framework/externals/projects/aliyun.md): Aliyun 项目的能力范围、部署产物、接入入口与使用边界。
- [Amazon (amazon)](https://docs.zongsoft.com/framework/externals/projects/amazon.md): Amazon 项目的能力范围、部署产物、接入入口与使用边界。
- [ClosedXml (closedxml)](https://docs.zongsoft.com/framework/externals/projects/closedxml.md): ClosedXml 项目的能力范围、部署产物、接入入口与使用边界。
- [Etcd (etcd)](https://docs.zongsoft.com/framework/externals/projects/etcd.md): Etcd 项目的能力范围、部署产物、接入入口与使用边界。
- [Garnet (garnet)](https://docs.zongsoft.com/framework/externals/projects/garnet.md): Garnet 项目的能力范围、部署产物、接入入口与使用边界。
- [Hangfire (hangfire)](https://docs.zongsoft.com/framework/externals/projects/hangfire.md): Hangfire 项目的能力范围、部署产物、接入入口与使用边界。
- [Lua (lua)](https://docs.zongsoft.com/framework/externals/projects/lua.md): Lua 项目的能力范围、部署产物、接入入口与使用边界。
- [Opc (opc)](https://docs.zongsoft.com/framework/externals/projects/opc.md): Opc 项目的能力范围、部署产物、接入入口与使用边界。
- [OpenXml (openxml)](https://docs.zongsoft.com/framework/externals/projects/openxml.md): OpenXml 项目的能力范围、部署产物、接入入口与使用边界。
- [Polly (polly)](https://docs.zongsoft.com/framework/externals/projects/polly.md): Polly 项目的能力范围、部署产物、接入入口与使用边界。
- [Python (python)](https://docs.zongsoft.com/framework/externals/projects/python.md): Python 项目的能力范围、部署产物、接入入口与使用边界。
- [Redis (redis)](https://docs.zongsoft.com/framework/externals/projects/redis.md): Redis 项目的能力范围、部署产物、接入入口与使用边界。
- [Scriban (scriban)](https://docs.zongsoft.com/framework/externals/projects/scriban.md): Scriban 项目的能力范围、部署产物、接入入口与使用边界。
- [Wechat (wechat)](https://docs.zongsoft.com/framework/externals/projects/wechat.md): Wechat 项目的能力范围、部署产物、接入入口与使用边界。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.zongsoft.com/framework.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.