基礎總結篇之八：建立及調用本身的ContentProvider

時間  2019-11-12
標籤 基礎 總結 之八 建立 調用 本身 contentprovider 简体版
原文   原文鏈接

今天咱們來說解一下如何建立及調用本身的ContentProvider。css

在前面兩篇文章中咱們分別講了如何讀寫聯繫人和短消息，相信你們對於ContentProvider的操做方法已經有了必定程度的瞭解。在有些場合，除了操做ContentProvider以外，咱們還有可能須要建立本身的ContentProvider，來提供信息共享的服務，這就要求咱們很好的掌握ContentProvider的建立及使用技巧。下面咱們就由表及裏的逐步講解每一個步驟。html

在正式開始實例演示以前，咱們先來了解如下兩個知識點：java

受權：android

在Android中，每個ContentProvider都會用相似於域名的字符串來註冊本身，咱們成爲受權(authority)。這個惟一標識的字符串是此ContentProvider可提供的一組URI的基礎，有了這個基礎，纔可以向外界提供信息的共享服務。sql

受權是在AndroidManifest.xml中完成的，每個ContentProvider必須在此聲明並受權，方式以下：瀏覽器

<provider android:name=".SomeProvider"  
    android:authorities="com.your-company.SomeProvider"/>

上面的<provider>元素指明瞭ContentProvider的提供者是「SomeProvider」這個類，併爲其受權，受權的基礎URI爲「com.your-company.SomeProvider」。有了這個受權信息，系統能夠準確的定位到具體的ContentProvider，從而使訪問者可以獲取到指定的信息。這和瀏覽Web頁面的方式很類似，「SomeProvider」就像一臺具體的服務器，而「com.your-company.SomeProvider」就像註冊的域名，相信你們對這個概念並不陌生，由此聯想一下就能夠了解ContentProvider受權的做用了。（須要注意的是，除了Android內置應用程序以外，第三方程序應儘可能使用以上方式的徹底限定的受權名。）服務器

MIME類型：app

就像網站返回給定URL的MIME（Multipurpose Internet Mail Extensions，多用途Internet郵件擴展）類型同樣（這使瀏覽器可以用正確的程序來查看內容），ContentProvider還負責返回給定URI的MIME類型。根據MIME類型規範，MIME類型包含兩部分：類型和子類型。例如：text/html，text/css，text/xml等等。ide

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須要兩個步驟：

1.建立PersonProvider類：

咱們須要繼承ContentProvider類，實現onCreate、query、insert、update、delete和getType這幾個方法。具體代碼以下：

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:
			//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.scott.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類，代碼以下：

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);  
    }  
}

最後，要想讓這個ContentProvider生效，咱們須要在AndroidManifest.xml中聲明併爲其受權，以下所示：

<provider android:name=".PersonProvider"  
    android:authorities="com.scott.provider.PersonProvider"  
    android:multiprocess="true"/>

其中，android:multiprocess表明是否容許多進程操做。另外咱們也能夠爲其聲明相應的權限，對應的屬性是：android:permission。

2.調用PersonProvider類：

完成了person的ContentProvider後，下面咱們來看一下如何訪問它。這一步咱們在MainActivity中完成，看下面代碼：

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) {
			//update records.
			requery();
		};
	};
	
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        resolver = getContentResolver();
        listView = (ListView) findViewById(R.id.listView);
        
        //爲PERSON_ALL_URI註冊變化通知
        getContentResolver().registerContentObserver(PERSON_ALL_URI, true, new PersonObserver(handler));
    }
    
    /**
     * 初始化
     * @param view
     */
    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);
    	}
    }
    
    /**
     * 查詢全部記錄
     * @param view
     */
    public void query(View view) {
//    	Uri personOneUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);查詢_id爲1的記錄
    	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);
    		}
    	};
    	
    	//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(cursorWrapper);	//管理Cursor
    }
    
    /**
     * 插入一條記錄
     * @param view
     */
    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);
    }
    
    /**
     * 更新一條記錄
     * @param view
     */
    public void update(View view) {
    	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);
    }
    
    /**
     * 刪除一條記錄
     * @param view
     */
    public void delete(View view) {
    	//刪除_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(null);
    }
}

咱們看到，在上面的代碼中，分別對應每一種狀況進行測試，相對較爲簡單。咱們主要講一下registerContentObserver這一環節。

在前面的PersonProvider咱們也提到，在數據更改後，會向指定的URI訪問者發出通知，以便於更新查詢記錄。你們注意，僅僅是ContentProvider出力還不夠，咱們還須要在訪問者中註冊一個ContentObserver，纔可以接收到這個通知。下面咱們建立一個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.");
		//向handler發送消息,更新查詢記錄
		Message msg = new Message();
		handler.sendMessage(msg);
	}
}

這樣一來，當ContentProvider發來通知以後，咱們就能當即接收到，從而向handler發送一條消息，從新查詢記錄，使咱們可以看到最新的記錄信息。

最後，咱們要在AndroidManifest.xml中爲MainActivity添加MIME類型過濾器，告訴系統MainActivity能夠處理的信息類型：

<!-- MIME類型 -->  
<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>

這樣就完成了訪問者的代碼，咱們來看一下效果：


鑑於操做類型太多，我在這裏就再也不展現了，你們能夠本身試一試。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程