Android学习 —— 数据的存储与访问方式四： ContentProvider
笔记摘要：
对于私有数据的访问，除了文件读取方式（当然在创建的时候需要设置足够的权限），还可以通过ContentProvider来进行访问，ContentProvider 在android中的作用是对外共享数据，也就是说你可以通过ContentProvider把应用中的数据共享给其他应用访问，其他应用可以通过ContentProvider 对你应用中的数据进行添删改查。ContentProvider提供了数据访问的统一形式，对于要访问的数据，需要通过一定规则的Uri来配置要访问，并且需要使用ContentResolver来进行操作。
如何通过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">
<providerandroid:name=".PersonContentProvider" android:authorities="cn.test.providers.personprovider"/>
</application>
</manifest>
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或网络等其他存储方式，如: 要操作xml文件中person节点下的name节点，可以构建这样的路径：/person/name
如果要把一个字符串转换成Uri，可以使用Uri类中的parse()方法，如：Uri uri = Uri.parse("content://cn.itcast.provider.personprovider/person")
UriMatcher类使用介绍
因为Uri代表了要操作的数据，所以我们经常需要解析Uri，并从Uri中获取数据。
Android系统提供了两个用于操作Uri的工具类，分别为UriMatcher 和ContentUris
UriMatcher类用于匹配Uri，它的用法如下：
第一步
把需要匹配Uri路径全部给注册上，如下：
UriMatcher sMatcher = new UriMatcher(UriMatcher.NO_MATCH); //常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码
sMatcher.addURI(“cn.itcast.provider.personprovider”, “person”, 1);//添加需要匹配uri，如果匹配就会返回匹配码1
sMatcher.addURI(“cn.itcast.provider.personprovider”, “person/#”, 2);//#号为通配符， 例如，如果match()方法匹配content://cn.itcast.provider.personprovider/person/230路径，返回匹配码为2
第二部：
使用sMatcher.match(uri)方法对输入的Uri进行匹配，如果匹配就返回匹配码，由以上示例很清楚的知道匹配码就是调用addURI()方法传入的第三个参数，
假设匹配content://cn.itcast.provider.personprovider/person路径，返回的匹配码为1
ContentUris类使用介绍
ContentUris类用于获取Uri路径后面的ID部分，它有两个比较实用的方法：
withAppendedId(uri, id)方法：
用于为路径加上ID部分：
Uri uri = Uri.parse("content://cn.itcast.provider.personprovider/person")
Uri resultUri = ContentUris.withAppendedId(uri, 10); //生成后的Uri为：content://cn.itcast.provider.personprovider/person/10
parseId(uri)方法：
用于从路径中获取ID部分：
Uri uri = Uri.parse("content://cn.itcast.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://cn.itcast.provider.personprovider/person，那么返回的MIME类型字符串应该为：“vnd.android.cursor.dir/person”。
如果要操作的数据属于非集合类型数据，那么MIME类型字符串应该以vnd.android.cursor.item/开头。
例如：得到id为10的person记录，Uri为：content://cn.itcast.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://cn.itcast.providers.personprovider/person/10”)，那么将会对主机名为cn.itcast.providers.personprovider的ContentProvider进行操作，操作的数据为person表中id为10的记录。
示例：使用ContentResolver对ContentProvider进行操作
先在Application节点下注册
<provider
android:authorities="com.itheima.db"
android:name="com.itheima.db.provider.PersonDBProvider">
</provider>
操作数据库中Person表的ContentProvider：提供一些增删改查的操作
说明： 这里的操作都是调用数据库中的操作，此处省略了Dao的代码
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 com.itheima.db.PersonDBOpenHelper;
import com.itheima.db.dao.PersonDao2;
public class PersonDBProvider extends ContentProvider {
//定义一些操作的返回码
private static final int INSERT = 1;
private static final int DELETE = 2;
private static final int UPDATE = 3;
private static final int QUERY = 4;
private static final int QUERY_ONE = 5;
private PersonDao2 dao ;
private PersonDBOpenHelper helper;
//1、创建一些路径匹配的规则，用来识别要进行的操作
public static UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);
//2、定义URI的匹配规则
//com.itheima.db/person/insert 添加
// ...
static{
matcher.addURI("com.itheima.db", "person/insert", INSERT);
matcher.addURI("com.itheima.db", "person/delete", DELETE);
matcher.addURI("com.itheima.db", "person/update", UPDATE);
matcher.addURI("com.itheima.db", "person/query", QUERY);
matcher.addURI("com.itheima.db", "person/query/#", QUERY_ONE);
}
//该方法在ContentProvider创建后就会被调用,而 ContentProvider在其它应用第一次访问它时才会被创建
@Override
public boolean onCreate() {
dao = new PersonDao2(getContext());
helper = new PersonDBOpenHelper(getContext());
return false;
}
@Override
public String getType(Uri uri) {
int code = matcher.match(uri);
if (code == QUERY) {
// 查询的路径.
return "vnd.android.cursor.dir/person";//如果查询的是集合，就返回MIME类型：vnd.android.cursor.dir
} else if (code == QUERY_ONE) {
int id = (int) ContentUris.parseId(uri);
return "vnd.android.cursor.item/person";//如果非集合，就返回MIME类型：vnd.android.cursor.item
}
return null;
}
//提供查询的操作
@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
int code = matcher.match(uri);//对请求的资源路径进行匹配
if(code == QUERY){
return dao.findAllCursor();//调用PersonDao的查询所有数据的方法
}else if(code == QUERY_ONE){
int id = (int) ContentUris.parseId(uri);
return dao.find(id); //调用PersonDao的查询一条数据的方法
}else{
throw new IllegalArgumentException("路径非法");
}
}
//提供插入的操作
@Override
public Uri insert(Uri uri, ContentValues values) {
int code = matcher.match(uri);//对请求的资源路径进行匹配
if(code == INSERT){
SQLiteDatabase db = helper.getWritableDatabase();
db.insert("person", null,values); //调用PersonDao的insert方法
}else{
throw new IllegalArgumentException("路径非法");
}
return null;
}
//提供删除的操作
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
int code = matcher.match(uri);//对请求的资源路径进行匹配
if (code == DELETE) {
SQLiteDatabase db = helper.getWritableDatabase();
db.delete("person", selection, selectionArgs);//调用PersonDao的delete方法
} else {
throw new IllegalArgumentException("路径非法");
}
return 0;
}
//数据的更新
@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
int code = matcher.match(uri);//对请求的资源路径进行匹配
if (code == UPDATE) {
SQLiteDatabase db = helper.getWritableDatabase();
db.update("person", values, selection, selectionArgs);//调用PersonDao的update方法
} else {
throw new IllegalArgumentException("路径非法");
}
return 0;
}
}
说明：即对上面的数据库进行操作，只需通过指定资源的Uri，然后通过ContentResolver调用需要进行的操作即可，ContentProvider会自动进行匹配，然后执行相应的动作
import android.app.Activity;
import android.content.ContentResolver;
import android.content.ContentUris;
import android.content.ContentValues;
import android.database.Cursor;
import android.net.Uri;
import android.os.Bundle;
import android.text.TextUtils;
import android.util.Log;
import android.view.View;
import android.widget.Toast;
//利用ContentResolver访问私有数据库
public class MainActivity extends Activity {
private static final String TAG = "MainActivity";//定义一个静态最终常量，作为Logcat的TAG,一般和类名相同
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
//插入操作
public void insert(View view){
ContentResolver resolver = this.getContentResolver();//创建一个内容解析器
Uri uri = Uri.parse("content://com.itheima.db/person/insert");//请求资源的Uri
ContentValues values = new ContentValues(); //为请求资源所要进行的操作提供数据
values.put("name", "insertName");
values.put("id", "1");
values.put("amount","100000");
Uri newUri = resolver.insert(uri, values); //通过resolver进行插入操作，方法返回被插入资源的Uri
Log.i(TAG,newUri+"");
}
//查询操作
public void query(View view){
ContentResolver resolver = getContentResolver();//创建一个内容解析器
Uri uri = Uri.parse("content://com.itheima.db/person/query");//请求查询操作的Uri
Cursor cursor = resolver.query(uri, null, null, null, null);//通过resolver进行查询操作
while(cursor.moveToNext()){
int id = cursor.getInt(cursor.getColumnIndex("id"));
String name = cursor.getString(cursor.getColumnIndex("name"));
String phone = cursor.getString(cursor.getColumnIndex("phone"));
String moneyStr = cursor.getString(cursor.getColumnIndex("money"));
int money = 0;
if(TextUtils.isEmpty(moneyStr)){//使用Android自带的工具类TextUtils判断money是否为null或者长度为0
money = 0;
}else{
money = Integer.parseInt(moneyStr);
}
Log.i(TAG,"id:"+id+" name:"+name+" phone:"+phone);
}
}
//更新操作
public boolean update(View view){
ContentResolver resolver = this.getContentResolver();//创建一个内容解析器
Uri uri = Uri.parse("content://com.itheima.db/person/update");//请求更新操作的Uri
ContentValues values = new ContentValues();
values.put("name","updateName");
values.put("money","10001");
int affected = resolver.update(uri, values, "id=?", new String[]{"1"});//通过resolver进行更新操作，返回被更新的行号
if(affected > 0){
Toast.makeText(MainActivity.this, affected+" line", 1);
return true;
}
else
return false;
}
//删除操作
public boolean delete(View view){
ContentResolver resolver = this.getContentResolver();//创建一个内容解析器
Uri uri = Uri.parse("content://com.itheima.db/person/delete");//请求删除操作的Uri
int deleted = resolver.delete(uri, "id=?", new String[]{"10"});//通过resolver进行删除操作，返回被删除的行号
if(deleted>0)
return true;
else
return false;
}
}
