บทเรียนนี้จะแสดงวิธีดึงรายชื่อติดต่อที่มีข้อมูลตรงกับสตริงการค้นหาทั้งหมดหรือบางส่วน โดยใช้เทคนิคต่อไปนี้
- ชื่อผู้ติดต่อของแมตช์
- ดึงข้อมูลรายชื่อติดต่อโดยจับคู่สตริงการค้นหากับข้อมูลชื่อรายชื่อติดต่อทั้งหมดหรือบางส่วน Contacts Provider อนุญาตให้มีชื่อเดียวกันได้หลายอินสแตนซ์ ดังนั้นเทคนิคนี้จึงแสดงรายการที่ตรงกันได้
- จับคู่ข้อมูลประเภทที่เฉพาะเจาะจง เช่น หมายเลขโทรศัพท์
- ดึงข้อมูลรายชื่อติดต่อโดยการจับคู่สตริงการค้นหากับรายละเอียดประเภทใดประเภทหนึ่ง เช่น อีเมล เช่น เทคนิคนี้ช่วยให้คุณแสดงรายชื่อติดต่อทั้งหมดที่มีอีเมลตรงกับสตริงการค้นหาได้
- จับคู่ข้อมูลประเภทใดก็ได้
- ดึงข้อมูลรายชื่อติดต่อโดยจับคู่สตริงการค้นหากับข้อมูลรายละเอียดประเภทใดก็ได้ รวมถึงชื่อ หมายเลขโทรศัพท์ ที่อยู่ อีเมล และอื่นๆ เช่น เทคนิคนี้ช่วยให้คุณยอมรับข้อมูลประเภทใดก็ได้สำหรับสตริงการค้นหา แล้วแสดงรายชื่อติดต่อที่ข้อมูลตรงกับสตริง
หมายเหตุ: ตัวอย่างทั้งหมดในบทเรียนนี้ใช้ CursorLoader เพื่อดึงข้อมูลจาก Contacts Provider CursorLoader จะเรียกใช้การค้นหาในชุดข้อความที่แยกจากเธรด UI วิธีนี้ช่วยให้มั่นใจได้ว่าการค้นหาจะไม่ทำให้เวลาในการตอบสนองของ UI ช้าลงและทำให้ผู้ใช้ได้รับประสบการณ์การใช้งานที่ไม่ดี ดูข้อมูลเพิ่มเติมได้ที่ชั้นเรียนการฝึกอบรม Android เรื่อง
การโหลดข้อมูลในเบื้องหลัง
ขอสิทธิ์อ่านผู้ให้บริการ
หากต้องการค้นหา Contacts Provider ประเภทใดก็ตาม แอปของคุณต้องมี
READ_CONTACTS
หากต้องการขอสิทธิ์นี้ ให้เพิ่มองค์ประกอบ <uses-permission> นี้ลงในไฟล์ Manifest เป็นองค์ประกอบย่อยของ <manifest> ดังนี้
<uses-permission android:name="android.permission.READ_CONTACTS" />
จับคู่รายชื่อติดต่อตามชื่อและแสดงผลลัพธ์
เทคนิคนี้จะพยายามจับคู่สตริงการค้นหากับชื่อของรายชื่อติดต่อในตาราง ContactsContract.Contacts ของ Contacts Provider โดยปกติแล้ว คุณจะต้องการแสดงผลลัพธ์ใน ListView เพื่อให้ผู้ใช้เลือกจากรายชื่อติดต่อที่ตรงกันได้
กำหนด ListView และเลย์เอาต์ของรายการ
หากต้องการแสดงผลการค้นหาใน ListView คุณต้องมีไฟล์เลย์เอาต์หลัก
ที่กำหนด UI ทั้งหมด รวมถึง ListView และไฟล์เลย์เอาต์รายการ
ที่กำหนดบรรทัดเดียวของ ListView ตัวอย่างเช่น คุณสามารถสร้างไฟล์เลย์เอาต์หลัก res/layout/contacts_list_view.xml ด้วย XML ต่อไปนี้
<?xml version="1.0" encoding="utf-8"?> <ListView xmlns:android="http://schemas.android.com/apk/res/android" android:id="@android:id/list" android:layout_width="match_parent" android:layout_height="match_parent"/>
XML นี้ใช้วิดเจ็ต ListView ในตัวของ Android
android:id/list
กำหนดไฟล์เลย์เอาต์รายการ contacts_list_item.xml ด้วย XML ต่อไปนี้
<?xml version="1.0" encoding="utf-8"?> <TextView xmlns:android="http://schemas.android.com/apk/res/android" android:id="@android:id/text1" android:layout_width="match_parent" android:layout_height="wrap_content" android:clickable="true"/>
XML นี้ใช้วิดเจ็ต TextView ในตัวของ Android
android:text1
หมายเหตุ: บทเรียนนี้ไม่ได้อธิบาย UI สำหรับการรับสตริงการค้นหาจากผู้ใช้ เนื่องจากคุณอาจต้องการรับสตริงโดยอ้อม เช่น คุณสามารถให้ตัวเลือกแก่ผู้ใช้ในการค้นหารายชื่อติดต่อที่มีชื่อตรงกับสตริงใน SMS ที่เข้ามา
ไฟล์เลย์เอาต์ 2 ไฟล์ที่คุณเขียนจะกำหนดอินเทอร์เฟซผู้ใช้ที่แสดง ListView ขั้นตอนถัดไปคือการเขียนโค้ดที่ใช้ UI นี้เพื่อแสดง
รายชื่อติดต่อ
กำหนด Fragment ที่แสดงรายชื่อติดต่อ
หากต้องการแสดงรายชื่อติดต่อ ให้เริ่มต้นด้วยการกำหนด Fragment
ที่โหลดโดย Activity การใช้ Fragment เป็นเทคนิคที่ยืดหยุ่นกว่า เนื่องจากคุณสามารถใช้ Fragment รายการหนึ่งเพื่อแสดงรายการ และใช้ Fragment รายการที่ 2 เพื่อแสดงรายละเอียดของรายชื่อติดต่อที่ผู้ใช้เลือกจากรายการ เมื่อใช้แนวทางนี้ คุณสามารถรวมเทคนิคอย่างใดอย่างหนึ่งที่นำเสนอในบทเรียนนี้เข้ากับเทคนิคจากบทเรียน
ดึงรายละเอียดของรายชื่อติดต่อ
หากต้องการดูวิธีใช้ออบเจ็กต์ Fragment อย่างน้อย 1 รายการจาก
Activity โปรดอ่านคลาสการฝึกอบรม
สร้าง UI แบบไดนามิกด้วย Fragment
เฟรมเวิร์ก Android มีคลาส Contract ชื่อ ContactsContract เพื่อช่วยคุณเขียนการค้นหาเทียบกับ Contacts Provider ซึ่งจะกำหนดค่าคงที่และเมธอดที่มีประโยชน์สำหรับการเข้าถึงผู้ให้บริการ เมื่อใช้คลาสนี้ คุณไม่จำเป็นต้องกำหนดค่าคงที่ของคุณเองสำหรับ URI เนื้อหา ชื่อตาราง หรือคอลัมน์ หากต้องการใช้คลาสนี้ ให้ใส่คำสั่งต่อไปนี้
Kotlin
import android.provider.ContactsContract
Java
import android.provider.ContactsContract;
เนื่องจากโค้ดใช้ CursorLoader เพื่อดึงข้อมูลจากผู้ให้บริการ คุณจึงต้องระบุว่าโค้ดดังกล่าวใช้อินเทอร์เฟซ Loader LoaderManager.LoaderCallbacks นอกจากนี้ เพื่อช่วยตรวจหาว่าผู้ใช้เลือกรายชื่อติดต่อใดจากรายการผลการค้นหา ให้ใช้ส่วนติดต่อของอแดปเตอร์ AdapterView.OnItemClickListener เช่น
Kotlin
... import android.support.v4.app.Fragment import android.support.v4.app.LoaderManager import android.widget.AdapterView ... class ContactsFragment : Fragment(), LoaderManager.LoaderCallbacks<Cursor>, AdapterView.OnItemClickListener {
Java
... import android.support.v4.app.Fragment; import android.support.v4.app.LoaderManager.LoaderCallbacks; import android.widget.AdapterView; ... public class ContactsFragment extends Fragment implements LoaderManager.LoaderCallbacks<Cursor>, AdapterView.OnItemClickListener {
กำหนดตัวแปรส่วนกลาง
กำหนดตัวแปรส่วนกลางที่ใช้ในส่วนอื่นๆ ของโค้ด
Kotlin
... /* * Defines an array that contains column names to move from * the Cursor to the ListView. */ @SuppressLint("InlinedApi") private val FROM_COLUMNS: Array<String> = arrayOf( if ((Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB)) { ContactsContract.Contacts.DISPLAY_NAME_PRIMARY } else { ContactsContract.Contacts.DISPLAY_NAME } ) /* * Defines an array that contains resource ids for the layout views * that get the Cursor column contents. The id is pre-defined in * the Android framework, so it is prefaced with "android.R.id" */ private val TO_IDS: IntArray = intArrayOf(android.R.id.text1) ... class ContactsFragment : Fragment(), LoaderManager.LoaderCallbacks<Cursor>, AdapterView.OnItemClickListener { ... // Define global mutable variables // Define a ListView object lateinit var contactsList: ListView // Define variables for the contact the user selects // The contact's _ID value var contactId: Long = 0 // The contact's LOOKUP_KEY var contactKey: String? = null // A content URI for the selected contact var contactUri: Uri? = null // An adapter that binds the result Cursor to the ListView private val cursorAdapter: SimpleCursorAdapter? = null
Java
... /* * Defines an array that contains column names to move from * the Cursor to the ListView. */ @SuppressLint("InlinedApi") private final static String[] FROM_COLUMNS = { Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB ? ContactsContract.Contacts.DISPLAY_NAME_PRIMARY : ContactsContract.Contacts.DISPLAY_NAME }; /* * Defines an array that contains resource ids for the layout views * that get the Cursor column contents. The id is pre-defined in * the Android framework, so it is prefaced with "android.R.id" */ private final static int[] TO_IDS = { android.R.id.text1 }; // Define global mutable variables // Define a ListView object ListView contactsList; // Define variables for the contact the user selects // The contact's _ID value long contactId; // The contact's LOOKUP_KEY String contactKey; // A content URI for the selected contact Uri contactUri; // An adapter that binds the result Cursor to the ListView private SimpleCursorAdapter cursorAdapter; ...
หมายเหตุ: เนื่องจาก
Contacts.DISPLAY_NAME_PRIMARY ต้องใช้ Android 3.0 (API เวอร์ชัน 11) ขึ้นไป การตั้งค่า minSdkVersion ของแอปเป็น 10 หรือต่ำกว่าจะทำให้เกิดคำเตือน Android Lint ใน Android Studio
หากต้องการปิดคำเตือนนี้ ให้เพิ่มคำอธิบายประกอบ @SuppressLint("InlinedApi") ก่อนคำจำกัดความของ FROM_COLUMNS
เริ่มต้น Fragment
เริ่มต้น Fragment เพิ่มตัวสร้างสาธารณะที่ว่างเปล่า
ซึ่งระบบ Android ต้องการ และ Inflate UI ของออบเจ็กต์ Fragment
ในเมธอด Callback onCreateView()
เช่น
Kotlin
// A UI Fragment must inflate its View override fun onCreateView( inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle? ): View? { // Inflate the fragment layout return inflater.inflate(R.layout.contact_list_fragment, container, false) }
Java
// Empty public constructor, required by the system public ContactsFragment() {} // A UI Fragment must inflate its View @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { // Inflate the fragment layout return inflater.inflate(R.layout.contact_list_fragment, container, false); }
ตั้งค่า CursorAdapter สำหรับ ListView
ตั้งค่า SimpleCursorAdapter ที่เชื่อมโยงผลการค้นหากับ ListView หากต้องการรับออบเจ็กต์ ListView ที่แสดงรายชื่อติดต่อ คุณต้องเรียกใช้ Activity.findViewById() โดยใช้กิจกรรมหลักของ Fragment ใช้ Context ของกิจกรรมหลักเมื่อเรียกใช้ setAdapter()
เช่น
Kotlin
override fun onActivityCreated(savedInstanceState: Bundle?) { super.onActivityCreated(savedInstanceState) ... // Gets the ListView from the View list of the parent activity activity?.also { contactsList = it.findViewById<ListView>(R.id.contact_list_view) // Gets a CursorAdapter cursorAdapter = SimpleCursorAdapter( it, R.layout.contact_list_item, null, FROM_COLUMNS, TO_IDS, 0 ) // Sets the adapter for the ListView contactsList.adapter = cursorAdapter } }
Java
public void onActivityCreated(Bundle savedInstanceState) { super.onActivityCreated(savedInstanceState); ... // Gets the ListView from the View list of the parent activity contactsList = (ListView) getActivity().findViewById(R.layout.contact_list_view); // Gets a CursorAdapter cursorAdapter = new SimpleCursorAdapter( getActivity(), R.layout.contact_list_item, null, FROM_COLUMNS, TO_IDS, 0); // Sets the adapter for the ListView contactsList.setAdapter(cursorAdapter); }
ตั้งค่า Listener รายชื่อติดต่อที่เลือก
เมื่อแสดงผลการค้นหา คุณมักต้องการอนุญาตให้ผู้ใช้เลือกผู้ติดต่อรายเดียวเพื่อดำเนินการต่อ เช่น เมื่อผู้ใช้คลิกรายชื่อติดต่อ คุณจะ
แสดงที่อยู่ของรายชื่อติดต่อบนแผนที่ได้ หากต้องการใช้ฟีเจอร์นี้ ก่อนอื่นคุณต้องกำหนด Fragment ปัจจุบันเป็นฟังก์ชันรอคลิกโดยระบุว่าคลาสใช้ AdapterView.OnItemClickListener ดังที่แสดงในส่วนกำหนด Fragment ที่แสดงรายชื่อติดต่อ
หากต้องการตั้งค่า Listener ต่อ ให้เชื่อมโยงกับ ListView โดยเรียกใช้เมธอด setOnItemClickListener() ใน onActivityCreated() เช่น
Kotlin
fun onActivityCreated(savedInstanceState:Bundle) { ... // Set the item click listener to be the current fragment. contactsList.onItemClickListener = this ... }
Java
public void onActivityCreated(Bundle savedInstanceState) { ... // Set the item click listener to be the current fragment. contactsList.setOnItemClickListener(this); ... }
เนื่องจากคุณระบุว่า Fragment ปัจจุบันคือ
OnItemClickListener สําหรับ
ListView ตอนนี้คุณจึงต้องใช้เมธอดที่จําเป็น
onItemClick() ซึ่ง
จัดการกิจกรรมการคลิก ซึ่งจะอธิบายไว้ในส่วนถัดไป
กำหนดการคาดการณ์
กำหนดค่าคงที่ซึ่งมีคอลัมน์ที่คุณต้องการแสดงผลจากการค้นหา แต่ละรายการใน
ListView จะแสดงชื่อที่แสดงของผู้ติดต่อ
ซึ่งมีรูปแบบหลักของชื่อผู้ติดต่อ ใน Android 3.0 (API เวอร์ชัน 11) ขึ้นไป คอลัมน์นี้ชื่อ Contacts.DISPLAY_NAME_PRIMARY ส่วนในเวอร์ชันก่อนหน้านั้นจะชื่อ Contacts.DISPLAY_NAME
กระบวนการเชื่อมโยง SimpleCursorAdapter ใช้คอลัมน์ Contacts._ID
Contacts._ID และ LOOKUP_KEY จะใช้ร่วมกันเพื่อสร้าง URI เนื้อหาสำหรับรายชื่อติดต่อที่ผู้ใช้เลือก
Kotlin
... @SuppressLint("InlinedApi") private val PROJECTION: Array<out String> = arrayOf( ContactsContract.Contacts._ID, ContactsContract.Contacts.LOOKUP_KEY, if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) ContactsContract.Contacts.DISPLAY_NAME_PRIMARY else ContactsContract.Contacts.DISPLAY_NAME )
Java
... @SuppressLint("InlinedApi") private static final String[] PROJECTION = { Contacts._ID, Contacts.LOOKUP_KEY, Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB ? ContactsContract.Contacts.DISPLAY_NAME_PRIMARY : ContactsContract.Contacts.DISPLAY_NAME };
กำหนดค่าคงที่สำหรับดัชนีคอลัมน์เคอร์เซอร์
หากต้องการรับข้อมูลจากคอลัมน์แต่ละรายการใน Cursor คุณต้องมีดัชนีของคอลัมน์ภายใน Cursor คุณสามารถกำหนดค่าคงที่สำหรับดัชนีของคอลัมน์ Cursor ได้ เนื่องจากดัชนีจะเหมือนกับลำดับของชื่อคอลัมน์ในการฉายภาพ เช่น
Kotlin
// The column index for the _ID column private const val CONTACT_ID_INDEX: Int = 0 // The column index for the CONTACT_KEY column private const val CONTACT_KEY_INDEX: Int = 1
Java
// The column index for the _ID column private static final int CONTACT_ID_INDEX = 0; // The column index for the CONTACT_KEY column private static final int CONTACT_KEY_INDEX = 1;
ระบุเกณฑ์การเลือก
หากต้องการระบุข้อมูลที่ต้องการ ให้สร้างชุดค่าผสมของนิพจน์ข้อความและตัวแปร ซึ่งจะบอกผู้ให้บริการว่าควรค้นหาคอลัมน์ข้อมูลใดและควรค้นหาค่าใด
สำหรับนิพจน์ข้อความ ให้กำหนดค่าคงที่ซึ่งแสดงรายการคอลัมน์การค้นหา แม้ว่านิพจน์นี้จะมีค่าได้ด้วย แต่แนวทางปฏิบัติที่แนะนำคือการแสดงค่าด้วยตัวยึดตำแหน่ง "?" ในระหว่างการดึงข้อมูล ระบบจะแทนที่ตัวยึดตำแหน่งด้วยค่าจากอาร์เรย์ การใช้ "?" เป็นตัวยึดตำแหน่งช่วยให้มั่นใจได้ว่าข้อกำหนดการค้นหาจะสร้างขึ้นโดยการเชื่อมโยง แทนที่จะเป็นการคอมไพล์ SQL แนวทางปฏิบัตินี้จะช่วยลดโอกาสในการแทรก SQL ที่เป็นอันตราย เช่น
Kotlin
// Defines the text expression @SuppressLint("InlinedApi") private val SELECTION: String = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) "${ContactsContract.Contacts.DISPLAY_NAME_PRIMARY} LIKE ?" else "${ContactsContract.Contacts.DISPLAY_NAME} LIKE ?" ... // Defines a variable for the search string private val searchString: String = ... // Defines the array to hold values that replace the ? private val selectionArgs = arrayOf<String>(searchString)
Java
// Defines the text expression @SuppressLint("InlinedApi") private static final String SELECTION = Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB ? Contacts.DISPLAY_NAME_PRIMARY + " LIKE ?" : Contacts.DISPLAY_NAME + " LIKE ?"; // Defines a variable for the search string private String searchString; // Defines the array to hold values that replace the ? private String[] selectionArgs = { searchString };
กำหนดเมธอด onItemClick()
ในส่วนก่อนหน้า คุณได้ตั้งค่าฟังก์ชันรอคลิกรายการสำหรับ ListView
ตอนนี้ให้ใช้การดำเนินการสำหรับ Listener โดยกำหนดเมธอด AdapterView.OnItemClickListener.onItemClick() ดังนี้
Kotlin
override fun onItemClick(parent: AdapterView<*>, view: View?, position: Int, id: Long) { // Get the Cursor val cursor: Cursor? = (parent.adapter as? CursorAdapter)?.cursor?.apply { // Move to the selected contact moveToPosition(position) // Get the _ID value contactId = getLong(CONTACT_ID_INDEX) // Get the selected LOOKUP KEY contactKey = getString(CONTACT_KEY_INDEX) // Create the contact's content Uri contactUri = ContactsContract.Contacts.getLookupUri(contactId, mContactKey) /* * You can use contactUri as the content URI for retrieving * the details for a contact. */ } }
Java
@Override public void onItemClick( AdapterView<?> parent, View item, int position, long rowID) { // Get the Cursor Cursor cursor = parent.getAdapter().getCursor(); // Move to the selected contact cursor.moveToPosition(position); // Get the _ID value contactId = cursor.getLong(CONTACT_ID_INDEX); // Get the selected LOOKUP KEY contactKey = cursor.getString(CONTACT_KEY_INDEX); // Create the contact's content Uri contactUri = Contacts.getLookupUri(contactId, mContactKey); /* * You can use contactUri as the content URI for retrieving * the details for a contact. */ }
เริ่มต้น Loader
เนื่องจากคุณใช้ CursorLoader เพื่อดึงข้อมูล คุณจึงต้องเริ่มต้นเทรดเบื้องหลังและตัวแปรอื่นๆ ที่ควบคุมการดึงข้อมูลแบบอะซิงโครนัส ทําการเริ่มต้นใน
onCreate() ดังที่
แสดงในตัวอย่างต่อไปนี้
Kotlin
class ContactsFragment : Fragment(), LoaderManager.LoaderCallbacks<Cursor> { ... override fun onCreate(savedInstanceState: Bundle?) { // Always call the super method first super.onCreate(savedInstanceState) ... // Initializes the loader loaderManager.initLoader(0, null, this)
Java
public class ContactsFragment extends Fragment implements LoaderManager.LoaderCallbacks<Cursor> { ... // Called just before the Fragment displays its UI @Override public void onCreate(Bundle savedInstanceState) { // Always call the super method first super.onCreate(savedInstanceState); ... // Initializes the loader getLoaderManager().initLoader(0, null, this);
ใช้ onCreateLoader()
ใช้เมธอด onCreateLoader() ซึ่งเฟรมเวิร์กของ Loader จะเรียกใช้ทันทีหลังจากที่คุณเรียกใช้ initLoader()
ใน onCreateLoader() ให้ตั้งค่ารูปแบบสตริงการค้นหา หากต้องการทำให้สตริงเป็นรูปแบบ ให้ใส่อักขระ "%" (เปอร์เซ็นต์) เพื่อแสดงลำดับของอักขระ 0 ตัวขึ้นไป หรืออักขระ "_" (ขีดล่าง) เพื่อแสดงอักขระตัวเดียว หรือทั้ง 2 อย่าง เช่น รูปแบบ "%Jefferson%"
จะตรงกับทั้ง "Thomas Jefferson" และ "Jefferson Davis"
ส่งคืน CursorLoader ใหม่จากเมธอด สำหรับ URI เนื้อหา ให้ใช้ Contacts.CONTENT_URI
URI นี้อ้างอิงถึงทั้งตาราง ดังที่แสดงในตัวอย่างต่อไปนี้
Kotlin
... override fun onCreateLoader(loaderId: Int, args: Bundle?): Loader<Cursor> { /* * Makes search string into pattern and * stores it in the selection array */ selectionArgs[0] = "%$mSearchString%" // Starts the query return activity?.let { return CursorLoader( it, ContactsContract.Contacts.CONTENT_URI, PROJECTION, SELECTION, selectionArgs, null ) } ?: throw IllegalStateException() }
Java
... @Override public Loader<Cursor> onCreateLoader(int loaderId, Bundle args) { /* * Makes search string into pattern and * stores it in the selection array */ selectionArgs[0] = "%" + searchString + "%"; // Starts the query return new CursorLoader( getActivity(), ContactsContract.Contacts.CONTENT_URI, PROJECTION, SELECTION, selectionArgs, null ); }
ใช้ onLoadFinished() และ onLoaderReset()
ใช้เมธอด
onLoadFinished()
เฟรมเวิร์ก Loader จะเรียกใช้
onLoadFinished()
เมื่อ Contacts Provider แสดงผลการค้นหา ในวิธีนี้ ให้ใส่ผลลัพธ์
Cursor ใน
SimpleCursorAdapter ซึ่งจะอัปเดต ListView ด้วยผลการค้นหาโดยอัตโนมัติ ดังนี้
Kotlin
override fun onLoadFinished(loader: Loader<Cursor>, cursor: Cursor) { // Put the result Cursor in the adapter for the ListView cursorAdapter?.swapCursor(cursor) }
Java
@Override public void onLoadFinished(Loader<Cursor> loader, Cursor cursor) { // Put the result Cursor in the adapter for the ListView cursorAdapter.swapCursor(cursor); }
เมธอด onLoaderReset() จะเรียกใช้เมื่อเฟรมเวิร์กของโปรแกรมโหลดตรวจพบว่าผลลัพธ์
Cursor มีข้อมูลที่ล้าสมัย ลบ
SimpleCursorAdapter การอ้างอิงถึง
Cursor ที่มีอยู่ หากไม่ทำเช่นนั้น เฟรมเวิร์ก Loader จะไม่รีไซเคิล Cursor ซึ่งทำให้หน่วยความจำรั่วไหล เช่น
Kotlin
override fun onLoaderReset(loader: Loader<Cursor>) { // Delete the reference to the existing Cursor cursorAdapter?.swapCursor(null) }
Java
@Override public void onLoaderReset(Loader<Cursor> loader) { // Delete the reference to the existing Cursor cursorAdapter.swapCursor(null); }
ตอนนี้คุณมีส่วนสำคัญของแอปที่ตรงกับสตริงการค้นหาชื่อผู้ติดต่อและแสดงผลลัพธ์ใน ListView แล้ว ผู้ใช้สามารถคลิกชื่อรายชื่อติดต่อเพื่อเลือกได้
ซึ่งจะทริกเกอร์ Listener ที่คุณสามารถทำงานกับข้อมูลของรายชื่อติดต่อเพิ่มเติมได้ เช่น คุณสามารถเรียกดูรายละเอียดของรายชื่อติดต่อได้ หากต้องการดูวิธีดำเนินการนี้ ให้ไปที่บทเรียนถัดไป ดึงรายละเอียดสำหรับรายชื่อติดต่อ
ดูข้อมูลเพิ่มเติมเกี่ยวกับอินเทอร์เฟซผู้ใช้ของ Search ได้ในคู่มือ API สร้างอินเทอร์เฟซการค้นหา
ส่วนที่เหลือในบทเรียนนี้จะแสดงวิธีอื่นๆ ในการค้นหารายชื่อติดต่อใน Contacts Provider
จับคู่รายชื่อติดต่อตามประเภทข้อมูลที่เฉพาะเจาะจง
เทคนิคนี้ช่วยให้คุณระบุประเภทข้อมูลที่ต้องการจับคู่ได้ การดึงข้อมูล ตามชื่อเป็นตัวอย่างที่เฉพาะเจาะจงของคำค้นหาประเภทนี้ แต่คุณยังดึงข้อมูลประเภทใดก็ได้ ของข้อมูลรายละเอียดที่เชื่อมโยงกับรายชื่อติดต่อ เช่น คุณสามารถดึงข้อมูลรายชื่อติดต่อที่มีรหัสไปรษณีย์ ที่เฉพาะเจาะจงได้ ในกรณีนี้ สตริงการค้นหาต้องตรงกับข้อมูลที่จัดเก็บไว้ในแถวรหัสไปรษณีย์
หากต้องการใช้การดึงข้อมูลประเภทนี้ ให้ใช้โค้ดต่อไปนี้ก่อนตามที่ระบุไว้ในส่วนก่อนหน้า
- ขอสิทธิ์อ่านผู้ให้บริการ
- กำหนด ListView และเลย์เอาต์รายการ
- กำหนด Fragment ที่แสดงรายชื่อติดต่อ
- กำหนดตัวแปรส่วนกลาง
- เริ่มต้น Fragment
- ตั้งค่า CursorAdapter สำหรับ ListView
- ตั้งค่าเครื่องมือฟังรายชื่อติดต่อที่เลือก
-
กำหนดค่าคงที่สำหรับดัชนีคอลัมน์เคอร์เซอร์
แม้ว่าคุณจะดึงข้อมูลจากตารางอื่น แต่ลำดับของคอลัมน์ในการฉายภาพจะเหมือนกัน คุณจึงใช้ดัชนีเดียวกันสำหรับเคอร์เซอร์ได้
- กำหนดเมธอด onItemClick()
- เริ่มต้น Loader
- ใช้ onLoadFinished() และ onLoaderReset()
ขั้นตอนต่อไปนี้แสดงโค้ดเพิ่มเติมที่คุณต้องใช้เพื่อจับคู่สตริงการค้นหากับข้อมูลรายละเอียดประเภทหนึ่งๆ และแสดงผลลัพธ์
เลือกประเภทข้อมูลและตาราง
หากต้องการค้นหาข้อมูลแบบละเอียดประเภทใดประเภทหนึ่ง คุณต้องทราบค่าประเภท MIME ที่กำหนดเอง
สำหรับประเภทข้อมูล ค่าประเภท MIME ที่ไม่ซ้ำกันของแต่ละประเภทข้อมูล
จะกำหนดโดยค่าคงที่ CONTENT_ITEM_TYPE ในคลาสย่อยของ
ContactsContract.CommonDataKinds ที่เชื่อมโยงกับประเภทข้อมูล
คลาสย่อยมีชื่อที่ระบุประเภทข้อมูล เช่น คลาสย่อยสำหรับข้อมูลอีเมลคือ ContactsContract.CommonDataKinds.Email และประเภท MIME ที่กำหนดเองสำหรับข้อมูลอีเมลจะกำหนดโดยค่าคงที่ Email.CONTENT_ITEM_TYPE
ใช้ContactsContract.Dataตารางสำหรับการค้นหา ค่าคงที่ทั้งหมดที่จำเป็นสำหรับการฉายภาพ ส่วนคำสั่งการเลือก และลำดับการจัดเรียงจะกำหนดไว้ในหรือรับค่ามาจากตารางนี้
กำหนดการคาดการณ์
หากต้องการกำหนดการฉายภาพ ให้เลือกคอลัมน์อย่างน้อย 1 คอลัมน์ที่กำหนดไว้ใน ContactsContract.Data หรือคลาสที่รับค่ามา โดย Contacts Provider จะทำการรวมโดยนัยระหว่าง ContactsContract.Data กับตารางอื่นๆ ก่อนที่จะแสดงผลแถว เช่น
Kotlin
@SuppressLint("InlinedApi") private val PROJECTION: Array<out String> = arrayOf( /* * The detail data row ID. To make a ListView work, * this column is required. */ ContactsContract.Data._ID, // The primary display name if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB) ContactsContract.Data.DISPLAY_NAME_PRIMARY else ContactsContract.Data.DISPLAY_NAME, // The contact's _ID, to construct a content URI ContactsContract.Data.CONTACT_ID, // The contact's LOOKUP_KEY, to construct a content URI ContactsContract.Data.LOOKUP_KEY )
Java
@SuppressLint("InlinedApi") private static final String[] PROJECTION = { /* * The detail data row ID. To make a ListView work, * this column is required. */ ContactsContract.Data._ID, // The primary display name Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB ? ContactsContract.Data.DISPLAY_NAME_PRIMARY : ContactsContract.Data.DISPLAY_NAME, // The contact's _ID, to construct a content URI ContactsContract.Data.CONTACT_ID, // The contact's LOOKUP_KEY, to construct a content URI ContactsContract.Data.LOOKUP_KEY // A permanent link to the contact };
กำหนดเกณฑ์การค้นหา
หากต้องการค้นหาสตริงภายในข้อมูลประเภทใดประเภทหนึ่ง ให้สร้างกลไกการเลือกจาก รายการต่อไปนี้
-
ชื่อคอลัมน์ที่มีสตริงการค้นหา ชื่อนี้จะแตกต่างกันไปตามประเภทข้อมูล คุณจึงต้องค้นหาคลาสย่อยของ
ContactsContract.CommonDataKindsที่สอดคล้องกับประเภทข้อมูล แล้วเลือกชื่อคอลัมน์จากคลาสย่อยนั้น เช่น หากต้องการค้นหาอีเมล ให้ใช้คอลัมน์Email.ADDRESS - สตริงการค้นหา ซึ่งแสดงเป็นอักขระ "?" ในส่วนคำสั่งการเลือก
-
ชื่อของคอลัมน์ที่มีค่าประเภท MIME ที่กำหนดเอง ชื่อนี้จะเป็น
Data.MIMETYPEเสมอ -
ค่าประเภท MIME ที่กำหนดเองสำหรับประเภทข้อมูล ตามที่อธิบายไว้ก่อนหน้านี้ ค่าคงที่นี้คือ
CONTENT_ITEM_TYPEในคลาสย่อยContactsContract.CommonDataKindsเช่น ค่าประเภท MIME สำหรับข้อมูลอีเมลคือEmail.CONTENT_ITEM_TYPEใส่วันที่ในเครื่องหมายคำพูดเดี่ยวโดยเชื่อมต่ออักขระ "'" (เครื่องหมายคำพูดเดี่ยว) ที่จุดเริ่มต้นและจุดสิ้นสุดของค่าคงที่ มิฉะนั้น ผู้ให้บริการจะตีความค่าเป็นชื่อตัวแปรแทนที่จะเป็นค่าสตริง คุณไม่จำเป็นต้องใช้ตัวยึดตำแหน่งสำหรับค่านี้ เนื่องจากคุณใช้ค่าคงที่ แทนค่าที่ผู้ใช้ระบุ
เช่น
Kotlin
/* * Constructs search criteria from the search string * and email MIME type */ private val SELECTION: String = /* * Searches for an email address * that matches the search string */ "${Email.ADDRESS} LIKE ? AND " + /* * Searches for a MIME type that matches * the value of the constant * Email.CONTENT_ITEM_TYPE. Note the * single quotes surrounding Email.CONTENT_ITEM_TYPE. */ "${ContactsContract.Data.MIMETYPE } = '${Email.CONTENT_ITEM_TYPE}'"
Java
/* * Constructs search criteria from the search string * and email MIME type */ private static final String SELECTION = /* * Searches for an email address * that matches the search string */ Email.ADDRESS + " LIKE ? " + "AND " + /* * Searches for a MIME type that matches * the value of the constant * Email.CONTENT_ITEM_TYPE. Note the * single quotes surrounding Email.CONTENT_ITEM_TYPE. */ ContactsContract.Data.MIMETYPE + " = '" + Email.CONTENT_ITEM_TYPE + "'";
ถัดไป ให้กำหนดตัวแปรเพื่อเก็บอาร์กิวเมนต์การเลือก ดังนี้
Kotlin
private var searchString: String? = null private val selectionArgs: Array<String> = arrayOf("")
Java
String searchString; String[] selectionArgs = { "" };
ใช้ onCreateLoader()
เมื่อระบุข้อมูลที่ต้องการและวิธีค้นหาแล้ว ให้กำหนดการค้นหาในการติดตั้งใช้งาน onCreateLoader()
ส่งคืน CursorLoader ใหม่จากเมธอดนี้
โดยใช้การคาดการณ์ นิพจน์ข้อความการเลือก และอาร์เรย์การเลือกเป็น
อาร์กิวเมนต์ สำหรับ URI เนื้อหา ให้ใช้ Data.CONTENT_URI เช่น
Kotlin
override fun onCreateLoader(id: Int, args: Bundle?): Loader<Cursor> { // OPTIONAL: Makes search string into pattern searchString = "%$mSearchString%" searchString?.also { // Puts the search string into the selection criteria selectionArgs[0] = it } // Starts the query return activity?.let { CursorLoader( it, ContactsContract.Data.CONTENT_URI, PROJECTION, SELECTION, selectionArgs, null ) } ?: throw IllegalStateException() }
Java
@Override public Loader<Cursor> onCreateLoader(int loaderId, Bundle args) { // OPTIONAL: Makes search string into pattern searchString = "%" + searchString + "%"; // Puts the search string into the selection criteria selectionArgs[0] = searchString; // Starts the query return new CursorLoader( getActivity(), Data.CONTENT_URI, PROJECTION, SELECTION, selectionArgs, null ); }
ข้อมูลโค้ดเหล่านี้เป็นพื้นฐานของการค้นหาแบบย้อนกลับพื้นฐานตามประเภทข้อมูลรายละเอียดที่เฉพาะเจาะจง เทคนิคนี้เป็นเทคนิคที่ดีที่สุดหากแอปของคุณมุ่งเน้นที่ข้อมูลประเภทใดประเภทหนึ่ง เช่น อีเมล และคุณต้องการอนุญาตให้ผู้ใช้รับชื่อที่เชื่อมโยงกับข้อมูลชิ้นหนึ่ง
จับคู่รายชื่อติดต่อตามข้อมูลประเภทใดก็ได้
การดึงข้อมูลรายชื่อติดต่อตามข้อมูลประเภทใดก็ตามจะแสดงรายชื่อติดต่อหากข้อมูลตรงกับสตริงการค้นหา ซึ่งรวมถึงชื่อ อีเมล ที่อยู่ไปรษณีย์ หมายเลขโทรศัพท์ และอื่นๆ ซึ่งจะทำให้ได้ผลการค้นหาที่กว้าง ตัวอย่างเช่น หากสตริงการค้นหา คือ "Doe" การค้นหาประเภทข้อมูลใดก็ตามจะแสดงรายชื่อติดต่อ "John Doe" และยังแสดง รายชื่อติดต่อที่อาศัยอยู่ที่ "Doe Street" ด้วย
หากต้องการใช้การดึงข้อมูลประเภทนี้ ให้ใช้โค้ดต่อไปนี้ก่อนตามที่ระบุไว้ในส่วนก่อนหน้า
- ขอสิทธิ์อ่านผู้ให้บริการ
- กำหนด ListView และเลย์เอาต์รายการ
- กำหนด Fragment ที่แสดงรายชื่อติดต่อ
- กำหนดตัวแปรส่วนกลาง
- เริ่มต้น Fragment
- ตั้งค่า CursorAdapter สำหรับ ListView
- ตั้งค่าเครื่องมือฟังรายชื่อติดต่อที่เลือก
- กำหนดการฉายภาพ
-
กำหนดค่าคงที่สำหรับดัชนีคอลัมน์เคอร์เซอร์
สำหรับการดึงข้อมูลประเภทนี้ คุณจะใช้ตารางเดียวกับที่ใช้ในส่วน จับคู่รายชื่อติดต่อตามชื่อและแสดงผลลัพธ์ ใช้ดัชนีคอลัมน์เดียวกันด้วย
- กำหนดเมธอด onItemClick()
- เริ่มต้น Loader
- ใช้ onLoadFinished() และ onLoaderReset()
ขั้นตอนต่อไปนี้แสดงโค้ดเพิ่มเติมที่คุณต้องใช้เพื่อจับคู่สตริงการค้นหากับข้อมูลประเภทใดก็ได้และแสดงผลลัพธ์
นำเกณฑ์การเลือกออก
อย่านิยามค่าคงที่ SELECTION หรือตัวแปร mSelectionArgs
ระบบจะไม่ใช้ข้อมูลเหล่านี้ในการดึงข้อมูลประเภทนี้
ใช้ onCreateLoader()
ใช้เมธอด onCreateLoader() ซึ่งจะแสดงผล CursorLoader ใหม่
คุณไม่จำเป็นต้องแปลงสตริงการค้นหาเป็นรูปแบบ เนื่องจาก Contacts Provider จะดำเนินการให้โดยอัตโนมัติ ใช้ Contacts.CONTENT_FILTER_URI เป็น URI พื้นฐาน และเพิ่มสตริงการค้นหาต่อท้ายโดยเรียกใช้ Uri.withAppendedPath() การใช้ URI นี้
จะทริกเกอร์การค้นหาประเภทข้อมูลโดยอัตโนมัติ ดังที่แสดงในตัวอย่างต่อไปนี้
Kotlin
override fun onCreateLoader(loaderId: Int, args: Bundle?): Loader<Cursor> { /* * Appends the search string to the base URI. Always * encode search strings to ensure they're in proper * format. */ val contentUri: Uri = Uri.withAppendedPath( ContactsContract.Contacts.CONTENT_FILTER_URI, Uri.encode(searchString) ) // Starts the query return activity?.let { CursorLoader( it, contentUri, PROJECTION2, null, null, null ) } ?: throw IllegalStateException() }
Java
@Override public Loader<Cursor> onCreateLoader(int loaderId, Bundle args) { /* * Appends the search string to the base URI. Always * encode search strings to ensure they're in proper * format. */ Uri contentUri = Uri.withAppendedPath( Contacts.CONTENT_FILTER_URI, Uri.encode(searchString)); // Starts the query return new CursorLoader( getActivity(), contentUri, PROJECTION, null, null, null ); }
ข้อมูลโค้ดเหล่านี้เป็นพื้นฐานของแอปที่ทำการค้นหาแบบกว้างใน Contacts Provider เทคนิคนี้มีประโยชน์สำหรับแอปที่ต้องการใช้ฟังก์ชันการทำงานที่คล้ายกับหน้าจอข้อมูลรายชื่อติดต่อของแอป People