Android内容提供者(Content provider)

时间:2020-12-20 06:40:34

使用ContentProvider共享数据

当应用继承ContentProvider类,并重写该类用于提供数据和存储数据的方法,就可以向其他应用共享其数据。虽然使用其他方法也可以对外共享数据,但数据访问方式会因数据存储的方式而不同,如:采用文件方式对外共享数据,需要进行文件操作读写数据;采用sharedpreferences共享数据,需要使用sharedpreferences API读写数据。而使用ContentProvider共享数据的好处是统一了数据访问方式。

当应用需要通过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)}

第二步需要在AndroidManifest.xml使用<provider>对该ContentProvider进行配置,为了能让其他应用找到该ContentProvider , ContentProvider 采用了authorities(主机名/域名)对它进行唯一标识,你可以把 ContentProvider看作是一个网站(想想,网站也是提供数据者),authorities 就是他的域名:

<manifest .... >

<application android:icon="@drawable/icon" android:label="@string/app_name">

<provider android:name=".PersonContentProvider" android:authorities="com.jbridge.provider.personprovider"/>

</application>

</manifest>

注意:一旦应用继承了ContentProvider类,后面我们就会把这个应用称为ContentProvider(内容提供者)。

Uri介绍

Uri代表了要操作的数据,Uri主要包含了两部分信息:1》需要操作的ContentProvider ,2》对ContentProvider中的什么数据进行操作,一个Uri由以下几部分组成:

ContentProvider(内容提供者)的scheme已经由Android所规定, scheme为:content://

主机名(或叫Authority)用于唯一标识这个ContentProvider,外部调用者可以根据这个标识来找到它。
路径(path)可以用来表示我们要操作的数据,路径的构建应根据业务而定,如下:
要操作person表中id为10的记录,可以构建这样的路径:/person/10
要操作person表中id为10的记录的name字段, person/10/name
要操作person表中的所有记录,可以构建这样的路径:/person
要操作xxx表中的记录,可以构建这样的路径:/xxx
当然要操作的数据不一定来自数据库,也可以是文件等他存储方式,如下:
要操作xml文件中person节点下的name节点,可以构建这样的路径:/person/name
如果要把一个字符串转换成Uri,可以使用Uri类中的parse()方法,如下:
Uri uri = Uri.parse("content://com.jbridge.provider.personprovider/person")
UriMatcher类使用介绍
因为Uri代表了要操作的数据,所以我们很经常需要解析Uri,并从Uri中获取数据。Android系统提供了两个用于操作Uri的工具类,分别为UriMatcher 和ContentUris 。掌握它们的使用,会便于我们的开发工作。
UriMatcher类用于匹配Uri,它的用法如下:
首先第一步把你需要匹配Uri路径全部给注册上,如下:
//常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码(UriMatcher.NO_MATCH的值为-1)
UriMatcher  sMatcher = new UriMatcher(UriMatcher.NO_MATCH);
//如果match()方法匹配content://com.jbridge.provider.personprovider/person路径,返回匹配码为1
sMatcher.addURI(“com.jbridge.provider.personprovider”, “person”, 1);//添加需要匹配uri,如果匹配就会返回匹配码
//如果match()方法匹配content://com.jbridge.provider.personprovider/person/230路径,返回匹配码为2
sMatcher.addURI(“com.jbridge.provider.personprovider”, “person/#”, 2);//#号为通配符
switch (sMatcher.match(Uri.parse("content://com.jbridge.provider.personprovider/person/10"))) { 
   case 1
    break;
   case 2
    break;
   default://不匹配
    break;
}
注册完需要匹配的Uri后,就可以使用sMatcher.match(uri)方法对输入的Uri进行匹配,如果匹配就返回匹配码,匹配码是调用addURI()方法传入的第三个参数,假设匹配content://com.jbridge.provider.personprovider/person路径,返回的匹配码为1
ContentUris类使用介绍
ContentUris类用于获取Uri路径后面的ID部分,它有两个比较实用的方法:
withAppendedId(uri, id)用于为路径加上ID部分:
Uri uri = Uri.parse("content://com.jbridge.provider.personprovider/person")
Uri resultUri = ContentUris.withAppendedId(uri, 10); 
//生成后的Uri为:content://com.jbridge.provider.personprovider/person/10
 
parseId(uri)方法用于从路径中获取ID部分:
Uri uri = Uri.parse("content://com.jbridge.provider.personprovider/person/10")
long personid = ContentUris.parseId(uri);//获取的结果为:10
使用ContentProvider共享数据
ContentProvider类主要方法的作用:
public boolean onCreate()
该方法在ContentProvider创建后就会被调用, Android在系统启动时就会创建ContentProvider 。
public Uri insert(Uri uri, ContentValues values)
该方法用于供外部应用往ContentProvider添加数据。
public int delete(Uri uri, String selection, String[] selectionArgs)
该方法用于供外部应用从ContentProvider删除数据。
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
该方法用于供外部应用更新ContentProvider中的数据。
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
该方法用于供外部应用从ContentProvider中获取数据。
public String getType(Uri uri)
该方法用于返回当前Url所代表数据的MIME类型。如果操作的数据属于集合类型,那么MIME类型字符串应该以vnd.android.cursor.dir/开头,例如:要得到所有person记录的Uri为content://com.jbridge.provider.personprovider/person,那么返回的MIME类型字符串应该为:“vnd.android.cursor.dir/person”。如果要操作的数据属于单一数据,那么MIME类型字符串应该以vnd.android.cursor.item/开头,例如:得到id为10的person记录,Uri为content://com.jbridge.provider.personprovider/person/10,那么返回的MIME类型字符串应该为:“vnd.android.cursor.item/person”。
使用ContentResolver操作ContentProvider中的数据
当外部应用需要对ContentProvider中的数据进行添加、删除、修改和查询操作时,可以使用ContentResolver 类来完成,要获取ContentResolver 对象,可以使用Activity提供的getContentResolver()方法。 ContentResolver 类提供了与ContentProvider类相同签名的四个方法:
public Uri insert(Uri uri, ContentValues values)
该方法用于往ContentProvider添加数据。
public int delete(Uri uri, String selection, String[] selectionArgs)
该方法用于从ContentProvider删除数据。
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
该方法用于更新ContentProvider中的数据。
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)
该方法用于从ContentProvider中获取数据。
 
这些方法的第一个参数为Uri,代表要操作的是哪个ContentProvider和对其中的什么数据进行操作,假设给定的是: Uri.parse(“content://com.jbridge.provider.personprovider/person/10”),那么将会对主机名为cn.itcast.provider.personprovider的ContentProvider进行操作,操作的数据为person表中id为10的记录。
使用ContentResolver操作ContentProvider中的数据
使用ContentResolver对ContentProvider中的数据进行添加、删除、修改和查询操作:
ContentResolver resolver =  getContentResolver();
Uri uri = Uri.parse("content://com.jbridge.provider.personprovider/person");
//添加一条记录
ContentValues values = new ContentValues();
values.put("name", "itcast");
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);

ContentProvider示例程序

我们为《Android之SQlite存储》示例程序添加一个ContentProvider,供其他应用来访问我们的数据。

 1.为SQLite示例程序添加ContentProvider类

package com.jbridge.db;

import com.jbridge.service.DataBaseOpenHelper;

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;
import android.text.TextUtils; public class PersonContentProvider extends ContentProvider {
private DataBaseOpenHelper dbOpenHelper;
private static final int ALLPERSON = 1;
private static final int PERSON = 2;
private static final UriMatcher sMatcher = new UriMatcher(
UriMatcher.NO_MATCH);
static {
sMatcher.addURI("com.jbridge.provider.personprovider", "person",
ALLPERSON);
sMatcher.addURI("com.jbridge.provider.personprovider", "person/#",
PERSON);
} @Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
int count = 0;
switch (sMatcher.match(uri)) {
case ALLPERSON:// com.jbridge.provider.personprovider/person
count=db.delete("person", selection,selectionArgs);
break;
case PERSON:// com.jbridge.provider.personprovider/person/10
long personid=ContentUris.parseId(uri);
//防止他输入时String selection, String[] selectionArgs参数为空,这样就会修改表的所有数据了
String where=TextUtils.isEmpty(selection)?"personid=?":selection+" and personid=?";
String[] params=new String[]{String.valueOf(personid)};
if (!TextUtils.isEmpty(selection)&&selectionArgs!=null) {
params=new String[selectionArgs.length+1];
for (int i=0;i<selectionArgs.length;i++) {
params[i]=selectionArgs[i];
}
params[selectionArgs.length]=String.valueOf(personid);
}
count = db.delete("person", where,params);
break;
default:
throw new IllegalArgumentException("Unknow Uri:" + uri); } return count;
} @Override
public String getType(Uri uri) {
switch (sMatcher.match(uri)) {
case ALLPERSON:// //数据集的MIME类型字符串则应该以vnd.android.cursor.dir/开头
return "vnd.android.cursor.dir/personprovider.person";
case PERSON://单一数据的MIME类型字符串应该以vnd.android.cursor.item/开头
return "vnd.android.cursor.item/personprovider.person";
default:
throw new IllegalArgumentException("Unknow Uri:" + uri);
}
} @Override
public Uri insert(Uri uri, ContentValues values) {
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
long id = 0;
switch (sMatcher.match(uri)) {
case ALLPERSON:// com.jbridge.provider.personprovider/person
id = db.insert("person", "name", values);// 返回值是记录的行号,主键为int实际上就是主键值,主键为text则为行号
return ContentUris.withAppendedId(uri, id);
case PERSON:// com.jbridge.provider.personprovider/person/10
id = db.insert("person", "name", values);// 返回值是记录的行号,主键为int实际上就是主键值,主键为text则为行号
String path = uri.toString();
return Uri.parse(path.substring(0, path.lastIndexOf("/")) + id);
default:
throw new IllegalArgumentException("Unknow Uri:" + uri);
}
} @Override
public boolean onCreate() {
dbOpenHelper=new DataBaseOpenHelper(this.getContext());
return false;
} @Override
public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs,
String sortOrder) {
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
switch (sMatcher.match(uri)) {
case ALLPERSON:// com.jbridge.provider.personprovider/person
return db.query("person",projection, selection, selectionArgs,null, null, sortOrder);
case PERSON:// com.jbridge.provider.personprovider/person/10
long personid=ContentUris.parseId(uri);
//防止他输入时String selection, String[] selectionArgs参数为空,这样就会修改表的所有数据了
String where=TextUtils.isEmpty(selection)?"personid=?":selection+" and personid=?";
String[] params=new String[]{String.valueOf(personid)};
if (!TextUtils.isEmpty(selection)&&selectionArgs!=null) {
params=new String[selectionArgs.length+1];
for (int i=0;i<selectionArgs.length;i++) {
params[i]=selectionArgs[i];
}
params[selectionArgs.length]=String.valueOf(personid);
}
return db.query("person",projection, where, params,null, null, sortOrder); default:
throw new IllegalArgumentException("Unknow Uri:" + uri); } } @Override
//返回值为影响的记录数
public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {
SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
int count = 0;
switch (sMatcher.match(uri)) {
case ALLPERSON:// com.jbridge.provider.personprovider/person
count = db.update("person", values, selection,selectionArgs);
break;
case PERSON:// com.jbridge.provider.personprovider/person/10
long personid=ContentUris.parseId(uri);
//防止他输入时String selection, String[] selectionArgs参数为空,这样就会修改表的所有数据了
String where=TextUtils.isEmpty(selection)?"personid=?":selection+" and personid=?";
String[] params=new String[]{String.valueOf(personid)};
if (!TextUtils.isEmpty(selection)&&selectionArgs!=null) {
params=new String[selectionArgs.length+1];
for (int i=0;i<selectionArgs.length;i++) {
params[i]=selectionArgs[i];
}
params[selectionArgs.length]=String.valueOf(personid);
}
count = db.update("person", values, where,params);
break;
default:
throw new IllegalArgumentException("Unknow Uri:" + uri); } return count;
} }

  2.添加ContentProvider配置

<provider android:name=".PersonContentProvider" android:authorities="com.jbridge.provider.personprovider"  android:permission="android.permission.READ_PERSON_DB"/>

       3.测试SQLite示例程序的ContentProvider,建立项目contentProviderUser

Project name: contentProviderUser

BuildTarget:Android2.2

Application name: 内容使用者

Package name: com.jbridge.user

Create Activity: ContentProviderUserActivity

Min SDK Version:8

package com.jbridge.user;

import android.R.string;
import android.app.Activity;
import android.content.ContentResolver;
import android.content.ContentValues;
import android.database.Cursor;
import android.net.Uri;
import android.os.Bundle;
import android.provider.ContactsContract;
import android.util.Log; public class ContentProviderUserActivity extends Activity {
private static final String TAG="ContentProviderUserActivity";
/* @Override
//向数据库插入数据
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
ContentResolver contentResolver=this.getContentResolver();
Uri uri=Uri.parse("content://com.jbridge.provider.personprovider/person");
ContentValues values=new ContentValues();
values.put("name", "刘德华");
values.put("age",(short)55);
contentResolver.insert(uri, values);
}*/ /* @Override
//向数据库修改数据
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
ContentResolver contentResolver=this.getContentResolver();
Uri uri=Uri.parse("content://com.jbridge.provider.personprovider/person/4");
ContentValues values=new ContentValues();
values.put("name", "haha");
values.put("age",(short)55);
contentResolver.update(uri, values, null, null);
}*/ /*@Override
//向数据库删除数据
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
ContentResolver contentResolver=this.getContentResolver();
Uri uri=Uri.parse("content://com.jbridge.provider.personprovider/person");
contentResolver.delete(uri, "personid>?",new String[]{String.valueOf(18)} );
// contentResolver.delete(uri,null,null );
}*/ /*@Override
//向数据库查询数据
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
ContentResolver contentResolver=this.getContentResolver();
Uri uri=Uri.parse("content://com.jbridge.provider.personprovider/person");
Cursor cursor=contentResolver.query(uri, new String[]{"personid","name","age"}, null, null, "personid desc");
while (cursor.moveToNext()) {
Log.i(TAG, "personid "+cursor.getInt(0));
}
cursor.close();
}*/ @Override
//向电话本取得数据
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
ContentResolver contentResolver=this.getContentResolver(); Cursor cursor=contentResolver.query(ContactsContract.Contacts.CONTENT_URI,null, null, null, null);
while (cursor.moveToNext()) {
int contactID=cursor.getInt(cursor.getColumnIndex(ContactsContract.Contacts._ID));
String name=cursor.getString(cursor.getColumnIndex(ContactsContract.Contacts.DISPLAY_NAME));
Log.i(TAG, "contactid="+contactID+",name="+name);
Cursor phones=contentResolver.query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI, null,ContactsContract.CommonDataKinds.Phone.CONTACT_ID+"="+contactID,null, null);
StringBuilder sb=new StringBuilder();
while (phones.moveToNext()) {
String phoneNumber=phones.getString(phones.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
sb.append(phoneNumber).append(",");
}
sb.deleteCharAt(sb.lastIndexOf(","));
phones.close();
Log.i(TAG, sb.toString()); Cursor emails = getContentResolver().query(ContactsContract.CommonDataKinds.Email.CONTENT_URI,
null,
ContactsContract.CommonDataKinds.Email.CONTACT_ID + " = " + contactID,
null, null);
while (emails.moveToNext()) {
// This would allow you get several email addresses
String emailAddress = emails.getString(emails.getColumnIndex(ContactsContract.CommonDataKinds.Email.DATA));
Log.i(TAG, "emailAddress="+ emailAddress);
}
emails.close(); cursor.close();
} } }
在AndroidManifest.xml中添加
  1. <uses-permission android:name="android.permission.READ_CONTACTS"/>
  2. <uses-permission android:name="android.permission.READ_PERSON_DB"/>