ContentProvider使用详解

作者: johnnycmj | 来源:发表于2017-10-30 10:39 被阅读188次

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

ContentProvider使用详解

URI

UriMatcher类使用介绍

ContentUris类使用介绍

ContentResolver

监听ContentProvider中数据的变化

数据共享

实例

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读