使用 Image Loader 和自定义 schema 加载特殊来源的图片

首先,我们问一个问题。

Image Loader 一般拿来加载哪些图片?

不管是早期的 Universal-Image-Loader,还是后来的 PicassoGlide 以及 Fresco,它们都是很优秀的图片加载库,我们可以很轻松地通过它们来加载各种网络图片(http://, https://),甚至是从

  • 应用 Resource(android.resource://
  • 应用 Asset(file://android_asset/
  • 本地文件(file:///
  • 本地多媒体库(content://

加载图片。

但是,Image Loader 的作用绝不止于此。

Image Loader 还可以用来加载哪些图片?

  • 系统已安装动态壁纸的缩略图
  • 系统已安装应用的图标
  • 系统已安装应用里的图片资源
  • 未安装 apk 文件的图标
  • 未安装 apk 文件里的图片资源
  • 图片缩略图
  • 视频缩略图
  • 通讯录联系人头像

可以这么说,只要输出是图片的地方,都可以用 Image Loader 进行加载。

如何利用 Image Loader 加载这些特殊图片?

一种通用思路是,既然 Image Loader 根据 URL 来加载各种网络图片或本地图片,而它们的 schema 一般都不一样,如网络图片的 schema 是 httphttps,本地文件的 schema 是 file,那我们可以通过构造自定义 schema 的 URL,来指代不同类型(来源)的图片,只要配置 Image Loader 使其能从这些自定义 schema 的 URL 中识别并加载图片,后续就可以像加载普通图片一样方便地加载这些特殊图片了。

具体步骤如下。

1. 设计图片 URL 的格式

举个例子,比如我们在开发一个应用管理软件,需要在列表中显示系统已安装应用的图标,我们可以用 "application://com.elvishew.sampleapp/10" 表示包名为 com.elvishew.sampleapp、版本号为 10 的应用的缩略图。

又比如我们在开发一个文件管理器,需要显示 apk 文件的应用图标,我们可以用 "apk:///sdcard/sample.apk#1470000000000" 表示存放在 /sdcard 路径下、名为 sample.apk、最后修改时间戳为 1470000000000 的 apk 文件的应用图标。

以上有个小细节,我们把那些可能会影响加载结果的因素,如应用程序的版本号、apk 文件的最后修改时间戳,加入到 URL 中。这样一来,一旦这些影响因素变了,URL 也会跟着改变,Image Loader 就会视它们为不同的图片,而不去使用错误的缓存。

2. 配置 Image Loader,让其可以从自定义格式的 URL 中加载图片

首先,定义特殊图片的 schema。

1
2
3
4
5
6
7
8
// 系统已安装应用的图标 schema
public static final String URL_SCHEMA_APPLICATION = "application"

// apk 文件的应用图标 schema
public static final String URL_SCHEMA_APK = "apk"

// 省略其他 schema
...

其次,自定义 Downloader(Universal-Image-Loader) 或 RequestHandler(Picasso),在应用初始化时配置 Image Loader。

Universal-Image-Loader

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// 自定义 Downloader
private class CustomImageDownloader extends BaseImageDownloader {

// 省略部分代码
...

@Override
protected InputStream getStreamFromOtherSource(String imageUri, Object extra)
throws IOException {

InputStream is = null;
Uri uri = Uri.parse(imageUri);
if (URL_SCHEMA_APPLICATION.equals(uri.getScheme())) {
String packageName = uri.getHost();
is = getApplicationIconInputStream(packageName);
} else if (URL_SCHEMA_APK.equals(uri.getScheme())) {
String apkPath = uri.getAuthority();
is = getApkIconInputStream(apkPath);
}
... // 省略其他分支代码
return is;
}
}

// 配置 Universal-Image-Loader
ImageLoaderConfiguration.Builder configBuilder = new ImageLoaderConfiguration.Builder(context)
.imageDownloader(new CustomImageDownloader())
... // 省略其他配置代码

ImageLoader.getInstance().init(configBuilder.build());

Picasso

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// 自定义 RequestHandler
private class CustomRequestHandler extends RequestHandler {
@Override
public boolean canHandleRequest(Request data) {
return URL_SCHEMA_APPLICATION.equals(data.uri.getScheme())
|| URL_SCHEMA_APK.equals(data.uri.getScheme())
|| ... /* 省略其他 schema 的检查 */;
}

@Override
public Result load(Request request, int networkPolicy) throws IOException {
Uri uri = request.uri;
InputStream is = null;
if (URL_SCHEMA_APPLICATION.equals(uri.getScheme())) {
String packageName = uri.getHost();
int versionCode = uri.getPort();
is = getApplicationIconInputStream(packageName, versionCode);
} else if (URL_SCHEMA_APK.equals(uri.getScheme())) {
String apkPath = uri.getAuthority();
is = getApkIconInputStream(apkPath);
}
... // 省略其他分支代码
return new Result(is, Picasso.LoadedFrom.DISK);
}
}

// 配置 Picasso
mPicasso = new Picasso.Builder(context)
.addRequestHandler(new CustomRequestHandler())
.build();

3. 组装图片 URL

以加载 /sdcard/sample.apk 这个 apk 文件的应用图标为例,假设它的最后修改时间戳为 1470000000000,我们可以组装得到 URL "apk:///sdcard/sample.apk#1470000000000"

4. 使用组装的 URL 加载图片

Universal-Image-Loader

1
ImageLoader.getInstance().displayImage(uri, imageView);

Picasso

1
mPicasso.load(uri).into(imageView);

大功告成。

使用 Picasso 加载显示联系人头像

Picasso 自带了对加载显示联系人头像的支持,只要传入联系人头像的 URL,例如
"photo:content://com.android.contacts/contacts/1005/photo", 再调用 Picasso.load(Uri).into(ImageView),即可完成对联系人头像的显示。

但这种用法有个局限:当我们并不知道某个联系人的头像 URL 时,首先得通过名字(或其他,如电话号码)获取到联系人头像的 URL,而这通常是耗时操作(查询数据库),需要异步进行;这样一来,先异步查询出头像 URL,再交给 Picasso 进行异步加载并显示,两级异步显得有点儿鸡肋。所以本文除了简单介绍

  • Picasso 自带对联系人头像的支持

外,还将介绍另一种用法,

下面,我们以 根据联系人名字获取联系人头像 为例,来讲解这两种用法。

一、使用 Picasso 的内置支持来加载

Picasso(以 2.5.2 版本为例) 总共支持 5 种联系人头像的 URL 格式

  • photo:content://com.android.contacts/contacts/lookup/*/#
  • photo:content://com.android.contacts/contacts/lookup/*
  • photo:content://com.android.contacts/contacts/#/photo
  • photo:content://com.android.contacts/contacts/#
  • photo:content://com.android.contacts/display_photo/#

加载过程分以下几步:

1. 根据名字获取联系人头像的 URL

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Uri elvisUrl = getContactPhotoUrl("Elvis");

/**
* 根据名字获取联系人头像的 URL。
* @param contactName 联系人的名字
* @return 联系人头像的 URL
*/

@Nullable
public static Uri getContactPhotoUrl(Context context, String contactName) {
Uri phoneUri = null;
Cursor cursor = context.getContentResolver().query(
ContactsContract.Contacts.CONTENT_URI,
new String[]{ContactsContract.Contacts.PHOTO_URI},
ContactsContract.Contacts.DISPLAY_NAME_PRIMARY + " = ?",
new String[]{contactName},
null);
if (cursor != null) {
try {
if (cursor.moveToFirst()) {
String photoUrlString = cursor.getString(0);
if (!TextUtils.isEmpty(photoUrlString)) {
phoneUri = Uri.parse(photoUrlString);
}
}
} finally {
cursor.close();
}
}
return phoneUri;
}

2. 使用 Picasso.load(Uri).into(ImageView) 进行显示

1
mPicasso.load(elvisUrl).into(imageView);

二、使用自定义 RequestHandler 加载

1. 自定义 RequestHandler

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
public static final String URL_SCHEMA_CONTACT_PHOTO = "contact.photo";

private class CustomRequestHandler extends RequestHandler {
@Override
public boolean canHandleRequest(Request data) {
return URL_SCHEMA_CONTACT_PHOTO.equals(data.uri.getScheme());
}

/**
* 将联系人头像的缩略图数据作为输入流返回。
*/

@Override
public Result load(Request request, int networkPolicy) throws IOException {
Uri uri = request.uri;
// 从联系人 URL 中解析出联系人名字
String contactName = uri.getAuthority();
// 根据名字获取联系人的 Contact ID
long contactId = getContactId(mContext, contactName);
if (contactId <= 0) {
return null;
}
// 根据联系人的 Contact ID 获取联系人头像的缩略图数据
byte[] photoData = loadPhotoData(mContext, contactId);
if (photoData == null) {
return null;
}
InputStream photoInputStream = new ByteArrayInputStream(photoData);
return new Result(photoInputStream, Picasso.LoadedFrom.DISK);
}
}

/**
* 根据名字获取联系人的 Contact ID。
*
* @param displayName 联系人的名字
* @return 联系人的 Contact ID
*/

public static long getContactId(Context context, String displayName) {
long contactId = 0;
ContentResolver contentResolver = context.getContentResolver();
Uri uri = ContactsContract.Data.CONTENT_URI;
String[] projection = new String[]{ContactsContract.CommonDataKinds.StructuredName.CONTACT_ID};
String selection = ContactsContract.Data.MIMETYPE + " = ? AND "
+ ContactsContract.CommonDataKinds.StructuredName.DISPLAY_NAME + " = ?";
String[] selectionArguments = {
ContactsContract.CommonDataKinds.StructuredName.CONTENT_ITEM_TYPE, displayName};
Cursor cursor = contentResolver.query(uri, projection, selection, selectionArguments, null);
if (cursor != null) {
try {
if (cursor.moveToFirst()) {
contactId = cursor.getLong(0);
}
} finally {
cursor.close();
}
}
return contactId;
}

/**
* 根据联系人的 Contact ID 获取联系人头像的缩略图数据。
*
* @param contactId 联系人的 Contact ID
* @return 联系人头像的缩略图数据
*/

public static byte[] loadPhotoData(Context context, long contactId) {
byte[] photoData = null;
Uri contactUri = ContentUris.withAppendedId(ContactsContract.Contacts.CONTENT_URI, contactId);
Uri photoUri = Uri.withAppendedPath(contactUri,
ContactsContract.Contacts.Photo.CONTENT_DIRECTORY);
Cursor cursor = context.getContentResolver().query(photoUri,
new String[]{ContactsContract.Contacts.Photo.PHOTO}, null, null, null);
if (cursor != null) {
try {
if (cursor.moveToFirst()) {
photoData = cursor.getBlob(0);
}
} finally {
cursor.close();
}
}
return photoData;
}

2. 在初始化 Picasso 时添加自定义的 RequestHandler

1
2
3
4
mPicasso = new Picasso.Builder(context)
.addRequestHandler(new CustomRequestHandler())
... // 省略其他配置
.build();

3. 组装联系人(”Elvis”)的头像 URL

1
2
3
4
5
6
7
8
9
10
11
/**
* 获取代表特定联系人头像缩略图的 URL
*
* @param contactName 特定联系人的显示名
* @return 代表特定联系人头像缩略图的 URL
*/

public static Uri getContactPhotoLoadableUrl(String contactName) {
return new Uri.Builder().scheme(URL_SCHEMA_CONTACT_PHOTO).authority(contactName).build();
}

Uri elvisUrl = getContactPhotoLoadableUrl("Elvis");

4. 使用 Picasso.load(Uri).into(ImageView) 进行显示

1
mPicasso.load(elvisUrl).into(imageView);

至此,使用 Picasso 加截显示联系人头像的两种方法已介绍完毕。大家可根据自己需求,择其一使用。在联系人头像 URL 未知的情况下,优选第二种方案,这样可以让联系人的头像加载像其他网络图片的加载一样简便。