美文网首页android基础知识Android知识
Android 7.0 FileProvider 的使用与疑惑

Android 7.0 FileProvider 的使用与疑惑

作者: 彼岸sakura | 来源:发表于2017-03-31 10:45 被阅读2367次

    Android 7.0 设备已经逐渐普及了。然而和 6.0 系统的 运行时权限 类似, Google 又针对这个版本做了一些出于安全性考虑的改动。如果针对 24+ 的 SDK 版本 进行开发,你不得不做一些适配工作。

    FileUriExposedException

    我们创建一个项目,目标 SDK 设置为 24 或者更大。
    首先写一个布局文件,取名 activity_main
    很简单,一个帧布局,里面一个按钮。

    <?xml version="1.0" encoding="utf-8"?>
    <FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
        android:padding="16dp"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context="com.example.jin.fileprovidertest.MainActivity">
    
        <Button
            android:id="@+id/ac_main_btn"
            android:text="click me!"
            android:layout_width="match_parent"
            android:layout_height="wrap_content" />
    
    </FrameLayout>
    

    对应的 MainActivity ,也很简单,声明赋值按钮,然后添加点击事件。
    事件里调用 系统自带 的相机应用,这是 Google 推荐的方式,可以不用额外申请权限。
    因为仅仅为了测试,就不写回调了,直接打开系统相机的活动。

    package com.example.jin.fileprovidertest;
    
    import android.content.Intent;
    import android.net.Uri;
    import android.os.Environment;
    import android.provider.MediaStore;
    import android.support.v7.app.AppCompatActivity;
    import android.os.Bundle;
    import android.view.View;
    import android.widget.Button;
    
    import java.io.File;
    
    public class MainActivity extends AppCompatActivity {
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            Button btn = (Button) findViewById(R.id.ac_main_btn);
            btn.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    Uri uri = Uri.fromFile(new File(Environment.getExternalStorageDirectory().getPath()));
                    Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
                    intent.putExtra(MediaStore.EXTRA_OUTPUT, uri);
                    startActivity(intent);
                }
            });
        }
    }
    

    然后在一台 Android 7.0 设备上启动之,结果一点按钮就崩溃了——

    1.gif
    查看 logcat ,报了一个异常叫 FileUriExposedException
    原来这是 Android 7.0 的一处安全性改动:不允许再直接使用真实路径的URI。 因此不能再直接调 Uri.fromFile() 方法了,需要用到本文的主角 FileProvider

    FileProvider

    这是 Android 7.0 新增的一个类,位于 v4 包下,继承自四大组件之一的 ContentProvider ,因此需要 在清单配置文件里注册
    首先在资源文件夹下新建一个 xml 目录,里面包含一个文件 test ——

    1.png
    文件内容如下——
    <?xml version="1.0" encoding="utf-8"?>
    <resources>
        <paths>
            <root-path name="my_image" path=""/>
        </paths>
    </resources>
    

    外两层写法是固定的,重点在第三层。
    首先是节点名 <root-path> ,它对应前面代码中 Environment.getExternalStorageDirectory() 方法获取到的存储路径。
    如果是其它路径,节点名要做相应改变——
    <files-path> ,对应 Context.getFilesDir() 方法;
    <cache-path> ,对应 getCacheDir() 方法;
    <external-path>Google 官方文档和网上多数文章都说,是对应 Environment.getExternalStorageDirectory() 方法,但在现有设备上亲测均无效,会报 IllegalArgumentException 异常。
    <external-files-path> ,对应 Context.getExternalFilesDir() 方法;
    <external-cache-path> ,对应 Context.getExternalCacheDir() 方法。
    然后是 path 属性,Google 官方文档和网上多数文章同样都说,传空,代表你整个对应路径都可以用于共享;传入一个相对路径,代表只有这个路径的指向才能用于共享。但在现有设备上亲测同样均无效,会报 IllegalArgumentException 异常。
    以上二处原因不明,请指教。

    完成 test.xml 后,我们去 AndroidManifest 文件里注册——

    <provider
        android:authorities="com.example.jin.fileprovidertest.fileprovider"
        android:name="android.support.v4.content.FileProvider"
        android:exported="false"
        android:grantUriPermissions="true">
        <meta-data
            android:name="android.support.FILE_PROVIDER_PATHS"
            android:resource="@xml/test"/>
    </provider>
    

    需要注意的就是 authorities 属性,Google 官方推荐的写法是「包名 + .fileprovider」。其它属性写法固定,resource 的值应指向你之前的 xml 文件。
    好了,现在修改我们的 MainAcitivity ,将 onClick()方法的内容修改为——

    final String authority = "com.example.jin.fileprovidertest.fileprovider";
    boolean b = Build.VERSION.SDK_INT >= 24;
    File file = new File(Environment.getExternalStorageDirectory().getPath());
    Uri uri = b
            ? FileProvider.getUriForFile(MainActivity.this, authority, file)
            : Uri.fromFile(file);
    Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
    intent.putExtra(MediaStore.EXTRA_OUTPUT, uri);
    startActivity(intent);
    

    然后启动,完美!


    2.gif

    最近看了一些文章,补充更新:

    • 建议自己创建一个类 MyProvider 继承 FileProvider(类里面可以什么都不写),然后将 name 属性的值设为 .MyProvider。这样做的好处是可以确保当进行组件化开发时,不同组件之间的 merge 不会发生冲突。
    • authority 属性的值更规范一点的写法是 ${applicationId}.fileprovider。相应的在代码中,它的赋值为 getPackageName() + ".fileprovider"(需要有上下文环境)。
    • xml 文件的 <resource> 节点可以剥掉,直接用 <paths> 做根节点。

    本文结束,欢迎拍砖吐槽 and 指教~~

    相关文章

      网友评论

      • 灬金鳞:我想知道每多一个不同的路径就得配置一次么?还是能在同一个xml文件中配置
        谢谢
      • d586741e2fe3:<external-path>,Google 官方文档和网上多数文章都说,是对应 Environment.getExternalStorageDirectory() 方法,我用Android7.0设备上测试是可以的,不会报 IllegalArgumentException 异常呀。:stuck_out_tongue_closed_eyes:
        d586741e2fe3:@彼岸sakura 为啥不更新你的文章呢,还把错的展示在上面?
        彼岸sakura:楼上的说法是正确的,我并没有真正的存皂片,如果回调里写了保存逻辑就不会了,已测~
      • 71a14d18c30d:1. new File 的时候只有路径而没有文件名, 这样你拍完后, 照片是不会存储在指定的路径内的.
        2. 关于 IllegalArgumentException 先明确前提:
        一是xml 里的 paths 子项可以写多条, 会从上到下搜索来匹配
        二是你在 new File 中的文件路径至少能匹配到 paths 里的一条路径, 否则 throw IllegalArgumentException
        三是root-path指的是系统根目录, 也就是/
        基于以上, 很明显了, 你getExternalCacheDir是/storage/emulated/0...下的, 如果path为空, 当然能匹配到, 因为匹配的是根目录下所有目录文件.当你指定某个子目录, 一是你没权限, 二是可能没这个目录无法匹配到.
        另外你这样写uri只会转为content://com.myapp/storage/emulated/0/..../yourfile, 这个跟直接file:///没区别,违背了隐藏目录的初衷
      • d4d27c43a6d7:非常感谢~~~
        彼岸sakura:同样感谢支持:smile:
      • 魏震洲:感谢分享
        彼岸sakura:感谢支持~~多交流哈

      本文标题:Android 7.0 FileProvider 的使用与疑惑

      本文链接:https://www.haomeiwen.com/subject/jejpottx.html