ContentProvider使用详解

ContentProvider是Android四大组件之一。

ContentProvider一般为存储和获取数据提供统一的接口,可以在不同的应用程序之间共享数据。

如果要使用ContentProvider,首先需要继承ContentProvider并重写里面的几个方法:

public class TestProvider 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
    android:authorities="com.johnny.provider"
    android:name=".activity.provider.TestProvider" />

注意:为了能让其他应用找到该ContentProvider ,ContentProvider采用了authorities(主机名/域名)对它进行唯一标识。

URI

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

uri.png
  • Authority:授权信息,用以区别不同的ContentProvider;
  • Path:表名,用以区分ContentProvider中不同的数据表;
  • Id:Id号,用以区别表中的不同数据;

UriMatcher类使用介绍

UriMatcher类用于匹配Uri,它的用法如下:
首先第一步把你需要匹配Uri路径全部给注册上

static UriMatcher buildUriMatcher(){
//常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码
final UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);

final String authorith = "com.johnny.provider";

//如果match()方法匹配content://com.johnny.provider/person路径,返回匹配码为ADD
matcher.addURI(authorith,PATH_TEST,ADD);
//如果match()方法匹配content://com.johnny.provider/person/10 路径,返回匹配码为GET
matcher.addURI(authorith,PATH_DEL,DEL);

return matcher;
}

然后就可以使用Matcher.match(uri)方法对输入的Uri进行匹配。

switch (buildUriMatcher().match(uri)){
    case 1:
        break;
    case 2:
        break;
    default:
        break;
}

ContentUris类使用介绍

ContentUris类用于操作Uri路径后面的ID部分,它有两个比较实用的方法:
withAppendedId(uri, id)用于为路径加上ID部分:

Uri uri = Uri.parse("content://com.johnny.provider/person")
Uri resultUri = ContentUris.withAppendedId(uri, 10);
//生成后的Uri为:content://om.johnny.provider/person/10

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

Uri uri = Uri.parse("content://com.johnny.provider/person/10")
long personid = ContentUris.parseId(uri);//获取的结果为:10

ContentResolver

Android为我们提供了ContentResolver来统一管理与不同ContentProvider间的操作。外部可以通过ContentResolver来操作。

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类型。

监听ContentProvider中数据的变化

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

private class PersonObserver extends ContentObserver{
    private Uri personContentUri;       // 需要观察的Uri
    
    public PersonObserver(Uri uri,Handler handler) {
        super(handler);
        personContentUri = uri;
    }
    
    @Override
    public void onChange(boolean selfChange) {
        super.onChange(selfChange);
        handleContentChange(personContentUri);
    }
}

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

getContext().getContentResolver().notifyChange(uri,null);

数据共享

如果让其他应用也可以访问此应用中的数据呢,一种方法是向此应用设置一个android:sharedUserId,然后需要访问此数据的应用也设置同一个sharedUserId,具有同样的sharedUserId的应用间可以共享数据。

但此种方法不够安全,也无法做到对不同数据进行不同读写权限的管理,下面我们就来详细介绍下ContentProvider中的数据共享规则。

首先我们先介绍下,共享数据所涉及到的几个重要标签:

  • android:exported 设置此provider是否可以被其他应用使用。
  • android:readPermission 该provider的读权限的标识
  • android:writePermission 该provider的写权限标识
  • android:permission provider读写权限标识

实例

TestProvider.java

public class TestProvider extends ContentProvider {
    private final static DateFormat FORMAT = new SimpleDateFormat("yyyy-MM-dd", Locale.getDefault());

    private final static int ADD = 100;
    private final static int DEL = 101;
    private final static String PATH_TEST = "person";
    //其中# 是通配符.
    private final static String PATH_DEL = "person/#";
    private StudentDao mStudentDao;


    /**
     * UriMatcher类用于匹配Uri.
     * @return
     */
    static UriMatcher buildUriMatcher(){
        //常量UriMatcher.NO_MATCH表示不匹配任何路径的返回码
        final UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);

        final String authorith = "com.johnny.provider";

        //如果match()方法匹配content://com.johnny.provider/person路径,返回匹配码为ADD
        matcher.addURI(authorith,PATH_TEST,ADD);
        //如果match()方法匹配content://com.johnny.provider/person/10 路径,返回匹配码为GET
        matcher.addURI(authorith,PATH_DEL,DEL);

        return matcher;
    }


    @Override
    public boolean onCreate() {

        return true;
    }

    private void initDatabase(){
        DaoSession daoSession = DbHelper.getInstance().getDaoSession();
        mStudentDao = daoSession.getStudentDao();
    }



    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        return null;
    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        return null;
    }

    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        initDatabase();
        switch (buildUriMatcher().match(uri)){
            case ADD:
                String name = values.getAsString("name");
                int age = values.getAsInteger("age");
                String date = values.getAsString("date");
                Student student = new Student(null,name,age, TimeUtils.string2Date(date,FORMAT));
                LogHelper.i("insert " + student.toString());
                long id = mStudentDao.insert(student);
                LogHelper.i("insert id" + id);
                getContext().getContentResolver().notifyChange(uri,null);
                /**
                 * withAppendedId(uri, id)用于为路径加上ID部分:
                 * Uri uri = Uri.parse("content://com.johnny.provider/person")
                 Uri resultUri = ContentUris.withAppendedId(uri, 10);
                 //生成后的Uri为:content://om.johnny.provider/person/10
                 */
                return ContentUris.withAppendedId(uri,id);

            default:
                throw new IllegalArgumentException("Unknown URI"+ uri);
        }
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
        initDatabase();
        switch (buildUriMatcher().match(uri)){
            case DEL:
                /**
                 * parseId(uri)方法用于从路径中获取ID部分:
                 * Uri uri = Uri.parse("content://com.johnny.provider/person/10")
                  long personid = ContentUris.parseId(uri);//获取的结果为:10
                 */
                long id = ContentUris.parseId(uri);
                mStudentDao.deleteByKey(id);
                return 1;
            default:
                throw new IllegalArgumentException("Unknown URI"+ uri);
        }
    }

    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection, @Nullable String[] selectionArgs) {
        return 0;
    }


}

androidManifest.xml进行配置注册。

<provider
    android:authorities="com.johnny.provider"
    android:name=".activity.provider.TestProvider" />

ProviderActivity.java

public class ProviderActivity extends BaseActivity {

    private Uri insertUri = Uri.parse("content://com.johnny.provider/person");

    /**
     * 监听ContentProvider中数据的变化.
     * 使用ContentObserver对数据(数据采用uri描述)进行监听,当监听到数据变化通知时,系统就会调用ContentObserver的onChange()方法.
     * 必须在ContentProvider发生数据变化时调用getContentResolver().notifyChange(uri, null)来通知注册在此URI上的访问者
     */
    private class PersonObserver extends ContentObserver{
        private Uri personContentUri;       // 需要观察的Uri

        public PersonObserver(Uri uri,Handler handler) {
            super(handler);
            personContentUri = uri;
        }

        @Override
        public void onChange(boolean selfChange) {
            super.onChange(selfChange);
            handleContentChange(personContentUri);
        }
    }

    @Override
    protected void loadViewLayout() {
        setContentView(R.layout.test_provider_activity);

        getContentResolver().registerContentObserver(insertUri,true,new PersonObserver(insertUri,new Handler()));
    }


    @Override
    protected void setListener() {
        findViewById(R.id.insert).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                testInsert();
            }
        });
    }

    private void testInsert(){
        ContentResolver contentResolver = mContext.getContentResolver();

        ContentValues values = new ContentValues();
        values.put("name","Jim");
        values.put("age",21);
        values.put("date","1992-09-18");
        Uri uri = contentResolver.insert(insertUri,values);

        LogHelper.i(" testInsert " + uri);

    }

    private void handleContentChange(Uri uri){
        LogHelper.i("---回调---" +uri);
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,763评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,728评论 2 374
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,834评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,707评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,576评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,429评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,826评论 3 388
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,474评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,762评论 1 293
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,792评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,582评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,424评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,845评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,059评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,361评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,826评论 2 343
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,038评论 2 338

推荐阅读更多精彩内容