README

介绍

安装教程

1. php >=7.4.0
2. composer require hxy/php-toolkit

使用说明

1. 请参考各个子目录下的 readme.md 文件，了解每个子目录的功能和使用方法。

附：目录结构及简单说明

核心目录

• src/abstracts - 抽象类库目录（定义通用抽象基类）

  • src/abstracts/AbstractDict.php - 字典抽象类，提供标准的字典实现模板
  • src/abstracts/AbstractDtoEntity.php - 数据传输对象抽象类，继承自 AbstractEntity
  • src/abstracts/AbstractEntity.php - 实体抽象类，实现 Entityable 接口
  • src/abstracts/AbstractJo.php - 简单对象抽象类
  • src/abstracts/AbstractMapper.php - 映射器抽象类
  • src/abstracts/AbstractUc.php - 单位换算抽象类
  • src/abstracts/AbstractVoEntity.php - 视图对象实体抽象类
  • src/abstracts/Singleton.php - 单例模式实现类
  • src/abstracts/readme.md - 抽象类库说明文档

• src/constant - 常量定义目录（系统常量配置）

  • src/constant/CharConstants.php - 字符常量定义
  • src/constant/HttpConstants.php - HTTP相关常量定义
  • src/constant/TypeConstants.php - 类型常量定义
  • src/constant/readme.md - 常量定义说明文档

• src/contract - 接口/契约目录（定义组件交互规范）

  • src/contract/Adapterable.php - 适配器接口
  • src/contract/Arrayable.php - 数组化接口
  • src/contract/Cacheable.php - 缓存接口
  • src/contract/Checkable.php - 检查接口
  • src/contract/Contextable.php - 上下文接口
  • src/contract/Converterable.php - 转换器接口
  • src/contract/Curdable.php - CRUD操作接口
  • src/contract/Dictable.php - 字典接口
  • src/contract/Entityable.php - 实体接口
  • src/contract/Errorable.php - 异常接口
  • src/contract/Eventable.php - 事件接口
  • src/contract/Handlerable.php - 处理接口
  • src/contract/Instanceable.php - 实例接口
  • src/contract/Joable.php - 简单对象接口
  • src/contract/Jsonable.php - JSON化接口
  • src/contract/Listenable.php - 监听接口
  • src/contract/Lockerable.php - 锁接口
  • src/contract/Makeable.php - 工厂接口
  • src/contract/Managerable.php - 管理器接口
  • src/contract/Mapperable.php - 映射器接口
  • src/contract/Notifiable.php - 通知接口
  • src/contract/Payloadable.php - 载荷接口
  • src/contract/Registryable.php - 注册接口
  • src/contract/Singletonable.php - 单例接口
  • src/contract/Stateable.php - 状态接口
  • src/contract/Stdable.php - 标准接口
  • src/contract/Strategyable.php - 策略接口
  • src/contract/Ucable.php - 单位换算接口
  • src/contract/Validatorable.php - 验证器接口
  • src/contract/Verifyable.php - 验证接口
  • src/contract/Vrable.php - 验证规则接口
  • src/contract/readme.md - 接口契约说明文档

• src/core - 核心组件目录（项目核心功能实现）

  • src/core/struct/ - 结构体子目录
    • src/core/struct/CoordinateStruct.php - 经纬度结构体
    • src/core/struct/SnowflakeStruct.php - 雪花算法结构体
    • src/core/struct/SqlColumnsStruct.php - SQL列结构体
    • src/core/struct/SqlTableColumnsStruct.php - SQL表列结构体
  • src/core/Curl.php - Curl请求类，提供HTTP请求功能封装
  • src/core/Match.php - 匹配器类，实现模式匹配功能
  • src/core/ObjectId.php - ObjectId生成器类，生成类似MongoDB风格的ObjectId
  • src/core/Snowflake.php - 雪花ID生成器类，实现Twitter雪花算法
  • src/core/Std.php - 标准类，扩展标准stdClass类
  • src/core/Vr.php - 验证规则类，提供灵活的验证规则定义和执行功能
  • src/core/readme.md - 核心组件说明文档

• src/dict - 字典定义目录（业务字典映射）

  • src/dict/BoolDict.php - 布尔值字典
  • src/dict/DeleteStateDict.php - 删除状态字典
  • src/dict/EcDict.php - 错误码字典
  • src/dict/EffectiveStateDict.php - 生效状态字典
  • src/dict/EnvDict.php - 运行环境字典
  • src/dict/OperatorDict.php - 运算符字典
  • src/dict/PhpTypeDict.php - PHP数据类型字典
  • src/dict/SexGbDict.php - 性别字典
  • src/dict/StateDIct.php - 状态字典
  • src/dict/StdDict.php - 标准字典
  • src/dict/SwitchStateDict.php - 开关状态字典
  • src/dict/SyncStateDict.php - 同步状态字典
  • src/dict/readme.md - 字典定义说明文档

• src/entity - 实体类目录（数据传输/展示模型）

  • src/entity/AggregatePo.php - 聚合PO实体，用于存储聚合数据
  • src/entity/ApiResponseVo.php - API响应数据VO实体，标准化的API响应数据视图对象
  • src/entity/PageDto.php - 分页DTO实体，用于分页查询的数据传输对象
  • src/entity/PageVo.php - 分页VO实体，分页结果的视图对象
  • src/entity/RateLimiterDto.php - 限流器DTO实体
  • src/entity/readme.md - 实体类说明文档

• src/error - 异常处理目录（系统异常定义）

  • src/error/AbsException.php - 抽象异常类
  • src/error/BusinessException.php - 业务异常类
  • src/error/CacheException.php - 缓存异常类
  • src/error/DbException.php - 数据库异常类
  • src/error/HttpException.php - HTTP异常类
  • src/error/MacroException.php - 宏异常类
  • src/error/RateLimitException.php - 限流异常类
  • src/error/SystemException.php - 系统异常类
  • src/error/ThirdException.php - 第三方服务异常类
  • src/error/readme.md - 异常处理说明文档

• src/stdlib - 标准库目录（基础数据结构实现）

  • src/stdlib/HashMap.php - HashMap结构类，提供键值对映射的数据结构
  • src/stdlib/HashMapGroup.php - HashMap分组结构类，提供基于指定键进行分组的HashMap结构
  • src/stdlib/HashMapSet.php - HashMapSet结构类，提供键到唯一值集合的映射结构
  • src/stdlib/readme.md - 标准库说明文档

• src/support - 支持组件目录（业务支持工具）

  • src/support/Counter.php - 计数器类，提供简单的计数功能
  • src/support/HttpHeaders.php - HTTP头信息处理类
  • src/support/LapTimer.php - 分阶段计时器类
  • src/support/LengthUc.php - 长度单位换算工具类
  • src/support/RateLimiter.php - 限流器类，基于Redis实现
  • src/support/Timer.php - 计时器类
  • src/support/Tree.php - 树形结构工具类，提供树形结构的生成、平铺和子节点查找功能
  • src/support/Type.php - 类型转换工具类
  • src/support/VolumeUc.php - 体积单位换算工具类
  • src/support/WeightUc.php - 重量单位换算工具类
  • src/support/readme.md - 支持组件说明文档

• src/traits - 特性目录（可复用代码片段）

  • src/traits/ErrorsTrait.php - 错误处理特性
  • src/traits/InitTrait.php - 初始化特性
  • src/traits/InstanceTrait.php - 实例特性
  • src/traits/MacroTrait.php - 宏特性
  • src/traits/PropertyTrait.php - 属性特性
  • src/traits/ToArrayTrait.php - 转数组特性
  • src/traits/ToJsonTrait.php - 转JSON特性
  • src/traits/VrExecTrait.php - 验证规则执行特性
  • src/traits/readme.md - 特性说明文档

• src/utils - 工具类目录（通用工具函数）

  • src/utils/Abort.php - 中止工具类
  • src/utils/Arr.php - 数组工具类
  • src/utils/Bean.php - Bean工具类
  • src/utils/Closure.php - 闭包工具类
  • src/utils/Crypt.php - 加密工具类
  • src/utils/Datetime.php - 日期时间工具类
  • src/utils/Dd.php - 调试工具类
  • src/utils/Digit.php - 数字工具类
  • src/utils/Encoding.php - 编码工具类
  • src/utils/Extract.php - 提取工具类
  • src/utils/File.php - 文件工具类
  • src/utils/Fmt.php - 格式化工具类
  • src/utils/Ident.php - 标识符工具类
  • src/utils/Is.php - 类型判断工具类
  • src/utils/Json.php - JSON工具类
  • src/utils/LabelValue.php - 标签值工具类
  • src/utils/Math.php - 数学工具类
  • src/utils/Operator.php - 运算符工具类
  • src/utils/Random.php - 随机数工具类
  • src/utils/Ren.php - 命名转换工具类
  • src/utils/Safe.php - 安全工具类
  • src/utils/Sql.php - SQL工具类
  • src/utils/Str.php - 字符串工具类
  • src/utils/readme.md - 工具类说明文档

• src/helper.php - 全局辅助函数文件