Java学习---Pinyin4j使用手册

一般用法

pinyin4j的使用很方便，一般转换只需要使用PinyinHelper类的静态工具方法即可：

String[] pinyin = PinyinHelper.toHanyuPinyinStringArray(‘刘’);
//该类还有其他的拼音转换形式，但是基本上用不到，就不介绍了

返回的数组即是该字符的拼音，如上例就是pinyin[0]=liu2，后面的数字代表声调，声调为5表示轻读，无声调。之所谓返回数组，是因为被判定的汉字有可能有多个读音。如果输入的参数不是汉字，则返回null。

拼音格式化

如果对于拼音转换后的结果有一些特定的格式要求目前pinyin4j支持：

l 声调格式化。例如：“刘”字的格式化后为“liu2”或“liu”或“liú”

l 对特殊拼音ü的的显示格式。例如“u:”或“v”或“ü”

l 大小写的转换。例如：“liu2”或“LIU2”

以上这些格式可以混合使用，下面就来介绍具体的使用方法，首先需要创建格式化对象HanyuPinyinOutputFormat，例如：

HanyuPinyinOutputFormat outputFormat = new HanyuPinyinOutputFormat();

然后分别调用outputFormat的set方法设置上述一些格式要求：

设置声调格式：

outputFormat.setToneType(HanyuPinyinToneType);

方法参数HanyuPinyinToneType有以下常量对象：

HanyuPinyinToneType.WITH_TONE_NUMBER 用数字表示声调，例如：liu2

HanyuPinyinToneType.WITHOUT_TONE 无声调表示，例如：liu

HanyuPinyinToneType.WITH_TONE_MARK 用声调符号表示，例如：liú

设置特殊拼音ü的显示格式：

outputFormat.setVCharType(HanyuPinyinVCharType);

方法参数HanyuPinyinVCharType有以下常量对象：

HanyuPinyinVCharType.WITH_U_AND_COLON 以U和一个冒号表示该拼音，例如：lu:

HanyuPinyinVCharType.WITH_V 以V表示该字符，例如：lv

HanyuPinyinVCharType.WITH_U_UNICODE 以ü表示

设置大小写格式

outputFormat.setCaseType(HanyuPinyinCaseType);

HanyuPinyinCaseType.LOWERCASE 转换后以全小写方式输出

HanyuPinyinCaseType.UPPERCASE 转换后以全大写方式输出

设置好格式对象后还是利用上述的工具类方法进行拼音转换，只不过需要将格式化对象当成方法参数传入转换方法，告知要转换的格式要求：

String[] pinyin = PinyinHelper.toHanyuPinyinStringArray(‘刘’, outputFormat);

但该方法会有异常抛出，注意处理。

示例

 import net.sourceforge.pinyin4j.PinyinHelper;
 import net.sourceforge.pinyin4j.format.HanyuPinyinCaseType;
 import net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat;
 import net.sourceforge.pinyin4j.format.HanyuPinyinToneType;
 import net.sourceforge.pinyin4j.format.HanyuPinyinVCharType;
 import net.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination;
 public class Test {
     public static void main(String[] args) {
 import net.sourceforge.pinyin4j.PinyinHelper;
 import net.sourceforge.pinyin4j.format.HanyuPinyinCaseType;
 import net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat;
 import net.sourceforge.pinyin4j.format.HanyuPinyinToneType;
 import net.sourceforge.pinyin4j.format.HanyuPinyinVCharType;
 import net.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination;
 public class Test {
     public static void main(String[] args) {
         HanyuPinyinOutputFormat outputFormat = new HanyuPinyinOutputFormat();
         outputFormat.setToneType(HanyuPinyinToneType.WITH_TONE_MARK);
         outputFormat.setVCharType(HanyuPinyinVCharType.WITH_U_UNICODE);
         outputFormat.setCaseType(HanyuPinyinCaseType.UPPERCASE);
         try {
             System.out.println(concatPinyinStringArray(PinyinHelper.toHanyuPinyinStringArray('刘',outputFormat)));
         } catch (BadHanyuPinyinOutputFormatCombination e) {
             // TODO Auto-generated catch block
             e.printStackTrace();
         }
     }

     private static String concatPinyinStringArray(String[] pinyinArray)
     {
         StringBuffer pinyinStrBuf = new StringBuffer();
         if ((null != pinyinArray) && (pinyinArray.length > 0))
         {
             for (int i = 0; i < pinyinArray.length; i++)
             {
                 pinyinStrBuf.append(pinyinArray[i]);
                 pinyinStrBuf.append(System.getProperty("line.separator"));
             }
         }
         String outputString = pinyinStrBuf.toString();
         return outputString;
     }
 }
 输出结果为：LIÚ

其他

l PinyinHelper还有其他的静态方法，但示例和讲解中使用的方法是常见的拼音格式，因此其他静态方法我没有调研其含义。

l 貌似支持生僻字，我试过很怪异的字，都可以将其读音拼写出来，因此这个工具包还是很强的。

拼音工具

 package cn.itcast.bos.utils;

 import java.util.Arrays;

 import net.sourceforge.pinyin4j.PinyinHelper;
 import net.sourceforge.pinyin4j.format.HanyuPinyinCaseType;
 import net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat;
 import net.sourceforge.pinyin4j.format.HanyuPinyinToneType;
 import net.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination;

 public class PinYin4jUtils {
     /**
      * 将字符串转换成拼音数组
      *
      * @param src
      * @return
      */
     public static String[] stringToPinyin(String src) {
         return stringToPinyin(src, false, null);
     }

     /**
      * 将字符串转换成拼音数组
      *
      * @param src
      * @return
      */
     public static String[] stringToPinyin(String src, String separator) {

         return stringToPinyin(src, true, separator);
     }

     /**
      * 将字符串转换成拼音数组
      *
      * @param src
      * @param isPolyphone
      *            是否查出多音字的所有拼音
      * @param separator
      *            多音字拼音之间的分隔符
      * @return
      */
     public static String[] stringToPinyin(String src, boolean isPolyphone,
             String separator) {
         // 判断字符串是否为空
         if ("".equals(src) || null == src) {
             return null;
         }
         char[] srcChar = src.toCharArray();
         int srcCount = srcChar.length;
         String[] srcStr = new String[srcCount];

         for (int i = 0; i < srcCount; i++) {
             srcStr[i] = charToPinyin(srcChar[i], isPolyphone, separator);
         }
         return srcStr;
     }

     /**
      * 将单个字符转换成拼音
      *
      * @param src
      * @return
      */
     public static String charToPinyin(char src, boolean isPolyphone,
             String separator) {
         // 创建汉语拼音处理类
         HanyuPinyinOutputFormat defaultFormat = new HanyuPinyinOutputFormat();
         // 输出设置，大小写，音标方式
         defaultFormat.setCaseType(HanyuPinyinCaseType.LOWERCASE);
         defaultFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);

         StringBuffer tempPinying = new StringBuffer();

         // 如果是中文
         if (src > 128) {
             try {
                 // 转换得出结果
                 String[] strs = PinyinHelper.toHanyuPinyinStringArray(src,
                         defaultFormat);

                 // 是否查出多音字，默认是查出多音字的第一个字符
                 if (isPolyphone && null != separator) {
                     for (int i = 0; i < strs.length; i++) {
                         tempPinying.append(strs[i]);
                         if (strs.length != (i + 1)) {
                             // 多音字之间用特殊符号间隔起来
                             tempPinying.append(separator);
                         }
                     }
                 } else {
                     tempPinying.append(strs[0]);
                 }

             } catch (BadHanyuPinyinOutputFormatCombination e) {
                 e.printStackTrace();
             }
         } else {
             tempPinying.append(src);
         }

         return tempPinying.toString();

     }

     public static String hanziToPinyin(String hanzi) {
         return hanziToPinyin(hanzi, " ");
     }

     /**
      * 将汉字转换成拼音
      *
      * @param hanzi
      * @param separator
      * @return
      */
     public static String hanziToPinyin(String hanzi, String separator) {

         // 创建汉语拼音处理类
         HanyuPinyinOutputFormat defaultFormat = new HanyuPinyinOutputFormat();
         // 输出设置，大小写，音标方式
         defaultFormat.setCaseType(HanyuPinyinCaseType.LOWERCASE);
         defaultFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);

         String pinyingStr = "";
         try {
             pinyingStr = PinyinHelper.toHanyuPinyinString(hanzi, defaultFormat,
                     separator);
         } catch (BadHanyuPinyinOutputFormatCombination e) {
             // TODO Auto-generated catch block
             e.printStackTrace();
         }
         return pinyingStr;
     }

     /**
      * 将字符串数组转换成字符串
      *
      * @param str
      * @param separator
      *            各个字符串之间的分隔符
      * @return
      */
     public static String stringArrayToString(String[] str, String separator) {
         StringBuffer sb = new StringBuffer();
         for (int i = 0; i < str.length; i++) {
             sb.append(str[i]);
             if (str.length != (i + 1)) {
                 sb.append(separator);
             }
         }
         return sb.toString();
     }

     /**
      * 简单的将各个字符数组之间连接起来
      *
      * @param str
      * @return
      */
     public static String stringArrayToString(String[] str) {
         return stringArrayToString(str, "");
     }

     /**
      * 将字符数组转换成字符串
      *
      * @param str
      * @param separator
      *            各个字符串之间的分隔符
      * @return
      */
     public static String charArrayToString(char[] ch, String separator) {
         StringBuffer sb = new StringBuffer();
         for (int i = 0; i < ch.length; i++) {
             sb.append(ch[i]);
             if (ch.length != (i + 1)) {
                 sb.append(separator);
             }
         }
         return sb.toString();
     }

     /**
      * 将字符数组转换成字符串
      *
      * @param str
      * @return
      */
     public static String charArrayToString(char[] ch) {
         return charArrayToString(ch, " ");
     }

     /**
      * 取汉字的首字母
      *
      * @param src
      * @param isCapital
      *            是否是大写
      * @return
      */
     public static char[] getHeadByChar(char src, boolean isCapital) {
         // 如果不是汉字直接返回
         if (src <= 128) {
             return new char[] { src };
         }
         // 获取所有的拼音
         String[] pinyingStr = PinyinHelper.toHanyuPinyinStringArray(src);

         // 创建返回对象
         int polyphoneSize = pinyingStr.length;
         char[] headChars = new char[polyphoneSize];
         int i = 0;
         // 截取首字符
         for (String s : pinyingStr) {
             char headChar = s.charAt(0);
             // 首字母是否大写，默认是小写
             if (isCapital) {
                 headChars[i] = Character.toUpperCase(headChar);
             } else {
                 headChars[i] = headChar;
             }
             i++;
         }

         return headChars;
     }

     /**
      * 取汉字的首字母(默认是大写)
      *
      * @param src
      * @return
      */
     public static char[] getHeadByChar(char src) {
         return getHeadByChar(src, true);
     }

     /**
      * 查找字符串首字母
      *
      * @param src
      * @return
      */
     public static String[] getHeadByString(String src) {
         return getHeadByString(src, true);
     }

     /**
      * 查找字符串首字母
      *
      * @param src
      * @param isCapital
      *            是否大写
      * @return
      */
     public static String[] getHeadByString(String src, boolean isCapital) {
         return getHeadByString(src, isCapital, null);
     }

     /**
      * 查找字符串首字母
      *
      * @param src
      * @param isCapital
      *            是否大写
      * @param separator
      *            分隔符
      * @return
      */
     public static String[] getHeadByString(String src, boolean isCapital,
             String separator) {
         char[] chars = src.toCharArray();
         String[] headString = new String[chars.length];
         int i = 0;
         for (char ch : chars) {

             char[] chs = getHeadByChar(ch, isCapital);
             StringBuffer sb = new StringBuffer();
             if (null != separator) {
                 int j = 1;

                 for (char ch1 : chs) {
                     sb.append(ch1);
                     if (j != chs.length) {
                         sb.append(separator);
                     }
                     j++;
                 }
             } else {
                 sb.append(chs[0]);
             }
             headString[i] = sb.toString();
             i++;
         }
         return headString;
     }

     public static void main(String[] args) {
         // pin4j 简码 和 城市编码
         String s1 = "中华人民共和国";
         String[] headArray = getHeadByString(s1); // 获得每个汉字拼音首字母
         System.out.println(Arrays.toString(headArray));

         String s2 ="长城" ;
         System.out.println(Arrays.toString(stringToPinyin(s2,true,",")));

         String s3 ="长";
         System.out.println(Arrays.toString(stringToPinyin(s3,true,",")));
     }
 }