android轻量级缓存框架ASimpleCache的使用 （网络请求数据并缓存）

版权声明：本文为博主原创文章，未经博主允许不得转载。

框架地址

https://github.com/yangfuhai/ASimpleCache
此框架作者为大名鼎鼎的afinal作者

官方简介：

ASimpleCache 是一个为Android制定的 轻量级的 开源缓存框架。轻量到只有一个java文件（由十几个类精简而来）。

（有个问题是作者所说的自动失效，其实是在获取数据时判断存入缓存的数据是否过期，如果过期，则删除数据缓存，返回null。当然，如果真正的自动删除，应该只能开启服务，不断判断是否过期来删除吧，也没有必要）

--------------------------------------------------------------------------------

1、它可以缓存什么东西？

普通的字符串、JsonObject、JsonArray、Bitmap、Drawable、序列化的java对象，和 byte数据。

2、它有什么特色？

特色主要是：

1：轻，轻到只有一个JAVA文件。

2：可配置，可以配置缓存路径，缓存大小，缓存数量等。

3：可以设置缓存超时时间，缓存超时自动失效，并被删除。

4：支持多进程。

3、它在android中可以用在哪些场景？

1、替换SharePreference当做配置文件

2、可以缓存网络请求数据，比如oschina的android客户端可以缓存http请求的新闻内容，缓存时间假设为1个小时，超时后自动失效，让客户端重新请求新的数据，减少客户端流量，同时减少服务器并发量。

3、您来说...

4、如何使用 ASimpleCache？

以下有个小的demo，希望您能喜欢：

ACache mCache = ACache.get(this);

mCache.put("test_key1", "test value");

mCache.put("test_key2", "test value", 10);//保存10秒，如果超过10秒去获取这个key，将为null

mCache.put("test_key3", "test value", 2 * ACache.TIME_DAY);//保存两天，如果超过两天去获取这个key，将为null

获取数据

ACache mCache = ACache.get(this);

String value = mCache.getAsString("test_key1");

更多示例请见Demo

关于作者michael

屌丝程序员一枚，喜欢开源。

个人博客：http://www.yangfuhai.com

交流QQ群 ： 192341294（已满） 246710918（未满）

主要分析下集万千宠爱于一身的ACache类吧（以字符串存储为例）

一，首先先要创建缓存

get(Context ctx, String cacheName)方法新建缓存目录

get(File cacheDir, long max_zise, int max_count)方法新建缓存实例，存入实例map，key为缓存目录加上每次应用开启的进程id

[java]
view plain
copy





public static ACache get(Context ctx) {
return get(ctx, "ACache");
}

public static ACache get(Context ctx, String cacheName) {
//新建缓存目录
///data/data/com.yangfuhai.asimplecachedemo/cache/ACache
File f = new File(ctx.getCacheDir(), cacheName);
return get(f, MAX_SIZE, MAX_COUNT);
}

public static ACache get(File cacheDir) {
return get(cacheDir, MAX_SIZE, MAX_COUNT);
}

public static ACache get(Context ctx, long max_zise, int max_count) {
File f = new File(ctx.getCacheDir(), "ACache");
return get(f, max_zise, max_count);
}

public static ACache get(File cacheDir, long max_zise, int max_count) {
///data/data/com.yangfuhai.asimplecachedemo/cache/ACache
ACache manager = mInstanceMap.get(cacheDir.getAbsoluteFile() + myPid());
if (manager == null) {
manager = new ACache(cacheDir, max_zise, max_count);
//{/data/data/com.yangfuhai.asimplecachedemo/cache/ACache_4137=org.afinal.simplecache.ACache@2bc38270}
//{/data/data/com.yangfuhai.asimplecachedemo/cache/ACache_12189=org.afinal.simplecache.ACache@2bc3d890}
mInstanceMap.put(cacheDir.getAbsolutePath() + myPid(), manager);
}
return manager;
}

private static String myPid() {
return "_" + android.os.Process.myPid();
}

private ACache(File cacheDir, long max_size, int max_count) {
if (!cacheDir.exists() && !cacheDir.mkdirs()) {
throw new RuntimeException("can't make dirs in " + cacheDir.getAbsolutePath());
}
mCache = new ACacheManager(cacheDir, max_size, max_count);
}

二，存入数据

put(String key, String value)方法写数据到文件

put(String key, String value)方法中的mCache.put(file)方法做了如下设置

文件放入程序缓存后，统计缓存总量，总数，文件存放到文件map中（value值为文件最后修改时间，便于根据设置的销毁时间进行销毁）

缓存没有超过限制，则增加缓存总量，总数的数值

缓存超过限制，则减少缓存总量，总数的数值

通过removeNext方法找到最老文件的大小

[java]
view plain
copy





public void put(String key, String value) {
File file = mCache.newFile(key);
BufferedWriter out = null;
try {
out = new BufferedWriter(new FileWriter(file), 1024);
out.write(value);
} catch (IOException e) {
e.printStackTrace();
} finally {
if (out != null) {
try {
out.flush();
out.close();
} catch (IOException e) {
e.printStackTrace();
}
}
mCache.put(file);
}
}

[java]
view plain
copy





//文件放入程序缓存后，统计缓存总量，总数，文件存放到文件map中（value值为文件最后修改时间，便于根据设置的销毁时间进行销毁）
//缓存没有超过限制，则增加缓存总量，总数的数值
//缓存超过限制，则减少缓存总量，总数的数值
//通过removeNext方法找到最老文件的大小
private void put(File file) {
int curCacheCount = cacheCount.get();
while (curCacheCount + 1 > countLimit) {
long freedSize = removeNext();
cacheSize.addAndGet(-freedSize);

curCacheCount = cacheCount.addAndGet(-1);
}
cacheCount.addAndGet(1);

long valueSize = calculateSize(file);
long cu
e9e1
rCacheSize = cacheSize.get();
while (curCacheSize + valueSize > sizeLimit) {
long freedSize = removeNext();
curCacheSize = cacheSize.addAndGet(-freedSize);
}
cacheSize.addAndGet(valueSize);

Long currentTime = System.currentTimeMillis();
file.setLastModified(currentTime);
lastUsageDates.put(file, currentTime);
}

[java]
view plain
copy





/**
* 移除旧的文件（冒泡，找到最后修改时间最小的文件）
*
* @return
*/
private long removeNext() {
if (lastUsageDates.isEmpty()) {
return 0;
}

Long oldestUsage = null;
File mostLongUsedFile = null;
Set<Entry<File, Long>> entries = lastUsageDates.entrySet();
synchronized (lastUsageDates) {
for (Entry<File, Long> entry : entries) {
if (mostLongUsedFile == null) {
mostLongUsedFile = entry.getKey();
oldestUsage = entry.getValue();
} else {
Long lastValueUsage = entry.getValue();
if (lastValueUsage < oldestUsage) {
oldestUsage = lastValueUsage;
mostLongUsedFile = entry.getKey();
}
}
}
}

long fileSize = calculateSize(mostLongUsedFile);
if (mostLongUsedFile.delete()) {
lastUsageDates.remove(mostLongUsedFile);
}
return fileSize;
}

三，获取数据

getAsString(String key)方法从缓存文件中读取数据，其中通过Utils.isDue(readString)方法判断数据是否过期，是否要删除

[java]
view plain
copy





public String getAsString(String key) {
///data/data/com.yangfuhai.asimplecachedemo/cache/ACache/1727748931
File file = mCache.get(key);
if (!file.exists())
return null;
boolean removeFile = false;
BufferedReader in = null;
try {
in = new BufferedReader(new FileReader(file));
String readString = "";
String currentLine;
while ((currentLine = in.readLine()) != null) {
readString += currentLine;
}
if (!Utils.isDue(readString)) {
return Utils.clearDateInfo(readString);
} else {
removeFile = true;
return null;
}
} catch (IOException e) {
e.printStackTrace();
return null;
} finally {
if (in != null) {
try {
in.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (removeFile)
remove(key);
}
}

[java]
view plain
copy





/**
* 判断缓存的String数据是否到期
*
* @param str
* @return true：到期了 false：还没有到期
*/
private static boolean isDue(String str) {
return isDue(str.getBytes());
}

/**
* 判断缓存的byte数据是否到期（到期：当前时间大于保存时间加上保存后的存留时间）
*
* @param data
* @return true：到期了 false：还没有到期
*/
private static boolean isDue(byte[] data) {
String[] strs = getDateInfoFromDate(data);
if (strs != null && strs.length == 2) {
String saveTimeStr = strs[0];
while (saveTimeStr.startsWith("0")) {
saveTimeStr = saveTimeStr.substring(1, saveTimeStr.length());
}
long saveTime = Long.valueOf(saveTimeStr);
long deleteAfter = Long.valueOf(strs[1]);
if (System.currentTimeMillis() > saveTime + deleteAfter * 1000) {
return true;
}
}
return false;
}

[java]
view plain
copy





//数据有无存留时间设置
private static boolean hasDateInfo(byte[] data) {
return data != null && data.length > 15 && data[13] == '-' && indexOf(data, mSeparator) > 14;
}
//saveDate文件保存时间毫秒数，deleteAfter文件保存后的保留时间毫秒数
private static String[] getDateInfoFromDate(byte[] data) {
if (hasDateInfo(data)) {
String saveDate = new String(copyOfRange(data, 0, 13));
String deleteAfter = new String(copyOfRange(data, 14, indexOf(data, mSeparator)));
return new String[] { saveDate, deleteAfter };
}
return null;
}

带注释的demo http://download.csdn.net/detail/superjunjin/8605307