鍥而捨之,朽木不折;鍥而不捨,金石可鏤。戰(zhàn)國(guó).荀子《勸學(xué)篇》
若不能堅(jiān)持到底,即使是朽木也不能折斷;只要堅(jiān)持不停地用刀刻,就算是金屬玉石也可以雕出花飾。用今天的話來說就是:再容易的事情,沒有鍥而不舍的精神,都不可能做到;再難的事情,只要有堅(jiān)持不懈的努力,都一定能夠做到。希望我們?cè)趫?jiān)持理想的道路上都能夠鍥而不舍地雕刻自己的那塊“金石”。
今天我們來講解一下如何創(chuàng)建及調(diào)用自己的ContentProvider。
在前面兩篇文章中我們分別講了如何讀寫聯(lián)系人和短消息,相信大家對(duì)于ContentProvider的操作方法已經(jīng)有了一定程度的了解。在有些場(chǎng)合,除了操作ContentProvider之外,我們還有可能需要?jiǎng)?chuàng)建自己的ContentProvider,來提供信息共享的服務(wù),這就要求我們很好的掌握ContentProvider的創(chuàng)建及使用技巧。下面我們就由表及里的逐步講解每個(gè)步驟。
在正式開始實(shí)例演示之前,我們先來了解以下兩個(gè)知識(shí)點(diǎn):
授權(quán):
在Android中,每一個(gè)ContentProvider都會(huì)用類似于域名的字符串來注冊(cè)自己,我們成為授權(quán)(authority)。這個(gè)唯一標(biāo)識(shí)的字符串是此ContentProvider可提供的一組URI的基礎(chǔ),有了這個(gè)基礎(chǔ),才能夠向外界提供信息的共享服務(wù)。
授權(quán)是在AndroidManifest.xml中完成的,每一個(gè)ContentProvider必須在此聲明并授權(quán),方式如下:
- <provider android:name=".SomeProvider"
- android:authorities="com.your-company.SomeProvider"/>
上面的<provider>元素指明了ContentProvider的提供者是“SomeProvider”這個(gè)類,并為其授權(quán),授權(quán)的基礎(chǔ)URI為“com.
your-company.SomeProvider”。有了這個(gè)授權(quán)信息,系統(tǒng)可以準(zhǔn)確的定位到具體的ContentProvider,從而使訪問者能夠獲取到指定的信息。這和瀏覽Web頁(yè)面的方式很相似,“SomeProvider”就像一臺(tái)具體的服務(wù)器,而“com.
your-company.SomeProvider”就像注冊(cè)的域名,相信大家對(duì)這個(gè)概念并不陌生,由此聯(lián)想一下就可以了解ContentProvider授權(quán)的作用了。(需要注意的是,除了Android內(nèi)置應(yīng)用程序之外,第三方程序應(yīng)盡量使用以上方式的完全限定的授權(quán)名。)
MIME類型:
就像網(wǎng)站返回給定URL的MIME(Multipurpose Internet Mail Extensions,多用途Internet郵件擴(kuò)展)類型一樣(這使瀏覽器能夠用正確的程序來查看內(nèi)容),ContentProvider還負(fù)責(zé)返回給定URI的MIME類型。根據(jù)MIME類型規(guī)范,MIME類型包含兩部分:類型和子類型。例如:text/html,text/css,text/xml等等。
Android也遵循類似的約定來定義MIME類型。
對(duì)于單條記錄,MIME類型類似于:
vnd.android.cursor.item/vnd.your-company.content-type
而對(duì)于記錄的集合,MIME類型類似于:
vnd.android.cursor.dir/vnd.your-company.comtent-type
其中的vnd表示這些類型和子類型具有非標(biāo)準(zhǔn)的、供應(yīng)商特定的形式;content-type可以根據(jù)ContentProvider的功能來定,比如日記的ContentProvider可以為note,日程安排的ContentProvider可以為schedule,等等。
了解了以上兩個(gè)知識(shí)點(diǎn)之后,我們就結(jié)合實(shí)例來演示一下具體的過程。
我們將會(huì)創(chuàng)建一個(gè)記錄person信息的ContentProvider,實(shí)現(xiàn)對(duì)person的CRUD操作,訪問者可以通過下面路徑操作我們的ContentProvider:
訪問者可以通過“[BASE_URI]/persons”來操作person集合,也可以通過“[BASE_URI]/persons/#”的形式操作單個(gè)person。
我們創(chuàng)建一個(gè)person的ContentProvider需要兩個(gè)步驟:
1.創(chuàng)建PersonProvider類:
我們需要繼承ContentProvider類,實(shí)現(xiàn)onCreate、query、insert、update、delete和getType這幾個(gè)方法。具體代碼如下:
- package com.scott.provider;
-
- 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 final UriMatcher matcher;
- private DBHelper helper;
- private SQLiteDatabase db;
-
- private static final String AUTHORITY = "com.scott.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.scott.person";
- public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.scott.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 IllegalArgumentException("Unknown URI: " + uri);
- }
- }
-
- @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:
-
- 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:
-
- 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:
-
- 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;
- }
-
-
- private void notifyDataChanged() {
- getContext().getContentResolver().notifyChange(NOTIFY_URI, null);
- }
- }
在PersonProvider中,我們定義了授權(quán)地址為“com.scott.provider.PersonProvider”,相信大家在前面也有所了解了?;谶@個(gè)授權(quán),我們使用了一個(gè)UriMatcher對(duì)其路徑進(jìn)行匹配,“[BASE_URI]/persons"和“[BASE_URI]/persons/#”這兩種路徑我們?cè)谏厦嬉步榻B過,分別對(duì)應(yīng)記錄集合和單個(gè)記錄的操作。在query、insert、update和delete方法中我們根據(jù)UriMatcher匹配結(jié)果來判斷該URI是操作記錄集合還是單條記錄,從而采取不同的處理方法。在getType方法中,我們會(huì)根據(jù)匹配的結(jié)果返回不同的MIME類型,這一步是不能缺少的,比如我們?cè)趒uery方法中有可能是查詢?nèi)考?,有可能是查詢單條記錄,那么我們返回的Cursor或是集合類型,或是單條記錄,這個(gè)跟getType返回的MIME類型是一致的,就好像瀏覽網(wǎng)頁(yè)一樣,指定的url返回的信息是什么類型,那么瀏覽器就應(yīng)該接收到對(duì)應(yīng)的MIME類型。另外,我們注意到,上面代碼中,在insert、update、delete方法中都調(diào)用了notifyDataChanged方法,這個(gè)方法中僅有的一步操作就是通知“[BASE_URI]/persons"的訪問者,數(shù)據(jù)發(fā)生改變了,應(yīng)該重新加載了。
在我們的PersonProvider中,我們用到了Person、DBHelper類,代碼如下:
- package com.scott.provider;
-
- 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;
- }
- }
- package com.scott.provider;
-
- import android.content.Context;
- import android.database.sqlite.SQLiteDatabase;
- import android.database.sqlite.SQLiteOpenHelper;
-
- public class DBHelper extends SQLiteOpenHelper {
-
- private static final String DATABASE_NAME = "provider.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);
- }
- }
最后,要想讓這個(gè)ContentProvider生效,我們需要在AndroidManifest.xml中聲明并為其授權(quán),如下所示:
- <provider android:name=".PersonProvider"
- android:authorities="com.scott.provider.PersonProvider"
- android:multiprocess="true"/>
其中,android:multiprocess代表是否允許多進(jìn)程操作。另外我們也可以為其聲明相應(yīng)的權(quán)限,對(duì)應(yīng)的屬性是:android:permission。
完成了ContentProvider后,下面我們來看一下訪問者。這一步我們?cè)贛ainActivity中完成,看下面代碼:
- package com.scott.provider;
-
- import java.util.ArrayList;
-
- 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.Bundle;
- import android.os.Handler;
- import android.os.Message;
- import android.view.View;
- import android.widget.ListView;
- import android.widget.SimpleCursorAdapter;
-
-
- public class MainActivity extends Activity {
-
- private ContentResolver resolver;
- private ListView listView;
-
- private static final String AUTHORITY = "com.scott.provider.PersonProvider";
- private static final Uri PERSON_ALL_URI = Uri.parse("content://" + AUTHORITY + "/persons");
-
- private Handler handler = new Handler() {
- public void handleMessage(Message msg) {
-
- requery();
- };
- };
-
- @Override
- public void onCreate(Bundle savedInstanceState) {
- super.onCreate(savedInstanceState);
- setContentView(R.layout.main);
-
- resolver = getContentResolver();
- listView = (ListView) findViewById(R.id.listView);
-
-
- getContentResolver().registerContentObserver(PERSON_ALL_URI, true, new PersonObserver(handler));
- }
-
-
-
-
-
- public void init(View view) {
- 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(View view) {
-
- Cursor c = resolver.query(PERSON_ALL_URI, null, null, null, null);
-
- CursorWrapper cursorWrapper = new CursorWrapper(c) {
-
- @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);
- }
- };
-
-
- 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(cursorWrapper);
- }
-
-
-
-
-
- public void insert(View view) {
- 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(View view) {
- Person person = new Person();
- person.name = "Jane";
- person.age = 30;
-
- ContentValues values = new ContentValues();
- values.put("age", person.age);
- resolver.update(PERSON_ALL_URI, values, "name = ?", new String[]{person.name});
-
-
-
-
- }
-
-
-
-
-
- public void delete(View view) {
-
- Uri delUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);
- resolver.delete(delUri, null, null);
-
-
-
- }
-
-
-
-
- private void requery() {
-
- query(null);
- }
- }
我們看到,在上面的代碼中,分別對(duì)應(yīng)每一種情況進(jìn)行測(cè)試,相對(duì)較為簡(jiǎn)單。我們主要講一下registerContentObserver這一環(huán)節(jié)。
在前面的PersonProvider我們也提到,在數(shù)據(jù)更改后,會(huì)向指定的URI訪問者發(fā)出通知,以便于更新查詢記錄。大家注意,僅僅是ContentProvider出力還不夠,我們還需要在訪問者中注冊(cè)一個(gè)ContentObserver,才能夠接收到這個(gè)通知。下面我們創(chuàng)建一個(gè)PersonObserver:
- package com.scott.provider;
-
- import android.database.ContentObserver;
- import android.os.Handler;
- import android.os.Message;
- import android.util.Log;
-
- 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 requery.");
-
- Message msg = new Message();
- handler.sendMessage(msg);
- }
- }
這樣一來,當(dāng)ContentProvider發(fā)來通知之后,我們就能立即接收到,從而向handler發(fā)送一條消息,重新查詢記錄,使我們能夠看到最新的記錄信息。
最后,我們要在AndroidManifest.xml中為MainActivity添加MIME類型過濾器,告訴系統(tǒng)MainActivity可以處理的信息類型:
-
- <intent-filter>
- <data android:mimeType="vnd.android.cursor.dir/vnd.scott.person"/>
- </intent-filter>
- <intent-filter>
- <data android:mimeType="vnd.android.cursor.item/vnd.scott.person"/>
- </intent-filter>
這樣就完成了訪問者的代碼,我們來看一下效果: