Content Provider 与 File Provider

已于 2024-05-09 14:18:00 修改
阅读量2.4k 收藏 3
点赞数 1
分类专栏： Android 学习笔记 文章标签： android java 学习
于 2022-10-01 21:00:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/AmieVastness/article/details/127135082
版权

Android 学习笔记 —— Content Provider 与 File Provider

Content Provider

Content Provider（内容提供器）主要用于在不同的应用程序之间实现数据共享的功能。它为应用程序存取数据提供统一的外部接口，它不同应用之间得以共享数据，同时还能保证被访问数据的安全性。

创建自定义 Content Provider

Android Studio 提供了快速创建 Content Provider 的方式，和 Broadcast Receiver 一样。

  1. 在对应包上右键 -> New -> Other -> Content Provider。填写 Provider 类名和 Uri Authorities。在创建时 Authorities 可先乱填，创建完成后再修改。

  2. 在 AndroidManifest 中修改 Authorities。通常填入该 Provider 的完整类名，如在 privider 包下，则填入 com.amie.test.provider.CustomProvider。

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.amie.test">
    <application ... >
        <provider
            android:name=".provider.UserInfoProvider"
            android:authorities="com.amie.test.provider.CustomProvider"
            android:enabled="true"
            android:exported="true" />
        <!-- ... -->
    </application>
</manifest>

  3. Content Provider 是通过 Uri 来访问的，可以借助 UriMatcher 匹配不同格式的 Uri，同时所有的操作都要匹配到相应的 Uri 才可以被执行。Content Provider 的标准 Uri 格式为 content://<AUTHORITY>/<PATH>，例如 content://com.amie.test.provider.CustomProvider/tb_user。

    Uri 后面可以添加一个参数值，通常为 id。如 content://com.amie.test.provider.CustomProvider/tb_user/1 表示访问 tb_user 表中 id 为 1 的数据。对于这种格式的 Uri 还可以使用通配符来匹配。

    • *：表示匹配任意长度的任意字符。
    • #：表示匹配任意长度的数字。
    public class UserInfoProvider extends ContentProvider {
    private static final String AUTHORITY = "com.amie.test.provider.UserInfoProvider";
    private static final int ALL_TABLE = 0;
    private static final int TB_USER_DIR = 1;
    private static final int TB_USER_ITEM = 2;
    private static final int TB_TEST_DIR = 3;
    private static final int TB_TEST_ITEM = 4;

    private static UriMatcher uriMatcher;

    static {
        uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
        // 第二个参数是希望匹配的路径
        // 第三个参数是自定义代码，作为 uriMatcher.match(uri) 方法的返回值
        uriMatcher.addURI(AUTHORITY, "tb_user", TB_USER_DIR);
        uriMatcher.addURI(AUTHORITY, "tb_user/#", TB_USER_ITEM);
        uriMatcher.addURI(AUTHORITY, "tb_test", TB_TEST_DIR);
        uriMatcher.addURI(AUTHORITY, "tb_test/#", TB_TEST_ITEM);
        // * 可以用来匹配所有表
        // uriMatcher.addURI(AUTHORITY, "*", ALL_TABLE);
    }

    // 以 query 查询和 insert 插入方法为例，匹配不同格式 Uri 执行不同操作
    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
        LogUtil.i("UserInfoProvider query");
        SQLiteDatabase db = databaseHelper.getReadableDatabase();
        Cursor cursor = null;
        switch (uriMatcher.match(uri)) {
            case TB_USER_DIR:
                // 查询 tb_user 表中的所有数据
                cursor = db.query("tb_user", null, null, null, null, null, sortOrder);
                break;
            case TB_USER_ITEM:
                // 查询 tb_user 表中的单条数据
                cursor = db.query("tb_user", projection, selection, selectionArgs, null, null, sortOrder);
                break;
            case TB_TEST_DIR:
                // TODO 查询 tb_test 表中的所有数据
                break;
            case TB_TEST_ITEM:
                // TODO 查询 tb_test 表中的单条数据
                break;
        }
        return cursor;
    }

    @Override
    public Uri insert(Uri uri, ContentValues values) {
        LogUtil.i("UserInfoProvider insert");
        Uri uriReturn = null; // content://com.amie.providerserver.provider.UserInfoProvider/user
        if (values.size() <= 0) { // 空数据直接返回
            return null;
        }
        // 客户端传入的 ContentValues 数据可能不规范，此处作为服务端一定要验证，避免插入不良数据
        // 创建一个新的 ContentValues 作为数据验证后最终插入的数据
        ContentValues mValues = null;
        SQLiteDatabase db = databaseHelper.getWritableDatabase();
        switch (uriMatcher.match(uri)) {
            case TB_USER_DIR:
            case TB_USER_ITEM:
                mValues = new ContentValues();
                // 获取所需数据并开始验证
                Object name = values.get("name");
                Object age = values.get("age");
                Object gander = values.get("gander");
                // _id 应该是自动生成的，如果传入值可能会破坏 _id 顺序
                // 如果用户在 EditText 中没有输入任何内容，但是调用 getText().toString() 方法返回的是空字符串
                // 空字符串不应该作为正常数据插入，必须手动处理
                // 这里一定要使用 !"".equals(Object) 进行判断，使用 != 无效
                if (name != null && !"".equals(name)) {
                    mValues.put("name", name.toString());
                    if (age != null && !"".equals(age)) {
                        mValues.put("age", Integer.parseInt(age.toString()));
                    }
                    if (gander != null && !"".equals(gander)) {
                        mValues.put("gander", Integer.parseInt(gander.toString()));
                    }
                }
                if (mValues.size() <= 0) { // 验证后数据为空直接返回
                    return null;
                }
                // 向 tb_user 表中插入数据，这里传入的值为 mValues
                long newUserId = db.insert("tb_user", null,  mValues);
                uriReturn = Uri.parse("content://" + AUTHORITIES + "/tb_user/" + newUserId);
            case TB_TEST_DIR:
            case TB_TEST_ITEM:
                // TODO 向 tb_test 表中插入数据
                break;
        }
        return uriReturn;
    }
    // ...
}

  4. 上面的步骤完成后，这个 Content Provider 已经可以正常使用了，却还有一个 getType() 方法没有实现。事实上，这个方法是用来获取 Uri 对象所对应的 MIME 类型。Android 对 MIME 字符串进行了规定：

    • 必须以 vnd 开头。
    • 如果 Content Uri 以路径结尾，则 vnd 后接 android.cursor.dir/，如果 Content Uri 以 id 结尾，则 vnd 后接 android.cursor.item/。
    • 最后接上 vnd.<AUTHORITIES>.<PATH>。
    @Override
public String getType(Uri uri) {
    switch (uriMatcher.match(uri)) {
        case TB_USER_DIR:
            // "vnd.android.cursor.dir/vnd.com.amie.test.provider.UserInfoProvider.tb_user"
            return "vnd.android.cursor.dir/vnd." + AUTHORITIES + ".tb_user";
        case TB_USER_ITEM:
            // "vnd.android.cursor.item/vnd.com.amie.test.provider.UserInfoProvider.tb_user"
            return "vnd.android.cursor.item/vnd." + AUTHORITIES + ".tb_user";
        case TB_TEST_DIR:
            return "vnd.android.cursor.dir/vnd." + AUTHORITIES + ".tb_test";
        case TB_TEST_ITEM:
            return "vnd.android.cursor.item/vnd." + AUTHORITIES + ".tb_test";
    }
    return null;
}

访问 Content Provider

前面说了 Content Provider 是用于在不同的应用程序之间实现数据共享的，那么访问 Content Provider 就需要在另一个应用中去实现。

Context 提供了一个 getContentResolver() 方法去获取 ContentResolver 对象，通过它就可以调用 insert() 等方法。

注意：出于安全考虑，Android 11 要求应用在 AndroidManifest 中事先说明需要访问的其他软件包或 provider，不然无法运行。 具体做法是在 AndroidManifest 添加 <queries> 标签及内容。

<!-- 出于安全考虑，Android 11 要求应用事先说明需要访问的其他软件包或 provider -->
<manifest ... >
    <!-- ... -->
    <queries>
        <!-- 指定服务端的包名 -->
        <package android:name="com.amie.providerserver" />
        <!-- 指定服务端 Provider 的 authorities -->
        <provider android:authorities="com.amie.providerserver.provider.UserInfoProvider" />
    </queries>
    <!-- ... -->
</manifest>

File Provider

Android 7.0 开启了严格模式（StrictMode），Android 框架执行的 StrictMode API 政策禁止在您的应用外部公开 file://Uri。也就是说无法直接将一个 File Uri 共享给另一个程序进行使用。

FileProvider 是 Android 7.0 出现的新特性，它是 ContentProvider 的子类，可以通过创建一个 Content Uri 并赋予临时的文件访问权限来代替 File Uri 实现文件共享。简单来说就是将自身内部文件暴露给其他应用，并授予临时的文件读写权限。常见使用场景有，调用相机拍照和图片裁剪、应用升级调用系统应用安装器安装 APK。

使用步骤：

  1. 定义 FileProvider。

    <!-- authorities：一个标识，在当前系统内必须是唯一值，一般用 <package_name>.FileProvider。 -->
<!-- 这里使用官方提供的 FileProvider，name 规定为 androidx.core.content.FileProvider。推荐自定义 FileProvider -->
<!-- grantUriPermissions：是否允许通过 Uri 授予文件的临时访问权限。必须设置为 true。 -->
<!-- exported：表示是否对外公开。FileProvider 不需要也不应该对任何应用公开，为了安全必须为 false。 -->
<provider
    android:authorities="com.amie.cameraalbum.FileProvider"
    android:name="androidx.core.content.FileProvider"
    android:grantUriPermissions="true"
    android:exported="false" />

  2. 在 res 目录下创建 xml 安卓资源文件夹，在其中创建 file_paths.xml 文件，并定义可通过该 FileProvider 访问到的文件路径。

    <!-- res/xml/file_paths.xml -->
<?xml version="1.0" encoding="utf-8"?>
<paths>
    <!-- external-path 对应 Environment.getExternalStorageDirectory() 指向的目录。即 /storage/emulated/0 -->
    <external-path name="external_storage_root" path="." />

    <!-- files-path 对应 content.getFileDir() 获取到的目录。即 /data/data/<package_name>/files -->
    <files-path name="files-path" path="." />

    <!-- cache-path 对应 content.getCacheDir() 获取到的目录。即 /data/data/<package_name>/cache -->
    <cache-path name="cache-path" path="." />

    <!-- external-files-path 对应 ContextCompat.getExternalFilesDirs() 获取到的目录。即 /storage/emulated/0/Android/data/<package_name>/files -->
    <external-files-path name="external_file_path" path="." />

    <!-- external-cache-path 对应 ContextCompat.getExternalCacheDirs() 获取到的目录。即 /storage/emulated/0/Android/data/<package_name>/cache -->
    <external-cache-path name="external_cache_path" path="." />

    <!-- root-path 对应 DEVICE_ROOT,也就是 File DEVICE_ROOT = new File("/")，即根目录 "/"，一般不需要配置，标签上也有警告 Element root-path is not allowed here。 -->
    <!--配置 root-path 可以读取到 sd 卡和一些应用分身的目录，否则微信等应用分身保存的图片，在读取时会出现非法参数异常 java.lang.IllegalArgumentException: Failed to find configured root that contains /storage/emulated/999/tencent/MicroMsg/WeiXin/export1544062754693.jpg -->
    <root-path name="root-path" path="" />
</paths>

  3. 为定义的 FileProvider 添加文件路径。

    <provider
    ... >
    <!-- 配置哪些路径可以通过 FileProvider 访问 -->
    <meta-data android:name="android.support.FILE_PROVIDER_PATHS" android:resource="@xml/file_paths"/>
</provider>

  4. 为特定文件生成 Content Uri。FileProvider 提供了 getUriForFile() 方法生成 ContentUri。注意使用的文件路径必须是前面在 file_paths.xml 中定义的，否则无法通过该 Uri 访问。

    public class MainActivity extends AppCompatActivity implements View.OnClickListener {

    private Button takePhoto;
    private ImageView picture;
    private Uri imageUri;
    private File outputImage;
    private ActivityResultLauncher<Intent> launcher = registerForActivityResult(new ActivityResultContracts.StartActivityForResult(), new ActivityResultCallback<ActivityResult>() {
        @Override
        public void onActivityResult(ActivityResult result) {
            if (result.getResultCode() == RESULT_OK) {
                // TODO
            }
        }
    });

    // ...

    @Override
    public void onClick(View v) {
        outputImage = new File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS), "output_image.jpg");

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
            // 使用 FileProvider 生成 Content Uri
            imageUri = FileProvider.getUriForFile(this, "com.amie.cameraalbum.FileProvider", outputImage);
        } else {
            imageUri = Uri.fromFile(outputImage);
        }
        // 以调用相机拍照为例
        Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
        // 设置 Extra 指定输出到对应的 Uri 上，固定写法
        // 在 AOSP 的 Camera 源码中可以找到答案，具体查看参考文章
        intent.putExtra(MediaStore.EXTRA_OUTPUT, imageUri);
        //设置临时的读写权限
        intent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
        launcher.launch(intent);    // 使用 ActivityResultLauncher 启动 Intent
    }
}

最后，如果需要兼容 Android 4.4 之前的系统，那么还要在 AndroidManifest 文件中声明 android.permission.WRITE_EXTERNAL_STORAGE 权限，Android 4.4 版本开始不再需要声明该权限。

使用FileProvider替代ContentProvider在Android中共享文件
DevScript的博客
10-04 331
幸运的是，Android提供了一个更简单的解决方案，即使用FileProvider。通过配置FileProvider并使用其提供的API，我们可以轻松地共享文件，并确保文件共享的安全性和灵活性。然后，我们创建一个分享文件的Intent，并将文件的Uri作为附件添加到Intent中。通过这种方式，我们可以使用FileProvider来实现简单而高效的文件共享功能，而无需使用复杂的ContentProvider。在上述代码中，我们首先获取要共享的文件，然后使用FileProvider的。属性指定了路径的名称，
《Android 基础（四十七）》FileProvider
AndroidKt
06-30 1769
简介 FileProvider，是ContentProvider的子类，通过构建以”content://”开头的Uri取代之前以”file://”开头的Uri，以此实现应用间的文件共享。 由来 官文Android7.0行为变更说明： 对于面向 Android 7.0 的应用，Android 框架执行的 StrictMode API 政策禁止在应用外部公开 file:// URI。如果一...
跨进程共享数据——ContentProvider
xingyu19911016的博客
11-11 5708
跨进程共享数据——ContentProvider Android数据持久化技术，包括文件存储、SharedPreferences存储以及数据库存储，使用这些持久化技术所保存的数据只能在当前应用程序中访问。虽然文件存储和SharedPreferences存储中提供了MODE_WORLD_READABLE和MODE_WORLD_WRITEABLE这两种操作模式，用于供给其他应用程序访问当前应用的数据，但 这两种模式在Android 4.2版本中都已被废弃了。因为Android官方已经不再推荐使用这种方式来实现跨
面试重点一个不落：FileProvider你了解多少？透过FileProvider来看看四大组件之一ContentProvider！
weixin_44339238的博客
03-01 785
前言 大家应该都熟悉FileProvider吧，但是其诞生的原因，内部怎么实现的，又是怎么转化为文件的，大家有了解多少呢？今天就通过它重新看看ContentProvider这个四大组件之一。 在Android7.0，Android提高了应用的隐私权，限制了在应用间共享文件。如果需要在应用间共享，需要授予要访问的URI临时访问权限。 以下是官方说明： 对于面向 Android 7.0 的应用，Android 框架执行的 StrictMode API 政策禁止在您的应用外部公开file:// U...
使用Android系统自带文件分享功能(FileProvider)
最新发布
qq_44780769的博客
03-14 612
确保 FileProvider 路径配置正确，且文件存在。
FileProvider 和 ContentProvider 联合使用
wljian1的博客
04-13 2740
介绍：这里只是我的使用 只是一个思路而已  遇到一个需求需要共享私有目录的文件，供其他APP使用。不能跳转获取，我看网上大部分说FileProvider 的使用都是通过Intent 跳转 在 onActivityResult() 方法获取返回的Uri。本方法主要利用的是ContentProvider 来对外提供方法使用。还利用Uri 本身可以使用String 相互转换。FileProvider的使...
File Provider
梦想家Eva的专栏
12-19 890
File Provider, 今天解决一个bug： 首先是SDK24以上，打开相机拍照，uri路径不能使用file://,需要使用content:// ； 其次是收到返回值时，是File Provider封装过的路径，不是真实路径地址，需要自己再转换。 原始地址： /storage/emulated/0/DCIM/GalleryFinal/IMG20191219134527.jpg 原...
FileProvider
u013087553的博客
06-18 449
一、简介 对于android 7.0应用，android框架使用 StrictMode Api禁止我们的应用对外部(跨越应用分享)公开file://,若使用file://格式共享文件则会报FileUriExposedException异常，android 7.0应用间的文件共享需要使用content://类型的URI分享，并且需要为其提供临时的文件访问权限(Intent.FLAG_GRANT_R...
基于Android FileProvider 属性配置详解及FileProvider多节点问题
08-19
Uri contentUri = FileProvider.getUriForFile(context, SysInfo.packageName + ".fileProvider", outputFile); intent.setDataAndType(contentUri, "application/vnd.android.package-archive"); } else { // ...
android中Content Provider
03-21
5. **使用ContentResolver**：在其他应用中，通过`ContentResolver`来与Content Provider进行交互，使用`ContentResolver`的`query()`、`insert()`、`update()`和`delete()`方法，传入相应的URI来操作数据。...
android uri转file_Android世界：ContentProvider使用
weixin_39963853的博客
11-27 215
继上文输出之后，偶逢流感，又遇节日、停电。现在继续未完成的内容。一、Provider的使用概述本文暂且介绍FileProvider；至于后续遇到安卓新版本适配的其他Provider，到时再进行补充。FileProvider：ContentProvider的子类，安卓提供唯一的安全接口用来访问File文件，通过getUriForFile()方法获取File的Uri，以Intent的方式分享给其他应用...
FileProvider实例
11-16
一个简单的fileprovider实例，不依赖任何自定义库实现android7.0以后系统权限申请，使用intent申请相机服务拍照截图，并申请访问系统相册，适合新手参考。
Android 应用间共享文件（FileProvider）
浩子的专栏
04-06 4186
在 Android 7.0 中调用系统相机拍照，通过SD卡获取原图，抛出FileUriExposedException异常 从 Android 7.0 开始，应用间共享文件时，如果使用 file://格式的 Uri，就会抛出 FileUriExposedException。 谷歌官方推荐，使用 FileProvider 来生成一个 content://格式的Uri。
Android之FileProvider的使用
C安君的博客
08-24 5798
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录一、FileProvider是什么？二、FileProvider使用步骤1.定义一个FileProvider2.指定可访问的文件3.获取指定文件的Uri4.授予临时权限给Uri5.提供Uri给其他App三、案例 一、FileProvider是什么？ FileProvider是一个ContentProvider的子类，它取代了“file://”形式的Uri 通过“content://”形式的Uri实现了App间的安全通信。conte
FileProvider使用（拍照、安装APP、共享文件）
QyLost
12-21 3313
FileProvider 在Android7.0及之后我们无法直接将一个FileUri共享给另一个程序进行使用。系统会抛出一个异常FileUriExposedException。官方是这样描述的： The exception that is thrown when an application exposes a file:// Uri to another app. 当一个应用程序暴漏一个fil...
存储文件的ContentProvider
woshizoe的专栏
06-24 9433
http://ipjmc.iteye.com/blog/1447226 基于SQLite的ContentProvider我们见得多了，但是我们在做Android应用时，有时候程序需要下载网络上的图片，这时候我们希望能够把图片缓存到客户端本地，下次再要显示该图片时就不用再从网络上下载了，直接从本地缓存读取，这就需要用到存储文件的ContentProvider 。          这里只
FileProvider详解
Android技术之家
03-02 7897
作者：嘉伟咯 链接：https://www.jianshu.com/p/bf61f559f331高版本的android对文件权限的管控抓的很严格,理论上两个应用之间的文件传递现在都应该是用FileProvider去实现,这篇博客来一起了解下它的实现原理。首先我们要明确一点,FileProvider就是一个ContentProvider,所以需要在AndroidManifest.xml里面对它进行声...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

阿咩AmieVastness

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值