Android Provider用法

本文深入解析Android中的ContentProvider组件,探讨其在数据存储、共享及安全方面的应用。文章讲解了ContentProvider的基本概念、如何创建和使用ContentProvider,以及如何通过设置权限实现数据的安全共享。

https://blog.youkuaiyun.com/forwardto9/article/details/79771388

ContentProvider

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

之所以使用ContentProvider,主要有以下几个理由:
1,ContentProvider提供了对底层数据存储方式的抽象。比如下图中,底层使用了SQLite数据库,在用了ContentProvider封装后,即使你把数据库换成MongoDB,也不会对上层数据使用层代码产生影响。

2,Android框架中的一些类需要ContentProvider类型数据。如果你想让你的数据可以使用在如SyncAdapter, Loader, CursorAdapter等类上,那么你就需要为你的数据做一层ContentProvider封装。

3,第三个原因也是最主要的原因,是ContentProvider为应用间的数据交互提供了一个安全的环境。它准许你把自己的应用数据根据需求开放给其他应用进行增、删、改、查,而不用担心直接开放数据库权限而带来的安全问题。

ContentProvider是对数据层的封装,我们可以通过ContentResolver,来对不同的ContentProvider进行增,删,改,查的操作。

ContentResolver

有些人可能会疑惑,为什么我们不直接访问Provider,而是又在上面加了一层ContentResolver来进行对其的操作,这样岂不是更复杂了吗?其实不然,大家要知道一台手机中可不是只有一个Provider内容,它可能安装了很多含有Provider的应用,比如联系人应用,日历应用,字典应用等等。所以Android提供了ContentResolver来统一管理与不同ContentProvider间的操作。

Context.java的源码中有一段

 
  1. /** Return a ContentResolver instance for your application's package. */

  2. public abstract ContentResolver getContentResolver();

  3.  

所以我们可以通过在所有继承Context的类中通过调用getContentResolver()来获得ContentResolver

那ContentResolver是如何来区别不同的ContentProvider的呢?这就涉及到URI(Uniform Resource Identifier)问题,对URI是什么还不明白的童鞋请自行Google。

ContentProvider中的URI

ContentProvider中的URI有固定格式,如下图:

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

 

URI组装代码示例:

 
  1. public class TestContract {

  2.  
  3. protected static final String CONTENT_AUTHORITY = "me.pengtao.contentprovidertest";

  4. protected static final Uri BASE_CONTENT_URI = Uri.parse("content://" + CONTENT_AUTHORITY);

  5.  
  6. protected static final String PATH_TEST = "test";

  7. public static final class TestEntry implements BaseColumns {

  8.  
  9. public static final Uri CONTENT_URI = BASE_CONTENT_URI.buildUpon().appendPath(PATH_TEST).build();

  10. protected static Uri buildUri(long id) {

  11. return ContentUris.withAppendedId(CONTENT_URI, id);

  12. }

  13.  
  14. protected static final String TABLE_NAME = "test";

  15.  
  16. public static final String COLUMN_NAME = "name";

  17. }

  18. }

  19.  

从上面代码我们可以看到,我们创建了一个
content://me.pengtao.contentprovidertest/test的uri,并且开了一个静态方法,用以在有新数据产生时根据id生成新的uri。下面介绍下如何把此uri映射到数据库表中。

实作

首先我们创建一个自己的TestProvider继承ContentProvider。默认该Provider需要实现如下六个方法,onCreate(), query(Uri, String[], String, String[], String),insert(Uri, ContentValues), update(Uri, ContentValues, String, String[]), delete(Uri, String, String[]), getType(Uri),方法的具体介绍可以参考
http://developer.android.com/reference/android/content/ContentProvider.html

下面我们以实现insert和query方法为例

 
  1. private final static int TEST = 100;

  2.  
  3. static UriMatcher buildUriMatcher() {

  4. final UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);

  5. final String authority = TestContract.CONTENT_AUTHORITY;

  6.  
  7. matcher.addURI(authority, TestContract.PATH_TEST, TEST);

  8.  
  9. return matcher;

  10. }

  11.  
  12. @Nullable

  13. @Override

  14. public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {

  15. final SQLiteDatabase db = mOpenHelper.getReadableDatabase();

  16.  
  17. Cursor cursor = null;

  18. switch ( buildUriMatcher().match(uri)) {

  19. case TEST:

  20. cursor = db.query(TestContract.TestEntry.TABLE_NAME, projection, selection, selectionArgs, sortOrder, null, null);

  21. break;

  22. }

  23.  
  24. return cursor;

  25. }

  26.  
  27. @Nullable

  28. @Override

  29. public Uri insert(Uri uri, ContentValues values) {

  30. final SQLiteDatabase db = mOpenHelper.getWritableDatabase();

  31. Uri returnUri;

  32. long _id;

  33. switch ( buildUriMatcher().match(uri)) {

  34. case TEST:

  35. _id = db.insert(TestContract.TestEntry.TABLE_NAME, null, values);

  36. if ( _id > 0 )

  37. returnUri = TestContract.TestEntry.buildUri(_id);

  38. else

  39. throw new android.database.SQLException("Failed to insert row into " + uri);

  40. break;

  41. default:

  42. throw new android.database.SQLException("Unknown uri: " + uri);

  43. }

  44. return returnUri;

  45. }

  46.  

此例中我们可以看到,我们根据path的不同,来区别对不同的数据库表进行操作,从而完成uri与具体数据库间的映射关系。

因为ContentProvider作为四大组件之一,所以还需要在AndroidManifest.xml中注册一下。

 
  1. <provider

  2. android:authorities="me.pengtao.contentprovidertest"

  3. android:name=".provider.TestProvider" />

然后你就可以使用getContentResolver()方法来对该ContentProvider进行操作了,ContentResolver对应ContentProvider也有insert,query,delete等方法,详情请参考:
http://developer.android.com/reference/android/content/ContentResolver.html

此处因为我们只实现了ContentProvider的query和insert的方法,所以我们可以进行插入和查询处理。如下我们可以在某个Activity中进行如下操作,先插入一个数据peng,然后再从从表中读取第一行数据中的第二个字段的值。

 
  1. ContentValues contentValues = new ContentValues();

  2. contentValues.put(TestContract.TestEntry.COLUMN_NAME, "peng");

  3. contentValues.put(TestContract.TestEntry._ID, System.currentTimeMillis());

  4. getContentResolver().insert(TestContract.TestEntry.CONTENT_URI, contentValues);

  5.  
  6. Cursor cursor = getContentResolver().query(TestContract.TestEntry.CONTENT_URI, null, null, null, null);

  7.  
  8. try {

  9. Log.e("ContentProviderTest", "total data number = " + cursor.getCount());

  10. cursor.moveToFirst();

  11. Log.e("ContentProviderTest", "total data number = " + cursor.getString(1));

  12. } finally {

  13. cursor.close();

  14. }

  15.  

数据共享

以上例子中创建的ContentProvider只能在本应用内访问,那如何让其他应用也可以访问此应用中的数据呢,一种方法是向此应用设置一个android:sharedUserId,然后需要访问此数据的应用也设置同一个sharedUserId,具有同样的sharedUserId的应用间可以共享数据。

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

首先我们先介绍下,共享数据所涉及到的几个重要标签:
android:exported 设置此provider是否可以被其他应用使用。
android:readPermission 该provider的读权限的标识
android:writePermission 该provider的写权限标识
android:permission provider读写权限标识
android:grantUriPermissions 临时权限标识,true时,意味着该provider下所有数据均可被临时使用;false时,则反之,但可以通过设置<grant-uri-permission>标签来指定哪些路径可以被临时使用。这么说可能还是不容易理解,我们举个例子,比如你开发了一个邮箱应用,其中含有附件需要第三方应用打开,但第三方应用又没有向你申请该附件的读权限,但如果你设置了此标签,则可以在start第三方应用时,传入FLAG_GRANT_READ_URI_PERMISSIONFLAG_GRANT_WRITE_URI_PERMISSION来让第三方应用临时具有读写该数据的权限。

知道了这些标签用法后,让我们改写下AndroidManifest.xml,让ContentProvider可以被其他应用查询。

声明一个permission

<permission android:name="me.pengtao.READ" android:protectionLevel="normal"/>

然后改变provider标签为

 
  1. <provider

  2. android:authorities="me.pengtao.contentprovidertest"

  3. android:name=".provider.TestProvider"

  4. android:readPermission="me.pengtao.READ"

  5. android:exported="true">

  6. </provider>

  7.  

则在其他应用中可以使用以下权限来对TestProvider进行访问。

<uses-permission android:name="me.pengtao.READ"/>

有人可能又想问,如果我的provider里面包含了不同的数据表,我希望对不同的数据表有不同的权限操作,要如何做呢?Android为这种场景提供了provider的子标签<path-permission>,path-permission包括了以下几个标签。

 
  1. <path-permission android:path="string"

  2. android:pathPrefix="string"

  3. android:pathPattern="string"

  4. android:permission="string"

  5. android:readPermission="string"

  6. android:writePermission="string" />

可以对不同path设置不同的权限规则,具体如何设定我这里就不做详细介绍了,可以参考
http://developer.android.com/guide/topics/manifest/path-permission-element.html

进阶原理介绍

可以参考:http://gityuan.com/2016/07/30/content-provider/

Android ProviderAndroid 系统提供的一种数据存储方式,它提供了可供其他应用程序访问的公共数据集合。使用 Provider 可以实现数据共享,使得不同的应用程序可以访问和修改同一数据集合,从而实现数据的共享和协作。 在 Android 中,Provider 通常用于存储和共享应用程序的数据,比如联系人、短信、音乐、视频等。开发者可以通过 ContentResolver 类来访问 Provider 中的数据。 使用 Provider 的步骤如下: 1. 创建数据表结构:定义 Provider 中所需的数据表结构; 2. 创建 ContentProvider 子类:实现 Provider 中的 CRUD(增删改查)操作; 3. 在 AndroidManifest.xml 文件中注册 ContentProvider:声明 Provider 的信息; 4. 在应用程序中使用 ContentResolver 访问 Provider 中的数据。 接下来是一个简单的示例,演示如何创建一个 Provider 并向其中插入一条数据: 1. 首先,定义 Provider 中需要使用的数据表结构,比如: ``` public class MyProvider extends SQLiteOpenHelper { // 声明数据库名和版本号 public static final String DB_NAME = "my_provider.db"; public static final int DB_VERSION = 1; // 声明数据表名和字段名 public static final String TABLE_NAME = "users"; public static final String COLUMN_ID = "id"; public static final String COLUMN_NAME = "name"; // 构造函数 public MyProvider(Context context) { super(context, DB_NAME, null, DB_VERSION); } // 创建数据表 @Override public void onCreate(SQLiteDatabase db) { db.execSQL("CREATE TABLE " + TABLE_NAME + " (" + COLUMN_ID + " INTEGER PRIMARY KEY AUTOINCREMENT, " + COLUMN_NAME + " TEXT NOT NULL" + ");"); } // 升级数据表 @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { db.execSQL("DROP TABLE IF EXISTS " + TABLE_NAME); onCreate(db); } } ``` 2. 然后,创建一个 ContentProvider 子类,继承自 ContentProvider,并实现 CRUD 操作,比如: ``` public class MyContentProvider extends ContentProvider { // 声明 Provider 的唯一标识 public static final String AUTHORITY = "com.example.myprovider"; // 声明 UriMatcher 对象 private static final UriMatcher sUriMatcher = new UriMatcher(UriMatcher.NO_MATCH); private static final int USERS = 1; private static final int USER_ID = 2; // 声明 MyProvider 对象 private MyProvider mProvider; // 初始化 UriMatcher static { sUriMatcher.addURI(AUTHORITY, MyProvider.TABLE_NAME, USERS); sUriMatcher.addURI(AUTHORITY, MyProvider.TABLE_NAME + "/#", USER_ID); } // 获取 ContentProvider使用的数据源 @Override public boolean onCreate() { mProvider = new MyProvider(getContext()); return true; } // 查询数据 @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { SQLiteDatabase db = mProvider.getReadableDatabase(); Cursor cursor = null; switch (sUriMatcher.match(uri)) { case USERS: cursor = db.query(MyProvider.TABLE_NAME, projection, selection, selectionArgs, null, null, sortOrder); break; case USER_ID: String id = uri.getLastPathSegment(); cursor = db.query(MyProvider.TABLE_NAME, projection, MyProvider.COLUMN_ID + "=?", new String[]{id}, null, null, sortOrder); break; default: throw new IllegalArgumentException("Unknown URI: " + uri); } cursor.setNotificationUri(getContext().getContentResolver(), uri); return cursor; } // 插入数据 @Override public Uri insert(Uri uri, ContentValues values) { SQLiteDatabase db = mProvider.getWritableDatabase(); long id = db.insert(MyProvider.TABLE_NAME, null, values); if (id > 0) { Uri itemUri = ContentUris.withAppendedId(uri, id); getContext().getContentResolver().notifyChange(uri, null); return itemUri; } else { throw new SQLException("Failed to insert row into " + uri); } } // 更新数据 @Override public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { SQLiteDatabase db = mProvider.getWritableDatabase(); int count = 0; switch (sUriMatcher.match(uri)) { case USERS: count = db.update(MyProvider.TABLE_NAME, values, selection, selectionArgs); break; case USER_ID: String id = uri.getLastPathSegment(); count = db.update(MyProvider.TABLE_NAME, values, MyProvider.COLUMN_ID + "=?", new String[]{id}); break; default: throw new IllegalArgumentException("Unknown URI: " + uri); } getContext().getContentResolver().notifyChange(uri, null); return count; } // 删除数据 @Override public int delete(Uri uri, String selection, String[] selectionArgs) { SQLiteDatabase db = mProvider.getWritableDatabase(); int count = 0; switch (sUriMatcher.match(uri)) { case USERS: count = db.delete(MyProvider.TABLE_NAME, selection, selectionArgs); break; case USER_ID: String id = uri.getLastPathSegment(); count = db.delete(MyProvider.TABLE_NAME, MyProvider.COLUMN_ID + "=?", new String[]{id}); break; default: throw new IllegalArgumentException("Unknown URI: " + uri); } getContext().getContentResolver().notifyChange(uri, null); return count; } // 获取 MIME 类型 @Override public String getType(Uri uri) { switch (sUriMatcher.match(uri)) { case USERS: return "vnd.android.cursor.dir/" + AUTHORITY + "." + MyProvider.TABLE_NAME; case USER_ID: return "vnd.android.cursor.item/" + AUTHORITY + "." + MyProvider.TABLE_NAME; default: throw new IllegalArgumentException("Unknown URI: " + uri); } } } ``` 3. 在 AndroidManifest.xml 文件中注册 ContentProvider,比如: ``` <provider android:name=".MyContentProvider" android:authorities="com.example.myprovider" android:exported="false" /> ``` 4. 在应用程序中使用 ContentResolver 访问 Provider 中的数据,比如: ``` // 查询用户列表 Cursor cursor = getContentResolver().query(Uri.parse("content://com.example.myprovider/users"), null, null, null, null); while (cursor.moveToNext()) { int id = cursor.getInt(cursor.getColumnIndex(MyProvider.COLUMN_ID)); String name = cursor.getString(cursor.getColumnIndex(MyProvider.COLUMN_NAME)); Log.d(TAG, "id=" + id + ", name=" + name); } // 插入一条用户数据 ContentValues values = new ContentValues(); values.put(MyProvider.COLUMN_NAME, "Alice"); Uri uri = getContentResolver().insert(Uri.parse("content://com.example.myprovider/users"), values); Log.d(TAG, "insert uri: " + uri); // 更新用户数据 values.put(MyProvider.COLUMN_NAME, "Bob"); int count = getContentResolver().update(Uri.parse("content://com.example.myprovider/users/1"), values, null, null); Log.d(TAG, "update count: " + count); // 删除用户数据 count = getContentResolver().delete(Uri.parse("content://com.example.myprovider/users/1"), null, null); Log.d(TAG, "delete count: " + count); ```
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值