1、前言
最近在做公司專案的時候遇到一個新增手機聯絡人的需求，主要有以下幾個功能點：
- 讀取聯絡人：讀取使用者手機上的通訊錄裡的聯絡人列表
- 好友排序：按照拼音順序對好友進行排序，相容英文數字符號等
- 字母索引：右側字母導航條，既可拖動也可點選，聯動ListView滑動
- 匹配：最後要將通訊錄裡的聯絡人列表與後臺資料庫裡的使用者表進行匹配
最終的大致效果如下：
特意寫篇部落格將整個實現過程記錄下來，方便以後再次遇到這樣的需求的時候可以直接使用CV大法，也希望能幫到剛好有這方面需求的朋友。
2、讀取聯絡人
讀取手機通訊錄裡的聯絡人主要是通過ContentResolver 來獲取的，程式碼比較固定，直接貼程式碼：
先定義一個用來接收聯絡人的資料bean，主要是對id，name和phone三個欄位進行賦值，其他欄位主要是為了排序和匹配使用者表用到的。
/**
* @author hydCoder
* @date 2017/10/11 10:50
* @desc 手機聯絡人的資料bean
* @email hyd_coder@163.com
*/
public class ContactInfo implements Comparable<ContactInfo> {
public String id;
public String name;
public String phone;
public String pinyin; // 姓名對應的拼音
public String firstLetter; // 拼音的首字母
public String userAvatar;
public String userName;
public String userNick;
public int isFriend;
public String userId;
public int gradeLevel;
public String userPosition;
public String userCompany;
public int userType;
public boolean isUser = false;
public ContactInfo(String id, String name, String phone) {
this.id = id;
this.name = name;
this.phone = phone;
pinyin = Cn2Spell.getPinYin(name); // 根據姓名獲取拼音
firstLetter = pinyin.substring(0, 1).toUpperCase(); // 獲取拼音首字母並轉成大寫
if (!firstLetter.matches("[A-Z]")) { // 如果不在A-Z中則預設為“#”
firstLetter = "#";
}
}
@Override
public int compareTo(@NonNull ContactInfo another) {
if (firstLetter.equals("#") && !another.firstLetter.equals("#")) {
return 1;
} else if (!firstLetter.equals("#") && another.firstLetter.equals("#")){
return -1;
} else {
return pinyin.compareToIgnoreCase(another.pinyin);
}
}
}
複製程式碼獲取聯絡人資料的工具類：
/**
* @author hydCoder
* @date 2017/10/11 10:53
* @desc 獲取手機聯絡人資料
* @email hyd_coder@163.com
*/
public class ContactUtils {
/**
* 獲取聯絡人資料
*
* @param context
* @return
*/
public static List<ContactInfo> getAllContacts(Context context) {
List<ContactInfo> list = new ArrayList<>();
// 獲取解析者
ContentResolver resolver = context.getContentResolver();
// 訪問地址
Uri raw_contacts = Uri.parse("content://com.android.contacts/raw_contacts");
Uri data = Uri.parse("content://com.android.contacts/data");
// 查詢語句
// select contact_id from raw_contacts;//1 2 3 4
// select mimetype,data1 from view_data where raw_contact_id=3;
// Cursor cursor=resolver.query(訪問地址, 返回欄位 null代表全部, where 語句, 引數, 排序)
Cursor cursor = resolver.query(raw_contacts, new String[] { "contact_id" }, null, null, null);
while (cursor.moveToNext()) {
// getColumnIndex根據名稱查列號
String id = cursor.getString(cursor.getColumnIndex("contact_id"));
// 建立例項
String name = "";
String phone = "";
Cursor item = resolver.query(data, new String[] { "mimetype", "data1" }, "raw_contact_id=?", new String[] { id }, null);
while (item.moveToNext()) {
String mimetype = item.getString(item.getColumnIndex("mimetype"));
String data1 = item.getString(item.getColumnIndex("data1"));
if ("vnd.android.cursor.item/name".equals(mimetype)) {
name = data1;
} else if ("vnd.android.cursor.item/phone_v2".equals(mimetype)) {
// 有的手機號中間會帶有空格
phone = data1.replace(" ","");
}
}
ContactInfo info = new ContactInfo(id,name,phone);
item.close();
// 新增集合
list.add(info);
}
cursor.close();
return list;
}
}
複製程式碼3、好友排序和字母索引
3.1、右側字母索引的導航條--SideBar
這個可以在網上找到很多類似的，你也可以找一個自己喜歡的甚至自己寫一個出來，我在專案裡用的是這個
我把他的SideBar.java拷貝到專案裡，修改了部分程式碼：
public class SideBar extends TextView {
private String[] letters = new String[]{"A", "B", "C", "D", "E", "F", "G", "H", "I",
"J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V",
"W", "X", "Y", "Z", "#"};
private Paint textPaint;
private Paint bigTextPaint;
private Paint scaleTextPaint;
private Canvas canvas;
private int itemH;
private int w;
private int h;
/**
* 普通情況下字型大小
*/
float singleTextH;
/**
* 縮放離原始的寬度
*/
private float scaleWidth;
/**
* 滑動的Y
*/
private float eventY = 0;
/**
* 縮放的倍數
*/
private int scaleSize = 1;
/**
* 縮放個數item，即開口大小
*/
private int scaleItemCount = 6;
private ISideBarSelectCallBack callBack;
public SideBar(Context context) {
this(context, null);
}
public SideBar(Context context, AttributeSet attrs) {
this(context, attrs, 0);
}
public SideBar(Context context, AttributeSet attrs, int defStyleAttr) {
super(context, attrs, defStyleAttr);
init(attrs);
}
private void init(AttributeSet attrs) {
if (attrs != null) {
TypedArray ta = getContext().obtainStyledAttributes(attrs, R.styleable.SideBar);
scaleSize = ta.getInteger(R.styleable.SideBar_scaleSize, 1);
scaleItemCount = ta.getInteger(R.styleable.SideBar_scaleItemCount, 6);
scaleWidth = ta.getDimensionPixelSize(R.styleable.SideBar_scaleWidth, dp(100));
ta.recycle();
}
textPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
textPaint.setColor(getCurrentTextColor());
textPaint.setTextSize(getTextSize());
textPaint.setTextAlign(Paint.Align.CENTER);
bigTextPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
bigTextPaint.setColor(getCurrentTextColor());
bigTextPaint.setTextSize(getTextSize() * (scaleSize + 3));
bigTextPaint.setTextAlign(Paint.Align.CENTER);
scaleTextPaint = new Paint(Paint.ANTI_ALIAS_FLAG);
scaleTextPaint.setColor(getCurrentTextColor());
scaleTextPaint.setTextSize(getTextSize() * (scaleSize + 1));
scaleTextPaint.setTextAlign(Paint.Align.CENTER);
}
public void setDataResource(String[] data) {
letters = data;
invalidate();
}
public void setOnStrSelectCallBack(ISideBarSelectCallBack callBack) {
this.callBack = callBack;
}
/**
* 設定字型縮放比例
*
* @param scale
*/
public void setScaleSize(int scale) {
scaleSize = scale;
invalidate();
}
/**
* 設定縮放字型的個數，即開口大小
*
* @param scaleItemCount
*/
public void setScaleItemCount(int scaleItemCount) {
this.scaleItemCount = scaleItemCount;
invalidate();
}
private int dp(int px) {
final float scale = getContext().getResources().getDisplayMetrics().density;
return (int) (px * scale + 0.5f);
}
@Override
public boolean onTouchEvent(MotionEvent event) {
switch (event.getAction()) {
case MotionEvent.ACTION_DOWN:
case MotionEvent.ACTION_MOVE:
if (event.getX() > (w - getPaddingRight() - singleTextH - 10)) {
eventY = event.getY();
invalidate();
return true;
} else {
eventY = 0;
invalidate();
break;
}
case MotionEvent.ACTION_CANCEL:
eventY = 0;
invalidate();
return true;
case MotionEvent.ACTION_UP:
if (event.getX() > (w - getPaddingRight() - singleTextH - 10)) {
eventY = 0;
invalidate();
return true;
} else
break;
}
return super.onTouchEvent(event);
}
@Override
protected void onDraw(Canvas canvas) {
this.canvas = canvas;
DrawView(eventY);
}
private void DrawView(float y) {
int currentSelectIndex = -1;
if (y != 0) {
for (int i = 0; i < letters.length; i++) {
float currentItemY = itemH * i;
float nextItemY = itemH * (i + 1);
if (y >= currentItemY && y < nextItemY) {
currentSelectIndex = i;
if (callBack != null) {
callBack.onSelectStr(currentSelectIndex, letters[i]);
}
//畫大的字母
Paint.FontMetrics fontMetrics = bigTextPaint.getFontMetrics();
float bigTextSize = fontMetrics.descent - fontMetrics.ascent;
canvas.drawText(letters[i], w - getPaddingRight() - scaleWidth - bigTextSize, singleTextH + itemH * i, bigTextPaint);
}
}
}
drawLetters(y, currentSelectIndex);
}
private void drawLetters(float y, int index) {
//第一次進來沒有縮放情況，預設畫原圖
if (index == -1) {
w = getMeasuredWidth();
h = getMeasuredHeight();
itemH = h / letters.length;
Paint.FontMetrics fontMetrics = textPaint.getFontMetrics();
singleTextH = fontMetrics.descent - fontMetrics.ascent;
for (int i = 0; i < letters.length; i++) {
canvas.drawText(letters[i], w - getPaddingRight(), singleTextH + itemH * i, textPaint);
}
//觸控的時候畫縮放圖
} else {
//遍歷所有字母
for (int i = 0; i < letters.length; i++) {
//要畫的字母的起始Y座標
float currentItemToDrawY = singleTextH + itemH * i;
float centerItemToDrawY;
if (index < i)
centerItemToDrawY = singleTextH + itemH * (index + scaleItemCount);
else
centerItemToDrawY = singleTextH + itemH * (index - scaleItemCount);
float delta = 1 - Math.abs((y - currentItemToDrawY) / (centerItemToDrawY - currentItemToDrawY));
float maxRightX = w - getPaddingRight();
//如果大於0，表明在y座標上方
scaleTextPaint.setTextSize(getTextSize() + getTextSize() * delta);
float drawX = maxRightX - scaleWidth * delta;
//超出邊界直接花在邊界上
if (drawX > maxRightX)
canvas.drawText(letters[i], maxRightX, singleTextH + itemH * i, textPaint);
else
canvas.drawText(letters[i], drawX, singleTextH + itemH * i, scaleTextPaint);
}
}
}
public interface ISideBarSelectCallBack {
void onSelectStr(int index, String selectStr);
}
}
複製程式碼其中3個自定義的屬性如下：
<?xml version="1.0" encoding="utf-8"?>
<resources>
<declare-styleable name="SideBar">
<attr name="scaleSize" format="integer"/>
<attr name="scaleItemCount" format="integer"/>
<attr name="scaleWidth" format="dimension"/>
</declare-styleable>
</resources>
複製程式碼3.2、漢字轉拼音工具類
比較尷尬的是，java中是沒有提供介面和方法讓我們直接將漢字轉成拼音的。所以我們只能自己想辦法了，一般有以下兩種辦法：
**1、 使用第三方pinyin4j的jar包 ** 下載地址
Android Studio也可直接依賴
compile 'com.belerweb:pinyin4j:2.5.0'
複製程式碼優點：使用簡單，實用性好
缺點：需要依賴第三方jar包
2、 使用ASCII碼和拼音的對映
優點：零依賴，只有一個Class，使用簡單
缺點：只支援常見的一級漢字，對於一些不常見的漢字（亳bo）則無法正確獲取拼音
（中文編碼中一級漢字是按拼音排序的，容易對映。而二級漢字是按筆畫部首排序的）
其實，無論是使用哪種方法，我發現都是沒有去處理多音字的情況（畢竟這個真不好寫），不過基本需求都可以滿足啦。
我在這裡直接使用的就是pinyin4j的jar包。但我還是基於pinyin4j寫了個轉換的工具類：
/**
* 漢字轉換位漢語拼音，英文字元不變
*/
public class Cn2Spell {
public static StringBuffer sb = new StringBuffer();
/**
* 獲取漢字字串的首字母，英文字元不變
* 例如：阿飛→af
*/
public static String getPinYinHeadChar(String chines) {
sb.setLength(0);
char[] chars = chines.toCharArray();
HanyuPinyinOutputFormat defaultFormat = new HanyuPinyinOutputFormat();
defaultFormat.setCaseType(HanyuPinyinCaseType.LOWERCASE);
defaultFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
for (int i = 0; i < chars.length; i++) {
if (chars[i] > 128) {
try {
sb.append(PinyinHelper.toHanyuPinyinStringArray(chars[i], defaultFormat)[0].charAt(0));
} catch (Exception e) {
e.printStackTrace();
}
} else {
sb.append(chars[i]);
}
}
return sb.toString();
}
/**
* 獲取漢字字串的第一個字母
*/
public static String getPinYinFirstLetter(String str) {
sb.setLength(0);
char c = str.charAt(0);
String[] pinyinArray = PinyinHelper.toHanyuPinyinStringArray(c);
if (pinyinArray != null) {
sb.append(pinyinArray[0].charAt(0));
} else {
sb.append(c);
}
return sb.toString();
}
/**
* 獲取漢字字串的漢語拼音，英文字元不變
*/
public static String getPinYin(String chines) {
sb.setLength(0);
char[] nameChar = chines.toCharArray();
HanyuPinyinOutputFormat defaultFormat = new HanyuPinyinOutputFormat();
defaultFormat.setCaseType(HanyuPinyinCaseType.LOWERCASE);
defaultFormat.setToneType(HanyuPinyinToneType.WITHOUT_TONE);
for (int i = 0; i < nameChar.length; i++) {
if (nameChar[i] > 128) {
try {
sb.append(PinyinHelper.toHanyuPinyinStringArray(nameChar[i], defaultFormat)[0]);
} catch (Exception e) {
e.printStackTrace();
}
} else {
sb.append(nameChar[i]);
}
}
return sb.toString();
}
}
複製程式碼3.3、讓聯絡人可以根據拼音來排序
程式碼在上面已經貼過了，這裡就不重複貼了，其實就是讓JavaBean實現comparable介面，並重寫comparaTo方法。再在comparaTo方法里根據首字母判斷，首字母為“#”都放在最後，都為“#”或者都是字母時才根據拼音來比較排序。
4、與後臺資料庫進行匹配
我與我們後臺的開發大佬商量好的是將獲取到的聯絡人集合裡的手機號用","連線起來傳給他，他再將匹配到的聯絡人資料返回給我，我再進行資料整合並處理互動邏輯。程式碼比較簡單，這裡就不貼了。
5、組裝
由於沒有把這個單獨抽出來，所以只能貼部分關鍵程式碼。。。。。。
Activity的佈局檔案
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:background="@color/gray_e5e5e5">
<com.sdalolo.genius.utils.CustomNavigatorBar
android:id="@+id/cn_bar"
android:layout_width="match_parent"
android:layout_height="@dimen/title_bar_size"
android:paddingRight="10dp"
android:layout_alignParentTop="true"
app:leftImage="@drawable/backtrack"
app:leftImageVisiable="true"
app:leftTextVisibale="false"
app:midText="新增手機聯絡人"
app:midTextFontSize="@dimen/title_size"
app:midTextFontColor="@color/auxiliary_color"
app:rightTextVisible="false"
app:rightImageVisible="false"
app:titleBarBackground="@color/main_color">
</com.sdalolo.genius.utils.CustomNavigatorBar>
<ListView
android:id="@+id/list_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_below="@+id/cn_bar"
android:divider="@color/divide_color"
android:scrollbars="none"
android:dividerHeight="1dp">
</ListView>
<com.sdalolo.genius.ui.view.SideBar
android:id="@+id/side_bar"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:layout_below="@+id/cn_bar"
android:layout_alignParentRight="true"
android:paddingRight="10dp"
android:textColor="@color/auxiliary_color"
android:textSize="14sp" />
</RelativeLayout>
複製程式碼activity中的部分程式碼：
mSideBar.setOnStrSelectCallBack(new SideBar.ISideBarSelectCallBack() {
@Override
public void onSelectStr(int index, String selectStr) {
if (mAllContacts != null) {
for (int i = 0; i < mAllContacts.size(); i++) {
if (selectStr.equalsIgnoreCase(mAllContacts.get(i).firstLetter)) {
mListView.setSelection(i); // 選擇到首字母出現的位置
return;
}
}
}
}
});
複製程式碼adapter中的部分程式碼：
/**
* 獲取首字母首次出現位置
*/
public int getPositionForSection(String catalog) {
for (int i = 0; i < getCount(); i++) {
String sortStr = list.get(i).firstLetter;
if (catalog.equalsIgnoreCase(sortStr)) {
return i;
}
}
return -1;
}
//如果當前位置等於該分類首字母的Char的位置 ，則認為是第一次出現
if(position == getPositionForSection(catalog)){
viewHolder.catalog.setVisibility(View.VISIBLE);
viewHolder.catalog.setText(contact.firstLetter.toUpperCase());
}else{
viewHolder.catalog.setVisibility(View.GONE);
}
複製程式碼6、結語
到這裡基本上效果就實現了，是不是很簡單，不過如果編譯版本大於23的話，記得動態申請Manifest.permission.READ_CONTACTS許可權，不然會Crash，別問我怎麼知道的。。。。。。