#5 - Universal Image Loader. Часть 2 - Конфигурация [RU+EN]

English version - "Universal Image Loader. Part 2 - Configuration"

Предыдущая статья: "Universal Image Loader. Part 1 - Введение"

    Все манипуляции проходят посредством класса ImageLoader. Это singletone, поэтому чтобы получить единственный экземпляр класса надо вызвать метод getInstance(). Перед использованием ImageLoader'а по назначению (для отображения картинок), необходимо проинициализировать его конфигурацией - ImageLoaderConfiguration, с помощью метода init(...). Ну а дальше можно со спокойной душой юзать все вариации метода displayImage(...).

    В общем, самый простой вариант использования ImageLoader'a (с конфигурацией по умолчанию) представлен ниже:

ImageView imageView = ... // вьюха, где будет отображать картинку
String imageUrl = ... // URL картинки (н-р: "http://site.com/image.png", "file:///mnt/sdcard/img/image.jpg")

ImageLoader imageLoader = ImageLoader.getInstance(); // Получили экземпляр
imageLoader.init(ImageLoaderConfiguration.createDefault(context)); // Проинициализировали конфигом по умолчанию
imageLoader.displayImage(imageUrl, imageView); // Запустили асинхронный показ картинки

   
    А теперь рассмотрим полный функционал.

    Как вы уже поняли, сначала ImageLoader надо проинициализировать с помощью объекта конфигурации. Т.к. ImageLoader - синглтон, то инициализировать его нужно один раз за запуск приложения. Я бы рекомендовал делать это в перегруженном Application.onCreate(). Повторная инициализация уже проинициализированного ImageLoader'а не будет иметь никакого эффекта.
    Значит, создаем конфигурацию, а это объект класса ImageLoaderConfiguration. Создаем с помощью Builder'а:

File cacheDir = StorageUtils.getCacheDirectory(context, "UniversalImageLoader/Cache");

ImageLoaderConfiguration config = new ImageLoaderConfiguration.Builder(getApplicationContext())
            .memoryCacheExtraOptions(480, 800) // width, height
            .discCacheExtraOptions(480, 800, CompressFormat.JPEG, 75) // width, height, compress format, quality
            .threadPoolSize(5)
            .threadPriority(Thread.MIN_PRIORITY + 2)
            .denyCacheImageMultipleSizesInMemory()
            .memoryCache(new UsingFreqLimitedMemoryCache(2 * 1024 * 1024)) // 2 Mb
            .discCache(new UnlimitedDiscCache(cacheDir))
            .discCacheFileNameGenerator(new HashCodeFileNameGenerator())
            .imageDownloader(new BaseImageDownloader(5 * 1000, 30 * 1000)) // connectTimeout (5 s), readTimeout (30 s)
            .defaultDisplayImageOptions(DisplayImageOptions.createSimple())
            .enableLogging()
            .build();

    Рассмотрим каждую настройку:

•  memoryCacheExtraOptions() используется при декодировании изображений в объекты Bitmap. Чтобы не хранить в памяти полноразмерную картинку, она уменьшается до размера, определяемых из значений параметров ImageView, куда грузится картинка: maxWidth и maxHeight (в первую очередь), layout_width и layout_height (во вторую очередь). Если эти параметры не определены (значения fill_parent и wrap_content считаются неопределенными), то тогда берутся размеры, заданные параметрами из данного memoryCacheExtraOptions() ;
• Значения по умолчанию - размеры экрана аппарата
•  discCacheExtraOptions() задает параметры для хранения картинок на "дисковом кэше". По умолчанию на дисковом кэше хранятся полноразмерные картинки. С помощью данной настройки можно задать максимальный размер для хранимых картинок, а также формат сжатия и качество (для JPEG).
•  threadPoolSize(int) задает размер пула потоков. Каждое задание на загрузку и отображение картинки выполняется в отдельном потоке, а те потоки, в которых происходит загрузка изображений из сети, попадают в пул. Т.о. размер пула определяет количество потоков, работающих одновременно. Задание большого размера пула может существенно снизить скорость работы UI, например в списке может подтормаживать прокрутка. 
• Значения по умолчанию - 5
•  threadPriority(int) задает приоритет в системе (от 1 до 10) всех потоков, в которых выполняются задачи;
• Значения по умолчанию - 4
•  вызов denyCacheImageMultipleSizesInMemory() накладывает запрет на хранение в памяти разных размеров одной и той же картинки. Т.к в дисковом кэше хранятся полноразмерные картинки, а при загрузке в память они уменьшаются до размеров ImageView, в которых они должны отобразиться, то бывают случаи, что одну и ту же картинку необходимо отобразить сначала в маленькой вьюшке, а потом в большой. При этом в памяти будут хранится две Bitmap'ки разных размеров, представляющие одинаковую картинку. Это поведение по умолчанию. Инструкция  denyCacheImageMultipleSizesInMemory() обеспечивает удаление из кэша в памяти предыдущего размера загружаемой картинки.
•  с помощью memoryCache(...) можно задать реализацию кэша в памяти. Можно воспользоваться готовыми решениями (все они представляют собой реализации кэша ограниченного размера, где при превышении размера кэша из него удаляется объект по определенному алгоритму):
• FIFOLimitedCache (удаляется объект по принципу First-In-First-Out)
• LargestLimitedCache (удаляется самый большой по размеру объект)
• UsingAgeLimitedCache (удаляется объект с самой давней датой доступа)
• UsingFreqLimitedCache (удаляется самый редко используемый объект)
Либо можно подсунуть свой вариант кэша, реализовав интерфейс MemoryCacheAware<String, Bitmap>;
• Значение по умолчанию - UsingFreqLimitedCache с ограничением памяти в 2 Мб
•  memoryCacheSize(int) задает максимальный размер кэша в памяти. В этом случае используется кэш по умолчанию -  UsingFreqLimitedCache.
• Значение по умолчанию - 2 Мб 
• с помощью discCache(...) можно задать реализацию кэша на файловой системе. Можно воспользоваться готовыми решениями (в них файлы, соответствующие определенным URL-ам, именуются как хеш-коды этих URL-ов):
• UnlimitedDiscCache (обычный кэш, без ограничений)
• FileCountLimitedDiscCache  (ограниченный по количеству файлов кэш) 
• TotalSizeLimitedDiscCache (ограниченный по размеру кэш) 
Либо можно подсунуть свою реализацию кэша, реализовав интерфейс DiscCacheAware.
• Значение по умолчанию - UnlimitedDiscCache
•  discCacheSize(int) задает максимальный размер кэша на файловой системе. В этом случае используется TotalSizeLimitedDiscCache.
•  discCacheFileCount(int) задает максимальное количество файлов в дисковом кэше. В этом случае используется FileCountLimitedDiscCache.
•  с помощью discCacheFileNameGenerator(...)  можно задать свой генератор имен для файлов закешированных на диске картинок: на входе получается URI картинки, на выходе надо выдать уникальное имя для файла (FileNameGenerator).
  Есть готовые варианты:
  • HashCodeFileNameGenerator - в качестве имени файла берется java хеш-код URI картинки
  • Md5FileNameGenerator - в качестве имени файла генерируется хеш-код по алгоритму MD5
  По умолчанию используется HashCodeFileNameGenerator
• с помощью imageDownloader(...) можно задать свою реализацию загрузчика картинок: нужно представить свою имплементацию интерфейса ImageDownloader.
  Можно воспользоваться готовыми реализациями (по надобности их также можно унаследовать):
  • BaseImageDownloader - используется URLConnection для работы с сетью
  • HttpClientImageDownloader - используется HttpClient для работы с сетью
  По умолчанию используется BaseImageDownloader. 
• с помощью defaultDisplayImageOptions(...) можно задать опции отображения картинок, которые будут использоваться для всех вызовов метода displayImage(...), где не были переданы кастомные опции. Подробнее, что это за эти опции, будет рассказано ниже.
•  enableLogging() включает подробное логгирование процесса работы ImageLoader'a.

    Мы можем сами сконструировать объект конфигурации, либо довериться разработчику (т.е. мне) и воспользоваться конфигурацией по умолчанию:

ImageLoaderConfiguration config = ImageLoaderConfiguration.createDefault(context);

    Итак, конфигурация создана. Теперь ею можно проинициализировать ImageLoader:

ImageLoader.getInstance().init(config);

Вот и все, ImageLoader готов к использованию. Но об этом Я расскажу уже в следующей статье.

Следующая статья: "Universal Image Loader. Part 3 - Usage"

Исходники проекта доступны здесь.