手机通信录数据获取与分页查询功能封装要点分析

2023-12-02 20:26:35

前言

手机通讯录是手机用户保存联系人的一种方式，包含姓名、电话号码、电子邮件、地址等信息。在Android应用程序开发中，获取手机通讯录数据并进行分页查询是一种常见需求。本文将详细介绍如何封装此功能，以便在应用程序中轻松调用。

获取联系人列表

在Android中，获取手机通讯录数据可以使用ContentProvider，即内容提供者。它是Android系统中一种共享数据的方式，允许其他应用程序访问和操作数据。

1. 权限申请

在获取联系人数据之前，需要在AndroidManifest.xml文件中声明权限：

<uses-permission android:name="android.permission.READ_CONTACTS" />

2. 获取联系人数据

获取联系人数据可以使用ContentResolver，即内容解析器。它是Android系统中用于访问内容提供者的组件。

ContentResolver contentResolver = getContentResolver();
Cursor cursor = contentResolver.query(ContactsContract.Contacts.CONTENT_URI,
        null, null, null, null);

3. 遍历联系人数据

通过游标cursor可以遍历联系人数据。

while (cursor.moveToNext()) {
    String name = cursor.getString(cursor.getColumnIndex(ContactsContract.Contacts.DISPLAY_NAME));
    String phoneNumber = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
    String email = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Email.ADDRESS));
    // ...其他联系人信息
}

分页查询

为了提高效率和性能，对于大量联系人数据，需要进行分页查询。Android提供了CursorLoader来实现分页查询。

1. 创建CursorLoader

CursorLoader cursorLoader = new CursorLoader(this, ContactsContract.Contacts.CONTENT_URI,
        null, null, null, null);

2. 设置分页参数

cursorLoader.setLimit(pageSize);
cursorLoader.setOffset(pageSize * pageNumber);

3. 启动CursorLoader

cursorLoader.startLoading();

4. 获取分页查询结果

Cursor cursor = cursorLoader.loadInBackground();

封装获取联系人列表和分页查询功能

为了方便在应用程序中调用，我们可以将获取联系人列表和分页查询功能封装成一个类。

public class ContactsManager {

    private Context context;

    public ContactsManager(Context context) {
        this.context = context;
    }

    public List<Contact> getAllContacts() {
        // 获取所有联系人数据
        Cursor cursor = context.getContentResolver().query(ContactsContract.Contacts.CONTENT_URI,
                null, null, null, null);

        // 遍历联系人数据并保存到List中
        List<Contact> contacts = new ArrayList<>();
        while (cursor.moveToNext()) {
            Contact contact = new Contact();
            contact.setName(cursor.getString(cursor.getColumnIndex(ContactsContract.Contacts.DISPLAY_NAME)));
            contact.setPhoneNumber(cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER)));
            contact.setEmail(cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Email.ADDRESS)));
            // ...其他联系人信息
            contacts.add(contact);
        }
        cursor.close();

        return contacts;
    }

    public List<Contact> getContactsByPage(int pageNumber, int pageSize) {
        // 创建CursorLoader
        CursorLoader cursorLoader = new CursorLoader(context, ContactsContract.Contacts.CONTENT_URI,
                null, null, null, null);

        // 设置分页参数
        cursorLoader.setLimit(pageSize);
        cursorLoader.setOffset(pageSize * pageNumber);

        // 启动CursorLoader
        cursorLoader.startLoading();

        // 获取分页查询结果
        Cursor cursor = cursorLoader.loadInBackground();

        // 遍历联系人数据并保存到List中
        List<Contact> contacts = new ArrayList<>();
        while (cursor.moveToNext()) {
            Contact contact = new Contact();
            contact.setName(cursor.getString(cursor.getColumnIndex(ContactsContract.Contacts.DISPLAY_NAME)));
            contact.setPhoneNumber(cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER)));
            contact.setEmail(cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Email.ADDRESS)));
            // ...其他联系人信息
            contacts.add(contact);
        }
        cursor.close();

        return contacts;
    }
}

在应用程序中，只需要创建一个ContactsManager对象，就可以轻松获取联系人列表和进行分页查询。

ContactsManager contactsManager = new ContactsManager(this);
List<Contact> contacts = contactsManager.getAllContacts();
List<Contact> contactsByPage = contactsManager.getContactsByPage(1, 20);