README

📝 项目简介

这是一个功能强大的汉字转拼音工具，基于权威的Unihan数据库，提供完整的汉字拼音转换解决方案。支持自定义映射、特殊字符处理、自动学习功能和多音字处理，适用于各种需要拼音转换的应用场景。

🧩 功能模块列表

1. 核心转换系统

拼音转换器 - 提供基础转换、带声调转换、URL Slug生成等核心功能
字典加载系统 - 支持懒加载和多级缓存机制，优化内存使用
特殊字符处理器 - 支持keep、delete、replace三种处理模式

2. 字典系统

自定义字典 - 用户自定义拼音映射
多音字规则字典 - 基于上下文的多音字处理规则
常用字典 - 常用汉字拼音映射
生僻字字典 - 罕见汉字拼音映射
Unihan字典 - 基于Unicode数据库的权威拼音数据

3. 后台任务管理

任务管理器 - 管理后台任务队列
任务运行器 - 支持守护进程、批量处理和一次性执行模式
任务调度 - 支持周期性任务和优先级队列

4. Unihan数据管理

数据更新 - 自动更新Unihan数据库
数据报告 - 生成字典覆盖范围统计
区块管理 - 支持CJK基本汉字及扩展区A-G的拼音数据

5. 智能学习系统

自学习字典 - 自动识别并记忆生僻字拼音
字典合并 - 支持自学习字典与自定义字典合并
权重分析 - 基于使用频率优化多音字选择

6. 工具集

测试工具 - 支持多种测试类型和覆盖率报告
格式转换工具 - 字典格式标准化处理
备份恢复工具 - 字典文件备份和恢复功能

✨ 核心特性

🔤 精准转换 - 支持常用字和生僻字的准确拼音转换
🧠 智能学习 - 自动识别并记忆生僻字的拼音，支持自学习字典合并
🎛️ 多模式处理 - 三种特殊字符处理模式：keep/delete/replace
🔀 多音字识别 - 基于上下文的多音字智能处理
📚 完整字典系统 - 多级字典优先级，支持懒加载和内存优化
⚡ 高性能 - 多级缓存机制，支持高频字符快速转换
🔧 灵活配置 - 丰富的配置选项，满足不同使用场景
🔄 后台任务 - 完整的后台任务管理系统，支持守护进程模式
🌐 Unihan集成 - 基于Unicode权威数据库的拼音数据

💡 技术亮点

1. 多级字典优先级系统

创新的五级字典优先级设计（自定义 > 多音字规则 > 常用字 > 生僻字 > Unihan），确保拼音转换的准确性和灵活性。

2. 高性能处理机制

多级缓存设计，支持高频字符快速转换
懒加载策略，优化内存使用
批量处理模式，提高大规模转换效率

3. 智能多音字识别

基于上下文的多音字智能处理，通过规则匹配和权重算法，在不同语境中选择正确的拼音。

4. 完整的Unihan数据覆盖

覆盖超过60,000个汉字，包括CJK基本汉字及扩展区A-G的全部拼音数据，提供最全面的汉字拼音支持。

5. 灵活的配置系统

丰富的配置选项，支持自定义字典加载策略、持久化设置和自动保存间隔等参数，满足不同使用场景需求。

6. 完善的后台任务架构

支持守护进程模式的任务管理系统，可处理异步转换请求和大批量数据处理任务，适用于生产环境。

7. 智能学习能力

自动识别并记忆生僻字拼音，通过自学习机制不断优化转换准确性，实现系统的持续进化。

8. 全面的测试覆盖

包含基础转换、多音字、特殊字符、自定义字典和边界条件等多种测试类型，确保系统稳定性和准确性。

📋 快速开始

安装

使用Composer安装：

composer require tekintian/pinyin

基本使用

use tekintian\pinyin\PinyinConverter;

// 创建实例
$pinyinConverter = new PinyinConverter();

// 基本转换
$pinyin = $pinyinConverter->convert('你好，世界！');
echo $pinyin; // 输出: ni hao shi jie

// 保留声调
$pinyinWithTone = $pinyinConverter->convert('你好，世界！', ' ', true);
echo $pinyinWithTone; // 输出: nǐ hǎo shì jiè

// 生成URL Slug
$slug = $pinyinConverter->getUrlSlug('你好，世界！');
echo $slug; // 输出: ni-hao-shi-jie

🏗️ 项目架构

字典优先级系统

从高到低依次为：

custom_xxx - 自定义字典（用户自定义映射）
polyphone_xxx - 多音字规则字典
common_xxx - 常用字典
rare_xxx - 生僻字字典
unihan - Unihan字典（基于权威Unicode数据库）

核心模块

src/PinyinConverter.php - 主转换器类，提供核心转换功能
src/BackgroundTaskManager.php - 后台任务管理器
bin/task_runner.php - 统一任务运行器（支持守护进程模式）
unicode/ - Unihan数据管理和处理工具
tools/ - 辅助工具集（自动获取、测试、解析等）

🚀 高级功能

后台任务管理

# 守护进程模式（推荐生产环境）
php bin/task_runner.php -m daemon -i 60

# 批量处理模式
php bin/task_runner.php -m batch -b 100 -l 500

# 一次性执行模式
php bin/task_runner.php -m once

Unihan数据管理

use tekintian\pinyin\unicode\UnihanDataManager;

$manager = new UnihanDataManager();

// 更新Unihan数据
$updated = $manager->updateData();

// 生成数据报告
$report = $manager->generateReport();

特殊字符处理

// keep模式：保留所有特殊字符
$result = $converter->convert('你好$世界', ' ', false, 'keep');

// delete模式：删除非安全字符
$result = $converter->convert('你好$世界', ' ', false, 'delete');

// replace模式：自定义替换
$result = $converter->convert('你好$世界', ' ', false, [
    'mode' => 'replace',
    'map' => ['$' => 'dollar']
]);

📊 数据统计

Unihan字典覆盖

区块	字符数量	说明
CJK基本汉字	20,924	常用汉字
CJK扩展A区	5,786	扩展A区生僻字
CJK扩展B区	14,614	扩展B区生僻字
CJK扩展C区	506	扩展C区生僻字
CJK扩展D区	222	扩展D区生僻字
CJK扩展E区	5,762	扩展E区生僻字
CJK扩展F区	7,473	扩展F区生僻字
CJK扩展G区	4,939	扩展G区生僻字

总计: 超过 60,000 个汉字的完整拼音覆盖

📚 详细文档

📖 项目架构和使用指南 - 完整的项目架构说明和使用方法
🔧 工具使用手册 - 所有工具的使用方法和示例
📊 数据字典说明 - 字典系统的详细说明
🔄 后台任务管理 - 后台任务系统的使用指南
🌐 Unihan数据处理 - Unihan数据管理工具说明

⚙️ 配置选项

$config = [
    'dict' => [
        // 字典文件路径配置
    ],
    'dict_loading' => [
        'strategy' => 'both',        // 字典加载策略
        'lazy_loading' => true,    // 懒加载开关
        'preload_priority' => ['custom', 'common'], // 预加载优先级
    ],
    'custom_dict_persistence' => [
        'enable' => true,           // 自定义字典持久化
        'delay_write' => true,      // 延迟写入
        'auto_save_interval' => 300  // 自动保存间隔（秒）
    ]
];

$pinyinConverter = new PinyinConverter($config);

🧪 测试

本项目所有测试通过 run_tests.sh 脚本统一管理，支持多种测试类型和参数选项：

# 基本使用 - 运行所有测试
./run_tests.sh

./run_tests.sh all                    # 运行所有测试
./run_tests.sh unit --coverage        # 运行单元测试并生成覆盖率
./run_tests.sh fast                   # 运行快速测试
./run_tests.sh basic                  # 运行基础转换测试

注意: prod分支不包含测试用例代码和 unicode 数据管理工具和 tools 目录

测试类型说明

该测试脚本包含以下测试类型：

基础转换测试 - 验证常用汉字和词组的拼音转换正确性
多音字测试 - 测试多音字在不同上下文中的正确识别
特殊字符测试 - 验证各种特殊字符处理模式的正确性
自定义字典测试 - 测试自定义映射规则的生效情况
边界条件测试 - 测试空字符串、超长字符串等边界情况

测试报告

运行测试后，将生成 Markdown 格式的测试报告，包含详细的测试结果统计和潜在问题分析。

其他测试方式

# 快速测试
php tools/quick_pinyin_test.php

# 通过Composer运行测试
composer test

详细测试文档请参考测试指南.md

🔄 开发计划

✅ 已完成功能

基础汉字转拼音功能
多音字处理
自学习字典系统
后台任务管理
Unihan数据集成
完整的工具集

🔜 计划功能

更智能的多音字上下文识别
分布式任务处理支持
Web界面管理工具
更多拼音数据源集成

🤝 贡献指南

欢迎贡献代码！请阅读：

📄 许可证

本项目使用MIT许可证，详情请查看LICENSE文件。

🔗 相关链接

版本: 1.0.0
最后更新: 2025-11-20 维护者: tekintian https://dev.tekin.cn

tekintian / pinyin

Maintainers

Details