本课将介绍如何检索联系人的详细数据,例如电子邮件地址、电话 号码等。用户在检索联系人时,需要查找的就是这些详细信息。 您可以向用户提供联系人的所有详细信息,也可以仅显示特定类型的详细信息, 例如电子邮件地址。
本课中的步骤假定您已为用户选择的联系人创建
ContactsContract.Contacts 行。
检索联系人姓名课程介绍了如何
检索联系人列表。
检索联系人的所有详细信息
如需检索联系人的所有详细信息,请在
ContactsContract.Data 表中搜索包含联系人的
LOOKUP_KEY 的任何行。此列位于
ContactsContract.Data 表中,因为联系人
提供程序会在 ContactsContract.Contacts
表和 ContactsContract.Data 表之间进行隐式联接。检索联系人姓名课程中更详细地介绍了
LOOKUP_KEY 列。
注意:检索联系人的所有详细信息会降低设备的性能,因为它需要检索 ContactsContract.Data 表中的所有列。在使用此技术之前,请考虑性能影响。
您可以使用此技术。
请求权限
如需从联系人提供程序读取数据,您的应用必须具有
READ_CONTACTS 权限。
如需请求此权限,请将以下
<manifest> 子元素添加到清单文件中:
<uses-permission android:name="android.permission.READ_CONTACTS" />
设置映射
根据行所包含的数据类型,它可能仅使用很少的列,也可能使用很多列。此外,
数据位于不同的列中,具体取决于数据类型。
为确保您获得所有可能的数据类型的所有可能列,您需要将所有
列名称添加到映射中。如果您要将结果
Cursor 绑定到 ListView,请务必检索
Data._ID;否则,绑定
将不起作用。还要检索 Data.MIMETYPE
,以便您可以识别检索到的每一行的数据类型。例如:
Kotlin
private val PROJECTION: Array<out String> = arrayOf( ContactsContract.Data._ID, ContactsContract.Data.MIMETYPE, ContactsContract.Data.DATA1, ContactsContract.Data.DATA2, ContactsContract.Data.DATA3, ContactsContract.Data.DATA4, ContactsContract.Data.DATA5, ContactsContract.Data.DATA6, ContactsContract.Data.DATA7, ContactsContract.Data.DATA8, ContactsContract.Data.DATA9, ContactsContract.Data.DATA10, ContactsContract.Data.DATA11, ContactsContract.Data.DATA12, ContactsContract.Data.DATA13, ContactsContract.Data.DATA14, ContactsContract.Data.DATA15 )
Java
private static final String[] PROJECTION = { ContactsContract.Data._ID, ContactsContract.Data.MIMETYPE, ContactsContract.Data.DATA1, ContactsContract.Data.DATA2, ContactsContract.Data.DATA3, ContactsContract.Data.DATA4, ContactsContract.Data.DATA5, ContactsContract.Data.DATA6, ContactsContract.Data.DATA7, ContactsContract.Data.DATA8, ContactsContract.Data.DATA9, ContactsContract.Data.DATA10, ContactsContract.Data.DATA11, ContactsContract.Data.DATA12, ContactsContract.Data.DATA13, ContactsContract.Data.DATA14, ContactsContract.Data.DATA15 };
此映射使用
ContactsContract.Data 类中定义的列名称检索
ContactsContract.Data 表中行的所有列。
您还可以选择使用
ContactsContract.Data 类中定义或继承的任何其他列常量。不过请注意,列
SYNC1 到
SYNC4 旨在供同步
适配器使用,因此其数据没有用处。
定义选择标准
为选择子句定义一个常量,为保存选择参数定义一个数组,并为保存选择值定义一个
变量。使用
Contacts.LOOKUP_KEY 列查找联系人。例如:
Kotlin
// Defines the selection clause private const val SELECTION: String = "${ContactsContract.Data.LOOKUP_KEY} = ?" ... // Defines the array to hold the search criteria private val selectionArgs: Array<String> = arrayOf("") /* * Defines a variable to contain the selection value. Once you * have the Cursor from the Contacts table, and you've selected * the desired row, move the row's LOOKUP_KEY value into this * variable. */ private var lookupKey: String? = null
Java
// Defines the selection clause private static final String SELECTION = Data.LOOKUP_KEY + " = ?"; // Defines the array to hold the search criteria private String[] selectionArgs = { "" }; /* * Defines a variable to contain the selection value. Once you * have the Cursor from the Contacts table, and you've selected * the desired row, move the row's LOOKUP_KEY value into this * variable. */ private lateinit var lookupKey: String
在选择文本表达式中使用“?”作为占位符可确保生成的搜索结果 是通过绑定而非 SQL 编译生成的。这种方法消除了 可能性恶意 SQL 注入。
定义排列顺序
在生成的 Cursor 中定义所需的排列顺序。如需将特定数据类型的所有行放在一起,请按
Data.MIMETYPE 排序。此查询参数
会将所有电子邮件行分组在一起,将所有电话行分组在一起,依此类推。例如:
Kotlin
/* * Defines a string that specifies a sort order of MIME type */ private const val SORT_ORDER = ContactsContract.Data.MIMETYPE
Java
/* * Defines a string that specifies a sort order of MIME type */ private static final String SORT_ORDER = ContactsContract.Data.MIMETYPE;
注意 :某些数据类型不使用子类型,因此您无法按子类型排序。
相反,您必须遍历返回的 Cursor,
确定当前行的数据类型,并存储使用子类型的行的数据。读取完游标后,您可以按子类型对每种数据类型进行排序并显示结果。
初始化加载器
始终在后台线程中从联系人提供程序(以及所有其他 content provider)执行检索。使用
LoaderManager 类和
LoaderManager.LoaderCallbacks 接口定义的加载器框架执行后台
检索。
准备好检索行后,请通过
调用 initLoader() 初始化加载器框架。将整数标识符传递给该方法;此标识符会传递给LoaderManager.LoaderCallbacks 方法。该标识符可帮助您
在应用中使用多个加载器,因为它允许您区分这些加载器。
以下代码段展示了如何初始化加载器框架:
Kotlin
// Defines a constant that identifies the loader private const val DETAILS_QUERY_ID: Int = 0 class DetailsFragment : Fragment(), LoaderManager.LoaderCallbacks<Cursor> { ... override fun onCreate(savedInstanceState: Bundle?) { ... // Initializes the loader framework loaderManager.initLoader(DETAILS_QUERY_ID, null, this)
Java
public class DetailsFragment extends Fragment implements LoaderManager.LoaderCallbacks<Cursor> { ... // Defines a constant that identifies the loader static int DETAILS_QUERY_ID = 0; ... @Override public void onCreate(Bundle savedInstanceState) { ... // Initializes the loader framework getLoaderManager().initLoader(DETAILS_QUERY_ID, null, this);
实现 onCreateLoader()
实现 onCreateLoader() 方法,该方法会在您调用
initLoader() 后立即由加载器框架调用。从此方法返回
CursorLoader。由于您要搜索
ContactsContract.Data 表,因此请使用常量
Data.CONTENT_URI 作为内容 URI。
例如:
Kotlin
override fun onCreateLoader(loaderId: Int, args: Bundle?): Loader<Cursor> { // Choose the proper action mLoader = when(loaderId) { DETAILS_QUERY_ID -> { // Assigns the selection parameter selectionArgs[0] = lookupKey // Starts the query activity?.let { CursorLoader( it, ContactsContract.Data.CONTENT_URI, PROJECTION, SELECTION, selectionArgs, SORT_ORDER ) } } ... } return mLoader }
Java
@Override public Loader<Cursor> onCreateLoader(int loaderId, Bundle args) { // Choose the proper action switch (loaderId) { case DETAILS_QUERY_ID: // Assigns the selection parameter selectionArgs[0] = lookupKey; // Starts the query CursorLoader mLoader = new CursorLoader( getActivity(), ContactsContract.Data.CONTENT_URI, PROJECTION, SELECTION, selectionArgs, SORT_ORDER ); }
实现 onLoadFinished() 和 onLoaderReset()
实现
onLoadFinished()
方法。当联系人提供程序返回查询结果时,加载器框架会调用
onLoadFinished()
。例如:
Kotlin
override fun onLoadFinished(loader: Loader<Cursor>, data: Cursor) { when(loader.id) { DETAILS_QUERY_ID -> { /* * Process the resulting Cursor here. */ } ... } }
Java
@Override public void onLoadFinished(Loader<Cursor> loader, Cursor cursor) { switch (loader.getId()) { case DETAILS_QUERY_ID: /* * Process the resulting Cursor here. */ } break; ... } }
当加载器框架检测到支持结果
Cursor 的数据已更改时,系统会调用方法 onLoaderReset()。此时,请将对 Cursor 的所有现有引用
设置为 null,以将其移除。否则,加载器
框架不会销毁旧的 Cursor,并且您会遇到内存
泄漏。例如:
Kotlin
override fun onLoaderReset(loader: Loader<Cursor>) { when (loader.id) { DETAILS_QUERY_ID -> { /* * If you have current references to the Cursor, * remove them here. */ } ... } }
Java
@Override public void onLoaderReset(Loader<Cursor> loader) { switch (loader.getId()) { case DETAILS_QUERY_ID: /* * If you have current references to the Cursor, * remove them here. */ } break; }
检索联系人的具体详细信息
检索联系人的特定数据类型(例如所有电子邮件)遵循与检索所有详细信息相同的模式 。您只需对检索联系人的所有详细信息中列出的代码进行以下更改:
- 映射
-
修改映射以检索特定于
数据类型的列。还要修改映射,以使用与
数据类型对应的
ContactsContract.CommonDataKinds子类中定义的列名称常量。 - 选择
- 修改选择文本以搜索特定于数据类型的
MIMETYPE值。 - 排列顺序
-
由于您仅选择一种详细信息类型,因此请勿按
Data.MIMETYPE对返回的Cursor进行分组。
以下部分介绍了这些修改。
定义映射
使用数据类型的
ContactsContract.CommonDataKinds 子类中的列名称常量定义要检索的列。
如果您打算将 Cursor 绑定到 ListView,
请务必检索 _ID 列。例如,如需检索电子邮件数据,请定义以下映射:
Kotlin
private val PROJECTION: Array<String> = arrayOf( ContactsContract.CommonDataKinds.Email._ID, ContactsContract.CommonDataKinds.Email.ADDRESS, ContactsContract.CommonDataKinds.Email.TYPE, ContactsContract.CommonDataKinds.Email.LABEL )
Java
private static final String[] PROJECTION = { ContactsContract.CommonDataKinds.Email._ID, ContactsContract.CommonDataKinds.Email.ADDRESS, ContactsContract.CommonDataKinds.Email.TYPE, ContactsContract.CommonDataKinds.Email.LABEL };
请注意,此映射使用类
ContactsContract.CommonDataKinds.Email中定义的列名称,而不是类
ContactsContract.Data中定义的列名称。使用特定于电子邮件的
列名称可提高代码的可读性。
在映射中,您还可以使用
ContactsContract.CommonDataKinds 子类中定义的任何其他列。
定义选择标准
定义一个搜索文本表达式,该表达式检索特定联系人的
LOOKUP_KEY 和所需详细信息的
Data.MIMETYPE 的行。通过在常量开头和结尾连接“'”(单引号)字符,将 MIMETYPE 值用单引号括起来;否则,提供程序会将常量解释为变量名称,而不是字符串值。您无需为此值使用占位符,因为您使用的是常量而不是用户提供的值。例如:
Kotlin
/* * Defines the selection clause. Search for a lookup key * and the Email MIME type */ private const val SELECTION = "${ContactsContract.Data.LOOKUP_KEY} = ? AND " + "${ContactsContract.Data.MIMETYPE} = '${Email.CONTENT_ITEM_TYPE}'" ... // Defines the array to hold the search criteria private val selectionArgs: Array<String> = arrayOf("")
Java
/* * Defines the selection clause. Search for a lookup key * and the Email MIME type */ private static final String SELECTION = Data.LOOKUP_KEY + " = ?" + " AND " + Data.MIMETYPE + " = " + "'" + Email.CONTENT_ITEM_TYPE + "'"; // Defines the array to hold the search criteria private String[] selectionArgs = { "" };
定义排列顺序
为返回的 Cursor 定义排列顺序。由于您要检索特定数据类型,因此请省略对 MIMETYPE 的排序。相反,如果您要搜索的详细信息类型包含子类型,请按子类型排序。
例如,对于电子邮件数据,您可以按
Email.TYPE:
Kotlin
private const val SORT_ORDER: String = "${Email.TYPE} ASC"
Java
private static final String SORT_ORDER = Email.TYPE + " ASC ";