转载 - Pinyin4j的基本用法
原文:http://blog.csdn.net/pathuang68/article/details/6692882
1. 简单介绍
有时候,需要将汉字编程对应的拼音,以方便数据的处理。比如在Android手机应用的开发上,要查询联系人的姓名,通常都是用拼音进行查询的。比如要查询“曹孟德”,就可以输入“cmd”,即“曹孟德”三个汉字的拼音“caomengde”各字的首字母。但是怎样才能将“曹孟德”翻译成“caomengde”呢?很简单的办法就是建立一个大的对照表(比如用关联容器Map),比如<”曹”,”cao”>,<” 孟”,”meng”>,<” 德”,”de”>…但这样的做法,需要维护好一个比较大的对照表,同时一个汉字可能有多个发音,也就是说Map这样的容器时不行的,因为其<key,value>必须是一一对应的。在C++中可以用STL里面的multimap来解决这个问题,但Java中没有类似multimap这样的东西,除非自己实现一个。
Pinyin4j就是为了解决类似这样的问题的。它是sourceforge.net上的一个开源项目,功能非常强大:
+ 支持同一汉字有多个发音
+ 还支持拼音的格式化输出,比如第几声之类的,
+ 同时支持简体中文、繁体中文转换为拼音…使用起来也非常简单。下面是其官方网址,其中提供了下载:
http://pinyin4j.sourceforge.net/
2. 基本用法:
通常情况下,只需要用到其中的PinyinHelper类中的静态方法toHanyuPinyinStringArray就可以了,比如:
1 String[] pinyinArray =PinyinHelper.toHanyuPinyinStringArray('单'); 2 3 for(int i = 0; i < pinyinArray.length; ++i) 4 5 { 6 7 System.out.println(pinyinArray[i]); 8 9 }
就会输出:
dan1
chan2
shan4
这三种发音,后面的数字代表第几声。可以看到静态方法toHanyuPinyinStringArray返回的数据类型是一个String数组,它用来接收一个汉字的多个发音,如果toHanyuPinyinStringArray中的参数不是汉字,那么它会返回null。
3. 格式支持
Pinyin4j支持拼音输出的格式化,比如,“黄”可以输出为“huang”、“huang2”、“huáng”等等,下面的代码就似是输出“huáng”的示例:
1 HanyuPinyinOutputFormat format= new HanyuPinyinOutputFormat(); 2 3 format.setToneType(HanyuPinyinToneType.WITH_TONE_MARK); 4 5 format.setVCharType(HanyuPinyinVCharType.WITH_U_UNICODE); 6 7 8 9 String[] pinyinArray = null; 10 11 try 12 13 { 14 15 pinyinArray = PinyinHelper.toHanyuPinyinStringArray('黄', format); 16 17 } 18 19 catch(BadHanyuPinyinOutputFormatCombination e) 20 21 { 22 23 e.printStackTrace(); 24 25 } 26 27 for(int i = 0; i < pinyinArray.length; ++i) 28 29 { 30 31 System.out.println(pinyinArray[i]); 32 33 }
此外,还支持大小写转换、ü等等。详细情况,可以查看Pinyin4j自带的文档。
4. 实际示例代码
如果我们要将一段文字中的汉字全部转换成不带音调的拼音输出,而这段文字中又可能包含阿拉伯数字、英文、标点符号等等。如果完全靠自己写代码进行转换,那是非常麻烦的,其中一个首先就要区别,这段文字中那些是汉字,那些是非汉字。有了Pinyin4j,这个问题就不再困难了,因为对于非汉字,Pinyin4j会自动输出null。参考下面的示例代码:
1 importnet.sourceforge.pinyin4j.*; 2 3 importnet.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat; 4 5 importnet.sourceforge.pinyin4j.format.HanyuPinyinToneType; 6 7 importnet.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination; 8 9 10 11 public class Chinese2PY 12 13 { 14 15 public static void main(String[] args) 16 17 { 18 19 Hanyu hanyu = new Hanyu(); 20 21 // 中英文混合的一段文字 22 23 String str = "荆溪白石出,Hello 天寒红叶稀。Android 山路元无雨,What's up? 空翠湿人衣。"; 24 25 String strPinyin = hanyu.getStringPinYin(str); 26 27 System.out.println(strPinyin); 28 29 } 30 31 } 32 33 34 35 class Hanyu 36 37 { 38 39 private HanyuPinyinOutputFormat format = null; 40 41 private String[] pinyin; 42 43 44 45 public Hanyu() 46 47 { 48 49 format = new HanyuPinyinOutputFormat(); 50 51 format.setToneType(HanyuPinyinToneType.WITHOUT_TONE); 52 53 54 55 pinyin = null; 56 57 } 58 59 60 61 //转换单个字符 62 63 public String getCharacterPinYin(char c) 64 65 { 66 67 try 68 69 { 70 71 pinyin = PinyinHelper.toHanyuPinyinStringArray(c, format); 72 73 } 74 75 catch(BadHanyuPinyinOutputFormatCombination e) 76 77 { 78 79 e.printStackTrace(); 80 81 } 82 83 84 85 // 如果c不是汉字,toHanyuPinyinStringArray会返回null 86 87 if(pinyin == null) return null; 88 89 90 91 // 只取一个发音,如果是多音字,仅取第一个发音 92 93 return pinyin[0]; 94 95 } 96 97 98 99 //转换一个字符串 100 101 public String getStringPinYin(String str) 102 103 { 104 105 StringBuilder sb = new StringBuilder(); 106 107 String tempPinyin = null; 108 109 for(int i = 0; i < str.length(); ++i) 110 111 { 112 113 tempPinyin =getCharacterPinYin(str.charAt(i)); 114 115 if(tempPinyin == null) 116 117 { 118 119 // 如果str.charAt(i)非汉字,则保持原样 120 121 sb.append(str.charAt(i)); 122 123 } 124 125 else 126 127 { 128 129 sb.append(tempPinyin); 130 131 } 132 133 } 134 135 return sb.toString(); 136 137 } 138 139 }
输出结果:
jingxibaishichu,Hellotianhanhongyexi。Android shanluyuanwuyu,What'sup? kongcuishirenyi。