android ContentProvider

个人原创，请勿copy，转发请注明出处http://blog.csdn.net/zenmela2011/article/details/49616339

ContentProvider（内容提供器）主要用于在不同的应用程序之间实现数据共享的功能。他提供了一套完整的机制，允许一个程序访问另一个程序中的数据，同时还能保证被访数据的安全性。目前，使用内容提供器是android实现跨程序共享数据的标准方法。

内容提供器可以选择只对哪一部分数据进行共享，从而保证我们程序中的隐私数据不会有泄露的风险。

要访问内容提供器中共享的数据，就一定要借助ContentResolver类，可以通过Context中的getContentResolver()方法获得该类的实例。ContentResolver中提供了insert()、delete()、update()、query()方法来对数据进行CRUD操作。

内容提供器的用法一般有两种，一种是使用现有的内容提供器来读取和操作相应程序中的数据；另一种是创建自己的内容提供器给我们的程序提供外部访问接口。

一、使用系统已有的内容提供器

android系统中自导的电话簿、短信、媒体库等程序都已有了内容提供器接口，这样第三方应用程序可以充分利用这部分数据来实现更好的功能。以读取系统联系人为例：

①查询系统联系人

Cursor cursor=null;
        try{
            //查询联系人数据
            cursor=getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI, null, null, null, null);
            while(cursor.moveToNext()){
                //联系人姓名
                String contactName=cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
                //联系人手机号
                String contactNumber=cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
                //将得到的联系人数据存入contactsList中
                contactsList.add(contactName+":"+contactNumber);
            }
        }catch(Exception e){
            e.printStackTrace();
        }finally{
            if(cursor != null){
                cursor.close();
            }
        }

使用ContentResolver().query ()方法查询系统的联系人数据，第一个参数是内容URI，ContactsContract.CommonDataKinds.Phone.CONTENT_URI是系统已经定义好的用于查询联系人的URI常量。query()返回的联系人数据都存储在cursor中。然后通过对cursor遍历，将联系人姓名和手机号分别逐个读取出来存在contactList中。联系人姓名这一列对应的常量是ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME，联系人手机号这一列对应的常量是ContactsContract.CommonDataKinds.Phone.NUMBER。

②在AndroidManifest.xml中添加读取联系人的权限

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

完整代码如下：

public class MainActivity extends Activity {
    private ListView mLvContacts;
    //联系人数据
            List<String> contactsList=new ArrayList<String>();
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mLvContacts=(ListView) findViewById(R.id.lv_contacts);
        showContacts();//获得全部联系人并显示
    }
    /**
     * 获得全部联系人并显示
     */
    private void showContacts(){
        Cursor cursor=null;
        try{
            //查询联系人数据
            cursor=getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI, null, null, null, null);
            while(cursor.moveToNext()){
                //联系人姓名
                String contactName=cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
                //联系人手机号
                String contactNumber=cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
                //将得到的联系人数据存入contactsList中
                contactsList.add(contactName+":"+contactNumber);
            }
            //为listview设置adapter
            ArrayAdapter<String> adapter=new ArrayAdapter<String>(this,android.R.layout.simple_list_item_1,contactsList);
            mLvContacts.setAdapter(adapter);
        }catch(Exception e){
            e.printStackTrace();
        }finally{
            if(cursor != null){
                cursor.close();
            }
        }
    }
}

二、创建自己的内容提供器

1、内容URI。使用内容提供器，需要用到内容URI，内容URI给内容提供器中的的数据建立了唯一标识符，它主要由两部分组成，权限(authority)和路径(path)。权限是用于对不同的应用程序做区分的，一般为了避免冲突，都会采用程序包名的方式进行命名。比如某个程序的包名是com.example.test，那么该程序对应的权限就可以命名为com.example.test.provider。路径则是用于对同一应用程序中不同的表做区分的，通常会添加到权限的后面。比如某个程序的数据库中存在两张表，table1和table2，这时就可以将路径分别命名为/table1和/table2，然后把权限和路径进行组合，然后加上内容URI的头部，于是内容URI最终的标准格式如下：

content://com.example.test.provider/table1

content://com.example.test.provider/table2
可以看出，内容URI非常清楚的表达出我们想要访问哪个程序中哪张表里的数据。

在得到了内容URI字符串自后，还需要将他解析成Uri对象才可以作为ContentResolver方法中的参数。解析如下：

Uri uri = Uri.parse("content://com.example.test.provider/table1");

只需要调用Uri.parse()方法，就可以将内容URI字符串解析成Uri对象了。

2、新建一个类，继承ContentProvider。

public class MyProvider extends ContentProvider{
    @Override
    public int delete(Uri arg0, String arg1, String[] arg2) {
        // TODO Auto-generated method stub
        return 0;
    }
    @Override
    public String getType(Uri arg0) {
        // TODO Auto-generated method stub
        return null;
    }
    @Override
    public Uri insert(Uri arg0, ContentValues arg1) {
        // TODO Auto-generated method stub
        return null;
    }
    @Override
    public boolean onCreate() {
        // TODO Auto-generated method stub
        return false;
    }
    @Override
    public Cursor query(Uri arg0, String[] arg1, String arg2, String[] arg3,
            String arg4) {
        // TODO Auto-generated method stub
        return null;
    }
    @Override
    public int update(Uri arg0, ContentValues arg1, String arg2, String[] arg3) {
        // TODO Auto-generated method stub
        return 0;
    }
}

继承ContentProvider，需要重写六个方法：

onCreate():初始化内容提供器的时候调用。通常会在这里完成对数据库的创建和升级等操作，返回true表示内容提供器初始化成功，返回false则表示失败。注意，只有当存在ContentResolver尝试访问我们程序中的数据时，内容提供器才会被初始化。

getType():根据传入的内容URI来返回相应的MIME类型。

query()：从内容提供器中查询数据。使用Uri参数来确定查询哪张表，projection参数用于确定查询哪些列，selection和selectionArgs参数用于约束查询条件，sortOrder参数用于对结果进行排序。查询的结果存放在Cursor对象中返回。

Cursor cursor = getContentResolver().query(uri,projection,selection,selectionArgs,sortOrder);
if(cursor != null){
while(cursor.moveToNext()){
String column1=cursor.getString(cursor.getColumnIndex("column1"));
int column2=cursor.getInt(cursor.getColumnIndex("column2"));
}
cursor.close();
}

insert():向内容提供器中添加一条数据。使用Uri参数来确定要添加到的表，待添加的数据保存在values参数中。添加完成后，返回一个用于表示这条新记录的URI。

ContentValues values = new ContentValues();
values.put("column1","text");
values.put("column2",1);
getContentResolver().insert(uri,values);

update():更新内容提供器中已有的数据。使用uri参数确实更新哪一张表中的数据，新数据保存在values参数中，selection和selectionArgs参数用于约束更新哪些行，受影响的行数将作为返回值返回。

ContentValues values = new ContentValues();
values.put("column1","");
getContentResolver().update(uri,values,"column1=? and column2=?",new String[]{"text","1"});

dekete():从内容提供器中删除数据。使用uri参数确定要删除哪一张表中的数据，selection和selectionArgs参数用于约束删除哪些行，被删除的行数将作为返回值返回。

getContentResolver().delete(uri,"column2=?",new String[]{"1"});

完整demo如下：

先看看结构图

首先在AndroidTest项目中新建数据库类MyDatabaseHelper，代码如下：

package com.example.androidtest;
import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteDatabase.CursorFactory;
import android.database.sqlite.SQLiteOpenHelper;
public class MyDatabaseHelper extends SQLiteOpenHelper{
    private Context mContext;
    //创建表的语句
    public static final String CREATE_BOOK = "create table Book (id integer primary key autoincrement,author text,price real,pages integer,name text)";
    public MyDatabaseHelper(Context context, String name,
            CursorFactory factory, int version) {
        super(context, name, factory, version);
        mContext=context;
    }
    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL(CREATE_BOOK);//创建表
    }
    @Override
    public void onUpgrade(SQLiteDatabase arg0, int arg1, int arg2) {
    }
}

然后新建MyProvider类:

package com.example.androidtest;
import android.content.ContentProvider;
import android.content.ContentValues;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.net.Uri;
/**
 * contentProvider作为一种组件必须放在应用所在包或其子包下，主要作用是对外共享数据
 *
 */
public class MyProvider extends ContentProvider{
    // 匹配码
    private static final int BOOK_DIR = 0;
    private static final int BOOK_ITEM = 1;
    public static final String AUTHORITY = "com.example.databasetest.provider";
    private static UriMatcher uriMatcher;
    private MyDatabaseHelper dbHelper;
    static {
        uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
        uriMatcher.addURI(AUTHORITY, "book", BOOK_DIR);//对等待匹配的URI进行匹配操作，必须符合com.example.databasetest.provider/book格式才能匹配返回BOOK_DIR，不匹配返回-1
        uriMatcher.addURI(AUTHORITY, "book/#", BOOK_ITEM);//#表示任意长度的数字，必须是book表中任意一行数据才能匹配返回BOOK_ITEM，不匹配返回-1
    }
    @Override
    public boolean onCreate() {
        dbHelper = new MyDatabaseHelper(this.getContext(),"BookStore.db",null,2);
        return true;//返回true表示初始化成功
    }
    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        SQLiteDatabase db=dbHelper.getWritableDatabase();
        int deleteRows = 0;
        switch(uriMatcher.match(uri)){
        case BOOK_DIR:
            deleteRows=db.delete("Book", selection, selectionArgs);
            break;
        case BOOK_ITEM:
            /**
             * getPathSegments()方法会将内容URI权限之后的部分易“/”符号进行分割，并把分割后的结果放入到一个字符串列表中，
             * 那这个列表的第0个位置存放的就是路径，第一个位置存放的就是id了
             */
            String bookId=uri.getPathSegments().get(1);
            deleteRows=db.delete("Book", "id=?", new String[]{bookId});
            break;
            default:
                break;
        }
        return deleteRows;
    }
    /**
     * getType()方法返回MIME类型，MIME构成如下：
     * 必须以vnd开头；
     * 如果内容URI以路径结尾，则vnd后面接android.cursor.dir/，如果内容URI以id结尾，则vnd后面接android.cursor.item/；
     * 最后接上vnd.<权限>.<路径>.
     */
    @Override
    public String getType(Uri uri) {
        switch(uriMatcher.match(uri)){
        case BOOK_DIR:
            return "vnd.android.cursor.dir/vnd.com.example.databasetest.provider.book";
        case BOOK_ITEM:
            return "vnd.android.cursor.item/vnd.com.example.databasetest.provider.book";
        }
        return null;
    }
    @Override
    public Uri insert(Uri uri, ContentValues values) {
        SQLiteDatabase db = dbHelper.getWritableDatabase();
        Uri uriReturn = null;
        switch(uriMatcher.match(uri)){
        case BOOK_DIR:
        case BOOK_ITEM:
            long newBookId=db.insert("Book", null, values);
            uriReturn=Uri.parse("content://"+AUTHORITY+"/book/"+newBookId);
            break;
        }
        return uriReturn;
    }
    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
            String sortOrder) {
        SQLiteDatabase db=dbHelper.getReadableDatabase();
        Cursor cursor=null;
        switch(uriMatcher.match(uri)){
        case BOOK_DIR:
            cursor=db.query("Book", projection, selection, selectionArgs, null, null, sortOrder);
            break;
        case BOOK_ITEM:
            String bookId=uri.getPathSegments().get(1);
            cursor=db.query("Book", projection, "id=?", new String[]{bookId}, null, null, sortOrder);
            break;
            default:
                break;
        }
        return cursor;
    }
    @Override
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
        SQLiteDatabase db=dbHelper.getWritableDatabase();
        int updateRows=0;
        switch(uriMatcher.match(uri)){
        case BOOK_DIR:
            updateRows=db.update("Book", values, selection, selectionArgs);
            break;
        case BOOK_ITEM:
            String bookId=uri.getPathSegments().get(1);
            updateRows=db.update("Book", values, "id=?", new String[]{bookId});
            break;
            default:
                break;
        }
        return updateRows;
    }
}

MainActivity.class类：

package com.example.androidtest;
import java.util.ArrayList;
import java.util.List;
import android.app.Activity;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.database.Cursor;
import android.net.ConnectivityManager;
import android.net.NetworkInfo;
import android.net.Uri;
import android.os.Bundle;
import android.provider.ContactsContract;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.ArrayAdapter;
import android.widget.ListView;
import android.widget.Toast;
public class MainActivity extends Activity {
    private ListView mLvBooks;
    //数据
    List<String> booksList=new ArrayList<String>();
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mLvBooks=(ListView) findViewById(R.id.lv_contacts);
        showContacts();//获得全部联系人并显示
    }
    /**
     * 获得全部联系人并显示
     */
    private void showContacts(){
        Cursor cursor=null;
        try{
            Uri uri=Uri.parse("content://com.example.databasetest.provider/book");
            //查询联系人数据
            cursor=getContentResolver().query(uri, null, null, null, null);
            if(cursor != null){
                while(cursor.moveToNext()){
                    //书名
                    String bookName=cursor.getString(cursor.getColumnIndex("name"));
                    //作者
                    String bookAuthor=cursor.getString(cursor.getColumnIndex("author"));
                    //页数
                    int pages=cursor.getInt(cursor.getColumnIndex("pages"));
                    //价格
                    Double price=cursor.getDouble(cursor.getColumnIndex("price"));
                    //将得到的数据存入contactsList中
                    booksList.add(bookName+"---作者："+bookAuthor+"  页数："+pages+"  价格:"+price);
                }
            }
            //为listview设置adapter
            ArrayAdapter<String> adapter=new ArrayAdapter<String>(this,android.R.layout.simple_list_item_1,booksList);
            mLvBooks.setAdapter(adapter);
        }catch(Exception e){
            e.printStackTrace();
        }finally{
            if(cursor != null){
                cursor.close();
            }
        }
    }
}

注意：别忘了在androidManifest.xml中添加内容提供器注册代码：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.androidtest"
    android:versionCode="1"
    android:versionName="1.0" >
    <uses-sdk
        android:minSdkVersion="8"
        android:targetSdkVersion="19" />
    <application
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name" >
        <activity
            android:name="com.example.androidtest.MainActivity"
            android:label="@string/app_name" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
        <span style="color:#cc0000;"><provider android:name="com.example.androidtest.MyProvider"
            android:authorities="com.example.databasetest.provider"></provider></span>
    </application>
</manifest>

至此，AndroidTest项目已经拥有了跨程序共享数据的功能了，其他应用可以利用Uri来操作AndroidTest中数据库中的数据了。下面新建一个AndroidTest2来访问AndroidTest数据库中的数据吧！

activity.main代码：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    android:orientation="vertical" >
    <Button
        android:id="@+id/btn_add"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="add" />
    <Button
        android:id="@+id/btn_delete"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="delete" />
    <Button
        android:id="@+id/btn_update"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="update" />
    <Button
        android:id="@+id/btn_query"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="query" />
    <ListView
        android:id="@+id/lv_books"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" >
    </ListView>
</LinearLayout>

MainActivity.class:

package com.example.androidtest2;
import java.util.ArrayList;
import java.util.List;
import android.app.Activity;
import android.content.ContentValues;
import android.database.Cursor;
import android.net.Uri;
import android.os.Bundle;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.ListView;
public class MainActivity extends Activity implements OnClickListener{
    private ListView mLvBooks;
    //数据
    List<String> booksList=new ArrayList<String>();
    private Button mBtnAdd;
    private Button mBtnDelete;
    private Button mBtnUpdate;
    private Button mBtnQuery;
    String newId;//新添加的数据的id
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        mLvBooks=(ListView) findViewById(R.id.lv_books);
        mBtnAdd=(Button) findViewById(R.id.btn_add);
        mBtnAdd.setOnClickListener(this);
        mBtnDelete=(Button) findViewById(R.id.btn_delete);
        mBtnDelete.setOnClickListener(this);
        mBtnUpdate=(Button) findViewById(R.id.btn_update);
        mBtnUpdate.setOnClickListener(this);
        mBtnQuery=(Button) findViewById(R.id.btn_query);
        mBtnQuery.setOnClickListener(this);
    }
    @Override
    public void onClick(View view) {
        switch(view.getId()){
        case R.id.btn_add:
            //添加
            Uri addUri=Uri.parse("content://com.example.databasetest.provider/book");
            ContentValues values=new ContentValues();
            values.put("name", "精彩世界");
            values.put("author", "郭敬明");
            values.put("pages", 1020);
            values.put("price", 75.36);
            Uri returnUri=getContentResolver().insert(addUri, values);
            newId=returnUri.getPathSegments().get(1);
            break;
        case R.id.btn_delete:
            //删除新增加的数据
            Uri deleteUri=Uri.parse("content://com.example.databasetest.provider/book/"+newId);
            getContentResolver().delete(deleteUri, null, null);
            break;
        case R.id.btn_update:
            //更新新增加的数据
            Uri updateUri=Uri.parse("content://com.example.databasetest.provider/book/"+newId);
            ContentValues updateValues=new ContentValues();
            updateValues.put("name", "精彩世界2");
            updateValues.put("price", 88.88);
            getContentResolver().update(updateUri, updateValues, null, null);
            break;
        case R.id.btn_query:
            booksList.clear();
            //查询
            Uri queryUri=Uri.parse("content://com.example.databasetest.provider/book");
            Cursor cursor=getContentResolver().query(queryUri, null, null, null, null);
            if(cursor != null){
                while(cursor.moveToNext()){
                    //书名
                    String bookName=cursor.getString(cursor.getColumnIndex("name"));
                    //作者
                    String bookAuthor=cursor.getString(cursor.getColumnIndex("author"));
                    //页数
                    int pages=cursor.getInt(cursor.getColumnIndex("pages"));
                    //价格
                    Double price=cursor.getDouble(cursor.getColumnIndex("price"));
                    //将得到的数据存入contactsList中
                    booksList.add(bookName+"---作者："+bookAuthor+"  页数："+pages+"  价格:"+price);
                }
                //为listview设置adapter
                ArrayAdapter<String> adapter=new ArrayAdapter<String>(this,android.R.layout.simple_list_item_1,booksList);
                mLvBooks.setAdapter(adapter);
            }
            break;
        default:
            break;
        }
    }
}

我们在AndroidTest2的四个按钮的点击事件中处理了AndroidTest数据库中增删改查的操作。
可以看出，我们的跨程序共享数据功能已经实现了！现在不仅仅是AndroidTest2程序，任何一个程序都可以轻松访问AndroidTest中的数据，而且不存在隐私数据泄露的问题。