EzPinyin 1.0.15

There is a newer version of this package available.
See the version list below for details.
dotnet add package EzPinyin --version 1.0.15                
NuGet\Install-Package EzPinyin -Version 1.0.15                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EzPinyin" Version="1.0.15" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EzPinyin --version 1.0.15                
#r "nuget: EzPinyin, 1.0.15"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EzPinyin as a Cake Addin
#addin nuget:?package=EzPinyin&version=1.0.15

// Install EzPinyin as a Cake Tool
#tool nuget:?package=EzPinyin&version=1.0.15                

EzPinyin

介绍

适用于.Net Framework及.Net Standard的汉字转拼音组件。主要的设计目是实现对字符串进行快速的拼音转换,从而帮助开发人员在做数据开发时可以简单快速的建立拼音索引。

提示

本项目处于不停迭代中,若你使用过程中发现如下问题,建议升级到最新版本:

  • 用户自定义UTF32词汇的拼音格式不正确问题,包括1.0.13之前所有的版本。
  • 拼音格式不正确并且抛出NullReferenceException,包括版本1.0.2。

特性

  • 极快的处理速度,具体请参考性能章节。
  • 涵盖统一码平面A的基本汉字区及补充汉字区、汉字扩展区A的全部汉字,涵盖统一码平面B的汉字扩展区B、C、D、E、F、G的大部分汉字,总计约覆盖九万汉字、五十万词汇。
  • 高质量的字典,通过重新对字典中的多音字进行分析优化,使得此项目对于名称的处理具备更好的效果。
  • 除了支持在运行时重定义拼音之外,还可以用配置文件的方式自定义汉字或者词汇的拼音,从而达到修正或者补充的效果。
  • 词典同时适配简体与繁体。
  • 小巧简洁,包含字典、词典内容在内不超过1M,无其他项目依赖。

性能

对常见字符进行处理时,本项目的性能参考数据如下表所示:

项目 性能(字/秒)
检索拼音字符串 3000万
检索拼音首字母 5000万
检索拼音数组 6000万

兼容性

.Net Framework 2.0及以上 或者.Net Standard 2.0及以上。

线程安全性

如注释文档中没有额外说明,此项目中公开的方法都是线程安全的。

引用本项目

除了直接下载项目之外,还可以通过nuget来添加并使用本项目。本项目的nuget地址为 https://www.nuget.org/packages/EzPinyin/
可以通过visual studio的界面来搜索“ezpinyin”来引用本项目,也可以在nuget管理控制台输入命令来添加项目引用:“Install-Package EzPinyin”。

示例

//获得拼音完整字符串
PinyinHelper.GetPinyin("重庆银行川藏大区成都分行朝阳区长厦路重工大厦行动处九楼董事长藏宝室");//chong qing yin hang chuan zang da qu cheng du fen hang chao yang qu chang xia lu zhong gong da sha xing dong chu jiu lou dong shi zhang cang bao shi

//获得拼音的首字母
PinyinHelper.GetInitial("㐀㲒䔤䶵𠀀𠧄𡎈𡵌𢜐𣃔𣪘𤑜𤸠𥟤𦆨𦭬𧔰𧻴𨢸𩉼𩱀𪜀𪻐𫜴𫝀𫠝𫠠𫿰𬟀𬺰𭡫𮈦𰀀𱍊");//qbpchgfcwdgzmlldjlkspdc𫜴wbyst𬺰𭡫lzc

//获得拼音信息的数组
PinyinHelper.GetArray(text);//string[]

//重新定义拼音信息
PinyinHelper.Define("𫜴", "lun");//拼音仅供演示
PinyinHelper.Define("𫜴吧", new[]{"lun", "biu"});//拼音仅供演示

//加载自定义的拼音配置文件
PinyinHelper.LoadFrom("custom_file.txt");//文件内容格式请参考自定义配置章节。

//跳过文件名称,直接加载自定义配置文件的内容
PinyinHelper.Load("𫜴 liu\n𫜴吧 lun biu");//内容格式请参考自定义配置章节。

更多请参考EzPinyin.UnitTest项目中的代码。

自定义配置

你可以自定义一个或者数个文件名称包含“dict”关键字的文本文件作为自定义字典文件,扩展名不一定必须是“.txt”,将这些文件置于应用程序集相同的目录即可发挥作用,配置文件可以定义字符或者词汇的拼音,定义已经存在的字符或者词汇将进行重写,定义简体词汇将同步更新其对应的繁体词汇,也可以单独定义繁体词的词汇(但不会同步更新对应的简体字词汇),如果多次定义相同的信息,以最后一次生效的为准,配置细节请参考dictionary.txt模板。如无特别提示,本项目所有的文本文件支持的编码为UTF8。

免责声明

由于多音字在不同语义下的意涵十分复杂,因而这个项目在处理多音字时仍然会出现错误。任何使用本项目的开发人员应该理解这个问题并谨慎使用,此项目的开发者不对此项目的任何功能或者问题(或损失)提供任何(直接或间接)担保与承诺。

特别致谢

本项目的开发者仅贡献了核心的查询与优化算法,主要的汉字数据则自互联网收集,在此要特别感谢此项目的直接数据来源:

此外,此项目也吸收了下列站点的部分内容作为参考,一并致谢。

支持

此项目当前没有任何盈利计划,若你认为她对你有所帮助,可以考虑支持叶典(http://yedict.com/zhichi.htm) 或其他相关网站。

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net20 is compatible.  net35 was computed.  net40 was computed.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 2.0

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.