【攻克Android (45)】四大组件之 ContentProvider

本文围绕以下两个部分展开：

一、ContentProvider
案例一：获得手机通讯录中的所有联系人






一、ContentProvider

        1. 使用ContentProvider共享数据与其他方式的区别

        通过指定文件的操作模式为Context.MODE_WORLD_READABLE
或Context.MODE_WORLD_WRITEABLE同样可以对外共享数据，但数据的访问方式会因数据存储的方式而不同。

        如：采用xml文件对外共享数据，需要进行xml解析来读写数据；

        采用sharedpreferences共享数据，需要使用sharedpreferences API读写数据。

        而使用ContentProvider共享数据的好处是统一了数据访问方式。当应用继承ContentProvider类，并重写该类用于提供数据和存储数据的方法，就可以向其他应用共享其数据。


        2. Uri介绍

        （1）Uri代表了要操作的数据。


        （2）Uri主要包含了两部分信息：

            A. 需要操作的ContentProvider。

            B. 对ContentProvider中的什么数据进行操作。


        （3）一个Uri由以下几部分组成：

        content://com.xiangdonglee.provider.personprovider/person/10

        1）schema。ContentProvider的scheme已经由Android所规定，scheme为：content://

        2）Authority（或叫主机名）。用于唯一标识这个ContentProvider，外部调用者可以根据这个标识来找到它。Authority为：com.xiangdonglee.provider.personprovider

        3）path（路径）。path为：person/10（或person）

        path可以用来表示我们要操作的数据，路径的构建应根据业务而定，如下：

            A. 要操作person表中id为10的记录，可以构建这样的路径:/person/10

            B. 要操作person表中id为10的记录的name字段， person/10/name

            C. 要操作person表中的所有记录，可以构建这样的路径:/person

            D. 要操作xxx表中的记录，可以构建这样的路径:/xxx

        当然要操作的数据不一定来自数据库，也可以是文件、xml或网络等其他存储方式，如下：

            E. 要操作xml文件中person节点下的name节点，可以构建这样的路径：/person/name

        如果要把一个字符串转换成Uri，可以使用Uri类中的parse()方法，如下：

            Uri uri = Uri.parse("content://cn.xiangdonglee.provider.personprovider/person")

        4）id。id为：10


        3. 操作Uri的工具类

        因为Uri代表了要操作的数据，所以我们经常需要解析Uri，并从Uri中获取数据。Android系统提供了两个用于操作Uri的工具类，分别为UriMatcher 和 ContentUris 。掌握它们的使用，会便于我们的开发工作。

        （1）UriMatcher类

        1）UriMatcher类用于匹配Uri。

        2）UriMatcher类用法如下：

            A. 把你需要匹配Uri路径全部给注册上。

    //常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码
    UriMatcher  sMatcher = new UriMatcher(UriMatcher.NO_MATCH);
    //如果match()方法匹配content://cn.xiangdonglee.provider.personprovider/person路径，返回匹配码为1
    //添加需要匹配uri，如果匹配就会返回匹配码
    sMatcher.addURI(“cn.xiangdonglee.provider.personprovider”, “person”, 1);
    //如果match()方法匹配content://cn.xiangdonglee.provider.personprovider/person/230路径，返回匹配码为2
    //#号为通配符
    sMatcher.addURI(“cn.xiangdonglee.provider.personprovider”, “person/#”, 2);
    switch (sMatcher.match(Uri.parse("content://cn.xiangdonglee.provider.personprovider/person/10"))) {
        case 1:
            break;
        case 2:
            break;
        default:
            //不匹配
            break;
    }

            B. 注册完需要匹配的Uri后，就可以使用sMatcher.match(uri)方法对输入的Uri进行匹配。

            如果匹配就返回匹配码，匹配码是调用addURI()方法传入的第三个参数。假设匹配content://cn.xiangdonglee.provider.personprovider/person路径，返回的匹配码为1。


        （2）ContentUris类

        1）ContentUris类用于获取Uri路径后面的ID部分。

        2）它有两个比较实用的方法：

            A. withAppendedId(uri, id)：用于为路径加上ID部分。

    Uri uri = Uri.parse("content://cn.xiangdonglee.provider.personprovider/person");
    Uri resultUri = ContentUris.withAppendedId(uri, 10);
    //生成后的Uri为：content://cn.xiangdonglee.provider.personprovider/person/10

            B. parseId(uri)：用于从路径中获取ID部分。

    Uri uri = Uri.parse("content://cn.xiangdonglee.provider.personprovider/person/10");
    long personid = ContentUris.parseId(uri);
    //获取的结果为:10

        4. 通过ContentProvider对外共享数据的步骤：

        （1）需要继承ContentProvider类并重写下面方法：

    public class PersonContentProvider extends ContentProvider{
        // （1）
        public boolean onCreate(){
            // 该方法在ContentProvider创建后就会被调用。
            // Android开机后， ContentProvider在其它应用第一次访问它时才会被创建。
        }

        // （2）
        public Uri insert(Uri uri, ContentValues values){
            // 该方法用于供外部应用往ContentProvider添加数据。
        }

        // （3）
        public int delete(Uri uri, String selection, String[] selectionArgs){
            // 该方法用于供外部应用从ContentProvider删除数据。
        }

        // （4）
        public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs){
            // 该方法用于供外部应用更新ContentProvider中的数据。
        }

        // （5）
        public Cursor query(Uri uri, String[] projection,
                            String selection, String[] selectionArgs,
                            String sortOrder){
            // 该方法用于供外部应用从ContentProvider中获取数据。
        }

        // （6）
        public String getType(Uri uri){
            // 该方法用于返回当前Url所代表数据的MIME类型。

            /*
            如果操作的数据属于集合类型，
                那么MIME类型字符串应该以vnd.android.cursor.dir/开头，

            例如：要得到所有person记录的Uri为
                content://cn.xiangdonglee.provider.personprovider/person，
            那么返回的MIME类型字符串应该为：“vnd.android.cursor.dir/person”。
             */

            /*
            如果要操作的数据属于非集合类型数据，
                那么MIME类型字符串应该以vnd.android.cursor.item/开头，
            例如：得到id为10的person记录，Uri为
                content://cn.xiangdonglee.provider.personprovider/person/10，
            那么返回的MIME类型字符串应该为：“vnd.android.cursor.item/person”。
             */
        }
    }

        （2）需要在AndroidManifest.xml使用<provider>对该ContentProvider进行配置。

<manifest .... >
    <application 
		android:icon="@drawable/icon" 
		android:label="@string/app_name">
		
        <provider 
			android:name=".PersonContentProvider" 
			android:authorities="com.xiangdonglee.providers.personprovider"/>
    </application>
</manifest>

        为了能让其他应用找到该ContentProvider，ContentProvider 采用了authorities（主机名/域名）对它进行唯一标识。你可以把 ContentProvider看作是一个网站（想想，网站也是提供数据者），authorities 就是他的域名。

        注意：一旦应用继承了ContentProvider类，后面我们就会把这个应用称为ContentProvider（内容提供者）。


        5. 使用ContentResolver操作ContentProvider中的数据：

        当外部应用需要对ContentProvider中的数据进行添加、删除、修改和查询操作时，可以使用 ContentResolver 类来完成。

        要获取ContentResolver 对象，可以使用Activity提供的getContentResolver()方法。


        （1）ContentResolver 类提供了与ContentProvider类相同签名的四个方法：

    // （1）
    public Uri insert(Uri uri, ContentValues values){
        // 该方法用于往ContentProvider添加数据。
    }

    // （2）
    public int delete(Uri uri, String selection, String[] selectionArgs){
        // 该方法用于从ContentProvider删除数据。
    }
    
    // （3）
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs){
        // 该方法用于更新ContentProvider中的数据。
    }
    
    // （4）
    public Cursor query(Uri uri, String[] projection, 
                        String selection, String[] selectionArgs, 
                        String sortOrder){
        // 该方法用于从ContentProvider中获取数据。
    }

        这些方法的第一个参数为Uri，代表要操作的ContentProvider和对其中的什么数据进行操作。

        假设给定的是：Uri.parse(“content://cn.xiangdonglee.providers.personprovider/person/10”)，那么将会对主机名为cn.xiangdonglee.providers.personprovider的ContentProvider进行操作，操作的数据为person表中id为10的记录。


        （2）使用ContentResolver对ContentProvider中的数据进行添加、删除、修改和查询操作：

    ContentResolver resolver =  getContentResolver();
    Uri uri = Uri.parse("content://cn.xiangdonglee.provider.personprovider/person");

    // 添加一条记录
    ContentValues values = new ContentValues();
    values.put("name", "xiangdonglee");
    values.put("age", 25);
    resolver.insert(uri, values);

    // 获取person表中所有记录
    Cursor cursor = resolver.query(uri, null, null, null, "personid desc");
    while(cursor.moveToNext()){
        Log.i("ContentTest", "personid="+ cursor.getInt(0)+ ",name="+ cursor.getString(1));
    }

    // 把id为1的记录的name字段值更新为liming
    ContentValues updateValues = new ContentValues();
    updateValues.put("name", "liming");
    Uri updateIdUri = ContentUris.withAppendedId(uri, 2);
    resolver.update(updateIdUri, updateValues, null, null);

    // 删除id为2的记录
    Uri deleteIdUri = ContentUris.withAppendedId(uri, 2);
    resolver.delete(deleteIdUri, null, null);

案例一：获得手机通讯录中的所有联系人

        1. AndroidManifest.xml。授予读写手机联系人的权限。

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

        2. activity_main.xml。在ScrollView中写一个TextView，用于显示手机中的所有通讯录信息，并可以滚动查看。

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    tools:context=".MainActivity">

    <ScrollView
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <TextView
            android:id="@+id/tvContact"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="@string/hello_world" />
    </ScrollView>

</RelativeLayout>

        3. MainActivity。通过ContentResolver获得手机通讯录中的所有联系人信息。

package com.android.mycontact;

import android.app.Activity;
import android.content.ContentResolver;
import android.database.Cursor;
import android.net.Uri;
import android.os.Bundle;
import android.provider.ContactsContract;
import android.view.Menu;
import android.view.MenuItem;
import android.widget.TextView;

public class MainActivity extends Activity {
    private TextView tvContact;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        tvContact = (TextView) findViewById(R.id.tvContact);

        getAllContacts();
    }

    /**
     * 获得手机通讯录中的所有联系人
     */
    private void getAllContacts() {
        String text = null;
        // 获取通讯录中联系人的路径（网址）
        // content://com.android.contacts/contacts
        Uri uri = ContactsContract.Contacts.CONTENT_URI;
        // 实例化 内容访问者
        ContentResolver resolver = this.getContentResolver();
        // 内容访问者通过指定路径访问内容提供者，返回查询结果集
        // 参数：路径,返回字段,条件字段,条件字段值,排序
        // 相当于： select 返回字段 from 路径 where 条件字段=条件字段值 order by 排序
        Cursor cursor = resolver.query(uri, null, null, null, null);
        while (cursor.moveToNext()) {
            // 长度可变的字符串
            StringBuilder sb = new StringBuilder();
            // 获得联系人的id和姓名
            String contactId = cursor.getString(cursor
                    .getColumnIndex(ContactsContract.Contacts._ID));
            String name = cursor.getString(cursor
                    .getColumnIndex(ContactsContract.Contacts.DISPLAY_NAME));
            sb.append("id=").append(contactId).append(",name=").append(name + "\n");

            // 获得联系人的手机号码（一个联系人可能有多个手机号码）
            Cursor phones = resolver.query(
                    ContactsContract.CommonDataKinds.Phone.CONTENT_URI,
                    null,
                    ContactsContract.CommonDataKinds.Phone.CONTACT_ID
                            + " = " + contactId, null, null);
            while (phones.moveToNext()) {
                String phoneNumber = phones.getString(phones
                        .getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
                sb.append(",phone=").append(phoneNumber);
            }
            phones.close();
            text += sb.toString() + "\n";
        }
        cursor.close();

        tvContact.setText("");
        tvContact.append(text);
    }

}