Android 建立及呼叫自己的 ContentProvider
如何建立及呼叫自己的ContentProvider。
Android 開發工程師對於ContentProvider的操作方法有一定程度的瞭解。在有些場合,除了操作ContentProvider之外,我們還有可能需要建立自己的ContentProvider,來提供資訊共享的服務,這就要求我們很好的掌握ContentProvider的建立及使用技巧。下面我們就由表及裡的逐步講解每個步驟。
我們先來了解以下兩個知識點:
授權:
在Android中,每一個ContentProvider都會用類似於域名的字串來註冊自己,我們稱之為授權(authority)。這個唯一標識的字串是此ContentProvider可提供的一組URI的基礎,有了這個基礎,才能夠向外界提供資訊的共享服務。
授權是在AndroidManifest.xml中完成的,每一個ContentProvider必須在此宣告並授權,方式如下:
<provider
android:name=".PersonProvider"
android:authorities="com.owenchan.provider.PersonProvider"></provider>
上面的元素指明瞭ContentProvider的提供者是“ PersonProvider”這個類,併為其授權,授權的基礎URI為“com.owenchan.provider.PersonProvider”。有了這個授權資訊,系統可以準確的定位到具體的ContentProvider,從而使訪問者能夠獲取到指定的資訊。這和瀏覽Web頁面的方式很相似,“ PersonProvider”就像一臺具體的伺服器,而“com.owenchan.provider.PersonProvider”就像註冊的域名,相信大家對這個概念並不陌生,由此聯想一下就可以瞭解ContentProvider授權的作用了。
MIME型別:
就像網站返回給定URL的MIME(Multipurpose Internet Mail Extensions,多用途Internet郵件擴充套件)型別一樣(這使瀏覽器能夠用正確的程式來檢視內容),ContentProvider還負責返回給定URI的MIME型別。根據MIME型別規範,MIME型別包含兩部分:型別和子型別。例如:text/html,text/css,text/xml等等。
Android也遵循類似的約定來定義MIME型別。
對於單條記錄,MIME型別類似於:
vnd.android.cursor.item/vnd.your-company.content-type
而對於記錄的集合,MIME型別類似於:
vnd.android.cursor.dir/vnd.your-company.comtent-type
其中的vnd表示這些型別和子型別具有非標準的、供應商特定的形式;content-type可以根據ContentProvider的功能來定,比如日記的ContentProvider可以為note,日程安排的ContentProvider可以為schedule,等等。
瞭解了以上兩個知識點之後,我們就結合例項來演示一下具體的過程。
我們將會建立一個記錄person資訊的ContentProvider,實現對person的CRUD操作,訪問者可以通過下面路徑操作我們的ContentProvider:
訪問者可以通過“[BASE_URI]/persons”來操作person集合,也可以通過“[BASE_URI]/persons/#”的形式操作單個person。
我們建立一個person的ContentProvider需要兩個步驟:
建立PersonProvider類:
我們需要繼承ContentProvider類,實現onCreate、query、insert、update、delete和getType這幾個方法。具體程式碼如下:
package com.ownchan.providerdemo;
import android.content.ContentProvider;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.net.Uri;
public class PersonProvider extends ContentProvider {
private static UriMatcher matcher;
private DBHelper helper;
private SQLiteDatabase db;
private static final String AUTHORITY = "com.owenchan.provider.PersonProvider";
private static final int PERSON_ALL = 0;
private static final int PERSON_ONE = 1;
public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.owen.person";
public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.owen.person";
//資料改變後立即重新查詢
private static final Uri NOTIFY_URI = Uri.parse("content://" + AUTHORITY + "/persons");
static {
matcher = new UriMatcher(UriMatcher.NO_MATCH);
matcher.addURI(AUTHORITY, "persons", PERSON_ALL); //匹配記錄集合
matcher.addURI(AUTHORITY, "persons/#", PERSON_ONE); //匹配單條記錄
}
@Override
public boolean onCreate() {
helper = new DBHelper(getContext());
return true;
}
@Override
public String getType(Uri uri) {
int match = matcher.match(uri);
switch (match) {
case PERSON_ALL:
return CONTENT_TYPE;
case PERSON_ONE:
return CONTENT_ITEM_TYPE;
default:
throw new UnsupportedOperationException("Not yet implemented");
}
}
@Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
db = helper.getReadableDatabase();
int match = matcher.match(uri);
switch (match) {
case PERSON_ALL:
//doesn't need any code in my provider.
break;
case PERSON_ONE:
long _id = ContentUris.parseId(uri);
selection = "_id = ?";
selectionArgs = new String[]{String.valueOf(_id)};
break;
default:
throw new IllegalArgumentException("Unknown URI: " + uri);
}
return db.query("person", projection, selection, selectionArgs, null, null, sortOrder);
}
@Override
public Uri insert(Uri uri, ContentValues values) {
int match = matcher.match(uri);
if (match != PERSON_ALL) {
throw new IllegalArgumentException("Wrong URI: " + uri);
}
db = helper.getWritableDatabase();
if (values == null) {
values = new ContentValues();
values.put("name", "no name");
values.put("age", "1");
values.put("info", "no info.");
}
long rowId = db.insert("person", null, values);
if (rowId > 0) {
notifyDataChanged();
return ContentUris.withAppendedId(uri, rowId);
}
return null;
}
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
db = helper.getWritableDatabase();
int match = matcher.match(uri);
switch (match) {
case PERSON_ALL:
//doesn't need any code in my provider.
break;
case PERSON_ONE:
long _id = ContentUris.parseId(uri);
selection = "_id = ?";
selectionArgs = new String[]{String.valueOf(_id)};
}
int count = db.delete("person", selection, selectionArgs);
if (count > 0) {
notifyDataChanged();
}
return count;
}
@Override
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
db = helper.getWritableDatabase();
int match = matcher.match(uri);
switch (match) {
case PERSON_ALL:
//doesn't need any code in my provider.
break;
case PERSON_ONE:
long _id = ContentUris.parseId(uri);
selection = "_id = ?";
selectionArgs = new String[]{String.valueOf(_id)};
break;
default:
throw new IllegalArgumentException("Unknown URI: " + uri);
}
int count = db.update("person", values, selection, selectionArgs);
if (count > 0) {
notifyDataChanged();
}
return count;
}
//通知指定URI資料已改變
private void notifyDataChanged() {
getContext().getContentResolver().notifyChange(NOTIFY_URI, null);
}
}
在PersonProvider中,我們定義了授權地址為“com.owenchan.provider.PersonProvider”。基於這個授權,我們使用了一個UriMatcher對其路徑進行匹配,“[BASE_URI]/persons”和“[BASE_URI]/persons/#”這兩種路徑我們在上面也介紹過,分別對應記錄集合和單個記錄的操作。在query、insert、update和delete方法中我們根據UriMatcher匹配結果來判斷該URI是操作記錄集合還是單條記錄,從而採取不同的處理方法。在getType方法中,我們會根據匹配的結果返回不同的MIME型別,這一步是不能缺少的,比如我們在query方法中有可能是查詢全部集合,有可能是查詢單條記錄,那麼我們返回的Cursor或是集合型別,或是單條記錄,這個跟getType返回的MIME型別是一致的,就好像瀏覽網頁一樣,指定的url返回的資訊是什麼型別,那麼瀏覽器就應該接收到對應的MIME型別。另外,我們注意到,上面程式碼中,在insert、update、delete方法中都呼叫了notifyDataChanged方法,這個方法中僅有的一步操作就是通知“[BASE_URI]/persons”的訪問者,資料發生改變了,應該重新載入了。
在我們的PersonProvider中,我們用到了Person、DBHelper類,程式碼如下:
Person.java 類
package com.ownchan.providerdemo;
/**
* Author: Owen Chan
* DATE: 2017-02-15.
*/
public class Person {
public int _id;
public String name;
public int age;
public String info;
public Person() {
}
public Person(String name, int age, String info) {
this.name = name;
this.age = age;
this.info = info;
}
}
SQLiteOpenHelper.java 類
package com.ownchan.providerdemo;
import android.content.Context;
import android.database.sqlite.SQLiteDatabase;
import android.database.sqlite.SQLiteOpenHelper;
/**
* Author: Owen Chan
* DATE: 2017-02-15.
*/
public class DBHelper extends SQLiteOpenHelper {
private static final String DATABASE_NAME = "news.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) {
String sql = "CREATE TABLE IF NOT EXISTS person" +
"(_id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR, age INTEGER, info TEXT)";
db.execSQL(sql);
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
db.execSQL("DROP TABLE IF EXISTS person");
onCreate(db);
}
}
最後,要想讓這個ContentProvider生效,我們需要在AndroidManifest.xml中宣告併為其授權,如下所示:
package com.ownchan.providerdemo;
import android.app.Activity;
import android.content.ContentResolver;
import android.content.ContentUris;
import android.content.ContentValues;
import android.database.Cursor;
import android.database.CursorWrapper;
import android.net.Uri;
import android.os.Handler;
import android.os.Message;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.ListView;
import android.widget.SimpleCursorAdapter;
import java.util.ArrayList;
public class MainActivity extends Activity implements View.OnClickListener {
private ContentResolver resolver;
private ListView listView;
private static final String AUTHORITY = "com.owenchan.provider.PersonProvider";
private static final Uri PERSON_ALL_URI = Uri.parse("content://" + AUTHORITY + "/persons");
private Handler handler = new Handler() {
public void handleMessage(Message msg) {
//update records.
requery();
};
};
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
resolver = getContentResolver();
listView = (ListView) findViewById(R.id.list_view);
getContentResolver().registerContentObserver(PERSON_ALL_URI, true, new PersonObserver(handler));
initView();
}
/**
* 初始化點選的button
*/
private void initView() {
findViewById(R.id.init).setOnClickListener(this);
findViewById(R.id.query).setOnClickListener(this);
findViewById(R.id.insert).setOnClickListener(this);
findViewById(R.id.update).setOnClickListener(this);
findViewById(R.id.delete).setOnClickListener(this);
}
@Override
public void onClick(View view) {
switch (view.getId()) {
case R.id.init:
init();
break;
case R.id.query:
query();
break;
case R.id.insert:
insert();
break;
case R.id.update:
update();
break;
case R.id.delete:
delete();
break;
default:
//do nothing
}
}
/**
* 初始化
*/
public void init() {
ArrayList<Person> persons = new ArrayList<Person>();
Person person1 = new Person("Ella", 22, "lively girl");
Person person2 = new Person("Jenny", 22, "beautiful girl");
Person person3 = new Person("Jessica", 23, "sexy girl");
Person person4 = new Person("Kelly", 23, "hot baby");
Person person5 = new Person("Jane", 25, "pretty woman");
persons.add(person1);
persons.add(person2);
persons.add(person3);
persons.add(person4);
persons.add(person5);
for (Person person : persons) {
ContentValues values = new ContentValues();
values.put("name", person.name);
values.put("age", person.age);
values.put("info", person.info);
resolver.insert(PERSON_ALL_URI, values);
}
}
/**
* 查詢所有記錄
*/
public void query() {
Cursor cursor = resolver.query(PERSON_ALL_URI, null, null, null, null);
CursorWrapper cursorWrapper = new CursorWrapper(cursor) {
@Override
public String getString(int columnIndex) {
//將簡介前加上年齡
if (getColumnName(columnIndex).equals("info")) {
int age = getInt(getColumnIndex("age"));
return age + " years old, " + super.getString(columnIndex);
}
return super.getString(columnIndex);
}
};
//Cursor須含有"_id"欄位
SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2,
cursorWrapper, new String[]{"name", "info"}, new int[]{android.R.id.text1, android.R.id.text2});
listView.setAdapter(adapter);
startManagingCursor(cursor);
}
/**
* 插入一條記錄
*/
public void insert() {
Person person = new Person("Alina", 26, "attractive lady");
ContentValues values = new ContentValues();
values.put("name", person.name);
values.put("age", person.age);
values.put("info", person.info);
resolver.insert(PERSON_ALL_URI, values);
}
/**
* 更新一條記錄
*/
public void update() {
Person person = new Person();
person.name = "Jane";
person.age = 30;
//將指定name的記錄age欄位更新為30
ContentValues values = new ContentValues();
values.put("age", person.age);
resolver.update(PERSON_ALL_URI, values, "name = ?", new String[]{person.name});
//將_id為1的age更新為30
// Uri updateUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);
// resolver.update(updateUri, values, null, null);
}
/**
* 刪除一條記錄
*/
public void delete() {
//刪除_id為1的記錄
Uri delUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);
resolver.delete(delUri, null, null);
//刪除所有記錄
// resolver.delete(PERSON_ALL_URI, null, null);
}
/**
* 重新查詢
*/
private void requery() {
//實際操作中可以查詢集合資訊後Adapter.notifyDataSetChanged();
query();
}
}
我們看到,在上面的程式碼中,分別對應每一種情況進行測試,相對較為簡單。我們主要講一下registerContentObserver這一環節。
在前面的PersonProvider我們也提到,在資料更改後,會向指定的URI訪問者發出通知,以便於更新查詢記錄。大家注意,僅僅是ContentProvider出力還不夠,我們還需要在訪問者中註冊一個ContentObserver,才能夠接收到這個通知。下面我們建立一個PersonObserver:
package com.ownchan.providerdemo;
import android.database.ContentObserver;
import android.os.Handler;
import android.os.Message;
import android.util.Log;
/**
* Author: Owen Chan
* DATE: 2017-02-15.
*/
public class PersonObserver extends ContentObserver {
public static final String TAG = "PersonObserver";
private Handler handler;
public PersonObserver(Handler handler) {
super(handler);
this.handler = handler;
}
@Override
public void onChange(boolean selfChange) {
super.onChange(selfChange);
Log.i(TAG, "data changed , try to require.");
Message msg = Message.obtain();
handler.sendMessage(msg);
}
}
這樣一來,當ContentProvider發來通知之後,我們就能立即接收到,從而向handler傳送一條訊息,重新查詢記錄,使我們能夠看到最新的記錄資訊。
最後,我們要在AndroidManifest.xml中為MainActivity新增MIME型別過濾器,告訴系統MainActivity可以處理的資訊型別:
<intent-filter> <data android:mimeType="vnd.android.cursor.dir/vnd.ownchan.person"/> </intent-filter> <intent-filter> <data android:mimeType="vnd.android.cursor.item/vnd.owenchan.person"/> </intent-filter>
操作介面: