通讯录获取首字母，并以首字母归类返回

需求背景

最近在做的一个项目里，有需要展示我的通讯录功能，与前端沟通结果是我将通讯录里所有联系人全部在接口里返给他们，当然返回的数据格式是按照首字母已经归类好了的，整体返回对象是一个Map<String,List>,key值就是首字母firstChar，value是所有首字母的集合list

具体实战

pinyinUtil

在录入通讯录的时候， 根据录入的中文服务端在入库的时候取到中文对应的首字母存到表里，这里有一个jar包已经有很好的封装方法。首先要引入

<!--汉语拼音-->
<dependency>
		<groupId>com.belerweb</groupId>
		<artifactId>pinyin4j</artifactId>
		<version>2.5.0</version>
</dependency>
           

然后看这里提供的两个方法，一个是将中文转拼音，这个有可能有这样的业务场景，另一个就是根据输入字符串取首字母了，里面逻辑还可以根据具体需求进行修改，我这里是将特殊字符和数字全部按照#号处理，消防微信做的

import lombok.extern.slf4j.Slf4j;
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;

/**
 * @author zhangyu
 * @description 汉语拼音工具类
 * @date 2019/5/23 17:42
 */
@Slf4j
public class PinyinUtil {

    /**
     * 将文字转为汉语拼音
     * @param chineseLanguage 要转成拼音的中文
     */
    public static String convertToPinyin(String chineseLanguage){
        char[] cl_chars = chineseLanguage.trim().toCharArray();
        String pinyin = "";
        HanyuPinyinOutputFormat defaultFormat = new HanyuPinyinOutputFormat();
        // 输出拼音全部小写
        defaultFormat.setCaseType(HanyuPinyinCaseType.LOWERCASE);
        // 不带声调
        defaultFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
        defaultFormat.setVCharType(HanyuPinyinVCharType.WITH_V) ;
        try {
            for (int i=0; i<cl_chars.length; i++){
                // 如果字符是中文,则将中文转为汉语拼音
                if (String.valueOf(cl_chars[i]).matches("[\u4e00-\u9fa5]+")){
                    pinyin += PinyinHelper.toHanyuPinyinStringArray(cl_chars[i], defaultFormat)[0];
                } else {
                    // 如果字符不是中文,则不转换
                    pinyin += cl_chars[i];
                }
            }
        } catch (BadHanyuPinyinOutputFormatCombination e) {
            log.info("字符:{},转拼音异常，原因为{}",chineseLanguage,e);
        }
        return pinyin;
    }


    /**
     * 取第一个汉字的第一个字符
     * @Title: getFirstLetter
     * @Description: TODO
     * @return String
     * @throws
     */
    public static String getFirstLetter(String chineseLanguage){
        char[] cl_chars = chineseLanguage.trim().toCharArray();
        String pinyin = "";
        HanyuPinyinOutputFormat defaultFormat = new HanyuPinyinOutputFormat();
        // 输出拼音全部大写
        defaultFormat.setCaseType(HanyuPinyinCaseType.UPPERCASE);
        // 不带声调
        defaultFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
        try {
            String str = String.valueOf(cl_chars[0]);
            // 如果字符是中文,则将中文转为汉语拼音,并取第一个字母
            if (str.matches("[\u4e00-\u9fa5]+")) {
                pinyin = PinyinHelper.toHanyuPinyinStringArray(cl_chars[0], defaultFormat)[0].substring(0, 1);
            } else if (str.matches("[0-9]+")) {
                // 如果字符是数字,取数字
                //pinyin += cl_chars[0];
                //本次需求数字变成#
                return "#";
            } else if (str.matches("[a-zA-Z]+")) {
                // 如果字符是字母,取字母
                pinyin += cl_chars[0];
            } else {
                // 否则返回'#'
                return "#";
            }
        } catch (BadHanyuPinyinOutputFormatCombination e) {
            log.info("字符:{},转拼音异常，原因为{}",chineseLanguage,e);
        }
        if(chineseLanguage.startsWith("重庆") || chineseLanguage.startsWith("长沙")
                || chineseLanguage.startsWith("长春") ||chineseLanguage.startsWith("长治")){
            return "C";
        }
        if(chineseLanguage.startsWith("厦门")){
            return "X";
        }
        return pinyin;
    }

    public static void main(String[] args) {
        System.out.println(convertToPinyin("张飞"));
        System.out.println(getFirstLetter("长沙市"));
    }
}
           

有了获取首字母入库的前提条件后，再返回前端通讯录时，按照前端伙伴的需求将结果按照首字母归类返回

public Map<String,List<AddressBookVO>> list() {
        //伪代码需要自己实现
        List<AddressBookVO> addressBookVOS = selectAll();
        //以首字母分组返回
        Map<String,List<AddressBookVO>> resultMap = new HashMap<>();
        if （CollectionUtil.isNotEmpty(addressBookVOS)） { 
            for(AddressBookVO temp : addressBookVOS){
                //map中已存在
                if(resultMap.containsKey(temp.getFirstChar())){
                    resultMap.get(temp.getFirstChar()).add(temp);
                }else{
                    //map中不存在，新建key，用来存放数据
                    List<AddressBookVO> tmpList = new ArrayList<>();
                    tmpList.add(temp);
                    resultMap.put(temp.getFirstChar(), tmpList);
                }
            }
        }
        return resultMap;
    }
           

上面这个方法，同样适用于在一个list里面按照某个字段进行分类的场景。