Android開發之ContentProvider的使用詳解

前言

　　Content Provider為儲存資料和擷取資料提供了統一的介面，它可以完成在不同應用程式下的資料共用，而在上一篇文章Android開發之SQLite的使用方法講到的SQLite只能在同一個程式中共用資料。另外android為一些常見的資料，比如說音頻，視頻，圖片，通訊錄等提供了Content Provider，這樣我們就可以很方便的對這些類型的資料操作了。使用ContentProvider的好處是開發人員不需要考慮資料內部是怎麼儲存的，比如說如果我們想利用ContenProvider來存資料，只需告訴insert函數該ContentProvider的uri和想存入的資料（包括列名和數值），查詢時也是一樣，只需輸入Uri和查詢的表，列名和查詢條件，至於ContentProvider裡面是怎麼進行這些操作的我們不需要知道。

　　實驗基礎

　　在瞭解本實驗的內容，需要用到下面這幾個跟ContentProvider有關的類。

　　UriMatcher：

　　要瞭解UriMatcher，首先需要瞭解android中的Uri表示方法，眾所周知，Uri為通用資源標識符，它代表的是要操作的資料，Android中的每一種資源(比如文本，映像，視頻等)都可以用Uri來表示。Android中的Uri由以下三部分組成:”content://”(即authory),資料的路徑，資源標識ID(可選)，其中如果存在ID，則表示某一個具體的資源，如果不存在ID，則表示路徑下的整體。因此addUri()函數的3個參數也是對應上面的那3個。

　　UriMatcher的匹配過程分為3步，初始化UriMatcher；註冊需要用的Uri；與已經註冊的Uri進行匹配。

　　ContentResolver ：

　　當使用ContentProvider在不同的應用程式中共用資料時，其資料的暴露方式是採取類似資料庫中表的方法。而ContentResolver 是恰好是採用類似資料庫的方法來從ContentProvider中存取資料的，它是通過Uri來查詢ContentProvider中提供的資料，查詢時，還需知道目的資料庫的名稱，資料區段的資料類型，或者說資源的ID。

　　SQLiteQueryBuilder:

　　SQLiteQueryBuilder是一個用來生產SQL查詢語句的輔助類，可以方便的去訪問SQLiteDatabase. 在構造SQL查詢語句時，它同樣也需要指定表名，指定列名，指定where條件等。

　　實驗過程

　　本文通過一個執行個體來實現一個ContentProvider，其實一般情況下我們是不需要自己來實現的，而是使用andorid內建的ContentProvider，但是自己實現一個以後，對它的原理能更深刻的認識，以後使用內建的就得心應手了。這是mars老師的話，本人火候不夠，暫時還沒深刻的體會。Mars老師將實現ContentProvider的步驟總結為如下：

　　

　　程式中需要4個java檔案，下面就分別來介紹實現這些類需注意的事項：

　　FirstProviderMetaData類：

　　因為在繼承類FirstContentProvider得到的子類中要用到很多常量，所以這裡我們建立了一個類專門用來儲存這些常量的，該類這裡取名為FirstProviderMetaData,裡面存著authorty名，資料庫名，資料庫版本號碼，表名，字表名，子表Uri，子表ContentProvider資料類型等等。其中字表是繼承BaseColumns類的，而BaseColumns類中已經有_ID和_COUNT這2列了。

　　DatabaseHelper類：

　　與android中使用SQLite類似，這裡同樣需要一個繼承SQLiteOpenHelper的子類，子類名為DatabaseHelper，我們在子類的回呼函數onCreate()中建立了一個表，表名和表中的列名都是引用FirstProviderMetaData類中定義好了的常量的。

　　FirstContentProvider類：

　　建立一個類，名為FirstContentProvider，繼承類ContentProvider這個類，且必須重寫父類的下面5個方法，否則會報錯。這5個方法分別為onCreate(), getType(), insert(), update(), delete().

　　onCreate()為回呼函數，是指當ContentProvider建立的時候調用，本程式在該函數中使用DatabaseHelper建立了一個SQLite資料庫。

　　在getType()方法完成的功能是根據傳入的Uri，返回該Uri所表示的資料類型。函數內部是使用的UriMatcher來匹配該函數所傳進來的參數，來得到其資料類型。

　　insert()函數給指定的資料庫表中插入一個指定的值，插入完成後必然會產生一個新的記錄，然後利用該記錄和表的Uri重建一個新的Uri，這個Uri就代表了插入成功的那條記錄的Uri，該函數返回的也是這個Uri。

　　MainActivity類：

　　在MainActivity中，主要是有2個按鈕，分為為它們綁定了監聽器，來完成插入和查詢操作。

　　當單擊插入按鈕時，在監聽器函數中會首先得到一個ContentResolver，然後當在執行ContentResolver的insert方法時會自動調用ContentProvider的insert方法，因為ContentResolver的insert方法中的第一個參數就為某個ContentProvider的Uri。

　　AndroidManifest.xml:

　　ContentProvider的使用需要在AndroidManifest.xml中進行註冊，在activity標籤外加入如下聲明即可：

<provider android:name="com.example.cptest.FirstContentProvider" android:authorities="com.example.cptest.FirstContentProvider" />

　　實驗主要部分代碼及注釋：

MainActivity.java:

複製代碼 代碼如下:package com.example.cptest;

//import com.example.cptest.FirstProviderMetaData;
import com.example.cptest.FirstProviderMetaData.UserTableMetaData;

import android.app.Activity;
import android.content.ContentValues;
import android.database.Cursor;
import android.net.Uri;
import android.os.Bundle;
import android.view.Menu;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;

public class MainActivity extends Activity {

private Button insert = null;
private Button query = null;
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
insert = (Button)findViewById(R.id.insert);
insert.setOnClickListener(new InsertOnClickListener());
query = (Button)findViewById(R.id.query);
query.setOnClickListener(new QueryOnClickListener());
System.out.println(getContentResolver().getType(FirstProviderMetaData.UserTableMetaData.CONTENT_URI));
}

//往子表中插入一條記錄
public class InsertOnClickListener implements OnClickListener{

public void onClick(View arg0) {
// TODO Auto-generated method stub
ContentValues values = new ContentValues();
values.put(FirstProviderMetaData.UserTableMetaData.USER_NAME, "tornadomeet");
//實際上使用的是ContentResolver的insert方法
//該insert中有2個參數，第一個為代表了ContentProvider的Uri，第二個參數為要插入的值。此處的insert函數
//一執行，則自動調用ContentProvider的insert方法。
Uri uri = getContentResolver().insert(FirstProviderMetaData.UserTableMetaData.CONTENT_URI,
values);
System.out.println("uri--->" +uri.toString());
}
}

//查詢也是採用的ContentResolver中的query方法。
public class QueryOnClickListener implements OnClickListener{
public void onClick(View v) {
// TODO Auto-generated method stub
Cursor c = getContentResolver().query(FirstProviderMetaData.UserTableMetaData.CONTENT_URI,
null, null, null, null);
while(c.moveToNext())
System.out.println(c.getString(c.getColumnIndex(UserTableMetaData.USER_NAME)));
}
}

@Override
public boolean onCreateOptionsMenu(Menu menu) {
getMenuInflater().inflate(R.menu.activity_main, menu);
return true;
}
}

DatabaseHelper:複製代碼 代碼如下:package com.example.cptest;

import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
import android.database.sqlite.SQLiteDatabase.CursorFactory;

public class DatabaseHelper extends SQLiteOpenHelper {

private static final int VERSON = 1;//預設的資料庫版本

//繼承SQLiteOpenHelper類的類必須有自己的建構函式
//該建構函式4個參數，直接調用父類的建構函式。其中第一個參數為該類本身；第二個參數為資料庫的名字；
//第3個參數是用來設定遊標對象的，這裡一般設定為null；參數四是資料庫的版本號碼。
public DatabaseHelper(Context context, String name, CursorFactory factory, int verson){
super(context, name, factory, verson);
}

//該建構函式有3個參數，因為它把上面函數的第3個參數固定為null了
public DatabaseHelper(Context context, String name, int verson){
this(context, name, null, verson);
}

//該建構函式只有2個參數，在上面函數 的基礎山將版本號碼固定了
public DatabaseHelper(Context context, String name){
this(context, name, VERSON);
}

//該函數在資料庫第一次被建立時調用
@Override
public void onCreate(SQLiteDatabase arg0) {
// TODO Auto-generated method stub
System.out.println("create a database");
//execSQL()為執行參數裡面的SQL語句，因此參數中的語句需要符合SQL文法,這裡是建立一個表
//arg0.execSQL("create table user1(id int, name varchar(20))");下面的語句格式是與該句類似
// arg0.execSQL("create table" + FirstProviderMetaData.USERS_TABLE_NAME
// + "(" + FirstProviderMetaData.UserTableMetaData._ID
// + " INTEGER PRIMARY KEY AUTOINCREMENT," + //ID類型為自增長的整型
// FirstProviderMetaData.UserTableMetaData.USER_NAME + " varchar(20));"
// );
// arg0.execSQL("create table user1(id int, name varchar(20))");
arg0.execSQL("create table" + FirstProviderMetaData.USERS_TABLE_NAME + "("
+ FirstProviderMetaData.UserTableMetaData._ID + " INTEGER PRIMARY KEY AUTOINCREMENT, "
+FirstProviderMetaData.UserTableMetaData.USER_NAME + " varchar(20))");
System.out.println("create a database ok");
}

@Override
public void onUpgrade(SQLiteDatabase arg0, int arg1, int arg2) {
// TODO Auto-generated method stub
System.out.println("update a database");
}

}

FirstProviderMetaData.java:複製代碼 代碼如下:package com.example.cptest;

import android.net.Uri;
import android.provider.BaseColumns;

public class FirstProviderMetaData {

//這裡的AUTHORTY為包的全名+ContentProvider子類的全名
public static final String AUTHORTY = "com.example.cptest.FirstContentProvider";
//資料庫的名稱
public static final String DATABASE_NAME = "FisrtProvider.db";
//資料庫的版本號碼
public static final int DATABASE_VERSION = 1;
//資料庫中的表名
public static final String USERS_TABLE_NAME = "users";
//表中的字表
public static final class UserTableMetaData implements BaseColumns{
//子表名
public static final String TABLE_NAME = "users";
//CONTENT_URI為常量Uri; parse是將文本轉換成Uri
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORTY + "/users");
//返回ContentProvider中表的資料類型
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.firstprovider.user";
//返回ContentProvider表中item的資料類型
public static final String CONTENT_TYPE_ITEM = "vnd.android.cursor.item/vnd.firstprovider.user";
//子表列名
public static final String USER_NAME = "name";
//表中記錄的預設排序演算法，這裡是降序排列
public static final String DEFAULT_SORT_ORDER = "_id desc";

}

}

FirstContentProvider.java:複製代碼 代碼如下:package com.example.cptest;

import java.util.HashMap;

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.database.sqlite.SQLiteQueryBuilder;
import android.net.Uri;
import android.text.TextUtils;

import com.example.cptest.FirstProviderMetaData.UserTableMetaData;

public class FirstContentProvider extends ContentProvider {

//定義一個UriMatcher類對象，用來匹配Uri的。
public static final UriMatcher uriMatcher;
//組時的ID
public static final int INCOMING_USER_COLLECTION = 1;
//單個時的ID
public static final int INCOMING_USER_SIGNAL = 2;
private DatabaseHelper dh;//定義一個DatabaseHelper對象
static{
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);//UriMatcher.NO_MATCH表示不匹配任何路徑的返回碼
uriMatcher.addURI(FirstProviderMetaData.AUTHORTY, "users", INCOMING_USER_COLLECTION);
uriMatcher.addURI(FirstProviderMetaData.AUTHORTY, "users/#", INCOMING_USER_SIGNAL);//後面加了#表示為單個
}

public static HashMap<String, String> userProjectionMap;//建立一個HashMap,後面執行插入操作時有用
static
{
userProjectionMap = new HashMap<String, String>();
//這裡可以直接調用另外一個類的public變數，這裡put裡面的2個參數一樣，
//是因為這裡是給資料庫表中的列取別名，因此取的是一樣的名字
userProjectionMap.put(UserTableMetaData._ID, UserTableMetaData._ID);
userProjectionMap.put(UserTableMetaData.USER_NAME, UserTableMetaData.USER_NAME);
}

//得到ContentProvider的資料類型，返回的參數Uri所代表的資料類型
@Override
public String getType(Uri arg0) {
// TODO Auto-generated method stub
System.out.println("getType");
switch(uriMatcher.match(arg0)){
//matcher滿足Uri的前2項（即協議+路徑）為第1種情況時，switch語句的值為Uri的第3項，此處為INCOMING_USER_COLLECTION
case INCOMING_USER_COLLECTION:
return UserTableMetaData.CONTENT_TYPE;
case INCOMING_USER_SIGNAL://同上
return UserTableMetaData.CONTENT_TYPE_ITEM;
default:
throw new IllegalArgumentException("Unknown URI" + arg0);//throw是處理異常的，java中的文法
}
}

@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
// TODO Auto-generated method stub
System.out.println("delete");
return 0;
}

@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
// TODO Auto-generated method stub
System.out.println("update");
return 0;
}

@Override
public Uri insert(Uri uri, ContentValues values) {
// TODO Auto-generated method stub
System.out.println("insert");
// dh = new DatabaseHelper(getContext(), FirstProviderMetaData.DATABASE_NAME);
SQLiteDatabase db = dh.getWritableDatabase();
long rowId = db.insert(UserTableMetaData.TABLE_NAME, null, values);
// System.out.println("insert OK");
// System.out.println("" + rowId);
if(rowId > 0){
//發出通知給監聽器，說明資料已經改變
//ContentUris為工具類
Uri insertedUserUri = ContentUris.withAppendedId(UserTableMetaData.CONTENT_URI, rowId);
getContext().getContentResolver().notifyChange(insertedUserUri, null);

return insertedUserUri;
}
throw new SQLException("Failed to insert row into" + uri);
}

//回呼函數，在ContentProvider建立的時候調用
@Override
public boolean onCreate() {
// TODO Auto-generated method stub
System.out.println("onCreate");
dh = new DatabaseHelper(getContext(), FirstProviderMetaData.DATABASE_NAME);//建立1個DatabaseHelper對象
return true;
}

@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
// TODO Auto-generated method stub
System.out.println("query");
SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
switch(uriMatcher.match(uri)){
case INCOMING_USER_COLLECTION:
qb.setTables(UserTableMetaData.TABLE_NAME);//設定表的名稱
qb.setProjectionMap(userProjectionMap);//其中userProjectionMap為上面建立好了的hashmap
break;
case INCOMING_USER_SIGNAL:
qb.setTables(UserTableMetaData.TABLE_NAME);//設定表的名稱
qb.setProjectionMap(userProjectionMap);//其中userProjectionMap為上面建立好了的hashmap
//uri.getPathSegments()得到Path部分，即把uri的協議+authory部分去掉，把剩下的部分分段擷取，這裡取第
//一部分
qb.appendWhere(UserTableMetaData._ID + "=" +uri.getPathSegments().get(1));//設定where條件
break;
}
//排序
String orderBy;
if(TextUtils.isEmpty(sortOrder)){
orderBy = UserTableMetaData.DEFAULT_SORT_ORDER;//傳入的排序參數為空白的時候採用預設的排序
}
else{
orderBy = sortOrder;//不為空白時用指定的排序方法進行排序
}
SQLiteDatabase db = dh.getWritableDatabase();
//採用傳入的參數進行查詢
Cursor c = qb.query(db, projection, selection, selectionArgs, null, null, sortOrder);
//發出通知
c.setNotificationUri(getContext().getContentResolver(), uri);
return c;
}

}