介绍图片Sd卡缓存的使用和功能。特性:1使用简单2根据系统配置初始化缓存3预取图片4支持文件sd卡保存5多种缓存算法或自定义6省流量性能佳7支持不同类型网络

本文主要介绍一个支持图片自动预取、支持多种缓存算法、支持数据保存和恢复的图片Sd卡缓存的使用、功能及网友反馈的常见问题解答。

需要二级缓存或ListView和GridView图片加载请优先使用ImageCache。

更多 Android 图片缓存开源项目可见 Android 图片缓存。

与Android LruCache相比主要特性：(1). 使用简单 (2). 轻松获取及预取新图片 (3). 可选择多种缓存算法(FIFO、LIFO、LRU、MRU、LFU、MFU等13种)或自定义缓存算法 (4). 可方便的保存及初始化恢复数据 (5). 支持文件sd卡保存及自定义文件名规则 (6). 省流量性能佳(有且仅有一个线程获取图片) (7). 支持不同类型网络处理 (8). 可根据系统配置初始化缓存 (9). 扩展性强 (10). 支持等待队列 (11). 包含map的大多数接口。

适用：获取图片较多且图片较大的应用，如新浪微博大图、twitter大图、微信图片、美丽说、蘑菇街、花瓣、淘宝等等。

本文以用ImageSDCardCache实现Gallery为例，示例代码地址见ImageSDCardCacheDemo，效果图如下：

Demo APK 可以方便的查看效果，在各大应用商店搜索 trinea android 下载即可，如：Google Play。

1、使用

（1）引入公共库

引入TrineaAndroidCommon@Github(欢迎star和fork^_^)作为你项目的library，或是自己抽取其中的ImageSDCardCache.java部分使用。

（2）调用

仅需简单三步：

a. AndroidManifest.xml中添加权限

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

1 2	<uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

b.定义缓存和回调接口

基本使用：只对ImageView加载图片有效，定义只需要一条语句

public static final ImageSDCardCache IMAGE_SD_CACHE = CacheManager.getImageSDCardCache();

1	public static final ImageSDCardCache IMAGE_SD_CACHE = CacheManager.getImageSDCardCache();

高级使用：自定义图片获取成功的回调接口，如下：

/** init cache **/
public static final ImageSDCardCache IMAGE_SD_CACHE = new ImageSDCardCache();

static {
    OnImageSDCallbackListener imageCallBack = new OnImageSDCallbackListener() {

		private static final long serialVersionUID = 1L;

		// callback function before get image, run on ui thread
		@Override
		public void onPreGet(String imageUrl, View view) {
			// Log.e(TAG_CACHE, "pre get image");
		}

		// callback function after get image successfully, run on ui thread
		@Override
		public void onGetSuccess(String imageUrl, String imagePath, View view, boolean isInCache) {
			ImageView imageView = (ImageView)view;
			Bitmap bm = BitmapFactory.decodeFile(imagePath);
			if (bm != null) {
				imageView.setImageBitmap(bm);
			}
		}

		// callback function after get image failed, run on ui thread
		@Override
		public void onGetFailed(String imageUrl, String imagePath, View view, FailedReason failedReason) {
			Log.e(TAG_CACHE,
				  new StringBuilder(128).append("get image ").append(imageUrl).append(" error"));
		}
	};
    IMAGE_SD_CACHE.setOnImageSDCallbackListener(imageCallBack);
    IMAGE_SD_CACHE.setCacheFolder(Environment.getExternalStorageDirectory().getAbsolutePath() + File.separator + "TrineaAndroidCommon");
}

/** init cache **/

public static final ImageSDCardCache IMAGE_SD_CACHE = new ImageSDCardCache();

static {

OnImageSDCallbackListener imageCallBack = new OnImageSDCallbackListener() {

private static final long serialVersionUID = 1L;

// callback function before get image, run on ui thread

@Override

public void onPreGet(String imageUrl, View view) {

// Log.e(TAG_CACHE, "pre get image");

}

// callback function after get image successfully, run on ui thread

@Override

public void onGetSuccess(String imageUrl, String imagePath, View view, boolean isInCache) {

ImageView imageView = (ImageView)view;

Bitmap bm = BitmapFactory.decodeFile(imagePath);

if (bm != null) {

imageView.setImageBitmap(bm);

}

// callback function after get image failed, run on ui thread

@Override

public void onGetFailed(String imageUrl, String imagePath, View view, FailedReason failedReason) {

Log.e(TAG_CACHE,

new StringBuilder(128).append("get image ").append(imageUrl).append(" error"));

}

};

IMAGE_SD_CACHE.setOnImageSDCallbackListener(imageCallBack);

IMAGE_SD_CACHE.setCacheFolder(Environment.getExternalStorageDirectory().getAbsolutePath() + File.separator + "TrineaAndroidCommon");

}

c. 需要加载图片的地方调用get(String imageUrl, View view)异步加载图片

IMAGE_SD_CACHE.get(imageUrl, imageView);

1	IMAGE_SD_CACHE.get(imageUrl, imageView);

上面代码中new ImageSDCardCache()用来定义图片缓存，默认会根据系统内存设置缓存大小。默认缓存算法为LFU(Least Frequently Used)，最近最少使用先删除。

setOnImageSDCallbackListener(imageCallBack);设置图片获取成功回调接口，其中onPreGet为图片获取前的回调函数，onGetSuccess为图片获取成功的回调函数，onGetFailed为图片获取失败的回调函数。

setCacheFolder(String cacheFolder) 设置图片文件保存路径，默认为ImageSDCardCache#DEFAULT_CACHE_FOLDER

setFileNameRule(FileNameRule fileNameRule) 设置图片保存时文件名规则，默认根据url命名，见2.4部分详细介绍

可以在程序退出时调用saveDataToDb(Context context, String tag)保存数据，在程序启动时调用initData(Context context, String tag)初始化恢复数据。其中tag为此ImageCache的标识。

get(imageUrl, imageView)异步获取图片，在图片获取成功后会自动调用onImageLoaded将参数传入。
get(String imageUrl,List<String> urlList, View view)异步获取图片，并且会自动预取urlList中的图片。

上面是最简单的实现。
第2部分会介绍支持的其他功能，包括网络类型设置、预取个数设置、多种缓存算法、图片SD卡保存目录及文件名规则设置、保存及初始化恢复数据、等待队列开关、图片源读取方式设置、读取图片http设置、缓存有效时间、命中率及大部分map接口。

2、功能介绍
(1) 多种构造函数，可根据系统配置初始化缓存

public ImageSDCardCache()
public ImageSDCardCache(int maxSize)
public ImageSDCardCache(int maxSize, int threadPoolSize)
支持三种构造函数，支持缓存大小和获取图片线程池大小的设置。默认会根据系统可用内存大小设置缓存大小，根据系统Cpu个数设置线程池大小。

(2)、获取图片及自动预取
get(String imageUrl, View view)异步获取图片，在图片获取成功后自动调用OnImageSDCallbackListener的onImageLoaded函数，返回是否已在缓存中
get(String imageUrl, List<String> urlList, View view)异步获取图片，在图片获取成功后自动调用OnImageSDCallbackListener的onImageLoaded函数，并且根据imageUrl在urlList中的位置向前向后预取图片，返回是否已在缓存中。

public void setForwardCacheNumber(int forwardCacheNumber) 向前预取图片个数设置，默认为PreloadDataCache#DEFAULT_FORWARD_CACHE_NUMBER

public void setBackwardCacheNumber(int backwardCacheNumber)向后预取图片个数设置默认，默认为PreloadDataCache#DEFAULT_BACKWARD_CACHE_NUMBER

public CacheObject<V> get(K key)
public CacheObject<V> get(K key, List<K> keyList)
两个接口是直接同步获取图片，且获取成功后不会调用OnImageSDCallbackListener的onImageLoaded函数

(3)、设置缓存算法
setCacheFullRemoveType(CacheFullRemoveType<String> cacheFullRemoveType)
设置缓存算法，缓存算法即为缓存满时为了插入新数据，删除旧数据的规则。

目前包括FIFO、LIFO、LRU、MRU、LFU、MFU、优先级低先删除、优先级高先删除、数据小先删除、数据大先删除、图片小先删除、图片大先删除、永不删除。还可以通过实现CacheFullRemoveType来自定义缓存算法。。默认为RemoveTypeUsedCountSmall，即LRU使用频率低先删除。下面详细介绍各个算法：

RemoveTypeEnterTimeFirst FIFO先进先出，先进入先删除
RemoveTypeEnterTimeLast LIFO后进先出，后进入先删除
RemoveTypeLastUsedTimeFirst LRU(Least Recently User)，最先使用先删除
RemoveTypeLastUsedTimeLast MRU(Most Recently Used)，最近使用先删除
RemoveTypeUsedCountSmall LFU(Least Frequently Used)，使用频率低先删除
RemoveTypeUsedCountBig MRU(Most Frequently Used)，使用频率高先删除
RemoveTypePriorityLow 优先级低先删除
RemoveTypePriorityHigh 优先级低先删除
RemoveTypeFileSmall 文件小的先删除
RemoveTypeFileLarge 文件大的先删除

RemoveTypeDataBig 数据大先删除，根据缓存数据的compareTo函数决定
RemoveTypeDataSmall 数据小先删除，根据缓存数据的compareTo函数决定
RemoveTypeNotRemove 不删除，缓存满时不再允许插入新数据

自定义缓存算法只需要实现CacheFullRemoveType的compare方法即可。比较结果小于0表示会被先删除

public class MyRemoveType<T> implements CacheFullRemoveType<T> {

    private static final long serialVersionUID = 1L;

    @Override
    public int compare(CacheObject<T> obj1, CacheObject<T> obj2) {
        // process and return, smaller than zero means may be removed
        return ***;
    }
}

public class MyRemoveType<T> implements CacheFullRemoveType<T> {

private static final long serialVersionUID = 1L;

@Override

public int compare(CacheObject<T> obj1, CacheObject<T> obj2) {

// process and return, smaller than zero means may be removed

return ***;

}

(4)、设置图片SD卡保存目录及文件名规则

setCacheFolder(String cacheFolder) 设置图片文件保存路径，默认为ImageSDCardCache#DEFAULT_CACHE_FOLDER

setFileNameRule(FileNameRule fileNameRule) 设置图片保存时文件名规则，默认根据url命名。已有命名规则有：

FileNameRuleImageUrl 根据图片url命名，url中所有非数字字母都会替换为_

FileNameRuleCurrentTime 根据当前图片获取成功时间命名，支持各种时间格式，见FileNameRuleCurrentTime#TimeRule

自定义文件命名规则算法只需要实现FileNameRule的getFileName方法即可。返回结果即为文件名，注释不能包含文件名以外的非法字符

public class MyFileNameRule implements FileNameRule {

    private static final long  serialVersionUID     = 1L;

    @Override
    public String getFileName(String imageUrl) {
        // process and return, the result need not contain char which not allowed in File name
        return ****;
    }
}

public class MyFileNameRule implements FileNameRule {

private static final long serialVersionUID = 1L;

@Override

public String getFileName(String imageUrl) {

// process and return, the result need not contain char which not allowed in File name

return ****;

}

(5)、保存及初始化恢复数据
public boolean saveDataToDb(Context context, String tag)
保存数据到数据库，可在程序退出时调用，不建议在activity onDestrory时调用，而是整个程序退出时，见本文3.1常见问题解答。

public void initData(Context context, String tag)

初始化恢复数据，可在程序刚开始加载时调用，不建议在每个activity oncreate调用，而是整个程序初始化时，见本文3.1常见问题解答。

(6)、是否启用队列

setOpenWaitingQueue(boolean isOpenWaitingQueue)
当不同view通过get函数获取图片时，是否开启等待队列。

若开启，保存所有view，图片获取成功后依次调用OnImageSDCallbackListener的onImageLoaded函数；否则仅保存最后调用get的view，图片获取成功后调用OnImageSDCallbackListener的onImageLoaded函数
默认开启队列等待。如果希望最优性能且场景满足，可设置为false。

(7)、设置图片获取方式接口
setOnGetDataListener(OnGetDataListener<String, String> onGetDataListener)
设置图片获取的方式。缓存通过该接口获取图片及预取图片。默认为ImageSDCardCache中getDefaultOnGetImageListener，通过url获取图片。你可以重写该方法将图片缓存改为本地图片文件缓存等等。

(8)、读取图片http设置
a. 设置图片读取http超时
public void setHttpReadTimeOut(int readTimeOutMillis)
若readTimeOutMillis小于0表示不设置超时，默认不设置，单位为毫秒

b. 设置无网络不读取
public void setContext(Context context)
设置context，网络连接失败不会新建线程请求图片。

c. 支持不同网络类型的处理
public void setAllowedNetworkTypes(int allowedNetworkTypes)
设置允许的网络类型，可选择PreloadDataCache#NETWORK_MOBILE、PreloadDataCache#NETWORK_WIFI或两者都允许。默认两者都允许。
注意：这个接口生效必须先setContext(Context context)

d. 设置读取图片http请求属性
public void setRequestProperties(Map<String, String> requestProperties)

public void setRequestProperty(String field, String newValue)
设置获取图片时的http request属性，如

setRequestProperty(“User-Agent”, “TrineaAndroidCommon/4.0 (Android 4.0) MI_2S”);设置User-Agent头信息
setRequestProperty(“Connection”, “false”);设置connection keep alive为false，默认为true

(9)、缓存元素有效时间
setValidTime(long validTime)
设置缓存元素有效时间，小于0表示不会失效，此时仅根据CacheFullRemoveType在缓存满时替换元素
通过protected boolean isExpired(K key)判断某key是否过期

(10)、缓存命中率
getHitRate()、getHitCount()、getMissCount()分别表示缓存命中率、命中次数、未命中次数

(11)、其他与map类似接口
public boolean containsKey(K key) 缓存中是否包含该key
public CacheObject<V> remove(K key) 从缓存中删除某个key
public void clear() 清空缓存
public Set<K> keySet() 缓存中key集合
public Set<Map.Entry<K, CacheObject<V>>> entrySet() 缓存中key,value键值对集合
public Collection<CacheObject<V>> values() 缓存中元素集合
public CacheObject<V> put(K key, V value) 手动插入某个元素
public CacheObject<V> put(K key, CacheObject<V> value) 手动插入某个元素
public CacheObject<V> get(K key) 得到某个key
public int getSize() 得到缓存中有效元素个数
public int getMaxSize() 得到缓存中元素最大个数

(12)得到设置
上面的set几乎都可以通过对应的get得到相应value
使用getOnGetDataListener()得到获取图片的方法
getForwardCacheNumber()得到自动向前缓存的个数
getBackCacheNumber()得到自动向后缓存的个数
getMaxSize()得到缓存最大容量
getValidTime()得到有效时间，以毫秒计
getCacheFullRemoveType()得到cache满时删除元素类型

3、常见问题解答
1、是每个Activity一个ImageSDCardCache还是整个程序共用一个？

建议ImageSDCardCache缓存整个app用同一个实例，而不是每个activity一个。在程序启动时initData初始化图片缓存，退出saveDataToDb保存图片缓存。因为：
a. 你的程序总不能就一个activity需要图片缓存，缓存本身就该应该所有页面共用
b. 每次进activity新建一个缓存只会增加系统消耗，没有必要
c. 这个缓存不会占用太多内存，所以程序运行期间一直存在也不会对性能有多大影响

2、为什么应用退出后会重新获取图片？为什么应用退出后无网络情况下之前缓存的图片不会自己加载？

在程序退出(比如onDestroy函数)时调用saveDataToDb(Context context, String tag)保存数据，在程序启动(比如onCreate函数)时调用initData(Context context, String tag)初始化数据。其中tag为此ImageCache的标识。

3、为什么无法加载图片？
可通过OnImageSDCallbackListener中的onGetFailed函数FailedReason参数判断失败原因。目前错误原因包括sdcard保存出错(请确保存在外部sdcard)和网络出错。

4、能否直接加载sdcard中已经存在的图片，即数据源为本地sdcard而不是网络？
可以通过setOnGetDataListener(OnGetDataListener<String, String> onGetDataListener)设置图片获取方式

5、配合ListView和GridView使用时卡顿？
请使用ImageCache，包含二级缓存，性能更佳

6、其他

ListView滑动过程中图片显示重复错乱闪烁问题解决
 图片OutOfMemory异常bitmap size exceeds VM budget的原因及解决方法

84 thoughts on “Android 图片SD卡缓存使用简单支持预取支持多种缓存算法支持不同网络类型支持序列化”

匿名

2017 年 4 月 30 日 at 上午 10:52

ImageSDCardCache initData不是一个静态方法，需要new 一个ImageSDCardCache 来使用吗？

回复
回头无岸

2014 年 9 月 23 日 at 下午 3:26

楼主你好，想问下现在我知道图片的url链接，图片也已经缓存下来了，通过什么方法可以获取到图片的本地链接？

回复
- Trinea
  
  2014 年 9 月 24 日 at 上午 12:50
  
  imageCache.getFileNameRule().getFileName(imageUrl)
  
  回复
anonymous

2014 年 6 月 3 日 at 下午 12:11

请问我现在要实现这一一个功能，里面有网络图片，有本地图片，怎么用你这个图片缓存呢？

回复
- Trinea
  
  2014 年 6 月 5 日 at 下午 8:20
  
  开两个缓存
  
  回复
  - anonymous
    
    2014 年 6 月 6 日 at 下午 2:43
    
    您说的开两个缓存的意思是？一个SD卡和一个普通的？不是很明白，忘明示！谢谢
    
    回复
    - Trinea
      
      2014 年 6 月 6 日 at 下午 3:28
      
      使用http://www.trinea.cn/android/android-imagecache/
    - anonymous
      
      2014 年 6 月 6 日 at 下午 4:20
      
      setOnGetDataListener(new OnGetDataListener() { private static final long serialVersionUID = 1L; @Override public CacheObject onGetData(String imagePath) { if (!FileUtils.isFileExist(imagePath)) { return null; } CompressListener compressListener = IMAGE_CACHE.getCompressListener(); int compressSize = 0; if (compressListener != null) { compressSize = compressListener.getCompressSize(imagePath); } Bitmap bm; if (compressSize > 1) { BitmapFactory.Options option = new BitmapFactory.Options(); option.inSampleSize = compressSize; bm = BitmapFactory.decodeFile(imagePath, option); } else { bm = BitmapFactory.decodeFile(imagePath); } return (bm == null ? null : new CacheObject(bm)); }});按照这个代码还是现实不出来呢、图片都不能现实。
    - anonymous
      
      2014 年 6 月 6 日 at 下午 4:21
      
      还有，这个没看到在哪设置图片呢？比如普通网络图片可以在onGetSuccess中看到设置图片的控件，但是这个没这个回调？
    - anonymous
      
      2014 年 6 月 6 日 at 下午 4:22
      
      我调用设置图片的时候还是这样调用的，不知道对不对？LoveCrystalApplication.IMAGE_SD_CACHE.get(imageUrl, holder.mReleImg)其它初始化，保存，都和网络一样，只不过设置setOnGetDataListener的时候使用的是上面的代码
_Xue散落雨水时

2014 年 3 月 14 日 at 下午 4:43

有一个问题，我使用ViewPager配合PhotoView在ViewPager里第一张图片会无法显示，图片是缓存过的，调试了一下本地路径获取的是正确的，也有调用setImageBitmap设置图片

回复
- Trinea
  
  2014 年 3 月 14 日 at 下午 5:07
  
  去掉photoview排查下具体是因为哪个库的原因
  
  回复
  - _Xue散落雨水时
    
    2014 年 3 月 14 日 at 下午 5:42
    
    还真是PhotoView的问题，真奇怪除了第一张其他都可以正常显示，从第二张回到第一张，第一张就显示出来了。还没找到解决方法
    
    回复
清王朝超

2013 年 12 月 27 日 at 下午 5:09

你好，二级缓存什么意思啊，我的主要是listview显示图片，用什么方法比较好，现在用的是保存到sd卡，但是经常OOM

回复
- Trinea
  
  2013 年 12 月 27 日 at 下午 5:46
  
  用ImageCache
  
  回复

84 thoughts on “Android 图片SD卡缓存 使用简单 支持预取 支持多种缓存算法 支持不同网络类型 支持序列化”

84 thoughts on “Android 图片SD卡缓存使用简单支持预取支持多种缓存算法支持不同网络类型支持序列化”