특정 URL 이미지를 목록에서 보여주어야 할 때, 동일 URL 이미지를 매번 다운로드 받아 출력하면 비효율적일 뿐만 아니라 사용자에게 보여지는 응답도 느려지게 된다. 사용자에게 응답을 빠르게 보여주기 위해서는 URL 이미지를 메모리나 로컬 파일에 캐싱하도록 구현해야 한다. 이미지를 캐싱함으로써, 동일 URL 이미지를 보여주어야 할 때 다운로드 없이 빠르게 이미지를 사용자에게 보여줄 수 있게 된다.
본 글에서는 이미지를 위한 캐시를 만들어보도록 하겠다. 실제 URL로부터 이미지를 읽어와 캐시에 담고 ImageView에 다운로드 받은 이미지를 보여주는 코드는 '안드로이드에서 URL 이미지를 ImageView에 보여주기' 글을 참고하기 바란다.
이미지 캐시 기능
제공할 기능은 다음과 같다.
- 이미지 메모리 캐시를 제공한다.
- 메모리에 지정 개수 만큼의 이미지를 보관한다.
- 이미지 메모리/파일의 2레벨 캐시를 제공한다.
- 캐시에 이미지를 보관하면 메모리와 파일에 동시에 보관된다.
- 메모리 캐시는 보관할 수 있는 개수에 제한이 있다.
- 파일 캐시는 보관할 수 있는 전체 크기에 제한이 있다. ('안드로이드에서 파일 캐시 구현하기' 글에서 만든 파일 캐시를 사용해서 구현한다.)
- 메모리 캐시에 없으면, 파일 캐시로부터 이미지를 읽어온다.
2레벨 캐시를 사용할 경우 자주 사용되는 이미지는 메모리에 담고 일정 크기만큼의 이미지는 파일로도 보관한다. 이를 통해 메모리 용량의 사용을 일정 수준으로 유지하면서 동시에 네트워크 사용을 최소화해서 사용자에게 이미지를 빠르게 보여줄 수 있다.
이미지 캐시 클래스 구성
구현할 이미지 캐시의 클래스 구성은 아래와 같다.
구성요소 |
설명 |
ImageCacheFactory |
ImageCache의 생성 및 검색 기능을 제공한다. |
ImageCache |
이미지 캐시를 위한 인터페이스를 제공한다. |
MemoryImageCache | 메모리 기반의 이미지 캐시를 구현한다. |
FileImageCache |
파일 기반의 이미지 캐시를 구현한다. |
ChainedImageCache | 캐시 체인 기능을 제공한다. |
ImageCache 인터페이스
public interface ImageCache {
public void addBitmap(String key, Bitmap bitmap);
public void addBitmap(String key, File bitmapFile);
public Bitmap getBitmap(String key);
public void clear();
}
MemoryImageCache 클래스
MemoryImageCache는 내부적으로 LruCache를 사용해서 구현하였다.
package com.toonburi.app.infra.imagecache;
import java.io.File;
import android.graphics.Bitmap;
import android.graphics.BitmapFactory;
import android.support.v4.util.LruCache;
public class MemoryImageCache implements ImageCache {
private LruCache<String, Bitmap> lruCache;
public MemoryImageCache(int maxCount) {
lruCache = new LruCache<String, Bitmap>(maxCount);
}
@Override
public void addBitmap(String key, Bitmap bitmap) {
if (bitmap == null)
return;
lruCache.put(key, bitmap);
}
@Override
public void addBitmap(String key, File bitmapFile) {
if (bitmapFile == null)
return;
if (!bitmapFile.exists())
return;
Bitmap bitmap = BitmapFactory.decodeFile(bitmapFile.getAbsolutePath());
lruCache.put(key, bitmap);
}
@Override
public Bitmap getBitmap(String key) {
return lruCache.get(key);
}
@Override
public void clear() {
lruCache.evictAll();
}
}
FileImageCache 클래스
FileImageCache는 앞서 '안드로이드에서 파일 캐시 구현하기'에서 만든 파일 캐시를 이용해서 구현하였다. 코드는 다음과 같다.
public class FileImageCache implements ImageCache {
private static final String TAG = "FileImageCache";
private FileCache fileCache;
public FileImageCache(String cacheName) {
fileCache = FileCacheFactory.getInstance().get(cacheName);
}
@Override
public void addBitmap(String key, final Bitmap bitmap) {
try {
fileCache.put(key, new ByteProvider() {
@Override
public void writeTo(OutputStream os) {
bitmap.compress(CompressFormat.PNG, 100, os);
}
});
} catch (IOException e) {
Log.e(TAG, "fail to bitmap to fileCache", e);
}
}
@Override
public void addBitmap(String key, File bitmapFile) {
try {
fileCache.put(key, bitmapFile, true);
} catch (IOException e) {
Log.e(TAG, String.format("fail to bitmap file[%s] to fileCache",
bitmapFile.getAbsolutePath()), e);
}
}
@Override
public Bitmap getBitmap(String key) {
FileEntry cachedFile = fileCache.get(key);
if (cachedFile == null) {
return null;
}
return BitmapFactory.decodeFile(cachedFile.getFile().getAbsolutePath());
}
@Override
public void clear() {
fileCache.clear();
}
}
위 코드에서 유의할 점은 FileImageCache 객체를 생성할 때, 파라미터로 전달받은 cacheName을 이용해서 FileCache를 구한다는 점이다. 즉, FileImageCache의 이름과 동일한 이름을 갖는 FileCache가 존재해야 정상적으로 동작한다. 따라서, FileImageCache를 사용하기 전에 다음과 같이 이미지 캐시와 동일한 이름을 갖는 FileCache를 생성해 주어야 한다.
// onCreate 등에서 파일을 이용하는 이미지 캐시 생성 전에 초기화
FileCacheFactory.getInstance().create(cacheName, cacheSize);
ChainedImageCache 클래스
이미지 캐시와 파일 캐시를 1차/2차 캐시로 사용하기 위해 ChainedImageCache 클래스를 만들었다.
public class ChainedImageCache implements ImageCache {
private List<ImageCache> chain;
public ChainedImageCache(List<ImageCache> chain) {
this.chain = chain;
}
@Override
public void addBitmap(String key, Bitmap bitmap) {
for (ImageCache cache : chain) {
cache.addBitmap(key, bitmap);
}
}
@Override
public void addBitmap(String key, File bitmapFile) {
for (ImageCache cache : chain) {
cache.addBitmap(key, bitmapFile);
}
}
@Override
public final Bitmap getBitmap(String key) {
Bitmap bitmap = null;
List<ImageCache> previousCaches = new ArrayList<ImageCache>();
for (ImageCache cache : chain) {
bitmap = cache.getBitmap(key);
if (bitmap != null) {
break;
}
previousCaches.add(cache);
}
if (bitmap == null)
return null;
if (!previousCaches.isEmpty()) {
for (ImageCache cache : previousCaches) {
cache.addBitmap(key, bitmap);
}
}
return bitmap;
}
@Override
public final void clear() {
for (ImageCache cache : chain) {
cache.clear();
}
}
}
ChainedImageCache는 chain에 등록되어 있는 모든 ImageCache를 차례대로 실행한다. getBitmap()은 약간 복잡하다. getBitmap()은 체인을 따라 Bitmap이 존재할 때까지 탐색한다. Bitmap이 발견되면 해당 캐시 이전에 위치한 캐시들(previousCaches에 보관됨)에 Bitmap 정보를 추가해서, 이후 동일 키로 요청이 오면 체인의 앞에서 발견되도록 한다.
ImageCacheFactory 클래스
ImageCacheFactory는 캐시 생성 기능을 제공한다.
public class ImageCacheFactory {
private static ImageCacheFactory instance = new ImageCacheFactory();
public static ImageCacheFactory getInstance() {
return instance;
}
private HashMap<String, ImageCache> cacheMap = new HashMap<String, ImageCache>();
private ImageCacheFactory() {
}
public ImageCache createMemoryCache(String cacheName, int imageMaxCounts) {
synchronized (cacheMap) {
checkAleadyExists(cacheName);
ImageCache cache = new MemoryImageCache(imageMaxCounts);
cacheMap.put(cacheName, cache);
return cache;
}
}
private void checkAleadyExists(String cacheName) {
ImageCache cache = cacheMap.get(cacheName);
if (cache != null) {
throw new ImageCacheAleadyExistException(String.format(
"ImageCache[%s] aleady exists", cacheName));
}
}
public ImageCache createTwoLevelCache(String cacheName, int imageMaxCounts) {
synchronized (cacheMap) {
checkAleadyExists(cacheName);
List<ImageCache> chain = new ArrayList<ImageCache>();
chain.add(new MemoryImageCache(imageMaxCounts));
chain.add(new FileImageCache(cacheName));
ChainedImageCache cache = new ChainedImageCache(chain);
cacheMap.put(cacheName, cache);
return cache;
}
}
public ImageCache get(String cacheName) {
ImageCache cache = cacheMap.get(cacheName);
if (cache == null) {
throw new ImageCacheNotFoundException(
String.format("ImageCache[%s] not founds"));
}
return cache;
}
}
createMemoryCache() 메서드는 메모리만 사용하는 ImageCache를 생성한다. createTwoLevelCache() 메서드는 1차 메모리/2차 파일 기반의 2레벨 캐시를 생성한다.
이미지 캐시 사용하기
다음은 이미지 캐시의 사용 예시이다.
-- onCreate 등 초기화 부분
// 2레벨 캐시(이미지 파일 캐시)를 사용하려면 동일 이름의 파일 캐시를 생성해 주어야 한다.
FileCacheFactory.getInstance().create(cacheName, cacheSize);
// 이미지 캐시 초기화
ImageCacheFactory.getInstance().createTwoLevelCache(cacheName, memoryImageMaxCounts);
-- 이미지 캐시 사용 부분
ImageCache imageCache = ImageCacheFactory.getInstance().getCache(cacheName);
Bitmap bitmap = imageCache.getBitmap(key);
if (bitmap != null) {
imageView.set.....
}
-- 이미지 캐시 추가 부분
imageCache.putBitmap(key, someBitmap);
실제 ImageCache를 사용하는 예제 코드는 '안드로이드에서 URL 이미지를 ImageView에 보여주기'에 있으니 이 글을 참고하면 된다.
관련자료
- 안도르이드에서 파일 캐시 구현하기:
http://javacan.tistory.com/entry/android-file-cache-implementation - 안드로이드에서 URL 이미지를 ImageView에 보여주기
http://javacan.tistory.com/entry/show-an-image-from-url-in-android-ImageView - Caching Bitmaps:
http://developer.android.com/training/displaying-bitmaps/cache-bitmap.html