ContentProvider數據訪問詳解

ContentProvider數據訪問詳解

 

　　Android官方指出的數據存儲方式總共有五種：Shared Preferences、網絡存儲、文件存儲、外儲存儲、SQLite，這些存儲方式一般都只是在一個單獨的應用程序中實現數據的共享，而對於需要操作其他應用程序中的數據時（如媒體庫、通訊錄等），可能就需要借助ContentProvider了。

 

1、ContentProvider

　　ContentProvider為存儲和獲取數據提供了統一的接口，使用表的形式來對數據進行封裝，使得開發者在后續的開發過程中不用關心數據存儲的細節。使用ContentProvider可以在不同的應用程序之間共享數據，Android為常見的數據類型提供了默認的ContentProvider（包括音頻、視頻、圖片和通訊錄等）。

　　總的來說，利用ContentProvider來實現共享數據的好處是統一了數據的訪問方式。

 

2、URI（Uniform Resource Identifier）

　　URI為系統中的每一個資源賦予一個名字，比方說通話記錄。每一個ContentProvider都擁有一個公共的URI，用於表示ContentProvider所提供的數據。 Android所提供的ContentProvider都位於android.provider包中， 可以將URI分為A、B、C、D 4個部分來理解。如對於content://com.wang.provider.myprovider/tablename/id：

　　a、標准前綴——content://，用來說明一個Content Provider控制這些數據；

　　b、URI的標識——com.wang.provider.myprovider，用於唯一標識這個ContentProvider，外部調用者可以根據這個標識來找到它。對於第三方應用程序，為了保證URI標識的唯一性，它必須是一個完整的、小寫的類名。這個標識在元素的authorities屬性中說明，一般是定義該ContentProvider的包.類的名稱；

　　c、路徑——tablename，通俗的講就是你要操作的數據庫中表的名字，或者你也可以自己定義，記得在使用的時候保持一致就可以了；

　　d、記錄ID——id，如果URI中包含表示需要獲取的記錄的ID，則返回該id對應的數據，如果沒有ID，就表示返回全部；

　　對於第三部分路徑（path）做進一步的解釋，用來表示要操作的數據，構建時應根據實際項目需求而定。如：

      a、操作tablename表中id為11的記錄，構建路徑：/tablename/11；

      b、操作tablename表中id為11的記錄的name字段：tablename/11/name；

      c、操作tablename表中的所有記錄：/tablename；

      d、操作來自文件、xml或網絡等其他存儲方式的數據，如要操作xml文件中tablename節點下name字段：/ tablename/name；

      e、若需要將一個字符串轉換成Uri，可以使用Uri類中的parse()方法，如：

Uri uri = Uri.parse("content://com.wang.provider.myprovider/tablename")；

 

3、UriMatcher

　　Uri代表要操作的數據，在開發過程中對數據進行獲取時需要解析Uri，Android提供了兩個用於操作Uri的工具類，分別為UriMatcher和ContentUris 。掌握它們的基本概念和使用方法，對一個Android開發者來說是一項必要的技能。

　　UriMatcher類用於匹配Uri，它的使用步驟如下：

　　a、將需要匹配的Uri路徑進行注冊，代碼如下：

//常量UriMatcher.NO_MATCH表示不匹配任何路徑的返回碼
UriMatcher  sMatcher = new UriMatcher(UriMatcher.NO_MATCH);
//如果match()方法匹配“content://com.wang.provider.myprovider/tablename”路徑，返回匹配碼為1
sMatcher.addURI("content://com.wang.provider.myprovider", " tablename ", 1);
 //如果match()方法匹配content://com.wang.provider.myprovider/tablename/11路徑，返回匹配碼為2
sMatcher.addURI("com.wang.provider.myprovider", "tablename/#", 2);

　　注意，添加第二個URI時，路徑后面的id采用了通配符形式“#”，表示只要前面三個部分都匹配上了就OK。

　　b、注冊完需要匹配的Uri后，可以使用sMatcher.match(Uri)方法對輸入的Uri進行匹配，如果匹配就返回對應的匹配碼，匹配碼為調用addURI()方法時傳入的第三個參數。

switch (sMatcher.match(Uri.parse("content://com.zhang.provider.yourprovider/tablename/100"))) {
   case 1:
     //match 1, todo something
     break;
   case 2
     //match 2, todo something
     break;
   default:
     //match nothing, todo something
     break;
}

 

4、ContentUris

　　ContentUris類用於操作Uri路徑后面的ID部分，它有兩個比較實用的方法：withAppendedId(Uri uri, long id)和parseId(Uri uri)。

　　withAppendedId(Uri uri, long id)用於為路徑加上ID部分：

Uri uri = Uri.parse("content://com.wang.provider.myprovider/tablename");
Uri resultUri = ContentUris.withAppendedId(uri, 10);

      parseId(Uri uri)則從路徑中獲取ID部分：

Uri uri = Uri.parse("content://com.zhang.provider.myprovider/tablename/10")
long personid = ContentUris.parseId(uri);

 

5、ContentProvider數據共享

　　ContentProvider類主要方法的介紹：

　　public boolean onCreate()，在ContentProvider創建后就會被調用，而ContentProvider是在其它應用第一次訪問它時被創建；

　　public Uri insert(Uri uri, ContentValues values)，供外部應用向ContentProvider添加數據；

　　public int delete(Uri uri, String selection, String[] selectionArgs)，供外部應用從ContentProvider刪除數據；

　　public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)，供外部應用更新ContentProvider中的數據；

　　public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)，供外部應用從ContentProvider中獲取數據；

　　public String getType(Uri uri)，返回當前Uri所代表數據的MIME類型；

　　如果操作的數據屬於集合類型，那么MIME類型字符串應該以vnd.android.cursor.dir/開頭，如要得到所有tablename記錄的Uri為content://com.wang.provider.myprovider/tablename，那么返回的MIME類型字符串應該為：vnd.android.cursor.dir/table。

　　如果要操作的數據屬於非集合類型數據，那么MIME類型字符串應該以vnd.android.cursor.item/開頭，如得到id為10的tablename記錄，Uri為content://com.wang.provider.myprovider/tablename/10，那么返回的MIME類型字符串為：vnd.android.cursor.item/tablename 。

 

6、ContentResolver操作數據

　　當外部應用需要對ContentProvider中的數據進行添加、刪除、修改及查詢操作時，可以使用ContentResolver 類來完成。而要獲取ContentResolver 對象，可以使用Activity提供的getContentResolver()方法。

　　ContentResolver 類提供了與ContentProvider類相同簽名的四個方法：

　　public Uri insert(Uri uri, ContentValues values)，往ContentProvider添加數據；

　　public int delete(Uri uri, String selection, String[] selectionArgs)，從ContentProvider刪除數據；

　　public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)，更新ContentProvider中的數據；

　　public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)，從ContentProvider中獲取數據；

　　這些方法的第一個參數為Uri，代表要操作的ContentProvider和對其中的什么數據進行操作，其實和ContentProvider里面的方法是一樣的。他們所對應的數據，最終會被傳到我們在之前程序里面定義的那個ContentProvider類的方法，假設給定的是：Uri.parse("content://com.wang.provider.myprovider/tablename/10")，那么將會對主機名為com.wang.provider.myprovider的ContentProvider進行操作，操作的數據為tablename表中id為10的記錄。

      使用ContentResolver對ContentProvider中的數據進行操作的代碼如下：

ContentResolver resolver = getContentResolver();
Uri uri = Uri.parse("content://com.wang.provider.myprovider/tablename");
//添加一條記錄
ContentValues values = new ContentValues();
values.put("name", "wang1");
values.put("age", 28);
resolver.insert(uri, values); 
//獲取tablename表中所有記錄
Cursor cursor = resolver.query(uri, null, null, null, "tablename data");
while(cursor.moveToNext()){
   Log.i("ContentTest", "tablename_id="+ cursor.getInt(0)+ ", name="+ cursor.getString(1));
}
//把id為1的記錄的name字段值更改新為zhang1
ContentValues updateValues = new ContentValues();
updateValues.put("name", "zhang1");
Uri updateIdUri = ContentUris.withAppendedId(uri, 2);
resolver.update(updateIdUri, updateValues, null, null);
//刪除id為2的記錄，即字段age
Uri deleteIdUri = ContentUris.withAppendedId(uri, 2);
resolver.delete(deleteIdUri, null, null);

 

7、監聽數據變化

　　如果ContentProvider的訪問者需要知道數據發生的變化，可以在ContentProvider發生數據變化時調用getContentResolver().notifyChange(uri, null)來通知注冊在此URI上的訪問者。只給出類中監聽部分的代碼：

public class MyProvider extends ContentProvider {
   public Uri insert(Uri uri, ContentValues values) {
      db.insert("tablename", "tablenameid", values);
      getContext().getContentResolver().notifyChange(uri, null);
   }
}

　　而訪問者必須使用ContentObserver對數據（數據采用uri描述）進行監聽，當監聽到數據變化通知時，系統就會調用ContentObserver的onChange()方法：

getContentResolver().registerContentObserver(Uri.parse("content://com.ljq.providers.personprovider/person"),
       true, new PersonObserver(new Handler()));
public class PersonObserver extends ContentObserver{
   public PersonObserver(Handler handler) {
      super(handler);
   }
   public void onChange(boolean selfChange) {
      //to do something
   }
}

 

8、完整項目代碼

　　a、對於實際測試中的Uri——com.wang.provider.myprovider，需要在AndroidManifest.xml文件中進行說明：

<provider android:name="MyProvider" android:authorities="com.wang.provider.myprovider" />

　　b、定義Profile類，其主要負責定義Uri各組成部分名稱對應的String常量：

package com.wang.testcontentprovider;

import android.net.Uri;  

public class Profile {  
      
    /** 
     * 表格名稱 
     */  
    public static final String TABLE_NAME = "tablename";  
      
    /** 
     * 列表一，_ID，自動增加 
     */  
    public static final String COLUMN_ID = "_id";  
      
    /** 
     * 列表二，名稱 
     */  
    public static final String COLUMN_NAME = "name";  
       
    public static final String AUTOHORITY = "com.wang.provider.myprovider";  
    public static final int ITEM = 1;  
    public static final int ITEM_ID = 2;  
       
    public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.wang.tablename";  
    public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.wang.tablename";  
       
    public static final Uri CONTENT_URI = Uri.parse("content://" + AUTOHORITY + "/tablename");  
}  

　　c、實現存放數據的DBHelper類，繼承自SQLiteOpenHelper類，完成數據庫的一些常規操作：

package com.wang.testcontentprovider;

import android.content.Context;  
import android.database.SQLException;  
import android.database.sqlite.SQLiteDatabase;  
import android.database.sqlite.SQLiteOpenHelper;  
  
public class DBHelper extends SQLiteOpenHelper {  
  
    /** 
     * 數據庫名稱 
     */  
    private static final String DATABASE_NAME = "test.db";    
      
    /** 
     * 數據庫版本 
     */  
    private static final int DATABASE_VERSION = 1;    
  
    public DBHelper(Context context) {  
        super(context, DATABASE_NAME, null, DATABASE_VERSION);  
    }  
  
    @Override  
    public void onCreate(SQLiteDatabase db)  throws SQLException {  
        //創建表格  
        db.execSQL("CREATE TABLE IF NOT EXISTS "+ Profile.TABLE_NAME + "("+ Profile.COLUMN_ID +" INTEGER PRIMARY KEY AUTOINCREMENT," + Profile.COLUMN_NAME +" VARCHAR NOT NULL);");  
    }  
  
    @Override  
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion)  throws SQLException {  
        //刪除並創建表格  
        db.execSQL("DROP TABLE IF EXISTS "+ Profile.TABLE_NAME+";");  
        onCreate(db);  
    }  
}  

　　d、MyProvider類的實現，主要負責向ContentProvider中添加數據

package com.wang.testcontentprovider;

import android.content.ContentProvider;    
import android.content.ContentUris;    
import android.content.ContentValues;    
import android.content.UriMatcher;    
import android.database.Cursor;    
import android.database.SQLException;    
import android.database.sqlite.SQLiteDatabase;    
import android.net.Uri;    
    
public class MyProvider extends ContentProvider {    
    
    DBHelper mDbHelper = null;    
    SQLiteDatabase db = null;    
    
    private static final UriMatcher mMatcher;    
    static{    
        mMatcher = new UriMatcher(UriMatcher.NO_MATCH);    
        mMatcher.addURI(Profile.AUTOHORITY,Profile.TABLE_NAME, Profile.ITEM);    
        mMatcher.addURI(Profile.AUTOHORITY, Profile.TABLE_NAME+"/#", Profile.ITEM_ID);    
    }    
    
    @Override    
    public int delete(Uri uri, String selection, String[] selectionArgs) {    
        // TODO Auto-generated method stub    
        return 0;    
    }    
    
    @Override    
    public String getType(Uri uri) {    
        switch (mMatcher.match(uri)) {    
        case Profile.ITEM:    
            return Profile.CONTENT_TYPE;    
        case Profile.ITEM_ID:    
            return Profile.CONTENT_ITEM_TYPE;    
        default:    
            throw new IllegalArgumentException("Unknown URI"+uri);    
        }    
    }    
    
    @Override    
    public Uri insert(Uri uri, ContentValues values) {    
        // TODO Auto-generated method stub    
        long rowId;    
        if(mMatcher.match(uri)!=Profile.ITEM){    
            throw new IllegalArgumentException("Unknown URI"+uri);    
        }    
        rowId = db.insert(Profile.TABLE_NAME,null,values);    
        if(rowId>0){    
            Uri noteUri=ContentUris.withAppendedId(Profile.CONTENT_URI, rowId);    
            getContext().getContentResolver().notifyChange(noteUri, null);    
            return noteUri;    
        }    
    
        throw new SQLException("Failed to insert row into " + uri);    
    }    
    
    @Override    
    public boolean onCreate() {    
        // TODO Auto-generated method stub    
        mDbHelper = new DBHelper(getContext());    
    
        db = mDbHelper.getReadableDatabase();    
    
        return true;    
    }    
    
    @Override    
    public Cursor query(Uri uri, String[] projection, String selection,    
            String[] selectionArgs, String sortOrder) {    
        // TODO Auto-generated method stub    
        Cursor c = null;    
        switch (mMatcher.match(uri)) {    
        case Profile.ITEM:    
            c =  db.query(Profile.TABLE_NAME, projection, selection, selectionArgs, null, null, sortOrder);    
            break;    
        case Profile.ITEM_ID:    
            c = db.query(Profile.TABLE_NAME, projection,Profile.COLUMN_ID + "="+uri.getLastPathSegment(), selectionArgs, null, null, sortOrder);    
            break;    
        default:    
            throw new IllegalArgumentException("Unknown URI"+uri);    
        }    
    
        c.setNotificationUri(getContext().getContentResolver(), uri);    
        return c;    
    }    
    
    @Override    
    public int update(Uri uri, ContentValues values, String selection,    
            String[] selectionArgs) {    
        // TODO Auto-generated method stub    
        return 0;    
    }    
    
}

　　e、作為主程序的MainActivity類，對ContentProvider中的數據進行獲取，並在界面上進行簡單的顯示：

package com.wang.testcontentprovider;

import android.support.v7.app.ActionBarActivity;
import android.os.Bundle;
import android.view.Menu;
import android.view.MenuItem;

import android.app.ListActivity;  
import android.content.ContentResolver;  
import android.content.ContentUris;  
import android.content.ContentValues;  
import android.database.Cursor;  
import android.database.SQLException;  
import android.database.sqlite.SQLiteDatabase;  
import android.net.Uri;  
import android.widget.SimpleCursorAdapter;  
  
public class MainActivity extends ListActivity {  
    private SimpleCursorAdapter adapter= null;  
    private Cursor mCursor = null;  
    private ContentResolver mContentResolver = null;  
  
    @Override  
    public void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        initData();  
        initAdapter();  
    }  
  
    public void initData(){  
        mContentResolver = getContentResolver();  
        for (int i = 0; i < 100; i++) {  
            ContentValues values = new ContentValues();  
            values.put(Profile.COLUMN_NAME, "Wang "+i);  
            mContentResolver.insert(Profile.CONTENT_URI, values);  
        }  
    }  
  
    public void initAdapter(){  
        mCursor = mContentResolver.query(Profile.CONTENT_URI, new String[]{Profile.COLUMN_ID,Profile.COLUMN_NAME}, null, null, null);  
  
        startManagingCursor(mCursor);  
  
        //設置adapter  
        adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, mCursor, new String[]{Profile.COLUMN_ID,Profile.COLUMN_NAME}, new int[]{android.R.id.text1,android.R.id.text2});  
        setListAdapter(adapter);  
    }  
  
    @Override  
    public boolean onCreateOptionsMenu(Menu menu) {  
        getMenuInflater().inflate(R.menu.main, menu);  
        return true;  
    }  
  
}  

 

9、結果分析

　　貼上一張不太美觀的結果圖：