Download the PHP package overtrue/pinyin without Composer
On this page you can find all versions of the php package overtrue/pinyin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download overtrue/pinyin
More information about overtrue/pinyin
Files in overtrue/pinyin
Package pinyin
Short Description Chinese to pinyin translator.
License MIT
Homepage https://github.com/overtrue/pinyin
Informations about the package pinyin
Pinyin
:cn: 基于 mozillazg/pinyin-data 词典的中文转拼音工具,更准确的支持多音字的汉字转拼音解决方案。
特性
- 准确的多音字支持
- 多种拼音风格(声调符号、数字声调、无声调)
- 支持姓氏识别
- 灵活的性能优化策略
- 内存友好的设计
- 完善的测试覆盖
安装
使用 Composer 安装:
使用
拼音风格
除了获取首字母的方法外,所有方法都支持第二个参数,用于指定拼音的格式,可选值为:
symbol
(默认)声调符号,例如pīn yīn
none
不输出声调,例如pin yin
number
末尾数字模式的拼音,例如pin1 yin1
你可以使用字符串值或者 ToneStyle
枚举:
返回值
除了 permalink
返回字符串外,其它方法都返回集合类型 Overtrue\Pinyin\Collection
:
你可以通过以下方式访问集合内容:
文字段落转拼音
生成用于链接的拼音字符串
通常用于文章链接等,可以使用 permalink
方法获取拼音字符串:
获取首字符字符串
通常用于创建搜索用的索引,可以使用 abbr
方法转换:
姓名首字母
将首字作为姓氏转换,其余作为普通词语转换:
姓名转换
姓名的姓的读音有些与普通字不一样,比如 ‘单’ 常见的音为 dan
,而作为姓的时候读 shan
。
护照姓名转换
根据国家规定 关于中国护照旅行证上姓名拼音 ü(吕、律、闾、绿、女等)统一拼写为 YU 的提醒 的规则,将 ü
转换为 yu
:
多音字
多音字的返回值为关联数组的集合,默认返回去重后的所有读音:
如果不想要去重,可以数组形式返回:
单字转拼音
和多音字类似,单字的返回值为字符串,多音字将根据该字字频调整得到常用音:
Warning
当单字处理时由于多音字来自词频表中取得常用音,所以在词语环境下可能出现不正确的情况,建议使用多音字处理。
性能优化策略 🚀
v6.0+ 版本提供了三种不同的转换策略,以适应不同的使用场景:
1. 内存优化策略(Memory Optimized)- 默认
- 内存占用:~400KB
- 适用场景:Web 请求、内存受限环境
- 特点:每次加载一个词典段,用完即释放
2. 缓存策略(Cached)
- 内存占用:~4MB
- 适用场景:批处理、长时运行进程
- 特点:缓存所有词典数据,重复转换速度提升 2-3 倍
3. 智能策略(Smart)
- 内存占用:600KB-1.5MB
- 适用场景:通用场景、自动优化
- 特点:根据文本长度智能选择加载策略
自动选择策略
直接使用 Converter
性能对比
策略 | 内存占用 | 首次转换 | 重复转换 | 推荐场景 |
---|---|---|---|---|
Memory Optimized | ~400KB | 中等 | 中等 | Web 请求 |
Cached | ~4MB | 慢 | 最快 | 批处理 |
Smart | 600KB-1.5MB | 快 | 快 | 通用场景 |
运行基准测试查看实际性能:
性能优化最佳实践
选择合适的策略
根据您的使用场景选择最合适的转换策略:
Web 应用(Laravel、Symfony 等)
CLI 批处理脚本
队列任务处理
性能监控
基准测试
项目提供了多个基准测试工具:
基准测试会显示不同策略的性能对比,包括:
- 内存使用情况
- 转换速度
- 不同文本长度的性能表现
内存管理建议
- 生产环境:使用
Memory Optimized
策略,避免内存泄漏 - 开发环境:可以使用
Smart
策略,平衡性能和内存 - 批处理任务:使用
Cached
策略,处理完成后调用clearCache()
- 内存受限环境:严格使用
Memory Optimized
策略
性能对比数据
基于 1000 次转换的基准测试结果:
场景 | Memory Optimized | Cached | Smart |
---|---|---|---|
短文本(<10字) | 1.2ms | 0.5ms | 0.8ms |
中等文本(10-50字) | 3.5ms | 1.2ms | 2.1ms |
长文本(>100字) | 8.7ms | 3.1ms | 5.2ms |
内存占用 | 400KB | 4MB | 1.5MB |
💡 提示:缓存策略在重复转换时性能提升约 2-3 倍,但会占用更多内存。
v/yu/ü 的问题
根据国家语言文字工作委员会的规定,lv
、lyu
、lǚ
都是正确的,但是 lv
是最常用的,所以默认使用 lv
,如果你需要使用其他的,可以在初始化时传入:
Warning
仅在拼音风格为非
none
模式下有效。
命令行工具
你可以使用命令行来实现拼音的转换:
更多使用方法,可以查看帮助文档:
命令行工具示例
在 Laravel 中使用
独立的包在这里:overtrue/laravel-pinyin
中文简繁转换
如何你有这个需求,也可以了解我的另一个包:overtrue/php-opencc
Contribution
欢迎提意见及完善补充词库:
- 单字拼音错误请添加到:sources/pathes/chars.txt;
- 词语错误或补齐,请添加到:sources/pathes/words.txt;
参考
:heart: Sponsor me
如果你喜欢我的项目并想支持它,点击这里 :heart:
PHP 扩展包开发
想知道如何从零开始构建 PHP 扩展包?
请关注我的实战课程,我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》
License
MIT