Android開發(fā)之ContentProvider的使用詳解
前言
Content Provider為存儲數(shù)據(jù)和獲取數(shù)據(jù)提供了統(tǒng)一的接口，它可以完成在不同應(yīng)用程序下的數(shù)據(jù)共享，而在上一篇文章Android開發(fā)之SQLite的使用方法講到的SQLite只能在同一個程序共享數(shù)據(jù)。另外android為一些常見的數(shù)據(jù)，比如說音頻，視頻，圖片，通訊錄等提供了Content Provider，這樣我們就可以很方便的對這些類型的數(shù)據(jù)操作了。使用ContentProvider的好處是開發(fā)人員不需要考慮數(shù)據(jù)內(nèi)部是怎么存儲的，比如說如果我們想利用ContenProvider來存數(shù)據(jù)，只需告訴insert函數(shù)該ContentProvider的uri和想存入的數(shù)據(jù)（包括列名和數(shù)值），查詢時也是一樣，只需輸入Uri和查詢的表，列名和查詢條件，至于ContentProvider里面是怎么進(jìn)行這些操作的我們不需要知道。
實驗基礎(chǔ)
在了解本實驗的內(nèi)容，需要用到下面這幾個跟ContentProvider有關(guān)的類。
UriMatcher：
要了解UriMatcher，首先需要了解android中的Uri表示方法，眾所周知，Uri為通用資源標(biāo)識符，它代表的是要操作的數(shù)據(jù)，Android中的每一種資源(比如文本，圖像，視頻等)都可以用Uri來表示。Android中的Uri由以下三部分組成:”content://”(即authory),數(shù)據(jù)的路徑，資源標(biāo)識ID(可選)，其中如果存在ID，則表示某一個具體的資源，如果不存在ID，則表示路徑下的整體。因此addUri()函數(shù)的3個參數(shù)也是對應(yīng)上面的那3個。
UriMatcher的匹配過程分為3步，初始化UriMatcher；注冊需要用的Uri；與已經(jīng)注冊的Uri進(jìn)行匹配。
ContentResolver ：
當(dāng)使用ContentProvider在不同的應(yīng)用程序共享數(shù)據(jù)時，其數(shù)據(jù)的暴露方式是采取類似數(shù)據(jù)庫中表的方法。而ContentResolver 是恰好是采用類似數(shù)據(jù)庫的方法來從ContentProvider中存取數(shù)據(jù)的，它是通過Uri來查詢ContentProvider中提供的數(shù)據(jù)，查詢時，還需知道目的數(shù)據(jù)庫的名稱，數(shù)據(jù)段的數(shù)據(jù)類型，或者說資源的ID。
SQLiteQueryBuilder:
SQLiteQueryBuilder是一個用來生產(chǎn)SQL查詢語句的輔助類，可以方便的去訪問SQLiteDatabase. 在構(gòu)造SQL查詢語句時，它同樣也需要指定表名，指定列名，指定where條件等。
實驗過程
本文通過一個實例來實現(xiàn)一個ContentProvider，其實一般情況下我們是不需要自己來實現(xiàn)的，而是使用andorid內(nèi)置的ContentProvider，但是自己實現(xiàn)一個以后，對它的原理能更深刻的認(rèn)識，以后使用內(nèi)置的就得心應(yīng)手了。這是mars老師的話，本人火候不夠，暫時還沒深刻的體會。Mars老師將實現(xiàn)ContentProvider的步驟總結(jié)為如下：
程序中需要4個java文件，下面就分別來介紹實現(xiàn)這些類需注意的事項：
FirstProviderMetaData類：
因為在繼承類FirstContentProvider得到的子類中要用到很多常量，所以這里我們新建了一個類專門用來存儲這些常量的，該類這里取名為FirstProviderMetaData,里面存著authorty名，數(shù)據(jù)庫名，數(shù)據(jù)庫版本號，表名，字表名，子表Uri，子表ContentProvider數(shù)據(jù)類型等等。其中字表是繼承BaseColumns類的，而BaseColumns類中已經(jīng)有_ID和_COUNT這2列了。
DatabaseHelper類：
與android中使用SQLite類似，這里同樣需要一個繼承SQLiteOpenHelper的子類，子類名為DatabaseHelper，我們在子類的回調(diào)函數(shù)onCreate()中建立了一個表，表名和表中的列名都是引用FirstProviderMetaData類中定義好了的常量的。
FirstContentProvider類：
新建一個類，名為FirstContentProvider，繼承類ContentProvider這個類，且必須重寫父類的下面5個方法，否則會報錯。這5個方法分別為onCreate(), getType(), insert(), update(), delete().
onCreate()為回調(diào)函數(shù)，是指當(dāng)ContentProvider創(chuàng)建的時候調(diào)用，本程序在該函數(shù)中使用DatabaseHelper新建了一個SQLite數(shù)據(jù)庫。
在getType()方法完成的功能是根據(jù)傳入的Uri，返回該Uri所表示的數(shù)據(jù)類型。函數(shù)內(nèi)部是使用的UriMatcher來匹配該函數(shù)所傳進(jìn)來的參數(shù)，來得到其數(shù)據(jù)類型。
insert()函數(shù)給指定的數(shù)據(jù)庫表中一個指定的值，完成后必然會生成一個新的記錄，然后利用該記錄和表的Uri重新生成一個新的Uri，這個Uri就代表了成功的那條記錄的Uri，該函數(shù)返回的也是這個Uri。
MainActivity類：
在MainActivity中，主要是有2個按鈕，分為為它們綁定了器，來完成和查詢操作。
當(dāng)單擊按鈕時，在器函數(shù)中會首先得到一個ContentResolver，然后當(dāng)在執(zhí)行ContentResolver的insert方法時會自動調(diào)用ContentProvider的insert方法，因為ContentResolver的insert方法中的第一個參數(shù)就為某個ContentProvider的Uri。
AndroidManifest.xml:
ContentProvider的使用需要在AndroidManifest.xml中進(jìn)行注冊，在activity標(biāo)簽外加入如下聲明即可：
<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個參數(shù)，第一個為代表了ContentProvider的Uri，第二個參數(shù)為要的值。此處的insert函數(shù)
//一執(zhí)行，則自動調(diào)用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;//默認(rèn)的數(shù)據(jù)庫版本
//繼承SQLiteOpenHelper類的類必須有自己的構(gòu)造函數(shù)
//該構(gòu)造函數(shù)4個參數(shù)，直接調(diào)用父類的構(gòu)造函數(shù)。其中第一個參數(shù)為該類本身；第二個參數(shù)為數(shù)據(jù)庫的名字；
//第3個參數(shù)是用來設(shè)置游標(biāo)對象的，這里一般設(shè)置為null；參數(shù)四是數(shù)據(jù)庫的版本號。
public DatabaseHelper(Context context, String name, CursorFactory factory, int verson){
super(context, name, factory, verson);
}
//該構(gòu)造函數(shù)有3個參數(shù)，因為它把上面函數(shù)的第3個參數(shù)固定為null了
public DatabaseHelper(Context context, String name, int verson){
this(context, name, null, verson);
}
//該構(gòu)造函數(shù)只有2個參數(shù)，在上面函數(shù) 的基礎(chǔ)山將版本號固定了
public DatabaseHelper(Context context, String name){
this(context, name, VERSON);
}
//該函數(shù)在數(shù)據(jù)庫第一次被建立時調(diào)用
@Override
public void onCreate(SQLiteDatabase arg0) {
// TODO Auto-generated method stub
System.out.println("create a database");
//execSQL()為執(zhí)行參數(shù)里面的SQL語句，因此參數(shù)中的語句需要符合SQL語法,這里是創(chuàng)建一個表
//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";
//數(shù)據(jù)庫的名稱
public static final String DATABASE_NAME = "FisrtProvider.db";
//數(shù)據(jù)庫的版本號
public static final int DATABASE_VERSION = 1;
//數(shù)據(jù)庫中的表名
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是將文本轉(zhuǎn)換成Uri
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORTY + "/users");
//返回ContentProvider中表的數(shù)據(jù)類型
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.firstprovider.user";
//返回ContentProvider表中item的數(shù)據(jù)類型
public static final String CONTENT_TYPE_ITEM = "vnd.android.cursor.item/vnd.firstprovider.user";
//子表列名
public static final String USER_NAME = "name";
//表中記錄的默認(rèn)排序算法，這里是降序排列
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,后面執(zhí)行操作時有用
static
{
userProjectionMap = new HashMap<String, String>();
//這里可以直接調(diào)用另外一個類的public變量，這里put里面的2個參數(shù)一樣，
//是因為這里是給數(shù)據(jù)庫表中的列取別名，因此取的是一樣的名字
userProjectionMap.put(UserTableMetaData._ID, UserTableMetaData._ID);
userProjectionMap.put(UserTableMetaData.USER_NAME, UserTableMetaData.USER_NAME);
}
//得到ContentProvider的數(shù)據(jù)類型，返回的參數(shù)Uri所代表的數(shù)據(jù)類型
@Override
public String getType(Uri arg0) {
// TODO Auto-generated method stub
System.out.println("getType");
switch(uriMatcher.match(arg0)){
//matcher滿足Uri的前2項（即協(xié)議+路徑）為第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){
//發(fā)出通知給器，說明數(shù)據(jù)已經(jīng)改變
//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);
}
//回調(diào)函數(shù)，在ContentProvider創(chuàng)建的時候調(diào)用
@Override
public boolean onCreate() {
// TODO Auto-generated method stub
System.out.println("onCreate");
dh = new DatabaseHelper(getContext(), FirstProviderMetaData.DATABASE_NAME);//創(chuàng)建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);//設(shè)置表的名稱
qb.setProjectionMap(userProjectionMap);//其中userProjectionMap為上面建立好了的hashmap
break;
case INCOMING_USER_SIGNAL:
qb.setTables(UserTableMetaData.TABLE_NAME);//設(shè)置表的名稱
qb.setProjectionMap(userProjectionMap);//其中userProjectionMap為上面建立好了的hashmap
//uri.getPathSegments()得到Path部分，即把uri的協(xié)議+authory部分去掉，把剩下的部分分段獲取，這里取第
//一部分
qb.appendWhere(UserTableMetaData._ID + "=" +uri.getPathSegments().get(1));//設(shè)置where條件
break;
}
//排序
String orderBy;
if(TextUtils.isEmpty(sortOrder)){
orderBy = UserTableMetaData.DEFAULT_SORT_ORDER;//傳入的排序參數(shù)為空的時候采用默認(rèn)的排序
}
else{
orderBy = sortOrder;//不為空時用指定的排序方法進(jìn)行排序
}
SQLiteDatabase db = dh.getWritableDatabase();
//采用傳入的參數(shù)進(jìn)行查詢
Cursor c = qb.query(db, projection, selection, selectionArgs, null, null, sortOrder);
//發(fā)出通知
c.setNotificationUri(getContext().getContentResolver(), uri);
return c;
}
}
相關(guān)文章
基于Android實現(xiàn)跳轉(zhuǎn)到WiFi開關(guān)設(shè)置頁的詳細(xì)步驟
在Android應(yīng)用開發(fā)中,有時候需要引導(dǎo)用戶到特定的系統(tǒng)設(shè)置頁面,例如Wi-Fi開關(guān)設(shè)置頁,可以通過隱式Intent來實現(xiàn)這一功能,以下是詳細(xì)的步驟以及相關(guān)的Kotlin代碼示例,需要的朋友可以參考下2024-09-09
本篇文章是對為Android添加一門新語言的解決方法進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下2013-06-06
這篇文章主要介紹了詳解Android登陸界面用戶協(xié)議解決方案，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-08-08
Android實現(xiàn)游戲中的漸隱和漸現(xiàn)動畫效果
本文給大家分享android中實現(xiàn)游戲中的漸隱漸現(xiàn)的動畫效果，在游戲開發(fā)中經(jīng)常會遇到，對android漸隱漸現(xiàn)效果感興趣的朋友可以參考下本教程2016-09-09
本文給大家介紹android實現(xiàn)返回鍵功能，返回鍵的操作方法，非常不錯，具有參考借鑒價值，感興趣的朋友一起學(xué)習(xí)吧2016-06-06
Android中通過反射實現(xiàn)圓角ImageView代碼實例
這篇文章主要介紹了Android中通過反射實現(xiàn)圓角ImageView代碼實例,本文直接給出核心實現(xiàn)代碼,需要的朋友可以參考下2015-04-04
Android筆記之:App應(yīng)用之發(fā)布各廣告平臺版本的詳解
Android的廣告平臺是很多的，各市場對各平臺的接受程度是不一樣的，Android的開發(fā)者如果想集成廣告基本要考慮下面兩個問題2013-04-04
Android中ListView是使用平率最高的控件之一（GridView跟ListView是兄弟，都是繼承AbsListView），ListView優(yōu)化最有效的無非就是采用ViewHolder來減少頻繁的對view查詢和更新，緩存圖片加快解碼，減小圖片尺寸2016-01-01
Android App中使用Gallery制作幻燈片播放效果
這篇文章主要介紹了Android App中使用Gallery制作幻燈片播放效果,相冊應(yīng)用中的輪播功能也與本文中例子的原理類似,需要的朋友可以參考下2016-04-04
這篇文章主要為大家介紹了快速了解Android Room使用細(xì)則，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-03-03