# Documentation

- [核心说明](/docs/bamboo-base-go/architecture): Bamboo Base 整体架构设计与模块说明
- [筱工具(Golang)](/docs/bamboo-base-go): 筱锋的 Go 语言基础组件库文档
- [快速开始](/docs/bamboo-base-go/quick-start): 5 分钟快速上手 Bamboo Base Go
- [模块架构](/docs/bamboo-base-java/architecture): 筱工具(Java) 多模块架构说明与依赖关系
- [筱工具(Java)](/docs/bamboo-base-java): 筱锋的 Java 语言基础组件库文档
- [快速开始](/docs/bamboo-base-java/quick-start): 5 分钟快速上手筱工具(Java)
- [AI 集成](/docs/guide/ai-integration): 让 AI 助手直接读取竹简文档内容
- [Claude Code 集成](/docs/guide/claude-code): 在 Claude Code 中使用竹简文档 MCP 服务
- [入门指南](/docs/guide): 快速了解竹简文档的使用方法
- [文档导航](/docs/guide/navigation): 熟悉竹简文档站的使用方式
- [gRPC 常量](/docs/bamboo-base-go/grpc/constants): Metadata 和 Trailer 常量定义，以及 ExtractMetadata 工具函数
- [gRPC（可选）](/docs/bamboo-base-go/grpc): Bamboo Base 的可选 gRPC 运行时能力
- [内置拦截器](/docs/bamboo-base-go/grpc/interceptors): 一元/流式拦截器、服务级中间件分发机制
- [内置 Proto](/docs/bamboo-base-go/grpc/proto): 记录 bamboo-base-go 内置 proto 定义，业务端可直接引用
- [gRPC 结果处理](/docs/bamboo-base-go/grpc/result): xGrpcResult 包提供统一的 gRPC 响应构建函数
- [gRPC 运行时](/docs/bamboo-base-go/grpc/runner): xGrpcRunner.New 将 gRPC 服务挂载到 xMain.Runner 生命周期中
- [Buf 工具配置](/docs/bamboo-base-go/grpc-best-practices/buf-config): buf.yaml 和 buf.gen.yaml 配置说明，以及 Makefile 集成
- [Handler 实现模式](/docs/bamboo-base-go/grpc-best-practices/handler-pattern): gRPC Handler 的标准结构、xGrpcResult 使用和依赖注入
- [gRPC 最佳实践](/docs/bamboo-base-go/grpc-best-practices): 基于 bamboo-base-go 的 gRPC 开发最佳实践指南
- [中间件模式](/docs/bamboo-base-go/grpc-best-practices/middleware-pattern): 服务级中间件分发机制、App 认证示例与自定义中间件
- [Proto 文件组织](/docs/bamboo-base-go/grpc-best-practices/proto-organization): Proto 文件目录结构、包命名规范与符号链接模式
- [服务注册](/docs/bamboo-base-go/grpc-best-practices/service-registration): 集中注册入口、与 gRPC Runner 集成和启动流程
- [请求绑定](/docs/bamboo-base-go/utils/binding): Bind(...).Data / Query / URI / Header 的统一绑定与校验
- [通用工具](/docs/bamboo-base-go/utils/common): 泛型指针操作、切片查找、布尔值转换
- [加密哈希](/docs/bamboo-base-go/utils/encryption): SHA-256 和 MD5 哈希计算
- [函数工具](/docs/bamboo-base-go/utils/function): 获取函数名称、方法名称等反射相关的工具函数
- [随机生成](/docs/bamboo-base-go/utils/generate): 生成随机字符串、数字串
- [概述](/docs/bamboo-base-go/utils): xUtil 提供字符串、时间、加密、验证等常用工具函数
- [类型解析](/docs/bamboo-base-go/utils/parse): Parse 提供通用类型解析与转换能力
- [密码处理](/docs/bamboo-base-go/utils/password): 基于 bcrypt 的密码加密与验证
- [安全密钥](/docs/bamboo-base-go/utils/security): 生成和验证安全密钥
- [字符串处理](/docs/bamboo-base-go/utils/string): 空白检查、截断、命名转换、脱敏等字符串工具
- [时间处理](/docs/bamboo-base-go/utils/time): 格式化、解析、范围计算、年龄计算等时间工具
- [数据验证](/docs/bamboo-base-go/utils/validate): 手机号、身份证、邮箱、URL、密码强度等格式验证
- [核心库](/docs/bamboo-base-java/base): bamboo-base 核心库提供响应模型、异常体系与多种 ID 生成能力
- [自动配置](/docs/bamboo-base-java/framework/auto-configuration): WebFluxSdkAutoConfiguration 自动装配与 ContextWebFluxProperties 配置说明
- [ContextHolder](/docs/bamboo-base-java/framework/context-holder): 请求上下文管理器，支持 MVC（ThreadLocal）和 WebFlux（Reactor Context）两种实现
- [GlobalErrorController](/docs/bamboo-base-java/framework/global-error): 全局错误控制器，统一处理所有未捕获的异常和 HTTP 错误状态
- [框架集成](/docs/bamboo-base-java/framework): 竹简框架的 Spring MVC 与 WebFlux 集成模块，提供统一的响应构建、上下文管理与异常处理能力
- [MyBatis-Plus 配置](/docs/bamboo-base-java/framework/mybatis-plus): 通过 MybatisPlusConfigHandler 自动注册分页拦截器与默认 ID 生成器
- [ResultUtil](/docs/bamboo-base-java/framework/result-util): 统一响应构建工具类，支持 MVC 和 WebFlux 两种编程模型
- [系统初始化](/docs/bamboo-base-java/framework/system-init): 基于 InitSystemStartupHandler 实现系统启动初始化
- [邮件通知](/docs/bamboo-base-java/notify/email): EmailNotify 基于 SMTP 协议实现邮件通知发送能力
- [通知服务](/docs/bamboo-base-java/notify): bamboo-notify 模块提供邮件、Webhook、短信等多渠道通知能力
- [数据模型](/docs/bamboo-base-java/notify/model): NotifyMessage 与 NotifyResult 定义通知服务的请求与响应数据结构
- [模板引擎](/docs/bamboo-base-java/notify/template): TemplateEngine 接口提供通知内容的模板渲染与变量替换能力
- [Webhook 通知](/docs/bamboo-base-java/notify/webhook): WebhookNotify 通过 HTTP 回调实现消息推送能力
- [注解](/docs/bamboo-base-java/triple/annotation): @DubboPersistentContext 与 @TripleRequestCheck 注解驱动上下文传播与请求校验
- [AOP 切面](/docs/bamboo-base-java/triple/aspect): DubboContextAspect 与 TripleRequestCheckAspect 实现上下文传播与请求校验
- [异常处理](/docs/bamboo-base-java/triple/exception): DubboException 与 CustomExecutionException 处理 Dubbo RPC 调用中的异常
- [Dubbo Triple](/docs/bamboo-base-java/triple): bamboo-triple 模块为 Dubbo Triple RPC 提供请求校验、上下文传播与统一响应能力
- [TripleRequest](/docs/bamboo-base-java/triple/request): TripleRequest 抽象类定义 Dubbo Triple RPC 请求的基础结构与校验规范
- [TripleResponse](/docs/bamboo-base-java/triple/response): TripleResponse<T> 泛型响应体，统一 Dubbo Triple RPC 返回格式
- [TripleResult](/docs/bamboo-base-java/triple/result): TripleResult 静态工厂类，快速构建标准化的成功与错误响应
- [HashCache](/docs/bamboo-base-go/components/cache/hash-cache): 基于哈希数据结构的二维键值对缓存接口
- [概述](/docs/bamboo-base-go/components/cache): xCache 提供基于 Redis 的多种数据结构缓存接口
- [KeyCache](/docs/bamboo-base-go/components/cache/key-cache): 基于字符串数据结构的键值对缓存接口
- [ListCache](/docs/bamboo-base-go/components/cache/list-cache): 基于列表数据结构的有序可重复元素缓存接口
- [SetCache](/docs/bamboo-base-go/components/cache/set-cache): 基于集合数据结构的无序唯一元素缓存接口
- [请求上下文](/docs/bamboo-base-go/components/helper/context): RequestContext 为每个请求生成唯一标识符和记录开始时间
- [HTTP 日志](/docs/bamboo-base-go/components/helper/http-logger): HttpLogger 记录请求详情，支持敏感信息脱敏
- [HTTP 工具](/docs/bamboo-base-go/components/helper/http): xHttp 提供请求头常量与 Token 解析能力
- [概述](/docs/bamboo-base-go/components/helper): xHelper 提供请求上下文、HTTP 日志、Panic 恢复等辅助中间件
- [Panic 恢复](/docs/bamboo-base-go/components/helper/panic-recovery): PanicRecovery 捕获异常并返回统一错误响应
- [GORM 集成](/docs/bamboo-base-go/components/log/gorm): SlogLogger 适配器将 GORM 日志输出到 slog
- [自定义 Handler](/docs/bamboo-base-go/components/log/handler): LogHandler 实现双通道输出，支持彩色控制台和 JSON 文件
- [概述](/docs/bamboo-base-go/components/log): xLog 包提供企业级日志管理，支持彩色控制台、文件切割、链路追踪
- [命名常量](/docs/bamboo-base-go/components/log/named): 预定义的日志命名常量，按模块分类管理日志
- [日志切割](/docs/bamboo-base-go/components/log/rotator): RotatingWriter 实现按大小切割和按天归档
- [CORS 跨域](/docs/bamboo-base-go/components/middleware/cors): ReleaseAllCors 和 AllowOption 处理跨域请求
- [概述](/docs/bamboo-base-go/components/middleware): xMiddle 提供 CORS、OPTIONS 预检、统一响应等常用中间件
- [统一响应](/docs/bamboo-base-go/components/middleware/response): ResponseMiddleware 自动处理未输出的响应和错误
- [基因提供者](/docs/bamboo-base-go/components/models/gene-provider): GeneProvider 接口允许实体定义自己的业务基因
- [基础实体](/docs/bamboo-base-go/components/models): xModels 包提供与 GORM 深度集成的基础实体类型
- [分页模型](/docs/bamboo-base-go/components/models/page): PageRequest 与 PageResponse 提供统一的分页请求和响应结构
- [软删除实体](/docs/bamboo-base-go/components/models/soft-delete): BaseEntityWithSoftDelete 提供逻辑删除支持
- [自定义验证器](/docs/bamboo-base-go/components/validator/custom): 注册 strict_url、enum_int、regexp 等自定义验证规则
- [概述](/docs/bamboo-base-go/components/validator): xVaild 提供自定义验证器、中文翻译、错误响应处理
- [错误响应](/docs/bamboo-base-go/components/validator/response): HandleValidationError 统一处理验证错误并返回友好响应
- [中文翻译](/docs/bamboo-base-go/components/validator/translator): 为验证错误提供中文翻译支持
- [自定义注入](/docs/bamboo-base-go/core/context/custom): 扩展上下文，通过节点化系统注入业务自定义数据
- [概述](/docs/bamboo-base-go/core/context): 上下文管理机制，基于标准 context.Context 实现框架解耦
- [上下文键](/docs/bamboo-base-go/core/context/keys): xCtx 包定义的上下文键常量
- [工具函数](/docs/bamboo-base-go/core/context/util): xCtxUtil 包提供便捷的上下文操作函数，已解耦 Gin 框架
- [配置初始化](/docs/bamboo-base-go/core/init/config): ConfigInit 从 .env 文件加载环境变量
- [上下文注入](/docs/bamboo-base-go/core/init/context): 通过节点化系统和中间件实现上下文资源注入
- [引擎初始化](/docs/bamboo-base-go/core/init/engine): engineInit 创建并配置 Gin 引擎，注册内置中间件和验证器，并注入初始化上下文
- [快速开始](/docs/bamboo-base-go/core/init): xReg 包提供节点化初始化系统，支持灵活的组件注册
- [日志初始化](/docs/bamboo-base-go/core/init/logger): LoggerInit 配置全局日志记录器，支持控制台彩色输出和文件 JSON 记录
- [服务运行时](/docs/bamboo-base-go/core/init/runner): xMain.Runner 统一启动 HTTP 服务并支持优雅关闭
- [雪花算法初始化](/docs/bamboo-base-go/core/init/snowflake): SnowflakeInit 作为内置节点初始化分布式唯一 ID 生成器
- [通用返回结构](/docs/bamboo-base-go/core/result/base-response): BaseResponse 是 Bamboo Base Go 的统一响应结构体，确保所有 API 返回格式一致。
- [错误码](/docs/bamboo-base-go/core/result/error-code): 100+ 预定义错误码速查表
- [错误处理](/docs/bamboo-base-go/core/result/error): xError 包提供统一的错误处理机制
- [结果处理](/docs/bamboo-base-go/core/result/result): xResult 包提供便捷的响应函数，用于统一 API 响应格式
- [业务基因](/docs/bamboo-base-go/components/snowflake/gene): Gene 类型定义业务数据类型，支持 64 种业务分类
- [概述](/docs/bamboo-base-go/components/snowflake): xSnowflake 包提供带业务基因的分布式唯一 ID 生成器
- [节点管理](/docs/bamboo-base-go/components/snowflake/node): Node 结构体管理雪花算法节点，支持自动和手动配置
- [ID 解析](/docs/bamboo-base-go/components/snowflake/parse): 从 SnowflakeID 解析时间戳、基因、节点等信息
- [Cron 定时任务（可选）](/docs/bamboo-base-go/plugins/cron): Bamboo Base 的可选 Cron 定时任务能力
- [Job 定义与适配](/docs/bamboo-base-go/plugins/cron/job): 定义定时任务结构和函数适配器
- [Cron 运行时](/docs/bamboo-base-go/plugins/cron/runner): Cron 定时任务的启动器配置
- [PageDTO](/docs/bamboo-base-java/base/dto/page-dto): 分页数据传输对象，用于标准化分页查询结果
- [BusinessException](/docs/bamboo-base-java/base/exception/business): 业务异常基类，用于表示业务逻辑相关的异常情况
- [异常处理架构](/docs/bamboo-base-java/base/exception): 竹简框架分层异常处理架构，提供从 Java 基础异常到业务异常的全面覆盖
- [Java 基础异常](/docs/bamboo-base-java/base/exception/java-base): JavaBaseExceptionHandler 处理 Java 标准库中的常见运行时异常与受检异常
- [MySQL 异常处理](/docs/bamboo-base-java/base/exception/mysql): MysqlExceptionHandler 捕获 MySQL 数据库操作中的 SQL 语法错误与数据截断异常
- [异常处理架构](/docs/bamboo-base-java/base/exception/overview): 竹简框架分层异常处理架构，提供从 Java 基础异常到业务异常的全面覆盖
- [PostgreSQL 异常处理](/docs/bamboo-base-java/base/exception/postgresql): PostgreSqlExceptionHandler 捕获 PostgreSQL 数据库操作中的 SQL 异常与数据截断异常
- [公共业务异常](/docs/bamboo-base-java/base/exception/public): PublicExceptionHandler 处理框架定义的业务级异常，覆盖认证、权限、参数校验等场景
- [BaseResponse](/docs/bamboo-base-java/base/response/base-response): BaseResponse<E> 统一响应模型，包含 context、状态码、错误信息与数据载体
- [ErrorCode](/docs/bamboo-base-java/base/response/error-code): ErrorCode 枚举定义 58 个预定义错误码，覆盖通用、客户端与服务端全场景
- [GeneSnowflakeInfoDTO](/docs/bamboo-base-java/base/snowflake/gene-info-dto): 基因雪花 ID 的解析结果对象
- [GeneSnowflakeUtil](/docs/bamboo-base-java/base/snowflake/gene-util): 基因雪花 ID 工具类，支持业务基因嵌入、解析与校验
- [SnowflakeIdGenerator](/docs/bamboo-base-java/base/snowflake/generator): 标准雪花算法生成器，实现 MyBatis-Plus IdentifierGenerator
- [雪花算法](/docs/bamboo-base-java/base/snowflake): 标准雪花 ID 与基因雪花 ID 的生成、解析与验证能力
- [SnowflakeInfoDTO](/docs/bamboo-base-java/base/snowflake/info-dto): 标准雪花 ID 的解析结果对象
- [SnowflakeUtil](/docs/bamboo-base-java/base/snowflake/util): 标准雪花 ID 的静态工具类，提供生成、解析、校验与配置读取能力
- [UuidUtil](/docs/bamboo-base-java/base/uuid/uuid-util): UUID 工具类，提供 UUID 生成与转换能力
- [UuidV7Generator](/docs/bamboo-base-java/base/uuid/uuid-v7-generator): UUID v7 生成器，实现 MyBatis-Plus IdentifierGenerator 接口
- [业务日志切面](/docs/bamboo-base-java/framework/aspect/business-log): BusinessLogAspect 提供独立的业务日志记录方法，支持 Controller、Service 和 DAO 三层的日志前置处理
- [调试切面](/docs/bamboo-base-java/framework/aspect/debug): 在非调试模式下拦截调试接口的访问，返回未授权错误
- [切面概览](/docs/bamboo-base-java/framework/aspect): 基于 Spring AOP 的日志记录、调试保护等横切关注点处理
- [日志切面](/docs/bamboo-base-java/framework/aspect/log): 通过 AOP 自动记录 Controller、Service、Repository 三层的请求日志与性能指标
- [自定义异常处理](/docs/bamboo-base-java/framework/exception/custom-system): 通过继承 SystemExceptionHandler 扩展异常处理能力，实现项目级异常捕获
- [异常处理概览](/docs/bamboo-base-java/framework/exception): 统一异常处理架构，提供从 Java 基础异常到业务异常的全面覆盖
- [Spring MVC 异常（仅 MVC）](/docs/bamboo-base-java/framework/exception/spring-boot): SystemExceptionHandler 处理 Spring MVC 框架级异常，覆盖参数校验、请求方法不匹配等场景
- [用户认证异常（仅 MVC）](/docs/bamboo-base-java/framework/exception/user-auth): UserAuthenticationException 提供携带错误类型枚举和用户信息的认证异常处理
- [上下文过滤器](/docs/bamboo-base-java/framework/filter/context): ContextFilter 以最高优先级为每个请求初始化上下文标识，支持 UUID 提取与 MDC 日志追踪
- [CORS 跨域过滤器](/docs/bamboo-base-java/framework/filter/cors): 可配置的 CORS 跨域请求处理，支持域名、方法和请求头白名单
- [过滤器概览](/docs/bamboo-base-java/framework/filter): 过滤器链提供上下文注入、跨域处理、安全校验等 HTTP 请求预处理能力
- [OPTIONS 过滤器](/docs/bamboo-base-java/framework/filter/options): 快速响应 OPTIONS 预检请求，返回 200 OK
- [权限过滤器](/docs/bamboo-base-java/framework/filter/permission): 基于 @NeedPermission 注解的抽象权限校验过滤器
- [Referer 拦截过滤器](/docs/bamboo-base-java/framework/filter/referer-ban): BanEmptyReferer 拦截空 Referer 请求，防止 API 被非浏览器客户端直接调用
- [HeaderUtil](/docs/bamboo-base-java/framework/util/header-util): HTTP 请求头解析工具类，提供授权用户标识、Referer、User-Agent 等请求头的提取与校验
- [HttpServletUtil](/docs/bamboo-base-java/framework/util/http-servlet-util): Servlet 请求工具类，提供从 HttpServletRequest 解析 HandlerMethod 的能力
- [工具类概览](/docs/bamboo-base-java/framework/util): HTTP 请求工具类，提供 Header 解析、Handler 解析等能力
- [ServerWebExchangeUtil](/docs/bamboo-base-java/framework/util/server-web-exchange-util): ServerWebExchange 工具类，提供 Handler 解析与请求信息提取能力