在设计 Android App 时,常常需要让用户选择自己设备内的图片、音乐、视频或是文档,来进行一些处理,例如上传文件或是编辑文件等等的功能。但是要如何让用户选择文件呢?Java 编程语言的 Swing 函数库中,提供了 JFileChooser 类别,可以直接产生出一个文件选取的窗口,能让用户选取电脑内的文件,还可以使用 FileFilter 过滤文件选取窗口显示出来的文件类型,十分方便。虽然 Android 的程序是使用 Java 编程语言进行开发,但 Android 上的 Java 只能算是半残的 Java,有许多类别不能使用,其中当然包括 JFileChooser,不然就用不着写这篇文章了。
要让 Android 程序拥有文件选取的功能,最保险、可靠而且一定能 Work 的方式,那就是自己使用 File 类别或是 ContentProvider 实作出一个能选取文件的 Activity 或是 Dialog。如果不知道要怎么自己做出文件选取器的话,也可以使用别人写好的,在网络上都可以找得到代码,只是品质无法保证。
这篇文章将不探讨如何直接在自己的 Android App 内实作出文件选取器,而是要应用 Android 设备已经安装的文件浏览器之类的 App 来选取文件。举例来说,假设要选取一张图片,而且设备上已经有安装「图片库(Google Gallery)」或是「快图浏览(QuickPic)」之类的 App,那么将可以直接使用它们来选取图片,就不需要在程序项目内实作出复杂的文件选取和图片浏览的功能了!
Android 上的文件类型
在选取文件之前,必须要清楚知道要选取什么样类型的文件。在 Android 系统中,跟内容(Content)相关的信息都可由 ContentProvider 来取得,当用户保存了一个文件,文件的实际路径与类型就会被保存在 ContentProvider 中,因此只要查找 ContentProvider 中的文件类型,就可以很容易地取得设备中所有属于这种类型的文件。
Android 的文件类型采用 MIME (Multipurpose Internet Mail Extensions)标准,MIME 使用特定的字符串格式来表示内容类型(当然也包括文件),MIME 的字符串格式如下:
以文件来说,可能会有以下几种类型:
- text
- text/plain:纯文字文档。
- text/html:HTML 文档。
- application
- application/xhtml+xml:XHTML 文档。
- application/pdf:PDF 文档。
- image
- image/gif:GIF 图片。
- image/jpeg:JPEG 图片。
- image/png:PNG 图片。
- audio
- audio/midi:MIDI 音乐。
- audio/x-mpeg:MP2 或是 MP3 音乐。
- audio/x-wav:WAV 音乐。
- video
- video/mp4:MP4 视频。
- video/mpeg:MPEG 视频。
- video/3gpp:3GP 视频。
如果要表示所有类型的文件,可以使用「*」字符。举例来说,MIME 类型若为「image/*」,表示所有的图片类型;MIME 类型若为「*/*」表示所有类型。
透过 MIME 选取文件
有了其他 Android App 的帮助,设计师就不需要自己使用 ContentProvider 来取得指定 MIME 类型下的文件清单,只需要让这些拥有文件选取功能的 App 知道应该要选择什么样 MIME 类型的文件即可。
Android 的 Intent 可以用在 Application 或是 Activity 之间的沟通,只要使用 Intent 的 ACTION_GET_CONTENT,系统就会帮用户找到设备内合适的 App 来取得指定 MIME 类型的内容,程序可以这样写:
...
Intent picker = new Intent(Intent.ACTION_GET_CONTENT);
picker.setType("*/*");
startActivity(picker);
建议用法
如果程序只有写成这样的话,将会遇到两个恰恰相反的问题。第一个是 Android 系统找不到符合指定 MIME 类型的内容选取器,程序将会因为找不到可运行的 Activity 而直接闪退,这个问题甚至可能会没办法直接用 try-catch 来解决。第二个可能会遇到的问题是,当 Android 系统找到两种以上可用的 App 或是 Activity 支持指定的 MIME 类型时,可能会自动使用其中一种,此时也许就会选到无法正常使用的 App 或是 Activity,连带使我们的 App 永远无法正常使用。
要解决第一个找不到 Activity 的问题,可以事先使用 PackageManager 查找可以使用该 MIME 类型的 Activity 列表来解决。而要解决第二个可用 App 或是 Activity 有两个以上的问题的话,可以使用系统内置的 Intent Chooser,跳出菜单让用户选择要使用哪个。因此选取文件的程序可以写成如以下的样子,大概就没有什么问题了。
final String mimeType = "image/png";
final PackageManager packageManager = context.getPackageManager();
final Intent intent = new Intent(Intent.ACTION_GET_CONTENT);
intent.setType(mimeType);
List<ResolveInfo> list = packageManager.queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY);
if (list.size() > 0) {
// 如果有可用的Activity
Intent picker = new Intent(Intent.ACTION_GET_CONTENT);
picker.setType(mimeType);
// 使用Intent Chooser
Intent destIntent = Intent.createChooser(picker, "选取PNG图片");
startActivity(destIntent);
} else {
// 没有可用的Activity
...
}
复选文件
如果要复选文件,可以在 picker 的 Intent 中,加入 EXTRA_ALLOW_MULTIPLE 字段,并将其值设为 true,如下:
picker.putExtra(Intent.EXTRA_ALLOW_MULTIPLE, true);
EXTRA_ALLOW_MULTIPLE 不一定能在所有的 Activity 上成功使用,要看该 Activity 有没有用到 EXTRA_ALLOW_MULTIPLE,并且实作出文件复选的功能。
只能选择本地端的文件
如果只要选择设备内本地端的文件,也可以在 picker 的 Intent 中,加入 EXTRA_LOCAL_ONLY 字段,并将其值设为 true。
picker.putExtra(Intent.EXTRA_LOCAL_ONLY, true);
至于什么时候有能选择设备外的文件的情况,当 Activity 有浏览云端文件或是同步之类的功能时,所选的文件就可能不在本地端,如果此时要抓取文件的实际路径来做些应用,就可能会因实际路径不在本地端上,而出现问题。EXTRA_LOCAL_ONLY 也是一样不一定能在所有的 Activity 上成功使用,要看该 Activity 的实作方式。
常见的错误用法
网络上常常可以看到有别人是使用 Intent 的 ACTION_PICK 来选取文件,写法其实和 ACTION_GET_CONTENT 类似,如下:
...
Intent picker = new Intent(Intent.ACTION_PICK);
picker.setType("*/*");
startActivity(picker);
虽然运行结果好像跟 ACTION_GET_CONTENT 没有两样,但是其实这样的用法是错误的。原因在于 ACTION_PICK 实际上是用来选择一个 URI 目录下的数据,比较正确的用法如下:
final Uri uri = android.provider.MediaStore.Images.Media.EXTERNAL_CONTENT_URI;
final PackageManager packageManager = context.getPackageManager();
final Intent intent = new Intent(Intent.ACTION_PICK, uri);
List<ResolveInfo> list = packageManager.queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY);
if (list.size() > 0) {
// 如果有可用的Activity
Intent picker = new Intent(Intent.ACTION_PICK, uri);
// 使用Intent Chooser
Intent destIntent = Intent.createChooser(picker, "选取图片");
startActivity(destIntent);
} else {
// 没有可用的Activity
...
}
取得文件位于设备上的实际路径
使用 Intent 的 ACTION_GET_CONTENT 和 MIME 类型来选择文件十分容易,但要如何取得用户选定的文件呢?那就得看用户所用来选取文件的 Activity,是如何传回文件数据的,这部份并没有特定的格式,而且也可能会有不符合指定 MIME 类型的文件。
但是,大部份可选择文件的 Activity 都是在 onActivityResult 时,将选择的结果包在传回的 Intent 内。如果要使用 onActivityResult 来取得 Activity 的回传结果,那么当初在打开 Activity 时,就要使用 startActivityForResult 方法,而不是 startActivity 方法。选取的结果,单选和复选的状况应该要分开探讨。
单选文件
使用 getData 方法取得传回的 Intent 所包含的 URI,这个 URI 通常可以直接被用来反查 ContentProvider 内的文件实际路径。
Uri uri = intent.getData();
复选文件
Intent 的 EXTRA_ALLOW_MULTIPLE 字段定义是在 Android API 18 之后才出现的,但是 API 18 之前的 Activity 究竟有没有支持文件复选也很难说。可以确定的是,复选文件的结果大多是包在 Intent 的 ClipData 中,因此可以使用 getClipData 方法取得传回的 Intent 所包含的 ClipData,再用循环抓出 ClipData 中所有项目的 URI,这个 URI 通常可以直接被用来反查 ContentProvider 内的文件实际路径。建议从 Android API 16 开始支持文件复选的功能。
if(Build.VERSION.SDK_INT >= 16){
ClipData clipData = intent.getClipData();
int count = clipData.getItemCount();
if (count > 0) {
Uri[] uris = new Uri[count];
for (int i = 0; i < count; i++) {
uris[i] = clipData.getItemAt(i).getUri();
}
}
}
实际路径
有了文件的 URI 后,接着就要找出 URI 所对应的文件,在 Android 设备上实际的路径。在 Android 4.4 (API 19)之前的版本,URI 都可以直接透过 ContentProvider 来查找其对应的文件实际路径,但在 Android 4.4 以及之后的版本,系统似乎内置了内容浏览器,并且使用了 Android 4.4 之后才添加的文档 URI 格式,回传的 URI Authority 将会使用「com.android.externalstorage.documents」、「com.android.providers.downloads.documents」或是「com.android.providers.media.documents」。如果直接用这样的 URI 查找 ContentProvider,将会得到空的路径,因此这样的 URI 需要进行一些转换,才能被用来查找 ContentProvider。
实作文件选取的程序
由于文件选取算是一个常用的功能,所以可以将它写成一个独立的类别来重复使用。代码如下:
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import android.annotation.SuppressLint;
import android.app.Activity;
import android.content.ClipData;
import android.content.ContentUris;
import android.content.Context;
import android.content.Intent;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.database.Cursor;
import android.net.Uri;
import android.os.Build;
import android.os.Environment;
import android.provider.DocumentsContract;
import android.provider.MediaStore;
/**
* 文件选取器,支持文件MIME类别筛选、强制可读取以及复选功能。
*
* @author Magic Len
*/
@SuppressLint("NewApi")
public class MagicFileChooser {
// TODO ------类别常数------
/**
* 文件选取器的Activity Request Code。
*/
public static final int ACTIVITY_FILE_CHOOSER = 9973;
// TODO -----对象变量-----
/**
* 保存使用这个文件选取器的Activity。
*/
private final Activity activity;
// TODO -----对象变量-----
/**
* 保存是否正在选取文件。
*/
private boolean choosing = false;
/**
* 保存被选到的文件是否一定要可以读取。
*/
private boolean mustCanRead;
/**
* 保存被选到的文件。
*/
private File[] chosenFiles;
// TODO -----构造器-----
/**
* 构造器,在Activity内使用文件选取器。
*
* @param activity 传入使用这个文件选取器的Activity。
*/
public MagicFileChooser(final Activity activity) {
this.activity = activity;
}
// TODO -----类别方法-----
/**
* 从Uri取得绝对路径。
*
* @param context 传入Context
* @param uris 传入Uri数组
* @return 传回绝对路径字符串数组,若绝对路径无法取得,则对应的数组索引位置为null
*/
public static String[] getAbsolutePathsFromUris(final Context context, final Uri[] uris) {
return getAbsolutePathsFromUris(context, uris, false);
}
/**
* 从多个Uri取得绝对路径。
*
* @param context 传入Context
* @param uris 传入Uri数组
* @param mustCanRead 传入Uri所指的路径是否一定要可以读取
* @return 传回绝对路径字符串数组,若绝对路径无法取得或是无法读取,则对应的数组索引位置为null
*/
public static String[] getAbsolutePathsFromUris(final Context context, final Uri[] uris, final boolean mustCanRead) {
if (uris == null) {
return null;
}
final int urisLength = uris.length;
final String[] paths = new String[urisLength];
for (int i = 0; i < urisLength; ++i) {
final Uri uri = uris[i];
paths[i] = getAbsolutePathFromUri(context, uri, mustCanRead);
}
return paths;
}
/**
* 从多个Uri取得File对象。
*
* @param context 传入Context
* @param uris 传入Uri数组
* @return 传回File对象数组,若File对象无法创建,则对应的数组索引位置为null
*/
public static File[] getFilesFromUris(final Context context, final Uri[] uris) {
return getFilesFromUris(context, uris, false);
}
/**
* 从多个Uri取得File对象。
*
* @param context 传入Context
* @param uris 传入Uri数组
* @param mustCanRead 传入Uri所指的路径是否一定要可以读取
* @return 传回File对象数组,若File对象无法创建或是文件路径无法读取,则对应的数组索引位置为null
*/
public static File[] getFilesFromUris(final Context context, final Uri[] uris, final boolean mustCanRead) {
if (uris == null) {
return null;
}
final int urisLength = uris.length;
final File[] files = new File[urisLength];
for (int i = 0; i < urisLength; ++i) {
final Uri uri = uris[i];
files[i] = getFileFromUri(context, uri, mustCanRead);
}
return files;
}
/**
* 从Uri取得绝对路径。
*
* @param context 传入Context
* @param uri 传入Uri对象
* @return 传回绝对路径,若绝对路径无法取得,传回null
*/
public static String getAbsolutePathFromUri(final Context context, final Uri uri) {
return getAbsolutePathFromUri(context, uri, false);
}
/**
* 从Uri取得绝对路径。
*
* @param context 传入Context
* @param uri 传入Uri对象
* @param mustCanRead 传入Uri所指的路径是否一定要可以读取
* @return 传回绝对路径,若绝对路径无法取得或是无法读取,传回null
*/
public static String getAbsolutePathFromUri(final Context context, final Uri uri, final boolean mustCanRead) {
final File file = getFileFromUri(context, uri, mustCanRead);
if (file != null) {
return file.getAbsolutePath();
} else {
return null;
}
}
/**
* 从Uri取得File对象。
*
* @param context 传入Context
* @param uri 传入Uri对象
* @return 传回File对象,若File对象无法创建,传回null
*/
public static File getFileFromUri(final Context context, final Uri uri) {
return getFileFromUri(context, uri, false);
}
/**
* 从Uri取得File对象。
*
* @param context 传入Context
* @param uri 传入Uri对象
* @param mustCanRead 传入Uri所指的路径是否一定要可以读取
* @return 传回File对象,若File对象无法创建或是文件路径无法读取,传回null
*/
@SuppressLint("NewApi")
public static File getFileFromUri(final Context context, final Uri uri, final boolean mustCanRead) {
if (uri == null) {
return null;
}
// 判断是否为Android 4.4之后的版本
final boolean after44 = Build.VERSION.SDK_INT >= 19;
if (after44 && DocumentsContract.isDocumentUri(context, uri)) {
// 如果是Android 4.4之后的版本,而且属于文档URI
final String authority = uri.getAuthority();
// 判断Authority是否为本地端文件所使用的
if ("com.android.externalstorage.documents".equals(authority)) {
// 外部保存空间
final String docId = DocumentsContract.getDocumentId(uri);
final String[] divide = docId.split(":");
final String type = divide[0];
if ("primary".equals(type)) {
String path = Environment.getExternalStorageDirectory().getAbsolutePath().concat("/").concat(divide[1]);
return createFileObjFromPath(path, mustCanRead);
} else {
String path = "/storage/".concat(type).concat("/").concat(divide[1]);
return createFileObjFromPath(path, mustCanRead);
}
} else if ("com.android.providers.downloads.documents".equals(authority)) {
// 下载目录
final String docId = DocumentsContract.getDocumentId(uri);
if (docId.startsWith("raw:")) {
final String path = docId.replaceFirst("raw:", "");
return createFileObjFromPath(path, mustCanRead);
}
final Uri downloadUri = ContentUris.withAppendedId(Uri.parse("content://downloads/public_downloads"), Long.parseLong(docId));
String path = queryAbsolutePath(context, downloadUri);
return createFileObjFromPath(path, mustCanRead);
} else if ("com.android.providers.media.documents".equals(authority)) {
// 图片、影音文件
final String docId = DocumentsContract.getDocumentId(uri);
final String[] divide = docId.split(":");
final String type = divide[0];
Uri mediaUri = null;
if ("image".equals(type)) {
mediaUri = MediaStore.Images.Media.EXTERNAL_CONTENT_URI;
} else if ("video".equals(type)) {
mediaUri = MediaStore.Video.Media.EXTERNAL_CONTENT_URI;
} else if ("audio".equals(type)) {
mediaUri = MediaStore.Audio.Media.EXTERNAL_CONTENT_URI;
} else {
return null;
}
mediaUri = ContentUris.withAppendedId(mediaUri, Long.parseLong(divide[1]));
String path = queryAbsolutePath(context, mediaUri);
return createFileObjFromPath(path, mustCanRead);
}
} else {
// 如果是一般的URI
final String scheme = uri.getScheme();
String path = null;
if ("content".equals(scheme)) {
// 内容URI
path = queryAbsolutePath(context, uri);
} else if ("file".equals(scheme)) {
// 文件URI
path = uri.getPath();
}
return createFileObjFromPath(path, mustCanRead);
}
return null;
}
/**
* 将路径转成File对象。
*
* @param path 传入文件路径
* @return 传回File对象,若File对象无法创建,传回null。
*/
public static File createFileObjFromPath(final String path) {
return createFileObjFromPath(path, false);
}
/**
* 将路径转成File对象。
*
* @param path 传入文件路径
* @param mustCanRead 传入文件路径是否一定要可以读取
* @return 传回File对象,若File对象无法创建或是文件路径无法读取,传回null
*/
public static File createFileObjFromPath(final String path, final boolean mustCanRead) {
if (path != null) {
try {
File file = new File(path);
if (mustCanRead) {
file.setReadable(true);
if (!file.canRead()) {
return null;
}
}
return file.getAbsoluteFile();
} catch (Exception ex) {
ex.printStackTrace();
}
}
return null;
}
/**
* 查找MediaStroe Uri对应的绝对路径。
*
* @param context 传入Context
* @param uri 传入MediaStore Uri
* @return 传回绝对路径
*/
public static String queryAbsolutePath(final Context context, final Uri uri) {
final String[] projection = {MediaStore.MediaColumns.DATA};
Cursor cursor = null;
try {
cursor = context.getContentResolver().query(uri, projection, null, null, null);
if (cursor != null && cursor.moveToFirst()) {
final int index = cursor.getColumnIndexOrThrow(MediaStore.MediaColumns.DATA);
return cursor.getString(index);
}
} catch (final Exception ex) {
ex.printStackTrace();
} finally {
if (cursor != null) {
cursor.close();
}
}
return null;
}
// TODO -----对象方法-----
/**
* 显示文件选取器,选取所有文件,不设置文件选取器的标题,仅进行单独选取,被选到的文件不一定要可以读取。
*
* @return 传回文件选取器是否打开成功
*/
public boolean showFileChooser() {
return showFileChooser("*/*");
}
/**
* 显示文件选取器,不设置文件选取器的标题,仅进行单独选取,被选到的文件不一定要可以读取。
*
* @param mimeType 传入筛选的MIME类型
* @return 传回文件选取器是否打开成功
*/
public boolean showFileChooser(final String mimeType) {
return showFileChooser(mimeType, null);
}
/**
* 显示文件选取器,仅进行单独选取,被选到的文件不一定要可以读取。
*
* @param mimeType 传入筛选的MIME类型
* @param chooserTitle 传入文件选取器的标题,若为null则用默认值
* @return 传回文件选取器是否打开成功
*/
public boolean showFileChooser(final String mimeType, final String chooserTitle) {
return showFileChooser(mimeType, chooserTitle, false);
}
/**
* 显示文件选取器,被选到的文件不一定要可以读取。
*
* @param mimeType 传入筛选的MIME类型
* @param chooserTitle 传入文件选取器的标题,若为null则用默认值
* @param allowMultiple 传入文件选取器是否使用复选
* @return 传回文件选取器是否打开成功
*/
public boolean showFileChooser(final String mimeType, final String chooserTitle, final boolean allowMultiple) {
return showFileChooser(mimeType, chooserTitle, allowMultiple, false);
}
/**
* 显示文件选取器。
*
* @param mimeType 传入筛选的MIME类型
* @param chooserTitle 传入文件选取器的标题,若为null则用默认值
* @param allowMultiple 传入文件选取器是否使用复选
* @param mustCanRead 传入被选到的文件是否一定要可以读取
* @return 传回文件选取器是否打开成功
*/
public boolean showFileChooser(final String mimeType, final String chooserTitle, final boolean allowMultiple, final boolean mustCanRead) {
if (mimeType == null || choosing) {
return false;
}
choosing = true;
// 检查是否有可用的Activity
final PackageManager packageManager = activity.getPackageManager();
final Intent intent = new Intent(Intent.ACTION_GET_CONTENT);
intent.setType(mimeType);
final List<ResolveInfo> list = packageManager.queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY);
if (list.size() > 0) {
this.mustCanRead = mustCanRead;
// 如果有可用的Activity
final Intent picker = new Intent(Intent.ACTION_GET_CONTENT);
picker.setType(mimeType);
picker.putExtra(Intent.EXTRA_ALLOW_MULTIPLE, allowMultiple);
picker.putExtra(Intent.EXTRA_LOCAL_ONLY, true);
// 使用Intent Chooser
final Intent destIntent = Intent.createChooser(picker, chooserTitle);
activity.startActivityForResult(destIntent, ACTIVITY_FILE_CHOOSER);
return true;
} else {
return false;
}
}
/**
* 当文件选取器被关闭后,应该要调用这个方法,判断文件选取器是否有选取到文件,接着再用getChosenFiles方法来取得选取结果。
*
* @param requestCode 传入Activity的Request Code
* @param resultCode 传入Activity的Request Code
* @param data 传入Activity的data
* @return 传回文件选取器是否有选取结果。
*/
public boolean onActivityResult(final int requestCode, final int resultCode, final Intent data) {
if (requestCode == ACTIVITY_FILE_CHOOSER) {
choosing = false;
if (resultCode == Activity.RESULT_OK) {
final Uri uri = data.getData();
if (uri != null) {
// 单选
chosenFiles = getFilesFromUris(activity, new Uri[]{uri}, mustCanRead);
return true;
} else if (Build.VERSION.SDK_INT >= 16) {
// 复选
final ClipData clipData = data.getClipData();
if (clipData != null) {
int count = clipData.getItemCount();
if (count > 0) {
final Uri[] uris = new Uri[count];
for (int i = 0; i < count; ++i) {
uris[i] = clipData.getItemAt(i).getUri();
}
chosenFiles = getFilesFromUris(activity, uris, mustCanRead);
return true;
}
}
}
}
}
return false;
}
/**
* 取得被选取到的文件。
*
* @return 传回被选取到的文件,过滤掉不成功的部份
*/
public File[] getChosenFiles(final boolean filter) {
if (chosenFiles == null) {
return new File[0];
} else {
final ArrayList<File> alFileList = new ArrayList<>();
for (final File chosenFile : chosenFiles) {
if (filter && chosenFile == null) {
continue;
}
alFileList.add(chosenFile);
}
final File[] files = new File[alFileList.size()];
alFileList.toArray(files);
return files;
}
}
/**
* 取得被选取到的文件。
*
* @return 传回被选取到的文件,过滤掉不成功的部份
*/
public File[] getChosenFiles() {
return getChosenFiles(true);
}
}
MagicFileChooser 的用法十分容易,如果只是要用来取得 URI 的实体路径,甚至不用使用 new 操作符来实体化出 MagicFileChooser 对象。
如果要使用 MagicFileChooser 来选取文件的话,一开始必须先将 MagicFileChooser 实体化,并且要在构造器的参数传入当前的 Activity。接着使用 showFileChooser 方法来显示出 Android 设备内可用的文件选取 App,或是文件选取 App 的列表。如果 showFileChooser 方法回传 false,表示设备内并没有适合的 Activity 能作为文件选取器。为了取得 MagicFileChooser 的文件选取结果,必须要覆写 Activity 的 onActivityResult 方法,要在 Activity 的 onActivityResult 方法中调用 MagicFileChooser 的 onActivityResult 方法。如果选取结果有回传成功,MagicFileChooser 的 onActivityResult 方法会传回 true,此时可以使用 MagicFileChooser 的 getChosenFiles 方法,取得用户所选的文件,型态为 File 数组。如此一来便能轻松无负担地选取文件了!

