工具类---Pinyin4j工具类的使用

妖狐艹你老母 2023-10-18 09:49 37阅读 0赞

说明：在开发中我们遇到**把汉字转换成拼音**这样一个需求，下面就是我从网上看了相关的资料总结的一个工具类，可以直接使用。

第一步：在创建的maven项目的pom.xml文件加入下列代码

<dependency>
            <groupId>com.belerweb</groupId>
            <artifactId>pinyin4j</artifactId>
            <version>2.5.0</version>
        </dependency>

第二步：创建Pinyin4jUtils类，写入下列代码

package cn.jeeweb.core.utils;
    
    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{
    
        HanyuPinyinOutputFormat format = null;
        public static enum Type {
            UPPERCASE,			  //全部大写
            LOWERCASE,			  //全部小写
            FIRSTUPPER            //首字母大写
        }
    
        public Pinyin4jUtils(){
            format = new HanyuPinyinOutputFormat();
            format.setCaseType(HanyuPinyinCaseType.UPPERCASE);
            format.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
        }
    
        /**
         * 将汉字转换成拼音首字母大写
         * @param str 字符串
         * @return str为'我爱编程' ,return获取到的是'WABC'
         * @throws BadHanyuPinyinOutputFormatCombination
         */
        public String toPinYinUppercase(String str) throws BadHanyuPinyinOutputFormatCombination {
            return toPinYin(str, "", Type.UPPERCASE);
        }
    
        /**
         * 将汉字转换成拼音首字母大写,可设置字母间的间隔符
         * @param str 字符串
         * @param spera 转换字母间隔加的字符串,如果不需要为""
         * @return str为'我爱编程' ,spera为'@' return获取到的是'W@A@B@C'
         * @throws BadHanyuPinyinOutputFormatCombination
         */
        public String toPinYinUppercase(String str,String spera) throws BadHanyuPinyinOutputFormatCombination{
            return toPinYin(str, spera, Type.UPPERCASE);
        }
    
        /**
         *  将汉字转换成拼音首字母小写
         * @param str 字符串
         * @return	str为'我爱编程' ,return获取到的是'wabc'
         * @throws BadHanyuPinyinOutputFormatCombination
         */
        public String toPinYinLowercase(String str) throws BadHanyuPinyinOutputFormatCombination{
            return toPinYin(str, "", Type.LOWERCASE);
        }
    
        /**
         * 将汉字转换成拼音首字母小写,可设置字母间的间隔符
         * @param str 字符串
         * @param spera 转换字母间隔加的字符串,如果不需要为""
         * @return	str为'我爱编程',spera为'@' return获取到的是'w@a@b@c'
         * @throws BadHanyuPinyinOutputFormatCombination
         */
        public String toPinYinLowercase(String str,String spera) throws BadHanyuPinyinOutputFormatCombination{
            return toPinYin(str, spera, Type.LOWERCASE);
        }
    
        /**
         * 获取拼音首字母大写
         * @param str 字符串
         * @return str为'我爱编程' ,return获取到的是'W'
         * @throws BadHanyuPinyinOutputFormatCombination 异常信息
         */
        public String toPinYinUppercaseInitials(String str) throws BadHanyuPinyinOutputFormatCombination {
            String initials = null;
            String py = toPinYinUppercase(str);
            if(py.length()>1){
                initials = py.substring(0, 1);
            }
            if(py.length()<=1){
                initials = py;
            }
            return initials.trim();
        }
    
        /**
         * 获取拼音首字母小写
         * @param str 字符串
         * @return str为'我爱编程' ,return获取到的是'w'
         * @throws BadHanyuPinyinOutputFormatCombination 异常信息
         */
        public String toPinYinLowercaseInitials(String str) throws BadHanyuPinyinOutputFormatCombination {
            String initials = null;
            String py = toPinYinLowercase(str);
            if(py.length()>1){
                initials = py.substring(0, 1);
            }
            if(py.length()<=1){
                initials = py;
            }
            return initials.trim();
        }
    
        /**
         * 将str转换成拼音，如果不是汉字或者没有对应的拼音，则不作转换
         * @param str    字符串
         * @param spera  默认,可为""
         * @param type   转换格式
         * @return 按照转换格式转换成字符串
         * @throws BadHanyuPinyinOutputFormatCombination 异常信息
         */
        public String toPinYin(String str, String spera, Type type) throws BadHanyuPinyinOutputFormatCombination {
            if(str == null || str.trim().length()==0) {
                return "";
            }
            if(type == Type.UPPERCASE) {
                format.setCaseType(HanyuPinyinCaseType.UPPERCASE);
            } else{
                format.setCaseType(HanyuPinyinCaseType.LOWERCASE);
            }
            String py = "";
            String temp = "";
            String[] t;
            for(int i=0;i<str.length();i++){
                char c = str.charAt(i);
                if((int)c <= 128)  {
                    py += c;
                }else{
                    t = PinyinHelper.toHanyuPinyinStringArray(c, format);
                    if(t == null) {
                        py += c;
                    }else{
                        temp = t[0];
                        if(type == Type.FIRSTUPPER) {
                            temp = t[0].toUpperCase().charAt(0)+temp.substring(1);
                        }
                        if(temp.length()>=1){
                            temp = temp.substring(0, 1);
                        }
                        py += temp+(i==str.length()-1?"":spera);
                    }
                }
            }
            return py.trim();
        }
    
    }