欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页

ContentProvider,Uri,ContentResolver,UriMatcher详解

程序员文章站 2024-02-09 18:01:52
...

前言

正如标题，四个类组成一种数据共享解决方案。下面会介绍如何使用系统提供的Api进行数据在不同应用间共享
（数据存储使用sqlite db）

ContentProvider在android中的作用是对外共享数据，也就是说你可以通过ContentProvider把应用中的数据共享给其他应用访问，
其他应用可以通过ContentProvider对你应用中的数据进行添删改查。关于数据共享，以前我们学习过文件操作模式，
知道通过指定文件的操作模式为Context.MODE_WORLD_READABLE或Context.MODE_WORLD_WRITEABLE同样也可以对外共享数据。
文件共享有它的弊端？

1,数据读取会因为存储方式不同，读取方式也会发生改变。

例如 xml格式，Txt 格式,sharedpreferences 格式。不同存储格式，需要使用不同的方式反序列。

2.对于批量数据写文件存储，不是明智的选择。读写会严重影响性能

使用ContentProvider 则统一了数据的访问方式，方便对共享数据进行增删改查操作。

### 配置db

ContentProvider 使用Sqlite作为数据存储容器。首先简单配置一下db

  public class AppOpenHelper extends SQLiteOpenHelper {

    public AppOpenHelper(Context context) {
        super(context, "person.db", null, 1);
    }

    //数据库创建时，此方法会调用
    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL("create table person(_id integer primary key autoincrement, name char(10), salary char(20), phone integer(20))");

    }

    //数据库升级时，此方法会调用
    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
    }


}

这里创建 person.db，并新建Person表，表中有三列 Name,salary,phone.

在Application中进行数据库初始化

public class AppContext extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
        // 需要配合另一个 app 访问 这个app 共享数据。 contentProvider
        AppOpenHelper appOpenHelper = new AppOpenHelper(this);
        appOpenHelper.getReadableDatabase();

        //检测内存是否泄露的工具
        LeakCanary.install(this);
    }
}

ContentProvider

想要对外共享需要遵循一组规则，自定义类需要继承ContentProvider，重写增删改查方法

i

mport android.content.ContentProvider;
import android.content.ContentValues;
import android.content.UriMatcher;
import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.net.Uri;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import com.nuoyuan.preone.db.AppOpenHelper;

/**
 * Created by weichyang on 2017/6/7.
 * 对外提供接口，方便其他应用使用提供的接口进行CURD
 * 1. 定义一个类 继承 ContentProvider
 * 2. 定义匹配规则 指定主机名 + path  code    urimatcher  content://
 * 3. 通过静态代码块添加匹配规则
 * 4. 一定要记得在AndroidManifest.xml 配置内容提供者 不要忘记加 authorities
 */

public class PersonContentProvider extends ContentProvider {

    // ctrl + shift + X(变大写)   变小写  + y
    private static final int QUEYSUCESS = 0;
    private static final int INSERTSUCESS = 1;
    private static final int UPDATESUCESS = 2;
    private static final int DELSUCESS = 3;

    //1 想使用内容提供者 必须定义 匹配规则   code:定义的匹配规则 如果 匹配不上  有一个返回码  -1
    static UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);


    //添加匹配规则，向外部暴漏内部操作api


    static {
        matcher.addURI("com.nuoyuan.prephone.personprovider", "query", QUEYSUCESS);
        matcher.addURI("com.nuoyuan.prephone.personprovider", "insert", INSERTSUCESS);
        matcher.addURI("com.nuoyuan.prephone.personprovider", "update", UPDATESUCESS);
        matcher.addURI("com.nuoyuan.prephone.personprovider", "delete", DELSUCESS);
    }

    private AppOpenHelper helper;


    @Override
    public boolean onCreate() {
        helper = new AppOpenHelper(getContext());
        return false;
    }

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

        int match = matcher.match(uri);
        if (match == QUEYSUCESS) {
            SQLiteDatabase db = helper.getWritableDatabase();
            Cursor cursor = db.query("person", projection, selection, selectionArgs, null, null, sortOrder);

            getContext().getContentResolver().notifyChange(uri, null);
            return cursor;
        } else {
            throw new IllegalArgumentException("路径匹配失败");
        }
    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        //两种类型  Uri统一资源标识符
        //vnd.android.cursor.dir/ 集合类型
        // vnd.android.cursor.item/ 非集合类型

        return null;
    }

    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        int match = matcher.match(uri);
        if (match == INSERTSUCESS) {
            SQLiteDatabase db = helper.getReadableDatabase();
            long insert = db.insert("person", null, values);
            if (insert > 0) {
                getContext().getContentResolver().notifyChange(uri, null);
            }
            Uri uri2 = Uri.parse("com.nuoyuan.prephone.personprovider/" + insert);
            return uri2;
        } else {
            throw new IllegalArgumentException("路径匹配失败");
        }
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {

        int match = matcher.match(uri);
        if (match == DELSUCESS) {
            SQLiteDatabase db = helper.getReadableDatabase();
            int delete = db.delete("person", selection, selectionArgs);

            if (delete > 0) {
                getContext().getContentResolver().notifyChange(uri, null);
            }
            return delete;
        } else {
            throw new IllegalArgumentException("路径匹配失败");
        }
    }

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

        int match = matcher.match(uri);
        if (match == UPDATESUCESS) {
            //匹配成功
            SQLiteDatabase db = helper.getReadableDatabase();
            int update = db.update("person", values, selection, selectionArgs);

            if (update > 0) {
                //大吼一声 数据库发生了改变
                getContext().getContentResolver().notifyChange(uri, null);
            }

            return update;
        } else {
            //匹配失败
            throw new IllegalArgumentException("路径匹配失败");
        }
    }
}

第二步需要在AndroidManifest.xml使用对该ContentProvider进行配置，
为了能让其他应用找到该ContentProvider ，ContentProvider采用了authorities（主机名/域名）对它进行唯一标识。

    <provider
            android:name=".ContentProvider.PersonContentProvider"
            android:authorities="com.nuoyuan.prephone.personprovider"
            android:exported="true" />

这里exported =true。允许外部应用调用改数据共享提供者

Uri介绍

Uri代表了要操作的数据，Uri主要包含了两部分信息：

1>需要操作的ContentProvider .
2>对ContentProvider中的什么数据进行操作，一个Uri由以下几部分组成：

ContentProvider,Uri,ContentResolver,UriMatcher详解

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://com.nuoyuan.prephone.personprovider/person")

UriMatcher

因为Uri代表了要操作的数据路径，所以需要解析Uri，并从Uri中获取数据。
Android系统提供了两个用于操作Uri的工具类，分别为UriMatcher和ContentUris 。掌握它们的使用，会便于我们的开发工作。
UriMatcher类用于匹配Uri，它的用法如下：

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

  //1 想使用内容提供者 必须定义 匹配规则   code:定义的匹配规则 如果 匹配不上  有一个返回码  -1

 private static final int QUEYSUCESS = 0;
    private static final int INSERTSUCESS = 1;
    private static final int UPDATESUCESS = 2;
    private static final int DELSUCESS = 3;


    static UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);

  static {
        matcher.addURI("com.nuoyuan.prephone.personprovider", "query", QUEYSUCESS);
        matcher.addURI("com.nuoyuan.prephone.personprovider", "insert", INSERTSUCESS);
        matcher.addURI("com.nuoyuan.prephone.personprovider", "update", UPDATESUCESS);
        matcher.addURI("com.nuoyuan.prephone.personprovider", "delete", DELSUCESS);
    }
注册完需要匹配的Uri后，就可以使用 int match = matcher.match(uri);方法对输入的Uri进行匹配，
如果匹配就返回匹配码，匹配码是调用addURI()方法传入的第三个参数，如果匹配失败返回-1

ContentUris

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

Uri uri = Uri.parse("content://com.nuoyuan.prephone.personprovider/person")
Uri resultUri = ContentUris.withAppendedId(uri, 10); 
//生成后的Uri为：content://com.ljq.provider.personprovider/person/10
parseId(uri)方法用于从路径中获取ID部分：

Uri uri = Uri.parse("content://com.nuoyuan.prephone.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.nuoyuan.prephone.personprovider/person，那么返回的MIME类型字符串应该为：“vnd.android.cursor.dir/person”。

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

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

ContentResolver

当外部应用需要对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.nuoyuan.prephone.personprovider/person/10”)，那么将会对主机名为com.nuoyuan.prephone.personprovider的ContentProvider进行操作，
操作的数据为person表中id为10的记录。

使用ContentResolver对ContentProvider中的数据进行添加、删除、修改和查询操作：

  private void insertPersonTable() {
        ContentResolver resolver = getContentResolver();
        Uri uri = Uri.parse("content://com.nuoyuan.prephone.personprovider/insert");
        //添加一条记录
        ContentValues values = new ContentValues();
        values.put("name", "wwwww");
        values.put("phone", "13781103217");

        resolver.insert(uri, values);
        //获取person表中所有记录
        Uri uri2 = Uri.parse("content://com.nuoyuan.prephone.personprovider/query");
        Cursor cursor = resolver.query(uri2, null, null, null, null);
        while (cursor.moveToNext()) {
            Log.i("ContentTest", "personid=" + cursor.getInt(0) + ",name=" + cursor.getString(1));
        }
        //把id为1的记录的name字段值更改新为liming
        Uri uri3 = Uri.parse("content://com.nuoyuan.prephone.personprovider/update");
        ContentValues updateValues = new ContentValues();
        updateValues.put("name", "杨卫超");
        resolver.update(uri3, updateValues, null, null);
    }

　监听ContentProvider中数据的变化

如果ContentProvider的访问者需要知道ContentProvider中的数据发生变化，
可以在ContentProvider发生数据变化时调用

getContentResolver().notifyChange(uri, null)来通知注册在此URI上的访问者，例子如下：


  @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {

        int match = matcher.match(uri);
        if (match == DELSUCESS) {
            SQLiteDatabase db = helper.getReadableDatabase();
            int delete = db.delete("person", selection, selectionArgs);

            if (delete > 0) {
                getContext().getContentResolver().notifyChange(uri, null);
            }
            return delete;
        } else {
            throw new IllegalArgumentException("路径匹配失败");
        }
    }
如果ContentProvider的访问者需要得到数据变化通知，必须使用ContentObserver对数据（数据采用uri描述）进行监听，
当监听到数据变化通知时，系统就会调用ContentObserver的onChange()方法：

 private void initListener() {
        Uri uri = Uri.parse("content://com.nuoyuan.prephone.personprovider/#");
        getContentResolver().registerContentObserver(uri, true, new ContentObserver(new Handler()) {
            @Override
            public boolean deliverSelfNotifications() {
                return super.deliverSelfNotifications();
            }

            @Override
            public void onChange(boolean selfChange) {
                super.onChange(selfChange);
                Log.e("--------", "数据库改变!!!");

            }

            @Override
            public void onChange(boolean selfChange, Uri uri) {
                super.onChange(selfChange, uri);
            }
        });
    }
这里#是通配符，匹配所有字符。也就是如上所说的 增删改查操作。

下载地址demo：http://download.csdn.net/detail/o279642707/9869106

相关标签： android

上一篇： ContentProvider内容提供者与ContentResolver内容访问者

下一篇： java中的length和length()以及size()的区别

推荐阅读