前言
-
屬于ContentProvider
的四大元件之一Android
- 本文全面解析了
,包括ContentProvider
原理、使用方法 & 執行個體講解,希望你們會喜歡。ContentProvider
Carson帶你學Android 文章系列:
Carson帶你學Android:頁面活動-Activity
Carson帶你學Android:廣播-BroadcastReceiver
Carson帶你學Android:服務-Service
Carson帶你學Android:記憶體承載器-ContentProvider
目錄
1. 定義
即内容提供者,是
Android
四大元件之一
2. 作用
程序間 進行資料互動 & 共享,即跨程序通信
3. 原理
-
的底層是采用ContentProvider
中的Android
機制Binder
- 具體請看文章圖文詳解 Android Binder跨程序通信的原理
4. 具體使用
關于
ContentProvider
的使用主要介紹以下内容:
4.1 統一資源辨別符(URI)
- 定義:
,即統一資源辨別符Uniform Resource Identifier
- 作用:唯一辨別
& 其中的資料ContentProvider
外界程序通過找到對應的
URI
& 其中的資料,再進行資料操作
ContentProvider
- 具體使用
分為 系統預置 & 自定義,分别對應系統内置的資料(如通訊錄、日程表等等)和自定義資料庫URI
- 關于 系統預置
此處不作過多講解,需要的同學可自行檢視
URI
- 此處主要講解 自定義
URI
// 設定URI
Uri uri = Uri.parse("content://com.carson.provider/User/1")
// 上述URI指向的資源是:名為 `com.carson.provider`的`ContentProvider` 中表名 為`User` 中的 `id`為1的資料
// 特别注意:URI模式存在比對通配符* & #
// *:比對任意長度的任何有效字元的字元串
// 以下的URI 表示 比對provider的任何内容
content://com.example.app.provider/*
// #:比對任意長度的數字字元的字元串
// 以下的URI 表示 比對provider中的table表的所有行
content://com.example.app.provider/table/#
4.2 MIME資料類型
-
作用:指定某個擴充名的檔案用某種應用程式來打開
如指定
檔案采用.html
應用程式打開、指定text
檔案采用.pdf
應用程式打開flash
- 具體使用:
4.2.1
ContentProvider
根據
URI
傳回
MIME
類型
ContentProvider.geType(uri) ;
4.2.2
MIME
類型組成
每種
MIME
類型 由2部分組成 = 類型 + 子類型
MIME類型是 一個 包含2部分的字元串
text / html
// 類型 = text、子類型 = html
text/css
text/xml
application/pdf
4.2.3
MIME
類型形式
MIME
類型有2種形式:
// 形式1:單條記錄
vnd.android.cursor.item/自定義
// 形式2:多條記錄(集合)
vnd.android.cursor.dir/自定義
// 注:
// 1. vnd:表示父類型和子類型具有非标準的、特定的形式。
// 2. 父類型已固定好(即不能更改),隻能差別是單條還是多條記錄
// 3. 子類型可自定義
執行個體說明
<-- 單條記錄 -->
// 單個記錄的MIME類型
vnd.android.cursor.item/vnd.yourcompanyname.contenttype
// 若一個Uri如下
content://com.example.transportationprovider/trains/122
// 則ContentProvider會通過ContentProvider.geType(url)傳回以下MIME類型
vnd.android.cursor.item/vnd.example.rail
<-- 多條記錄 -->
// 多個記錄的MIME類型
vnd.android.cursor.dir/vnd.yourcompanyname.contenttype
// 若一個Uri如下
content://com.example.transportationprovider/trains
// 則ContentProvider會通過ContentProvider.geType(url)傳回以下MIME類型
vnd.android.cursor.dir/vnd.example.rail
4.3 ContentProvider類
4.3.1 組織資料方式
-
主要以 表格的形式 組織資料ContentProvider
同時也支援檔案資料,隻是表格形式用得比較多
- 每個表格中包含多張表,每張表包含行 & 列,分别對應記錄 & 字段
同資料庫
4.3.2 主要方法
- 程序間共享資料的本質是:添加、删除、擷取 & 修改(更新)資料
- 是以
的核心方法也主要是上述4個作用ContentProvider
<-- 4個核心方法 -->
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 中的資料
// 注:
// 1. 上述4個方法由外部程序回調,并運作在ContentProvider程序的Binder線程池中(不是主線程)
// 2. 存在多線程并發通路,需要實作線程同步
// a. 若ContentProvider的資料存儲方式是使用SQLite & 一個,則不需要,因為SQLite内部實作好了線程同步,若是多個SQLite則需要,因為SQL對象之間無法進行線程同步
// b. 若ContentProvider的資料存儲方式是記憶體,則需要自己實作線程同步
<-- 2個其他方法 -->
public boolean onCreate()
// ContentProvider建立後 或 打開系統後其它程序第一次通路該ContentProvider時 由系統進行調用
// 注:運作在ContentProvider程序的主線程,故不能做耗時操作
public String getType(Uri uri)
// 得到資料類型,即傳回目前 Url 所代表資料的MIME類型
-
為常見的資料(如通訊錄、日程表等)提供了内置了預設的Android
ContentProvider
- 但也可根據需求自定義
,但上述6個方法必須重寫ContentProvider
本文主要講解自定義 ContentProvider
-
類并不會直接與外部程序互動,而是通過ContentProvider
類ContentResolver
4.4 ContentResolver類
4.1 作用
統一管理不同
ContentProvider
間的操作
- 即通過
即可操作 不同的
URI
中的資料
ContentProvider
- 外部程序通過
類 進而與
ContentResolver
類進行互動
ContentProvider
4.2 為什麼要使用通過 ContentResolver
類進而與 ContentProvider
類進行互動,而不直接通路 ContentProvider
類?
ContentResolver
ContentProvider
ContentProvider
答:
- 一般來說,一款應用要使用多個
,若需要了解每個ContentProvider
的不同實作進而再完成資料互動,操作成本高 & 難度大ContentProvider
- 是以再
類上加多了一個ContentProvider
類對所有的ContentResolver
進行統一管理。ContentProvider
4.3 具體使用
ContentResolver
類提供了與
ContentProvider
類相同名字 & 作用的4個方法
// 外部程序向 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)
- 執行個體說明
// 使用ContentResolver前,需要先擷取ContentResolver
// 可通過在所有繼承Context的類中 通過調用getContentResolver()來獲得ContentResolver
ContentResolver resolver = getContentResolver();
// 設定ContentProvider的URI
Uri uri = Uri.parse("content://cn.scu.myprovider/user");
// 根據URI 操作 ContentProvider中的資料
// 此處是擷取ContentProvider中 user表的所有記錄
Cursor cursor = resolver.query(uri, null, null, null, "userid desc");
Android
提供了3個用于輔助
ContentProvide
的工具類:
-
ContentUris
-
UriMatcher
-
ContentObserver
4.5 ContentUris類
- 作用:操作
URI
-
具體使用
核心方法有兩個:
&withAppendedId()
parseId()
// withAppendedId()作用:向URI追加一個id
Uri uri = Uri.parse("content://cn.scu.myprovider/user")
Uri resultUri = ContentUris.withAppendedId(uri, 7);
// 最終生成後的Uri為:content://cn.scu.myprovider/user/7
// parseId()作用:從URL中擷取ID
Uri uri = Uri.parse("content://cn.scu.myprovider/user/7")
long personid = ContentUris.parseId(uri);
//擷取的結果為:7
4.6 UriMatcher類
- 作用
- 在
中注冊ContentProvider
URI
- 根據
比對URI
中對應的資料表ContentProvider
- 在
- 具體使用
// 步驟1:初始化UriMatcher對象
UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);
//常量UriMatcher.NO_MATCH = 不比對任何路徑的傳回碼
// 即初始化時不比對任何東西
// 步驟2:在ContentProvider 中注冊URI(addURI())
int URI_CODE_a = 1;
int URI_CODE_b = 2;
matcher.addURI("cn.scu.myprovider", "user1", URI_CODE_a);
matcher.addURI("cn.scu.myprovider", "user2", URI_CODE_b);
// 若URI資源路徑 = content://cn.scu.myprovider/user1 ,則傳回注冊碼URI_CODE_a
// 若URI資源路徑 = content://cn.scu.myprovider/user2 ,則傳回注冊碼URI_CODE_b
// 步驟3:根據URI 比對 URI_CODE,進而比對ContentProvider中相應的資源(match())
@Override
public String getType(Uri uri) {
Uri uri = Uri.parse(" content://cn.scu.myprovider/user1");
switch(matcher.match(uri)){
// 根據URI比對的傳回碼是URI_CODE_a
// 即matcher.match(uri) == URI_CODE_a
case URI_CODE_a:
return tableNameUser1;
// 如果根據URI比對的傳回碼是URI_CODE_a,則傳回ContentProvider中的名為tableNameUser1的表
case URI_CODE_b:
return tableNameUser2;
// 如果根據URI比對的傳回碼是URI_CODE_b,則傳回ContentProvider中的名為tableNameUser2的表
}
}
4.7 ContentObserver類
- 定義:内容觀察者
- 作用:觀察
引起Uri
中的資料變化 & 通知外界(即通路該資料通路者)ContentProvider
當中的資料發生變化(增、删 & 改)時,就會觸發該
ContentProvider
類
ContentObserver
- 具體使用
// 步驟1:注冊内容觀察者ContentObserver
getContentResolver().registerContentObserver(uri);
// 通過ContentResolver類進行注冊,并指定需要觀察的URI
// 步驟2:當該URI的ContentProvider資料發生變化時,通知外界(即通路該ContentProvider資料的通路者)
public class UserContentProvider extends ContentProvider {
public Uri insert(Uri uri, ContentValues values) {
db.insert("user", "userid", values);
getContext().getContentResolver().notifyChange(uri, null);
// 通知通路者
}
}
// 步驟3:解除觀察者
getContentResolver().unregisterContentObserver(uri);
// 同樣需要通過ContentResolver類進行解除
至此,關于
ContentProvider
的使用已經講解完畢
5. 執行個體說明
- 由于
不僅常用于程序間通信,同時也适用于程序内通信ContentProvider
- 是以本執行個體會采用
講解:ContentProvider
- 程序内通信
- 程序間通信
- 執行個體說明:采用的資料源是
中的Android
資料庫SQLite
5.1 程序内通信
- 步驟說明:
- 建立資料庫類
- 自定義
類ContentProvider
- 注冊 建立的
類ContentProvider
- 程序内通路
的資料ContentProvider
- 具體使用
步驟1:建立資料庫類
關于資料庫操作請看文章:Android:SQLlite資料庫操作最詳細解析
DBHelper.java
public class DBHelper extends SQLiteOpenHelper {
// 資料庫名
private static final String DATABASE_NAME = "finch.db";
// 表名
public static final String USER_TABLE_NAME = "user";
public static final String JOB_TABLE_NAME = "job";
private static final int DATABASE_VERSION = 1;
//資料庫版本号
public DBHelper(Context context) {
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}
@Override
public void onCreate(SQLiteDatabase db) {
// 建立兩個表格:使用者表 和職業表
db.execSQL("CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " name TEXT)");
db.execSQL("CREATE TABLE IF NOT EXISTS " + JOB_TABLE_NAME + "(_id INTEGER PRIMARY KEY AUTOINCREMENT," + " job TEXT)");
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
}
}
步驟2:自定義 ContentProvider 類
public class MyProvider extends ContentProvider {
private Context mContext;
DBHelper mDbHelper = null;
SQLiteDatabase db = null;
public static final String AUTOHORITY = "cn.scu.myprovider";
// 設定ContentProvider的唯一辨別
public static final int User_Code = 1;
public static final int Job_Code = 2;
// UriMatcher類使用:在ContentProvider 中注冊URI
private static final UriMatcher mMatcher;
static{
mMatcher = new UriMatcher(UriMatcher.NO_MATCH);
// 初始化
mMatcher.addURI(AUTOHORITY,"user", User_Code);
mMatcher.addURI(AUTOHORITY, "job", Job_Code);
// 若URI資源路徑 = content://cn.scu.myprovider/user ,則傳回注冊碼User_Code
// 若URI資源路徑 = content://cn.scu.myprovider/job ,則傳回注冊碼Job_Code
}
// 以下是ContentProvider的6個方法
/**
* 初始化ContentProvider
*/
@Override
public boolean onCreate() {
mContext = getContext();
// 在ContentProvider建立時對資料庫進行初始化
// 運作在主線程,故不能做耗時操作,此處僅作展示
mDbHelper = new DBHelper(getContext());
db = mDbHelper.getWritableDatabase();
// 初始化兩個表的資料(先清空兩個表,再各加入一個記錄)
db.execSQL("delete from user");
db.execSQL("insert into user values(1,'Carson');");
db.execSQL("insert into user values(2,'Kobe');");
db.execSQL("delete from job");
db.execSQL("insert into job values(1,'Android');");
db.execSQL("insert into job values(2,'iOS');");
return true;
}
/**
* 添加資料
*/
@Override
public Uri insert(Uri uri, ContentValues values) {
// 根據URI比對 URI_CODE,進而比對ContentProvider中相應的表名
// 該方法在最下面
String table = getTableName(uri);
// 向該表添加資料
db.insert(table, null, values);
// 當該URI的ContentProvider資料發生變化時,通知外界(即通路該ContentProvider資料的通路者)
mContext.getContentResolver().notifyChange(uri, null);
// // 通過ContentUris類從URL中擷取ID
// long personid = ContentUris.parseId(uri);
// System.out.println(personid);
return uri;
}
/**
* 查詢資料
*/
@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
// 根據URI比對 URI_CODE,進而比對ContentProvider中相應的表名
// 該方法在最下面
String table = getTableName(uri);
// // 通過ContentUris類從URL中擷取ID
// long personid = ContentUris.parseId(uri);
// System.out.println(personid);
// 查詢資料
return db.query(table,projection,selection,selectionArgs,null,null,sortOrder,null);
}
/**
* 更新資料
*/
@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
// 由于不展示,此處不作展開
return 0;
}
/**
* 删除資料
*/
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
// 由于不展示,此處不作展開
return 0;
}
@Override
public String getType(Uri uri) {
// 由于不展示,此處不作展開
return null;
}
/**
* 根據URI比對 URI_CODE,進而比對ContentProvider中相應的表名
*/
private String getTableName(Uri uri){
String tableName = null;
switch (mMatcher.match(uri)) {
case User_Code:
tableName = DBHelper.USER_TABLE_NAME;
break;
case Job_Code:
tableName = DBHelper.JOB_TABLE_NAME;
break;
}
return tableName;
}
}
步驟3:注冊 建立的 ContentProvider類
AndroidManifest.xml
<provider android:name="MyProvider"
android:authorities="cn.scu.myprovider"
/>
步驟4:程序内通路 ContentProvider中的資料
MainActivity.java
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
/**
* 對user表進行操作
*/
// 設定URI
Uri uri_user = Uri.parse("content://cn.scu.myprovider/user");
// 插入表中資料
ContentValues values = new ContentValues();
values.put("_id", 3);
values.put("name", "Iverson");
// 擷取ContentResolver
ContentResolver resolver = getContentResolver();
// 通過ContentResolver 根據URI 向ContentProvider中插入資料
resolver.insert(uri_user,values);
// 通過ContentResolver 向ContentProvider中查詢資料
Cursor cursor = resolver.query(uri_user, new String[]{"_id","name"}, null, null, null);
while (cursor.moveToNext()){
System.out.println("query book:" + cursor.getInt(0) +" "+ cursor.getString(1));
// 将表中資料全部輸出
}
cursor.close();
// 關閉遊标
/**
* 對job表進行操作
*/
// 和上述類似,隻是URI需要更改,進而比對不同的URI CODE,進而找到不同的資料資源
Uri uri_job = Uri.parse("content://cn.scu.myprovider/job");
// 插入表中資料
ContentValues values2 = new ContentValues();
values2.put("_id", 3);
values2.put("job", "NBA Player");
// 擷取ContentResolver
ContentResolver resolver2 = getContentResolver();
// 通過ContentResolver 根據URI 向ContentProvider中插入資料
resolver2.insert(uri_job,values2);
// 通過ContentResolver 向ContentProvider中查詢資料
Cursor cursor2 = resolver2.query(uri_job, new String[]{"_id","job"}, null, null, null);
while (cursor2.moveToNext()){
System.out.println("query job:" + cursor2.getInt(0) +" "+ cursor2.getString(1));
// 将表中資料全部輸出
}
cursor2.close();
// 關閉遊标
}
}
結果
源碼位址
Carson-Ho Github位址:ContentProvider
至此,程序内對
ContentProvider
中的資料進行共享講解完畢。
5.2 程序間進行資料共享
- 執行個體說明:本文需要建立2個程序,即建立兩個工程,作用如下
- 具體使用
程序1
使用步驟如下:
- 建立資料庫類
- 自定義
類ContentProvider
- 注冊 建立的
類ContentProvider
前2個步驟同上例相同,此處不作過多描述,此處主要講解步驟3.
步驟3:注冊 建立的 ContentProvider類
AndroidManifest.xml
<provider
android:name="MyProvider"
android:authorities="scut.carson_ho.myprovider"
// 聲明外界程序可通路該Provider的權限(讀 & 寫)
android:permission="scut.carson_ho.PROVIDER"
// 權限可細分為讀 & 寫的權限
// 外界需要聲明同樣的讀 & 寫的權限才可進行相應操作,否則會報錯
// android:readPermisson = "scut.carson_ho.Read"
// android:writePermisson = "scut.carson_ho.Write"
// 設定此provider是否可以被其他程序使用
android:exported="true"
/>
// 聲明本應用 可允許通信的權限
<permission android:name="scut.carson_ho.Read" android:protectionLevel="normal"/>
// 細分讀 & 寫權限如下,但本Demo直接采用全權限
// <permission android:name="scut.carson_ho.Write" android:protectionLevel="normal"/>
// <permission android:name="scut.carson_ho.PROVIDER" android:protectionLevel="normal"/>
至此,程序1建立完畢,即建立
ContentProvider
& 資料 準備好了。
源碼位址
Carson-Ho Github位址:ContentProvider1
程序2
步驟1:聲明可通路的權限
AndroidManifest.xml
// 聲明本應用可允許通信的權限(全權限)
<uses-permission android:name="scut.carson_ho.PROVIDER"/>
// 細分讀 & 寫權限如下,但本Demo直接采用全權限
// <uses-permission android:name="scut.carson_ho.Read"/>
// <uses-permission android:name="scut.carson_ho.Write"/>
// 注:聲明的權限必須與程序1中設定的權限對應
步驟2:通路 ContentProvider的類
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
/**
* 對user表進行操作
*/
// 設定URI
Uri uri_user = Uri.parse("content://scut.carson_ho.myprovider/user");
// 插入表中資料
ContentValues values = new ContentValues();
values.put("_id", 4);
values.put("name", "Jordan");
// 擷取ContentResolver
ContentResolver resolver = getContentResolver();
// 通過ContentResolver 根據URI 向ContentProvider中插入資料
resolver.insert(uri_user,values);
// 通過ContentResolver 向ContentProvider中查詢資料
Cursor cursor = resolver.query(uri_user, new String[]{"_id","name"}, null, null, null);
while (cursor.moveToNext()){
System.out.println("query book:" + cursor.getInt(0) +" "+ cursor.getString(1));
// 将表中資料全部輸出
}
cursor.close();
// 關閉遊标
/**
* 對job表進行操作
*/
// 和上述類似,隻是URI需要更改,進而比對不同的URI CODE,進而找到不同的資料資源
Uri uri_job = Uri.parse("content://scut.carson_ho.myprovider/job");
// 插入表中資料
ContentValues values2 = new ContentValues();
values2.put("_id", 4);
values2.put("job", "NBA Player");
// 擷取ContentResolver
ContentResolver resolver2 = getContentResolver();
// 通過ContentResolver 根據URI 向ContentProvider中插入資料
resolver2.insert(uri_job,values2);
// 通過ContentResolver 向ContentProvider中查詢資料
Cursor cursor2 = resolver2.query(uri_job, new String[]{"_id","job"}, null, null, null);
while (cursor2.moveToNext()){
System.out.println("query job:" + cursor2.getInt(0) +" "+ cursor2.getString(1));
// 将表中資料全部輸出
}
cursor2.close();
// 關閉遊标
}
}
至此,通路
ContentProvider
資料的程序2建立完畢
源碼位址
Carson-Ho Github位址:ContentProvider2
結果展示
在程序展示時,需要先運作準備資料的程序1,再運作需要通路資料的程序2
-
運作準備資料的程序1
在程序1中,我們準備好了一系列資料
-
運作需要通路資料的程序2
在程序2中,我們先向
中插入資料,再查詢資料ContentProvider
至此,關于
ContentProvider
在程序内 & 程序間的使用講解完畢。
6. 優點
6.1 安全
ContentProvider
為應用間的資料互動提供了一個安全的環境:允許把自己的應用資料根據需求開放給 其他應用 進行 增、删、改、查,而不用擔心因為直接開放資料庫權限而帶來的安全問題
6.2 通路簡單 & 高效
對比于其他對外共享資料的方式,資料通路方式會因資料存儲的方式而不同:
- 采用 檔案方式 對外共享資料,需要進行檔案操作讀寫資料;
- 采用
共享資料,需要使用sharedpreferences API讀寫資料Sharedpreferences
這使得通路資料變得複雜 & 難度大。
- 而采用
方式,其 解耦了 底層資料的存儲方式,使得無論底層資料存儲采用何種方式,外界對資料的通路方式都是統一的,這使得通路簡單 & 高效ContentProvider
如一開始資料存儲方式 采用資料庫,後來把資料庫換成
SQLite
,也不會對上層資料
MongoDB
使用代碼産生影響
ContentProvider
7. 總結
- 我用一張圖總結本文内容
-
的底層是采用ContentProvider
中的Android
機制,若想了解請看文章圖文詳解 Android Binder跨程序通信的原理Binder
Carson帶你學Android 文章系列:
Carson帶你學Android:頁面活動-Activity
Carson帶你學Android:廣播-BroadcastReceiver
Carson帶你學Android:服務-Service
Carson帶你學Android:記憶體承載器-ContentProvider
歡迎關注Carson_Ho的CSDN部落格 與 公衆号!
部落格連結:https://carsonho.blog.csdn.net/