FileProvider的使用

还望支持个人博客站:http://www.enjoytoday.cn

概述

Android 7.0的新特性规定，对于android 7.0应用(仅仅对于android 7.0版本的sdk而言，若是编译版本低于25仍然不会受到影响)，android框架使用StrictMode Api禁止我们的应用对外部(跨越应用分享)公开file://,若使用file://格式共享文件则会报FileUriExposedException异常，android 7.0应用间的文件共享需要使用content://类型的URI分享，并且需要为其提供临时的文件访问权限

(Intent.FLAG_GRANT_READ_URI_PERMISSION和Intent.FLAG_GRANT_WRITE_URI_PERMISSION),对此，官方给我们的建议是使用FileProvider类进行分享.目前，我已经在华为mate系列最新Android 7.0系统测试验证证实。下面主要看下FileProvider的使用方法，我会结合官网给的资料和FileProvider 25.0.1的源代码进行分析。

FileProvider

简介

获取是因为v4包的版本问题，导致我发现FileProvider原代码和android官网的介绍有些许差异或者说是接入的某些细节和我在使用的v4包所能作的工作不符合。我使用的v4包是23.0.1,下面我就以我这个版本的v4来介绍FileProvider的使用。

使用

注册

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

 <manifest>
    ...
    <application>
        ...
     <provider
          android:name="android.support.v4.content.FileProvider" //provider的类名
            android:authorities="com.hfcai.fileprovider" //没有特定要求，自定义
            android:exported="false"           //不建议设置未true
            android:grantUriPermissions="true">  //允许你有给其赋予临时访问权限的权力

    <meta-data
          android:name="android.support.FILE_PROVIDER_PATHS"
          android:resource="@xml/file_paths" />
     </provider>
        ...
    </application>
</manifest>

这里是直接使用的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文件下面建立一个配置文件，格式如下:

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">

<!-- "/" -->
  <root-path name="test" path="test"/>
    <!--Context.getFilesDir().-->
    <files-path path="images" name="images"/>
    <!-- getCacheDir().-->
    <cache-path name="images1" path="images" />
    <!-- Environment.getExternalStorageDirectory().-->
    <external-path name="images2" path="images" />
    <!--Context#getExternalFilesDir(String) Context.getExternalFilesDir(null).   -->
    <external-files-path name="images3" path="images" />
    <!-- Context.getExternalCacheDir().  -->
    <external-cache-path name="images4" path="images" />
</paths>

这里需要注意的是，如上的配置是25.0.1版本的配置信息，各个版本或许有点不同，具体的可选配置可以在原码中查看，关于配置文件的解析部分在FileProvider的parsePathStrategy方法里，相关的代码如下:

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不难发现，这里有几点坑需要注意一下：

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

使用方法

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

File imagePath = new File(Context.getFilesDir(), "images");
File newFile = new File(imagePath, "test.png");
Uri contentUri = FileProvider.getUriForFile(getContext(), "com.hfcai.fileprovider", newFile);
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);

这样就可以通过系统的相册或其他可查看图片的应用打开我们所创建的图片文件了，下面给了一个FileProvider使用的Demo原码，可供参考，不喜勿喷。

FileProvider 示例:FileProviderDemo