深入探索Android应用数据共享之ContentProvider_android 自定义的 contentprovider

本文将深入探讨Android开发中非常重要的数据共享机制 - ContentProvider。

主要内容包括:

• ContentProvider的基本定义及特点
• 如何实现一个自定义的ContentProvider
• ContentProvider对外提供的功能以及对外部应用的权限控制
• 对ContentProvider的一些常见使用场景
• 使用ContentProvider的最佳实践及注意事项

一、什么是ContentProvider?

ContentProvider是Android系统提供的一种在应用之间共享数据的机制，也是 Android 的四大组件之一，可见它在 Android 中的作用非同小可。

其核心思想是通过标准化的接口(增删改查等操作)，让应用程序可以安全地访问和操作彼此的数据。相比直接访问文件或者数据库，ContentProvider提供了更加安全和标准化的数据共享方式。

ContentProvider 可以理解为 Android 应用对外开放的接口，只要是符合它所定义的 URI 格式的请求，均可以正常访问执行操作。

Android 应用之间可以使用 ContentResolver 对象通过与 ContentProvider 同名的方法请求执行，被执行的就是 ContentProvider 中的同名方法。

如图：

二、为什么要使用ContentProvider?

1、数据共享的需求

• 在实际开发中，经常会遇到多个应用之间需要共享数据的场景，比如通讯录应用需要被其他应用访问。

• 如果直接通过文件或数据库共享数据，会带来一些问题，比如数据访问权限难以控制，数据格式不统一等。

• ContentProvider提供了一种标准化的数据共享机制，可以方便地在不同应用之间共享数据。

2、权限控制的需求

• 数据的安全性是移动应用开发中的重中之重。如果直接暴露数据库或文件，很容易造成数据泄露和被篡改的风险。

• ContentProvider可以对数据的访问权限进行精细化控制，开发者可以根据需求设置读写权限，充分保护数据安全。

• 当其他应用请求访问数据时，ContentProvider会进行权限验证，阻止未授权的访问。

3、统一接口的需求

• 不同的应用可能会采用不同的数据存储方式，比如SQLite、文件系统等。这会给数据访问带来一定的复杂性。
• ContentProvider为数据访问提供了标准化的CRUD接口，开发者不需要关心底层的数据存储细节，可以专注于业务逻辑的实现。
• 这种统一的接口不仅简化了开发，也大大提高了代码的可维护性。

4、跨进程通信的需求

• Android应用是基于进程隔离的，不同应用之间的数据是隔离的。
• ContentProvider基于Binder机制实现了进程间通信，让应用之间的数据交互更加顺畅。
• 通过ContentProvider，开发者无需关心进程间通信的底层细节，就可以实现应用间的数据共享。

三、如何实现一个自定义的ContentProvider?

实现一个自定义的ContentProvider需要:

• 第一步，继承ContentProvider类，并实现6个抽象方法。

• 第二步，在AndroidManifest.xml中声明ContentProvider及其Authority。

• 第三步，在其他应用中使用ContentResolver访问ContentProvider提供的数据。

1、首先，我们定义一个名为MyContentProvider的ContentProvider类，它继承自ContentProvider基类:

public class MyContentProvider extends ContentProvider {
    // 声明Authority，这是ContentProvider的唯一标识符
    public static final String AUTHORITY = "com.example.mycontentprovider";

    // 声明Uri常量，用于构建Uri
    public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/users");

    // 声明表名常量
    private static final String TABLE_NAME = "users";

    // 声明数据库相关对象
    private SQLiteDatabase db;
    private MySQLiteOpenHelper dbHelper;

    @Override
    public boolean onCreate() {
        // 初始化数据库
        dbHelper = new MySQLiteOpenHelper(getContext());
        db = dbHelper.getWritableDatabase();
        return true;
    }

    @Override
    public Cursor query(Uri uri， String[] projection， String selection，
                       String[] selectionArgs， String sortOrder) {
        // 执行查询操作
        return db.query(TABLE_NAME， projection， selection， selectionArgs， null， null， sortOrder);
    }

    @Override
    public Uri insert(Uri uri， ContentValues values) {
        // 执行插入操作
        long id = db.insert(TABLE_NAME， null， values);
        return ContentUris.withAppendedId(CONTENT_URI， id);
    }

    @Override
    public int update(Uri uri， ContentValues values， String selection，
                     String[] selectionArgs) {
        // 执行更新操作
        return db.update(TABLE_NAME， values， selection， selectionArgs);
    }

    @Override
    public int delete(Uri uri， String selection， String[] selectionArgs) {
        // 执行删除操作
        return db.delete(TABLE_NAME， selection， selectionArgs);
    }

    @Override
    public String getType(Uri uri) {
        // 返回MIME类型，这里以"vnd.android.cursor.dir/vnd.com.example.mycontentprovider.users"为例
        return "vnd.android.cursor.dir/vnd." + AUTHORITY + "." + TABLE_NAME;
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

2、接下来，我们需要在应用的AndroidManifest.xml文件中声明这个自定义的ContentProvider:

<provider
    android:name=".MyContentProvider"
    android:authorities="com.example.mycontentprovider"
    android:exported="true" />
1
2
3
4

其中，android:authorities属性指定了ContentProvider的Authority，必须与前面定义的AUTHORITY字符串一致。android:exported属性表示ContentProvider是否对其他应用开放，这里设置为true。

3、现在，我们可以在其他应用中使用这个自定义的ContentProvider了

比如，在另一个应用中，我们可以通过以下代码访问MyContentProvider中的数据:

// 构建Uri
Uri uri = MyContentProvider.CONTENT_URI;

// 执行查询操作
Cursor cursor = getContentResolver().query(uri， null， null， null， null);

// 遍历查询结果
while (cursor.moveToNext()) {
    int id = cursor.getInt(cursor.getColumnIndex("id"));
    String name = cursor.getString(cursor.getColumnIndex("name"));
    // 处理数据
    Log.d("MyApp"， "id: " + id + "， name: " + name);
}
1
2
3
4
5
6
7
8
9
10
11
12
13

在这个示例中，我们首先通过MyContentProvider.CONTENT_URI构建了访问MyContentProvider的Uri。然后，使用getContentResolver().query()方法执行查询操作，并遍历查询结果，获取数据。

类似地，我们还可以使用insert()、update()和delete()方法对数据进行增删改操作。

四、ContentProvider的常见使用场景

1、访问系统级别的数据

• Android系统自带了一些ContentProvider，例如Contacts、Media、Calendar等，开发者可以通过这些ContentProvider访问系统级别的数据，如通讯录、图片、日历等。

• 这些系统级ContentProvider提供了标准化的接口，开发者无需关心底层实现，就可以方便地获取和操作系统数据。

2、实现应用间的数据共享

• 在实际开发中，经常会有多个应用之间需要共享数据的需求，比如社交应用需要获取用户的联系人信息。
• 开发者可以自定义ContentProvider，将应用内部的数据暴露给其他应用使用。通过设置合适的读写权限，既可以保证数据安全，又可以实现应用间的数据共享。

3、支持应用内部的数据持久化

• 除了实现应用间的数据共享，ContentProvider也可以用于应用内部的数据持久化。

• 例如，开发者可以结合Room或SQLite，将ContentProvider作为应用内部数据库的对外接口，为上层的ViewModel和UI层提供标准化的数据访问方式。

4、配合Android Jetpack实现数据驱动的UI

• 近年来，随着Android Jetpack的广泛应用，ViewModel和LiveData成为了实现数据驱动型UI的主流方案。
• 在这种架构中，ContentProvider可以作为数据源，为ViewModel提供标准化的数据访问接口，ViewModel则负责观察数据变化，实时刷新UI。这种设计可以大大提高代码的可维护性和可测试性。

5、实现文件共享

• ContentProvider不仅可以用于共享结构化数据，也可以用于共享文件数据。

• 开发者可以自定义ContentProvider，将应用内部的文件资源暴露给其他应用使用，例如实现文件或图片的跨应用共享。

五、使用ContentProvider的最佳实践及注意事项

1、合理设计Authority和Uri ，使用ContentUris管理Uri

• Authority是ContentProvider的唯一标识符，应该具有唯一性和可读性。通常采用反域名的形式，如"com.example.myprovider"。
• Uri是用于访问ContentProvider数据的标识，应该遵循一定的命名规范，例如"content://com.example.myprovider/users"。
• 合理设计Authority和Uri可以提高代码的可读性和可维护性，同时也有利于权限控制。

public class MyContentProvider extends ContentProvider {
    public static final String AUTHORITY = "com.example.mycontentprovider";
    public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/users");

    @Override
    public Uri insert(Uri uri， ContentValues values) {
        // 执行插入操作
        long id = db.insert(TABLE_NAME， null， values);
        return ContentUris.withAppendedId(CONTENT_URI， id);
    }

    @Override
    public Cursor query(Uri uri， String[] projection， String selection，
                       String[] selectionArgs， String sortOrder) {
        // 判断操作对象是单个记录还是记录集合
        if (ContentUris.parseId(uri) != -1) {
            // 查询单个记录
            selection = BaseColumns._ID + " = ?";
            selectionArgs = new String[] { String.valueOf(ContentUris.parseId(uri)) };
        }
        // 执行查询操作
        return db.query(TABLE_NAME， projection， selection， selectionArgs， null， null， sortOrder);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

上面示例，我们使用了ContentUris工具类来管理Uri。

在insert()方法中，我们使用ContentUris.withAppendedId()方法在基础Uri后附加记录id，生成唯一的Uri。

在query()方法中，我们使用ContentUris.parseId()方法解析Uri中的记录id，根据id进行针对性的查询操作。

这种方式可以更好地规范化Uri的使用。

2、合理控制读写权限

• ContentProvider提供了灵活的权限控制机制，开发者可以针对不同的操作(增删改查)设置不同的权限。
• 合理控制读写权限可以提高数据的安全性，防止未经授权的访问。同时，也可以根据业务需求，灵活地控制其他应用对数据的访问范围。

public class MyContentProvider extends ContentProvider {
    public static final String AUTHORITY = "com.example.mycontentprovider";
    private static final String TABLE_NAME = "users";

    @Override
    public boolean onCreate() {
        // 初始化数据库
        // ...
        return true;
    }

    @Override
    public Cursor query(Uri uri， String[] projection， String selection，
                       String[] selectionArgs， String sortOrder) {
        // 检查访问权限
        if (getContext().checkCallingOrSelfPermission(Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED) {
            throw new SecurityException("Permission denied to access the data");
        }
        // 执行查询操作
        return db.query(TABLE_NAME， projection， selection， selectionArgs， null， null， sortOrder);
    }

    @Override
    public Uri insert(Uri uri， ContentValues values) {
        // 检查访问权限
        if (getContext().checkCallingOrSelfPermission(Manifest.permission.WRITE_CONTACTS) != PackageManager.PERMISSION_GRANTED) {
            throw new SecurityException("Permission denied to access the data");
        }
        // 执行插入操作
        long id = db.insert(TABLE_NAME， null， values);
        return ContentUris.withAppendedId(CONTENT_URI， id);
    }

    // 其他方法的实现类似
}


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

上面示例中，我们在query()和insert()方法中分别检查了读和写权限。如果调用方没有所需的权限，则抛出SecurityException拒绝访问。这样可以确保数据的安全性。

3、合理使用MIME类型，遵循MIME类型约定

• MIME类型描述了ContentProvider返回的数据类型，应该根据实际情况设置合理的MIME类型。
• 正确的MIME类型可以帮助其他应用正确地解析和处理ContentProvider提供的数据。

@Override
public String getType(Uri uri) {
    // 根据Uri返回对应的MIME类型
    if (uri.equals(CONTENT_URI)) {
        return "vnd.android.cursor.dir/vnd." + AUTHORITY + "." + TABLE_NAME;
    } else if (ContentUris.parseId(uri) != -1) {
        return "vnd.android.cursor.item/vnd." + AUTHORITY + "." + TABLE_NAME;
    }
    throw new IllegalArgumentException("Unknown URI " + uri);
}
1
2
3
4
5
6
7
8
9
10

在上述实现中，我们根据Uri的类型返回了不同的MIME类型字符串。

当Uri表示记录集合时，我们返回"vnd.android.cursor.dir/"前缀。

当Uri表示单个记录时，我们返回"vnd.android.cursor.item/"前缀。

这样做可以让其他应用更好地识别和处理ContentProvider提供的数据。

4、注意线程安全，合理处理异常情况

• 注意线程安全，避免多线程访问时出现的数据竞争问题

• 在实现ContentProvider的各个方法时，应该合理地处理可能出现的异常情况，例如数据库操作异常、权限验证失败等。

• 合理的异常处理可以提高应用的健壮性，同时也有利于定位和解决问题。

private final ReentrantLock lock = new ReentrantLock();

@Override
public Cursor query(Uri uri， String[] projection， String selection，
                   String[] selectionArgs， String sortOrder) {
    lock.lock();
    try {
        // 执行查询操作
        return db.query(TABLE_NAME， projection， selection， selectionArgs， null， null， sortOrder);
    } finally {
        lock.unlock();
    }
}

@Override
public Uri insert(Uri uri， ContentValues values) {
    lock.lock();
    try {
        // 执行插入操作
        long id = db.insert(TABLE_NAME， null， values);
        return ContentUris.withAppendedId(CONTENT_URI， id);
    } finally {
        lock.unlock();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

在上述示例中，我们使用了ReentrantLock来保证ContentProvider各个方法的线程安全。

在执行数据库操作时，我们先获取锁，操作完成后再释放锁。这样可以避免多线程访问时出现的数据竞争问题。

六、结语

ContentProvider作为Android系统提供的标准化数据共享机制，在开发过程中扮演着非常重要的角色。

通过深入理解其工作原理，我们不仅可以轻松实现应用间的数据交互，还能够提升数据访问的安全性和可维护性。

相信通过本文的介绍，你已经掌握了使用ContentProvider的核心知识，相信在后续的Android开发之路上，一定能游刃有余。

那么让我们一起期待下一篇文章的精彩内容吧!