Android入門(9)| 四大元件之內容提供器
內容提供器（Content Provider)主要用於在不同的應用程式之間實現資料資料共享的功能，同時這也是Android實現跨程式共享資料的標準方式。儘管之前學習的SharedPreference的資料儲存也能夠實現讀寫操作，但是內容提供器可以選擇對哪一部分的資料進行共享，因此內容提供器有著更好的保護隱私的作用。
使用系統內容提供器
如果一個應用程式通過內容提供器對其資料提供了外部訪問借介面，那麼其他的程式就能夠通過該介面來對這些資料進行訪問。Android系統中自帶的電話簿、相簿、簡訊等應用都設定內容提供器，所以我們的程式都可以來利用這些資料。
1.內容URI的組成
由於是其他的程式在訪問內容提供器中的資料，所以需要用有一定格式規範的內容URI來代替，我們先來了解一下什麼是URI吧。
內容URI給內容提供器中的資料建立了唯一的表示符，它主要是由兩部分組成： authority和path 。authority是用於對不同的應用程式做區分的，而path則是用於對不同的表做區分的。舉例來說假設某個程式中有兩張表table 1和table 2，該程式的包為com.example.app，那該程式的兩個內容URI的標準寫法就是：
content://com.example.app.provider/table 1 content://cmom.example.app.provider/table 2
在得到了內容URI之後，我們還需要將其解析為Uri物件才可以作為引數來進行傳入，具體的解析方法是：
Uri uri1 = Uri.parse("content://com.example.app.provider/table 1");
Uri uri2 = Uri.parse("content://com.example.app.provider/table 2");
我們只用呼叫Uri中的parse()方法即可將其解析為Uri物件，之後我們就可以對該物件進行操作了。
2.ContentResolve類
如果想要訪問內容提供器中的內容，我們就需要使用ContentResolve類，使用該類的getContentResolve()方法就會返回一個該類的例項。有了該類的例項我們就可以對其進行CRUD操作，具體的方法仍然是查詢query()、新增insert()、更新update()和刪除delete()。但是這裡的CRUD操作所使用的引數和之前的SQLite有所不同，我們這裡不再用單純的表名指明被操作的表，而是使用內容URI來進行來當引數進行操作了。具體操作的方法和SQLite中的很相似，就用一張圖來概括：
方法操作
3.實踐：讀取系統聯絡人
知道了使用方法，下面就來具體的實踐一下吧。我們這裡是用我們的程式來呼叫系統的電話簿中的聯絡人並將他們的姓名和電話號碼顯示在我們的程式當中。先建立一個空專案，然後為佈局加上一個ListView，然後修改主程式碼：
package com.example.yzbkaka.contasttest;
import android.Manifest;
import android.content.pm.PackageManager;
import android.database.Cursor;
import android.provider.ContactsContract;
import android.support.v4.app.ActivityCompat;
import android.support.v4.content.ContextCompat;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.widget.ArrayAdapter;
import android.widget.ListView;
import android.widget.Toast;
import java.util.ArrayList;
import java.util.List;
public class MainActivity extends AppCompatActivity {
List<String> contactList = new ArrayList<String>();
ArrayAdapter<String> adapter;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ListView contaseView = (ListView)findViewById(R.id.list_view);
adapter = new ArrayAdapter<String>(this,android.R.layout.simple_list_item_1,contactList);
contaseView.setAdapter(adapter);
if(ContextCompat.checkSelfPermission(this, Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED){
ActivityCompat.requestPermissions(this,new String[] {Manifest.permission.READ_CONTACTS},1);
}
else{
readContast();
}
}
private void readContast(){
Cursor cursor = null;
try{
cursor = getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI,null,null,null,null);
if(cursor != null){
while(cursor.moveToNext()){
String displayName = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
String number = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
contactList.add(displayName+"\n"+number);
}
adapter.notifyDataSetChanged();
}
}catch(Exception e){
e.printStackTrace();
}finally {
if(cursor != null){
cursor.close();
}
}
}
@Override
public void onRequestPermissionsResult(int requestCode,String[] permission,int[] grantResults){
switch(requestCode){
case 1:
if(grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED){
readContast();
}
else{
Toast.makeText(this, "you denied the permission", Toast.LENGTH_SHORT).show();
}
}
}
}
這個程式碼看起來很長，但是其中的onRequestPermissionsResult()方法和中間申請許可權的程式碼都在技能總結篇(2)中見到過。這裡主要是看一下readContast()中的操作，我們先是使用getContentResolver()方法返回一個Cursor物件，接著是使用query()方法來進行查詢，這個方法中我們傳入的ContactsContract.Common DataKinds.Phone.CONTENT_URI類是已經幫我們封裝好的Uri物件。接著我們就對cursor物件進行便利，將其中的聯絡人的姓名和號碼讀取出來，在使用getColumnIndex()方法時我們傳入的引數仍然是系統為我們封裝好的常量，我們直接使用即可。最後就是將這些資訊傳入到List中展示出來。
最後要記住危險許可權的宣告一定要在AndroidManifest.xml中進行註冊：
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.yzbkaka.contasttest"> <uses-permission android:name="android.permission.READ_CONTACTS"/> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:roundIcon="@mipmap/ic_launcher_round" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name=".MainActivity"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> </manifest>
建立自己的內容提供器
建立自己的內容提供器可以讓我們的程式中的資料共享給其他的程式，我們這裡使用的資料庫是上一節中使用的Book.dp，我們的建立將會以它為基礎來進行。開啟那個專案，然後新建一個DatabaseProvider類，並讓它繼承自ContentProvider類，接著我們在類的開始新建幾個變數：
public static final int BOOK_DIR = 0;
public static final int BOOK_ITEM = 1;
public static final int CATEGORY_DIR = 2;
public static final int CATEGORY_ITEM = 3;
public static final String AUTHORITY = "com.example.databasetest.provider";
public static UriMatcher uriMatcher;
MyDatabaseHelper dbHelper;
static{
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI(AUTHORITY,"book",BOOK_DIR);
uriMatcher.addURI(AUTHORITY,"book/#",BOOK_ITEM);
uriMatcher.addURI(AUTHORITY,"category",CATEGORY_DIR);
uriMatcher.addURI(AUTHORITY,"category/#",CATEGORY_ITEM);
}
我們首先定義了4個常量，BOOK_DIR表示訪問Book表中的所有資料，BOOK_ITEM表示訪問Book表中的單條資料，CATEGORY_DIR表示訪問Category中的全部資料，CATEGORY_ITEM表示訪問Category中的單條資料。接著我們在靜態程式碼塊中定義了一個UriMatcher例項，利用它的addURI()方法我們可以將期望匹配的幾種URI格式添加了進去，這個方法需要傳入三個引數，可以分別把authority、path和一個自定義的程式碼傳進去。這樣當呼叫UriMatcher的match()方法時就可以將一個Uri物件傳入，而返回值就是一個之前自定義的程式碼，利用這個程式碼我們就可以判斷出呼叫方需要的是那一項資料了。
接著我們來分別實現繼承過來的方法，首先是onCreate()方法：
@Override
public boolean onCreate() {
dbHelper = new MyDatabaseHelper(getContext(),"BookStore.db",null,2);
return true;
}
在這一步中我們是定義了dbHelper，並且讓它建立了一個BookStore.db的資料庫，然後是返回true表示內容提供器初始化成功。接著來寫query()方法：
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
SQLiteDatabase db = dbHelper.getWritableDatabase();
Cursor cursor = null;
switch(uriMatcher.match(uri)){
case BOOK_DIR:
cursor = db.query("Book",projection,selection,selectionArgs,null,null,sortOrder);
break;
case BOOK_ITEM:
cursor = db.query("Book",projection,selection,selectionArgs,null,null,sortOrder);
break;
case CATEGORY_DIR:
cursor = db.query("Category",projection,selection,selectionArgs,null,null,sortOrder);
break;
case CATEGORY_ITEM:
cursor = db.query("Category",projection,selection,selectionArgs,null,null,sortOrder);
break;
default:
break;
}
return cursor;
}
在這個方法中需要我們傳入5個引數，第一個是Uri物件，第二個是查詢的列，第三個和第四個是用於約束查詢哪些行，第五個是對結果的排序方式。我們在這個方法裡面首先是得到了一個SQLiteDatabase物件，並定義了一個Cursor，之後我們再進行匹配，當匹配成功時，我們就使用SQLiteDatabase中的query()方法來進行查詢，該方法會返回一個Cursor物件。在最後我們會返回一個Cursor物件。
接著來看insert()方法：
@Override
public Uri insert(Uri uri, ContentValues contentValues) {
SQLiteDatabase db = dbHelper.getWritableDatabase();
Uri uriReturn = null;
switch (uriMatcher.match(uri)){
case BOOK_DIR:
case BOOK_ITEM:
long newBookId = db.insert("Book",null,contentValues);
uriReturn = Uri.parse("content://"+AUTHORITY+"/book/"+newBookId);
break;
case CATEGORY_DIR:
case CATEGORY_ITEM:
long newCategoryId = db.insert("Category",null,contentValues);
uriReturn = Uri.parse("context://"+AUTHORITY+"/category/"+newCategoryId);
break;
default:
break;
}
return uriReturn;
}
在這個方法中也是先獲取SQLiteDatabase物件，然後再來根據uri進行匹配。但是要注意的是這個方法要求返回一個Uri的物件，因此我們需要使用parse()方法來進行轉換，不過這個內容的URI是以新增資料的id結尾的。
接下來就是udata()方法：
@Override
public int update(Uri uri, ContentValues contentValues, String selection, String[] selectionArgs) {
SQLiteDatabase db = dbHelper.getWritableDatabase();
int updateDows = 0;
switch (uriMatcher.match(uri)){
case BOOK_DIR:
updateDows = db.update("Book",contentValues,selection,selectionArgs);
break;
case BOOK_ITEM:
String newBookId = uri.getPathSegments().get(1);
updateDows = db.update("Book",contentValues,"id=?",new String[] {newBookId});
break;
case CATEGORY_DIR:
updateDows = db.update("Book",contentValues,selection,selectionArgs);
break;
case CATEGORY_ITEM:
String newCategoryId = uri.getPathSegments().get(1);
updateDows = db.update("Book",contentValues,"id=?",new String[]{newCategoryId});
break;
default:
break;
}
return updateDows;
}
updata()方法也是和前面幾個相似，先是獲取SQLiteDatabase物件，然後再來根據uri進行匹配。這個方法需要返回一個整數代表的事更新的行數，所以在匹配的時候我們使用了一個getPathSegments()的方法，該方法可以把URI中的的許可權之後的部分以“/”分割，並把分割後的結果放在一個字串列表中，所以這個列表第0個位置存放的就是路徑，第1個位置存放的就是id了。
然後是delete()方法了：
@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;
caseBOOK_ITEM:
String bookId = uri.getPathSegments().get(1);
deleteRows = db.delete("Book","id = ?",new String[] {bookId});
break;
case CATEGORY_DIR:
deleteRows = db.delete("Category",selection,selectionArgs);
break;
case CATEGORY_ITEM:
String categoryId = uri.getPathSegments().get(1);
deleteRows = db.delete("Category","id = ?",new String[]{categoryId});
break;
default:
break;
}
return deleteRows;
}
這個方法也很簡單，就不多說了。
最後就是getType()方法了：
@Override
public String getType(Uri uri) {
switch (uriMatcher.match(uri)){
case BOOK_DIR:
return "vnd.android.cursor.dir/vand.com.example.databasetest.provider.book";
case BOOK_ITEM:
return "vnd.android.cursor.dir/vand.com.example.databasetest.provider.book";
case CATEGORY_DIR:
return "vnd.android.cursor.dir/vand.com.example.databasetest.provider.CATEGORY";
case CATEGORY_ITEM:
return "vnd.android.cursor.dir/vand.com.example.databasetest.provider.CATEGORY";
}
return null;
}
這個方法是用於獲取Uri物件所對應的MIME型別，一個內容Uri所對應的MIME字串主要是由三部分構成：Android對這三個部分做了以下格式規定：必須以vnd開頭；如果內容URI以路徑結尾，則後接android.cursor.dir/，如果內容URI以id結尾，則後接android.cursor.item/；最後接上vnd.< authority>.< path>。所以我們把這四個新增進去。
最後內容提供器一定要在AndroidManifst.xml中進行註冊：
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.yzbkaka.databasetest"> <application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:roundIcon="@mipmap/ic_launcher_round" android:supportsRtl="true" android:theme="@style/AppTheme"> <activity android:name=".MainActivity"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> <provider android:authorities="com.example.databasttest.provider" android:name=".DatabaseProvider" android:exported="true" android:enabled="true"> </provider> </application> </manifest>
我們在<application>標籤中添加了<provider>，其中authorities就是指它的authority，name指定了DatabaseProvider的類名，exported表示是否執行外部程式訪問我們的內容提供器，enable表示是否啟用該內容提供器。
最後我們執行程式，然後退出程式，再寫一個呼叫該程式的測試程式，先在佈局檔案裡面新增4個按鈕分別表示CRUE，然後修改主程式碼：
import android.content.ContentValues;
import android.database.Cursor;
import android.net.Uri;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
public class MainActivity extends AppCompatActivity {
private String newId;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Button addData = (Button) findViewById(R.id.add_data);
addData.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 新增資料
Uri uri = Uri.parse("content://com.example.databasetest.provider/book");
ContentValues values = new ContentValues();
values.put("name", "A Clash of Kings");
values.put("author", "George Martin");
values.put("pages", 1040);
values.put("price", 55.55);
Uri newUri = getContentResolver().insert(uri, values);
newId = newUri.getPathSegments().get(1);
}
});
Button queryData = (Button) findViewById(R.id.query_data);
queryData.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 查詢資料
Uri uri = Uri.parse("content://com.example.databasetest.provider/book");
Cursor cursor = getContentResolver().query(uri, null, null, null, null);
if (cursor != null) {
while (cursor.moveToNext()) {
String name = cursor.getString(cursor. getColumnIndex("name"));
String author = cursor.getString(cursor. getColumnIndex("author"));
int pages = cursor.getInt(cursor.getColumnIndex ("pages"));
double price = cursor.getDouble(cursor. getColumnIndex("price"));
Log.d("MainActivity", "book name is " + name);
Log.d("MainActivity", "book author is " + author);
Log.d("MainActivity", "book pages is " + pages);
Log.d("MainActivity", "book price is " + price);
}
cursor.close();
}
}
});
Button updateData = (Button) findViewById(R.id.update_data);
updateData.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 更新資料
Uri uri = Uri.parse("content://com.example.databasetest.provider/book/" + newId);
ContentValues values = new ContentValues();
values.put("name", "A Storm of Swords");
values.put("pages", 1216);
values.put("price", 24.05);
getContentResolver().update(uri, values, null, null);
}
});
Button deleteData = (Button) findViewById(R.id.delete_data);
deleteData.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
// 刪除資料
Uri uri = Uri.parse("content://com.example.databasetest.provider/book/" + newId);
getContentResolver().delete(uri, null, null);
}
});
}
}
最後執行程式，呼叫資料成功！！！