cn.trinea.android.common.service.impl

类 ImageCache

java.lang.Object

cn.trinea.android.common.service.impl.SimpleCache<K,V>

cn.trinea.android.common.service.impl.PreloadDataCache<String,android.graphics.Bitmap>

cn.trinea.android.common.service.impl.ImageMemoryCache

cn.trinea.android.common.service.impl.ImageCache

所有已实现的接口:

Cache<String,android.graphics.Bitmap>, Serializable

public class ImageCache
extends ImageMemoryCache

Image Cache

It's a cache with primary cache and secondary cache. It's a combination of ImageMemoryCache and ImageSDCardCache. It applies to apps those used much images, like sina weibo, twitter, taobao, huaban, weixin and so on.

Setting and Usage
• Use one of constructors in sections II to init cache
• ImageMemoryCache.setOnImageCallbackListener(OnImageCallbackListener) set callback interface after image get success
• ImageMemoryCache.get(String, List, View) get image asynchronous and preload other images asynchronous according to urlList
• ImageMemoryCache.get(String, View) get image asynchronous
• initData(Context, String) or loadDataFromDb(Context, String) to init data when app start, saveDataToDb(Context, String) to save data when app exit
• setHttpReadTimeOut(int) set http read image time out, if less than 0, not set. default is not set
• PreloadDataCache.setContext(Context) and setAllowedNetworkTypes(int) restrict the types of networks over which this data can get.
• ImageMemoryCache.setOpenWaitingQueue(boolean) set whether open waiting queue, default is true. If true, save all view waiting for image loaded, else only save the newest one
• PreloadDataCache.setOnGetDataListener(OnGetDataListener) set how to get image, this cache will get image and preload images by it
• SimpleCache.setCacheFullRemoveType(CacheFullRemoveType) set remove type when primary cache is full
• setCacheFullRemoveTypeOfSecondaryCache(CacheFullRemoveType) set remove type when secondary cache is full

Constructor
• ImageCache()
• ImageCache(int)
• ImageCache(int, int)
• ImageCache(int, int, int, int)

Attentions
• You should add android.permission.WRITE_EXTERNAL_STORAGE in manifest, to store image to sdcard.
• You should add android.permission.ACCESS_NETWORK_STATE in manifest if you get image from network.

作者:

Trinea 2013-10-18

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	ImageCache.CompressListener set image compress scale

从类继承的嵌套类/接口 cn.trinea.android.common.service.impl.ImageMemoryCache

ImageMemoryCache.OnImageCallbackListener

从类继承的嵌套类/接口 cn.trinea.android.common.service.impl.PreloadDataCache

PreloadDataCache.OnGetDataListener<K,V>

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_CACHE_FOLDER cache folder path which be used when saving images

从类继承的字段 cn.trinea.android.common.service.impl.ImageMemoryCache

DEFAULT_MAX_SIZE

从类继承的字段 cn.trinea.android.common.service.impl.PreloadDataCache

DEFAULT_BACKWARD_CACHE_NUMBER, DEFAULT_FORWARD_CACHE_NUMBER, DEFAULT_THREAD_POOL_SIZE, NETWORK_MOBILE, NETWORK_WIFI, onGetDataListener

从类继承的字段 cn.trinea.android.common.service.impl.SimpleCache

cache, hitCount, missCount

构造器概要

构造器

构造器和说明
ImageCache() max size of primary cache is ImageMemoryCache.DEFAULT_MAX_SIZE, max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE
ImageCache(int primaryCacheMaxSize) max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE
ImageCache(int primaryCacheMaxSize, int secondaryCacheMaxSize) thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE
ImageCache(int primaryCacheMaxSize, int primaryCacheThreadPoolSize, int secondaryCacheMaxSize, int secondaryCacheThreadPoolSize) Callback interface after image get success is null, can set by PreloadDataCache#setOnImageCallbackListener(OnImageCallbackListener) Get data listener of primary cache is getOnGetImageListenerOfPrimaryCache(), you can set by #setOnGetImageListenerOfPrimaryCache(OnGetDataListener), but not recommended, you may destory secondary cache.

方法概要

方法

限定符和类型	方法和说明
boolean	checkIsNetworkTypeAllowed() Check if get data can proceed over the given network type.
void	clear() clear both primary cache and secondary cache
void	deleteUnusedFiles() delete unused file in getCacheFolder(), you can use it after loadDataFromDb(Context, String) at first time
int	getAllowedNetworkTypes() get the types of networks over which this data can get
String	getCacheFolder() get cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
CacheFullRemoveType<String>	getCacheFullRemoveTypeOfSecondaryCache() get remove type when secondary cache is full
ImageCache.CompressListener	getCompressListener() get compressListener
int	getCompressSize() get compressSize
android.content.Context	getContext()
FileNameRule	getFileNameRule() get file name rule which be used when saving images, default is FileNameRuleImageUrl
int	getHttpReadTimeOut() get http read image time out of secondary cache, if less than 0, not set. default is not set
String	getImagePath(String imageUrl) get image file path
PreloadDataCache.OnGetDataListener<String,android.graphics.Bitmap>	getOnGetImageListenerOfPrimaryCache() get get image listener of primary cache
PreloadDataCache.OnGetDataListener<String,String>	getOnGetImageListenerOfSecondaryCache() get get image listener of secondary cache
Map<String,String>	getRequestProperties() get http request properties
void	initData(android.content.Context context, String tag) load all data from db and delete unused file in getCacheFolder() It's a combination of loadDataFromDb(Context, String) and deleteUnusedFiles() You should use saveDataToDb(Context, String) to save data when app exit
boolean	isCheckNetwork() get whether to check the network at first when get data, used when PreloadDataCache.checkIsNetworkTypeAllowed()
boolean	loadDataFromDb(android.content.Context context, String tag) load all data in db whose tag is same to tag to this cache. just put, do not affect the original data Attentions: If tag is null or empty, throws exception You should use saveDataToDb(Context, String) to save data when app exit
boolean	saveDataToDb(android.content.Context context, String tag) delete all rows in db whose tag is same to tag at first, and insert all data in this cache to db Attentions: If tag is null or empty, throws exception Will delete all rows in db whose tag is same to tag at first You can use initData(Context, String) or loadDataFromDb(Context, String) to init data when app start
void	setAllowedNetworkTypes(int allowedNetworkTypes) Restrict the types of networks over which this data can get.
void	setBackwardCacheNumber(int backwardCacheNumber) set count for preload backward, default is PreloadDataCache.DEFAULT_BACKWARD_CACHE_NUMBER
void	setCacheFolder(String cacheFolder) set cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER
void	setCacheFullRemoveTypeOfSecondaryCache(CacheFullRemoveType<String> cacheFullRemoveType) set remove type when secondary cache is full
void	setCheckNetwork(boolean isCheckNetwork) set whether to check the network at first when get data, used when PreloadDataCache.checkIsNetworkTypeAllowed()
void	setCompressListener(ImageCache.CompressListener compressListener) set compressListener Attentions: if this function is set, the function #setCompressSize(String) is not work
void	setCompressSize(int compressSize) set image compress scale Attentions: if setCompressListener(CompressListener) is set, this function is not work
void	setContext(android.content.Context context) used when PreloadDataCache.checkIsNetworkTypeAllowed()
void	setFileNameRule(FileNameRule fileNameRule) set file name rule which be used when saving images, default is FileNameRuleImageUrl
void	setForwardCacheNumber(int forwardCacheNumber) set count for preload forward, default is PreloadDataCache.DEFAULT_FORWARD_CACHE_NUMBER
void	setHttpReadTimeOut(int readTimeOutMillis) set http read image time out of secondary cache, if less than 0, not set. default is not set, in mills
void	setOnGetImageListenerOfPrimaryCache(PreloadDataCache.OnGetDataListener<String,android.graphics.Bitmap> onGetImageListener) set get data listener of primary cache, primary cache will get data and preload data by it
void	setOnGetImageListenerOfSecondaryCache(PreloadDataCache.OnGetDataListener<String,String> onGetImageListener) set get data listener of secondary cache, secondary cache will get data and preload data by it
void	setRequestProperties(Map<String,String> requestProperties) set http request properties If image is from the different server, setRequestProperty("Connection", "false") is recommended.
void	setRequestProperty(String field, String newValue) Sets the value of the http request header field
protected void	shutdown()
List<Runnable>	shutdownNow()

从类继承的方法 cn.trinea.android.common.service.impl.ImageMemoryCache

get, get, getDefaultOnGetImageListener, getOnImageCallbackListener, isOpenWaitingQueue, setOnImageCallbackListener, setOpenWaitingQueue

从类继承的方法 cn.trinea.android.common.service.impl.PreloadDataCache

get, get, getBackwardCacheNumber, getForwardCacheNumber, getOnGetDataListener, isExistGettingDataThread, loadCache, preloadDataBackward, preloadDataForward, setOnGetDataListener

从类继承的方法 cn.trinea.android.common.service.impl.SimpleCache

containsKey, entrySet, fullRemoveOne, getCacheFullRemoveType, getHitCount, getHitRate, getMaxSize, getMissCount, getSize, getValidTime, isExpired, isExpired, keySet, put, put, putAll, remove, removeExpired, saveCache, setCacheFullRemoveType, setUsedInfo, setValidTime, values

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

DEFAULT_CACHE_FOLDER

public static final String DEFAULT_CACHE_FOLDER

cache folder path which be used when saving images

构造器详细资料

ImageCache

public ImageCache()

• max size of primary cache is ImageMemoryCache.DEFAULT_MAX_SIZE, max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE
• thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE

另请参阅:

#ImageCache(int, int, int, int)}

ImageCache

public ImageCache(int primaryCacheMaxSize)

• max size of secondary cache is ImageSDCardCache.DEFAULT_MAX_SIZE
• thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE

参数:

primaryCacheMaxSize -

secondaryCacheMaxSize -

另请参阅:

#ImageCache(int, int, int, int)}

ImageCache

public ImageCache(int primaryCacheMaxSize,
          int secondaryCacheMaxSize)

thread pool size of primary cache and secondary cache both are PreloadDataCache.DEFAULT_THREAD_POOL_SIZE

参数:

primaryCacheMaxSize -

secondaryCacheMaxSize -

另请参阅:

#ImageCache(int, int, int, int)}

ImageCache

public ImageCache(int primaryCacheMaxSize,
          int primaryCacheThreadPoolSize,
          int secondaryCacheMaxSize,
          int secondaryCacheThreadPoolSize)

• Callback interface after image get success is null, can set by PreloadDataCache#setOnImageCallbackListener(OnImageCallbackListener)
• Get data listener of primary cache is getOnGetImageListenerOfPrimaryCache(), you can set by #setOnGetImageListenerOfPrimaryCache(OnGetDataListener), but not recommended, you may destory secondary cache.
• Get data listener of secondary cache is getOnGetImageListenerOfSecondaryCache(), you can set by #setOnGetImageListenerOfSecondaryCache(OnGetDataListener).
• Elements of the cache will not invalid
• Remove type of primary cache is RemoveTypeUsedCountSmall when cache is full

参数:

primaryCacheMaxSize - maximum size of the primary cache

primaryCacheThreadPoolSize - getting data thread pool size of the primary cache

secondaryCacheMaxSize - maximum size of the secondary cache

secondaryCacheThreadPoolSize - getting data thread pool size of the secondary cache

方法详细资料

getCompressSize

public int getCompressSize()

get compressSize

返回:

the compressSize

setCompressSize

public void setCompressSize(int compressSize)

set image compress scale

Attentions:
• if setCompressListener(CompressListener) is set, this function is not work

参数:

compressSize - the compressSize to set

另请参阅:

#setCompressSize(String)}

setCompressListener

public void setCompressListener(ImageCache.CompressListener compressListener)

set compressListener

Attentions:
• if this function is set, the function #setCompressSize(String) is not work

参数:

compressListener -

getCompressListener

public ImageCache.CompressListener getCompressListener()

get compressListener

返回:

compressListener

getHttpReadTimeOut

public int getHttpReadTimeOut()

get http read image time out of secondary cache, if less than 0, not set. default is not set

覆盖:

getHttpReadTimeOut 在类中 ImageMemoryCache

返回:

the httpReadTimeOut

setHttpReadTimeOut

public void setHttpReadTimeOut(int readTimeOutMillis)

set http read image time out of secondary cache, if less than 0, not set. default is not set, in mills

覆盖:

setHttpReadTimeOut 在类中 ImageMemoryCache

参数:

readTimeOutMillis -

clear

public void clear()

clear both primary cache and secondary cache

指定者:

clear 在接口中 Cache<String,android.graphics.Bitmap>

覆盖:

clear 在类中 SimpleCache<String,android.graphics.Bitmap>

另请参阅:

Map.clear()

setForwardCacheNumber

public void setForwardCacheNumber(int forwardCacheNumber)

从类复制的说明: PreloadDataCache

set count for preload forward, default is PreloadDataCache.DEFAULT_FORWARD_CACHE_NUMBER

覆盖:

setForwardCacheNumber 在类中 PreloadDataCache<String,android.graphics.Bitmap>

setBackwardCacheNumber

public void setBackwardCacheNumber(int backwardCacheNumber)

从类复制的说明: PreloadDataCache

set count for preload backward, default is PreloadDataCache.DEFAULT_BACKWARD_CACHE_NUMBER

覆盖:

setBackwardCacheNumber 在类中 PreloadDataCache<String,android.graphics.Bitmap>

getAllowedNetworkTypes

public int getAllowedNetworkTypes()

从类复制的说明: PreloadDataCache

get the types of networks over which this data can get

覆盖:

getAllowedNetworkTypes 在类中 PreloadDataCache<String,android.graphics.Bitmap>

返回:

any combination of the NETWORK_* bit flags.

setAllowedNetworkTypes

public void setAllowedNetworkTypes(int allowedNetworkTypes)

从类复制的说明: PreloadDataCache

Restrict the types of networks over which this data can get. By default, all network types are allowed.

Attentions:
• To make it effective, you need to ensure that PreloadDataCache.getContext() is not null

覆盖:

setAllowedNetworkTypes 在类中 PreloadDataCache<String,android.graphics.Bitmap>

参数:

allowedNetworkTypes - any combination of the NETWORK_* bit flags.

isCheckNetwork

public boolean isCheckNetwork()

从类复制的说明: PreloadDataCache

get whether to check the network at first when get data, used when PreloadDataCache.checkIsNetworkTypeAllowed()

覆盖:

isCheckNetwork 在类中 PreloadDataCache<String,android.graphics.Bitmap>

返回:

setCheckNetwork

public void setCheckNetwork(boolean isCheckNetwork)

从类复制的说明: PreloadDataCache

set whether to check the network at first when get data, used when PreloadDataCache.checkIsNetworkTypeAllowed()

覆盖:

setCheckNetwork 在类中 PreloadDataCache<String,android.graphics.Bitmap>

checkIsNetworkTypeAllowed

public boolean checkIsNetworkTypeAllowed()

从类复制的说明: PreloadDataCache

Check if get data can proceed over the given network type.

覆盖:

checkIsNetworkTypeAllowed 在类中 PreloadDataCache<String,android.graphics.Bitmap>

返回:

one of the NETWORK_* constants

• if PreloadDataCache.getContext() is null, return true
• if network is not avaliable, return false
• if PreloadDataCache.getAllowedNetworkTypes() is not match network, return false

getContext

public android.content.Context getContext()

覆盖:

getContext 在类中 PreloadDataCache<String,android.graphics.Bitmap>

setContext

public void setContext(android.content.Context context)

从类复制的说明: PreloadDataCache

used when PreloadDataCache.checkIsNetworkTypeAllowed()

覆盖:

setContext 在类中 PreloadDataCache<String,android.graphics.Bitmap>

setRequestProperties

public void setRequestProperties(Map<String,String> requestProperties)

set http request properties

• If image is from the different server, setRequestProperty("Connection", "false") is recommended. If image is from the same server, true is recommended, and this is the default value

覆盖:

setRequestProperties 在类中 ImageMemoryCache

参数:

requestProperties -

getRequestProperties

public Map<String,String> getRequestProperties()

get http request properties

覆盖:

getRequestProperties 在类中 ImageMemoryCache

返回:

setRequestProperty

public void setRequestProperty(String field,
                      String newValue)

Sets the value of the http request header field

覆盖:

setRequestProperty 在类中 ImageMemoryCache

参数:

field - the request header field to be set

newValue - the new value of the specified property

另请参阅:

#setRequestProperties(Map)}

getCacheFolder

public String getCacheFolder()

get cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER

返回:

the cacheFolder

另请参阅:

ImageSDCardCache.getCacheFolder()

setCacheFolder

public void setCacheFolder(String cacheFolder)

set cache folder path which be used when saving images, default is DEFAULT_CACHE_FOLDER

参数:

cacheFolder -

另请参阅:

ImageSDCardCache.setCacheFolder(String)

getFileNameRule

public FileNameRule getFileNameRule()

get file name rule which be used when saving images, default is FileNameRuleImageUrl

返回:

the fileNameRule

另请参阅:

ImageSDCardCache.getFileNameRule()

setFileNameRule

public void setFileNameRule(FileNameRule fileNameRule)

set file name rule which be used when saving images, default is FileNameRuleImageUrl

参数:

fileNameRule -

另请参阅:

ImageSDCardCache.setFileNameRule(FileNameRule)

initData

public void initData(android.content.Context context,
            String tag)

load all data from db and delete unused file in getCacheFolder()

• It's a combination of loadDataFromDb(Context, String) and deleteUnusedFiles()
• You should use saveDataToDb(Context, String) to save data when app exit

参数:

context -

tag -

另请参阅:

loadDataFromDb(Context, String), deleteUnusedFiles()

deleteUnusedFiles

public void deleteUnusedFiles()

delete unused file in getCacheFolder(), you can use it after loadDataFromDb(Context, String) at first time

另请参阅:

ImageSDCardCache#deleteUnusedFiles()}

loadDataFromDb

public boolean loadDataFromDb(android.content.Context context,
                     String tag)

load all data in db whose tag is same to tag to this cache. just put, do not affect the original data

Attentions:
• If tag is null or empty, throws exception
• You should use saveDataToDb(Context, String) to save data when app exit

参数:

context -

tag - tag used to mark this cache when save to and load from db, should be unique and cannot be null or empty

返回:

另请参阅:

ImageSDCardCache.loadDataFromDb(Context, ImageSDCardCache, String)

saveDataToDb

public boolean saveDataToDb(android.content.Context context,
                   String tag)

delete all rows in db whose tag is same to tag at first, and insert all data in this cache to db

Attentions:
• If tag is null or empty, throws exception
• Will delete all rows in db whose tag is same to tag at first
• You can use initData(Context, String) or loadDataFromDb(Context, String) to init data when app start

参数:

context -

tag - tag used to mark this cache when save to and load from db, should be unique and cannot be null or empty

返回:

另请参阅:

ImageSDCardCache.saveDataToDb(Context, ImageSDCardCache, String)

getImagePath

public String getImagePath(String imageUrl)

get image file path

参数:

imageUrl -

返回:

if not in cache return null, else return full path.

shutdown

protected void shutdown()

覆盖:

shutdown 在类中 ImageMemoryCache

另请参阅:

ExecutorService.shutdown()

shutdownNow

public List<Runnable> shutdownNow()

覆盖:

shutdownNow 在类中 ImageMemoryCache

另请参阅:

ExecutorService.shutdownNow()

getOnGetImageListenerOfPrimaryCache

public PreloadDataCache.OnGetDataListener<String,android.graphics.Bitmap> getOnGetImageListenerOfPrimaryCache()

get get image listener of primary cache

返回:

另请参阅:

PreloadDataCache#getOnGetDataListener()}

setOnGetImageListenerOfPrimaryCache

public void setOnGetImageListenerOfPrimaryCache(PreloadDataCache.OnGetDataListener<String,android.graphics.Bitmap> onGetImageListener)

set get data listener of primary cache, primary cache will get data and preload data by it

参数:

onGetImageListener -

另请参阅:

PreloadDataCache#setOnGetDataListener(OnGetDataListener)}

getOnGetImageListenerOfSecondaryCache

public PreloadDataCache.OnGetDataListener<String,String> getOnGetImageListenerOfSecondaryCache()

get get image listener of secondary cache

返回:

setOnGetImageListenerOfSecondaryCache

public void setOnGetImageListenerOfSecondaryCache(PreloadDataCache.OnGetDataListener<String,String> onGetImageListener)

set get data listener of secondary cache, secondary cache will get data and preload data by it

参数:

onGetImageListener -

getCacheFullRemoveTypeOfSecondaryCache

public CacheFullRemoveType<String> getCacheFullRemoveTypeOfSecondaryCache()

get remove type when secondary cache is full

返回:

setCacheFullRemoveTypeOfSecondaryCache

public void setCacheFullRemoveTypeOfSecondaryCache(CacheFullRemoveType<String> cacheFullRemoveType)

set remove type when secondary cache is full

参数:

cacheFullRemoveType - the cacheFullRemoveType to set