Android数据存储之ContentProvider

1.ContentProvider基础知识：

（1）ContentProvider是所有应用程序之间数据存储和检索的一个桥梁，它的作用就是使得各个应用程序之间实现数据共享。

使用ContentProvider共享数据的好处是统一了数据访问方式。

（2）ContentProvider操作的数据不一定来自数据库，也可以是文件、xml或网络等其他存储方式.

（3）ContentProvider的scheme已经由Android所规定， scheme为：content://

主机名（或叫Authority）用于唯一标识这个ContentProvider，外部调用者可以根据这个标识来找到它。

路径（path）可以用来表示我们要操作的数据，路径的构建应根据业务而定，

如下:要操作person表中id为10的记录，可以构建这样的路径:/person/10

要操作person表中id为10的记录的name字段， person/10/name

要操作person表中的所有记录，可以构建这样的路径:/person

要操作xxx表中的记录，可以构建这样的路径:/xxx

例如：content://com.hoo.provider.personprovider/person

（4）当应用需要通过ContentProvider对外共享数据时，第一步需要继承ContentProvider并重写下面方法：这里重写的方法可以根据需求进行选择性的重写

public class PersonContentProvider extends ContentProvider
{
   public boolean onCreate();
   public Uri insert(Uri uri, ContentValues values);
   public int delete(Uri uri, String selection, String[] selectionArgs);
   public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs);
   public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder);
   public String getType(Uri uri);
}

2.UriMatcher与ContentUris

（1）UriMatcher类

UriMatcher类用于匹配Uri，它的用法如下：

首先第一步把你需要匹配Uri路径全部给注册上，如下：

//常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码
UriMatcher  sMatcher = new UriMatcher(UriMatcher.NO_MATCH);
//如果match()方法匹配,返回匹配码为1
content://com.hoo.provider.personprovider/person路径 :
//添加需要匹配uri，如果匹配就会返回匹配码
sMatcher.addURI(“com.hoo.provider.personprovider”, “person”, 1);
//如果match()方法匹配,返回匹配码为2
content://com.hoo.provider.personprovider/person/230路径，
//#号为通配符
sMatcher.addURI(“com.hoo.provider.personprovider”, “person/#”, 2);
switch (sMatcher.match(Uri.parse("content://com.hoo.provider.personprovider/person/10")))
{
   case 1
    break;
   case 2
    break;
   default://不匹配
    break;
}

注册完需要匹配的Uri后，就可以使用sMatcher.match(uri)方法对输入的Uri进行匹配，如果匹配就返回匹配码，匹配码是调用addURI()方法传入的第三个参数，假设匹配content://com.hoo.provider.personprovider/person路径，返回的匹配码为1

（2）ContentUris类

ContentUris类用于获取Uri路径后面的ID部分，它有两个比较实用的方法：

withAppendedId(uri, id) //用于为路径加上ID部分：

Uri uri = Uri.parse("content://com.hoo.provider.personprovider/person")

Uri resultUri = ContentUris.withAppendedId(uri, 10);

//生成后的Uri为：content://com.hoo.provider.personprovider/person/10

parseId(uri)方法用于从路径中获取ID部分：

Uri uri = Uri.parse("content://com.hoo.provider.personprovider/person/10")

long personid = ContentUris.parseId(uri);//获取的结果为:10

3.使用ContentResolver操作ContentProvider中的数据

当外部应用需要对ContentProvider中的数据进行添加、删除、修改和查询操作时，可以使用ContentResolver类来完成，要获取ContentResolver对象，可以使用Activity提供的getContentResolver()方法。

ContentResolver类提供了与ContentProvider类相同签名的四个方法：

public Uri insert(Uriuri,ContentValuesvalues)

该方法用于往ContentProvider添加数据。

publicintdelete(Uriuri, String selection, String[]selectionArgs)

该方法用于从ContentProvider删除数据。

publicintupdate(Uriuri,ContentValuesvalues, String selection, String[]selectionArgs)

该方法用于更新ContentProvider中的数据。

public Cursor query(Uriuri, String[] projection, String selection, String[]selectionArgs, StringsortOrder)

该方法用于从ContentProvider中获取数据。

ContentResolver resolver =  getContentResolver();
Uri uri = Uri.parse("content://com.hoo.provider.personprovider/person");
//添加一条记录
ContentValues values = new ContentValues();
values.put("name", "csdn");
values.put("age", 25);
resolver.insert(uri, values);		
//获取person表中所有记录
Cursor cursor = resolver.query(uri, null, null, null, "personid desc");
while(cursor.moveToNext())
{
	Log.i("ContentTest", "personid="+ cursor.getInt(0)+ ",name="+ cursor.getString(1));
}
//把id为1的记录的name字段值更改新为liming
ContentValues updateValues = new ContentValues();
updateValues.put("name", "liming");
Uri updateIdUri = ContentUris.withAppendedId(uri, 2);
resolver.update(updateIdUri, updateValues, null, null);
//删除id为2的记录
Uri deleteIdUri = ContentUris.withAppendedId(uri, 2);
resolver.delete(deleteIdUri, null, null);

4.ContentProvider类主要方法的作用：

(1)public boolean onCreate()

该方法在ContentProvider创建后就会被调用， Android开机后， ContentProvider在其它应用第一次访问它时才会被创建。

(2)public Uri insert(Uri uri, ContentValues values)

该方法用于供外部应用往ContentProvider添加数据。

(3)public int delete(Uri uri, String selection, String[] selectionArgs)

该方法用于供外部应用从ContentProvider删除数据。

(4)public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)

该方法用于供外部应用更新ContentProvider中的数据。

(5)public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)

该方法用于供外部应用从ContentProvider中获取数据。

(6)public String getType(Uri uri)

该方法用于返回当前Url所代表数据的MIME类型。

如果操作的数据属于集合类型，那么MIME类型字符串应该以vnd.android.cursor.dir/开头，

例如：要得到所有person记录的Uri为content://com.hoo.provider.personprovider/person，那么返回的MIME类型字符串应 该为：“vnd.android.cursor.dir/person”。

如果要操作的数据属于非集合类型数据，那么MIME类型字符串应该以vnd.android.cursor.item/开头，

例如：得到id为10的person记录，Uri为content://com.hoo.provider.personprovider/person/10，那么返回的MIME类型字符串应该为：“vnd.android.cursor.item/person”。

5.实例演示

(1)操作目标类，对下面的Person类进行数据共享：Person.java

public class Person 
{
	private Integer id;
	private String name;
	private Integer amount;
	
	public Integer getAmount() 
	{
		return amount;
	}
	public void setAmount(Integer amount) 
	{
		this.amount = amount;
	}
	public Person(){}
	
	public Person(Integer id, String name) 
	{
		this.id = id;
		this.name = name;
	}
	public Integer getId() 
	{
		return id;
	}
	public void setId(Integer id)
	{
		this.id = id;
	}
	public String getName() 
	{
		return name;
	}
	public void setName(String name) 
	{
		this.name = name;
	}
	@Override
	public String toString() 
	{
		return "Person [amount=" + amount + ", id=" + id + ", name=" + name
				+ "]";
	}

（2）在AndroidManifest.xml进行设置：写在<application>标签里面

<provider android:name=".PersonProvider" android:authorities="com.hoo.providers.personprovider"/>

（3）PersonProvider.java

public class PersonProvider extends ContentProvider 
{
	private DBOpenHelper dbOpenHelper;
	private static final UriMatcher MATCHER = new UriMatcher(UriMatcher.NO_MATCH);
	private static final int PERSONS = 1;
	private static final int PERSON = 2;
	static
	{
		MATCHER.addURI("com.hoo.providers.personprovider", "person", PERSONS);
		MATCHER.addURI("com.hoo.providers.personprovider", "person/#", PERSON);
	}
	
	@Override
	public boolean onCreate() 
	{
		this.dbOpenHelper = new DBOpenHelper(this.getContext());
		return false;
	}
	
	/**
	 * 返回当前操作的数据的mimeType
	 */
	@Override
	public String getType(Uri uri) 
	{
		switch (MATCHER.match(uri)) 
		{
			case PERSONS:			
				return "vnd.android.cursor.dir/person";				
			case PERSON:			
				return "vnd.android.cursor.item/person";				
			default:
				throw new IllegalArgumentException("Unkwon Uri:"+ uri.toString());
		}
	}
	
	@Override
	public Uri insert(Uri uri, ContentValues values) 
	{// /person
		SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
		switch (MATCHER.match(uri)) 
		{
			case PERSONS:
				long rowid = db.insert("person", "name", values); 
				//得到代表新增记录的Uri
				Uri insertUri = ContentUris.withAppendedId(uri, rowid);
				this.getContext().getContentResolver().notifyChange(uri, null);
				return insertUri;
			default:
				throw new IllegalArgumentException("Unkwon Uri:"+ uri.toString());
		}
	}
	
	/**删除person表中的所有记录   /person
	 * 删除person表中指定id的记录 /person/10
	 */
	@Override
	public int delete(Uri uri, String selection, String[] selectionArgs) 
	{
		SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
		int count = 0;
		switch (MATCHER.match(uri)) 
		{
			case PERSONS:
				count = db.delete("person", selection, selectionArgs);
				return count;
				
			case PERSON:
				long id = ContentUris.parseId(uri);
				String where = "personid="+ id;
				if(selection!=null && !"".equals(selection))
				{
					where = selection + " and " + where;
				}
				count = db.delete("person", where, selectionArgs);
				return count;
				
			default:
				throw new IllegalArgumentException("Unkwon Uri:"+ uri.toString());
		}
	}
	
	/**查询person表中的所有记录   /person
	 * 查询person表中指定id的记录 /person/10
	 */
	public Cursor query(Uri uri, String[] projection, String selection,String[] selectionArgs, String sortOrder) 
	{
		SQLiteDatabase db = dbOpenHelper.getReadableDatabase();
		switch (MATCHER.match(uri)) 
		{
			case PERSONS:
				//查询所有记录
				return db.query("person", projection, selection, selectionArgs, null, null, sortOrder);
				
			case PERSON:
				//查询指定记录
				//获取id值
				long id = ContentUris.parseId(uri);
				String where = "personid="+ id;
				//如果方法参数传进来的不为空，并且不相等
				if(selection!=null && !"".equals(selection))
				{
					//组拼的条件
					where = selection + " and " + where;
				}
				return db.query("person", projection, where, selectionArgs, null, null, sortOrder);	
			default:
				throw new IllegalArgumentException("Unkwon Uri:"+ uri.toString());
		}
	}
	
	/**更新person表中的所有记录   /person
	 * 更新person表中指定id的记录 /person/10
	 */
	@Override
	public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) 
	{
		SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
		int count = 0;
		switch (MATCHER.match(uri)) 
		{
			case PERSONS:
				count = db.update("person", values, selection, selectionArgs);
				return count;				
			case PERSON:
				//获取id
				long id = ContentUris.parseId(uri);
				//
				String where = "personid=" + id;
				//如果方法参数传进来的不为空，并且不相等
				if(selection!=null && !"".equals(selection))
				{
					//组拼的条件
					where = selection + " and " + where;
				}
				count = db.update("person", values, where, selectionArgs);
				return count;				
			default:
				throw new IllegalArgumentException("Unkwon Uri:"+ uri.toString());
		}
	}
}

(4)AccessContentProviderTest.java（单元测试用例）

public class AccessContentProviderTest extends AndroidTestCase 
{
	private static final String TAG = "AccessContentProviderTest";
	/**
	 * 往内容提供者添加数据
	 * @throws Throwable
	 */
	public void testInsert() throws Throwable
	{
		ContentResolver contentResolver = this.getContext().getContentResolver();
		Uri insertUri = Uri.parse("content://com.hoo.providers.personprovider/person");
		ContentValues values = new ContentValues();
		values.put("name", "zhangxiaoxiao");
		values.put("amount", 90);
		Uri uri = contentResolver.insert(insertUri, values);
		Log.i(TAG, uri.toString());
	}
	/**
	 * 更新内容提供者中的数据
	 * @throws Throwable
	 */
	public void testUpdate() throws Throwable
	{
		ContentResolver contentResolver = this.getContext().getContentResolver();
		Uri updateUri = Uri.parse("content://com.hoo.providers.personprovider/person/1");
		ContentValues values = new ContentValues();
		values.put("name", "lili");
		contentResolver.update(updateUri, values, null, null);
	}
	
	/**
	 * 从内容提供者中删除数据
	 * @throws Throwable
	 */
	public void testDelete() throws Throwable
	{
		ContentResolver contentResolver = this.getContext().getContentResolver();
		Uri deleteUri = Uri.parse("content://com.hoo.providers.personprovider/person/1");
		contentResolver.delete(deleteUri, null, null);
	}
	
	/**
	 * 获取内容提供者中的数据
	 * @throws Throwable
	 */
	public void testFind() throws Throwable
	{
		ContentResolver contentResolver = this.getContext().getContentResolver();
		Uri selectUri = Uri.parse("content://com.hoo.providers.personprovider/person");
		Cursor cursor = contentResolver.query(selectUri, null, null, null, "personid desc");
		while(cursor.moveToNext())
		{
			int id = cursor.getInt(cursor.getColumnIndex("personid"));
			String name = cursor.getString(cursor.getColumnIndex("name"));
			int amount = cursor.getInt(cursor.getColumnIndex("amount"));
			Log.i(TAG, "id="+ id + ",name="+ name+ ",amount="+ amount);
		}
	}
}

6.监听ContentProvider中数据的变化

(1)如果ContentProvider的访问者需要知道ContentProvider中的数据发生了变化，可以在ContentProvider 发生数据变化时调用getContentResolver().notifyChange(uri, null)来通知注册在此URI上的访问者，

例子如下：

public class PersonContentProvider extends ContentProvider
{
     public Uri insert(Uri uri, ContentValues values) 
     {
	db.insert("person", "personid", values);
	getContext().getContentResolver().notifyChange(uri, null);
     }
}

（2）如果ContentProvider的访问者需要得到数据变化通知，必须使用ContentObserver对数据（数据采用uri描述）进行监听，当监听到数据变化通知时，系统就会调用ContentObserver的onChange()方法：

getContentResolver().registerContentObserver(Uri.parse("content://com.hoo.providers.personprovider/person"),
        		true, new PersonObserver(new Handler()));
public class PersonObserver extends ContentObserver
{
	public PersonObserver(Handler handler) 
        {
		super(handler);
 	}
	public void onChange(boolean selfChange) 
        {
	    //此处可以进行相应的业务处理,比如重新查询所有数据
	}
}