本课程教你:
- 指定 FileProvider
- 指定可分享的目录
为了安全在应用之间分享文件,你需要设置你的应用提供一种处理文件的安全机制,该机制采用content URI的形式。Android FileProvider 组件基于你在XML中提供的内容来产生文件的content URIs。本课程教你怎样在你的应用中添加一个默认的 FileProvider,怎样指定你想提供给其他应用的文件。
注意:FileProvider 类是 v4 Support Library 的一部分。关于这个库的更多信息,请参考 Support Library Setup.
指定FileProvider
为了你的应用定义一个 FileProvider ,你需要在manifest文件中设置一个入口。这个入口指定了使用content URIs需要的权限以及包含能够分享的文件目录的XML文件名称。
下面这段代码教你如何在manifest 文件中添加 <provider> 元素来指定一个 FileProvider 类,相关的权限以及XML文件名称:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.myapp">
<application
...>
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="com.example.myapp.fileprovider"
android:grantUriPermissions="true"
android:exported="false">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/filepaths" />
</provider>
...
</application>
</manifest>
在这个例子中, android:authorities
属性定义了由 FileProvider 产生的content URIs使用时需要的授权。这本例子中,这个权限是com.example.myapp.fileprovider
。对于你自己的应用,指定一个由应用的 android:package 值加上"fileprovider"字符串作为授权。关于授权的更多内容,请参考 Content URIs 和 android:authorities 相关的文档。
<provider> 的子元素 <meta-data> 指向一个XML文件,该文件包含你希望分享的文件目录。android:resource
属性是文件的路径和名字,不需要加上.xml
的扩展名。文件的内容将在写一部分介绍。
指定可分享的目录
一旦你在应用的manifest文件中添加了 FileProvider,你需要指定包含你希望分享的文件的路径。为了指定这个路径,在你的工程res/xml/
子目录下创建filepaths.xml
文件。在这个文件里面为每一个路径添加一个XML元素。下面这段代码显示了一个res/xml/filepaths.xml
具体内容的例子。这段代码也显示了如何在内部存储器的files/
目录下分享一个子目录的路径。
<paths>
<files-path path="images/" name="myimages" />
</paths>
在这个例子中,<files-path>
标签分享了在你的应用的内部存储器中的files/
路径。path
属性分享了files/
下面的images/
子目录。name
属性告诉 FileProvider 对于files/images/
子目录在content URIs中添加一个myimages
路径段。
<paths>
元素可以有多个子元素,每个子元素指定一个不同的分享路径。除了<files-path>
元素之外,你也可以使用<external-path>
来分享外部存储器的路径,使用<cache-path>
来分享内部缓存路径。关于指定分享路径的子元素的更多信息,参见 FileProvider 相关文档。
注意:这个XML文件是唯一能指定分享路径的方法,你不能在程序中动态的添加一个路径。
现在,对于你的应用内部存储器的files
路径以及files
子路径下的文件,你已经完成了使用 FileProvider 为它们生成对应的content URIs。当你的应用为文件生成一个content URI时,它包含指定在 <provider> 元素中的授权、myimages/
路径以及该文件的名字。
例如,如果你根据本课程的代码定义一个 FileProvider,如果你请求default_image.jpg
的content URI,FileProvider 会返回下面的URI:
content://com.example.myapp.fileprovider/myimages/default_image.jpg