FileProvider的使用

最新推荐文章于 2024-04-29 09:33:46 发布

duckbass

最新推荐文章于 2024-04-29 09:33:46 发布

阅读量1.7k

点赞数 1

原文出处 https://blog.csdn.net/chf1142152101/article/details/54729099

FileProvider是v4包中一个继承ContentProvider的子类，位置是android.support.v4.content，他可以通过File创建一个content://类型的Uri而不是file://类型的Uri.所以我们在使用的使用首先需要在清单文件中注册一个provider,如下所示:

<provider
    android:name="android.support.v4.content.FileProvider"
    android:authorities="@string/app_file_provider_authorities"
    android:exported="false"
    android:grantUriPermissions="true">
    <meta-data
        android:name="android.support.FILE_PROVIDER_PATHS"
        android:resource="@xml/file_paths" />
</provider>

这里是直接使用的v4包中的FileProvider，我们也可以直接继承FileProvider类，适当重写重载函数，但不建议如此做。下面来介绍上面的几个设置：

name:provider的类名,若使用默认的v4的FileProvider可使用”android.support.v4.content.FileProvider”,也可以设置为自定义的继承FileProvider的provider类
authorities:一个签名认证，可以自定义，但在获取uri的时候需要保持一致
grantUriPermissions:使用FileProvider的使用需要我们给流出的URI赋予临时访问权限（READ和WRITE），该设置是允许我们行使该项权力
meta-data:meta-data配置的是我们可以访问的文件的路径配置信息，需要使用xml文件进行配置，FileProvider会通过解析xml文件获取配置项，其中name名字不可改变为：android.support.FILE_PROVIDER_PATHS，resource为配置路径信息的配置项目

路径配置
可访问的路径配置可以在res中建立一个xml文件下面建立一个配置文件，格式如下:
file_paths.xml

<?xml version="1.0" encoding="utf-8"?>
<paths>
    <root-path path="" name="root" />
    <external-path path="Android/data/com.sweet.camera/" name="data" />
    <external-path path="Pictures/SweetCamera/" name="images" />
</paths>

关于file_paths下标签的类型，从代码中分析可知：
external-path 代表与Environment.getExternalStorageDirectory()相同的文件路径

其他标签参考以下代码：

private static PathStrategy parsePathStrategy(Context context, String authority)
        throws IOException, XmlPullParserException {
    final SimplePathStrategy strat = new SimplePathStrategy(authority);

    final ProviderInfo info = context.getPackageManager()
            .resolveContentProvider(authority, PackageManager.GET_META_DATA);
    final XmlResourceParser in = info.loadXmlMetaData(
            context.getPackageManager(), META_DATA_FILE_PROVIDER_PATHS);
    if (in == null) {
        throw new IllegalArgumentException(
                "Missing " + META_DATA_FILE_PROVIDER_PATHS + " meta-data");
    }

    int type;
    while ((type = in.next()) != END_DOCUMENT) {
        if (type == START_TAG) {
            final String tag = in.getName();

            final String name = in.getAttributeValue(null, ATTR_NAME);
            String path = in.getAttributeValue(null, ATTR_PATH);

            File target = null;
            if (TAG_ROOT_PATH.equals(tag)) {
                target = DEVICE_ROOT;
            } else if (TAG_FILES_PATH.equals(tag)) {
                target = context.getFilesDir();
            } else if (TAG_CACHE_PATH.equals(tag)) {
                target = context.getCacheDir();
            } else if (TAG_EXTERNAL.equals(tag)) {
                target = Environment.getExternalStorageDirectory();
            } else if (TAG_EXTERNAL_FILES.equals(tag)) {
                File[] externalFilesDirs = ContextCompat.getExternalFilesDirs(context, null);
                if (externalFilesDirs.length > 0) {
                    target = externalFilesDirs[0];
                }
            } else if (TAG_EXTERNAL_CACHE.equals(tag)) {
                File[] externalCacheDirs = ContextCompat.getExternalCacheDirs(context);
                if (externalCacheDirs.length > 0) {
                    target = externalCacheDirs[0];
                }
            }

            if (target != null) {
                strat.addRoot(name, buildPath(target, path));
            }
        }
    }

    return strat;
}

查看FileProvider不难发现，这里有几点坑需要注意一下：

配置可以添加多条路径信息，这是最容易看出来的
每条路径信息中的name是必须的，不能未空，且不可重复(可以自定义)，路径信息中的name，path解析后被一个HashMap作为Key和value保存，若name重复则会导致path数据被覆盖
path的设置必须是一个目录名，不可为一个文件名，可以选择添加或不添加file的分割符，因为FileProvider会自动帮我们补充

使用方法
使用FileProvider与其他共享文件的方法的唯一区别就是生成URI的方式，将之前使用Uri.formFile(File file)或者直接加上”file://”通过Uri.parse(String str)转化的方式改为FileProvider.getUriForFile(Context context,String auth,File file）方法获取。当然还需要给该uri添加临时访问权限，代码如下：

public static Uri getOutputMediaFileUri(Context context) {
    String folderName = Environment.getExternalStorageDirectory() + "/Pictures/SweetCamera";
    File folder = new File(folderName);
    if (!folder.exists()) folder.mkdirs();

    String fileName = "IMAGE"
            + new SimpleDateFormat(TIME_STAMP_NAME).format(new Date(System.currentTimeMillis()))
            + ".jpg";
    File file = new File(folderName, fileName);

    String authority = context.getString(R.string.app_file_provider_authorities);
    Uri fileUri = FileProvider.getUriForFile(context, authority, file);
    return fileUri;
}

public void viewImage() {
    Uri contentUri = getOutputMediaFileUri(getContext());
    Intent intent=new Intent(Intent.ACTION_VIEW);
    intent.setDataAndType(contentUri,"image/*");
    intent.setFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION | Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
    startActivity(intent);
}