摘要:加載并顯示圖片或加載并執行回調接口。加載圖片主要分為三類接口表示異步加載并顯示圖片到對應的上。以上三類接口最終都會調用到這個函數進行圖片加載。不允許訪問網絡的圖片下載器。創建圖片下載器,返回一個。
1. 功能介紹 1.1 Android Universal Image Loader
Android Universal Image Loader 是一個強大的、可高度定制的圖片緩存,本文簡稱為UIL。
簡單的說 UIL 就做了一件事——獲取圖片并顯示在相應的控件上。
添加完依賴后在Application或Activity中初始化ImageLoader,如下:
public class YourApplication extends Application { @Override public void onCreate() { super.onCreate(); ImageLoaderConfiguration configuration = new ImageLoaderConfiguration.Builder(this) // 添加你的配置需求 .build(); ImageLoader.getInstance().init(configuration); } }
其中 configuration 表示ImageLoader的配置信息,可包括圖片最大尺寸、線程池、緩存、下載器、解碼器等等。
……
添加網絡權限。如果允許磁盤緩存,需要添加寫外設的權限。
下載圖片,解析為 Bitmap 并在 ImageView 中顯示。
imageLoader.displayImage(imageUri, imageView);
下載圖片,解析為 Bitmap 傳遞給回調接口。
imageLoader.loadImage(imageUri, new SimpleImageLoadingListener() { @Override public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) { // 圖片處理 } });
以上是簡單使用,更復雜 API 見本文詳細設計。
1.3 特點可配置度高。支持任務線程池、下載器、解碼器、內存及磁盤緩存、顯示選項等等的配置。
包含內存緩存和磁盤緩存兩級緩存。
支持多線程,支持異步和同步加載。
支持多種緩存算法、下載進度監聽、ListView 圖片錯亂解決等。
2. 總體設計 2.1. 總體設計圖
上面是 UIL 的總體設計圖。整個庫分為ImageLoaderEngine,Cache及ImageDownloader,ImageDecoder,BitmapDisplayer,BitmapProcessor五大模塊,其中Cache分為MemoryCache和DiskCache兩部分。
簡單的講就是ImageLoader收到加載及顯示圖片的任務,并將它交給ImageLoaderEngine,ImageLoaderEngine分發任務到具體線程池去執行,任務通過Cache及ImageDownloader獲取圖片,中間可能經過BitmapProcessor和ImageDecoder處理,最終轉換為Bitmap交給BitmapDisplayer在ImageAware中顯示。
2.2. UIL 中的概念簡單介紹一些概念,在4. 詳細設計中會仔細介紹。
ImageLoaderEngine:任務分發器,負責分發LoadAndDisplayImageTask和ProcessAndDisplayImageTask給具體的線程池去執行,本文中也稱其為engine,具體參考4.2.6 ImageLoaderEngine.java。
ImageAware:顯示圖片的對象,可以是ImageView等,具體參考4.2.9 ImageAware.java。
ImageDownloader:圖片下載器,負責從圖片的各個來源獲取輸入流, 具體參考4.2.22 ImageDownloader.java。
Cache:圖片緩存,分為MemoryCache和DiskCache兩部分。
MemoryCache:內存圖片緩存,可向內存緩存緩存圖片或從內存緩存讀取圖片,具體參考4.2.24 MemoryCache.java。
DiskCache:本地圖片緩存,可向本地磁盤緩存保存圖片或從本地磁盤讀取圖片,具體參考4.2.38 DiskCache.java。
ImageDecoder:圖片解碼器,負責將圖片輸入流InputStream轉換為Bitmap對象, 具體參考4.2.53 ImageDecoder.java。
BitmapProcessor:圖片處理器,負責從緩存讀取或寫入前對圖片進行處理。具體參考4.2.61 BitmapProcessor.java。
BitmapDisplayer:將Bitmap對象顯示在相應的控件ImageAware上, 具體參考4.2.56 BitmapDisplayer.java。
LoadAndDisplayImageTask:用于加載并顯示圖片的任務, 具體參考4.2.20 LoadAndDisplayImageTask.java。
ProcessAndDisplayImageTask:用于處理并顯示圖片的任務, 具體參考4.2.19 ProcessAndDisplayImageTask.java。
DisplayBitmapTask:用于顯示圖片的任務, 具體參考4.2.18 DisplayBitmapTask.java。
3. 流程圖
上圖為圖片加載及顯示流程圖,在 uil 庫中給出,這里用中文重新畫出。
圖片加載器,對外的主要 API,采取了單例模式,用于圖片的加載和顯示。
主要函數:
得到ImageLoader的單例。通過雙層是否為 null 判斷提高性能。
初始化配置參數,參數configuration為ImageLoader的配置信息,包括圖片最大尺寸、任務線程池、磁盤緩存、下載器、解碼器等等。
實現中會初始化ImageLoaderEngine engine屬性,該屬性為任務分發器。
加載并顯示圖片或加載并執行回調接口。ImageLoader 加載圖片主要分為三類接口:
displayImage(…) 表示異步加載并顯示圖片到對應的ImageAware上。
loadImage(…) 表示異步加載圖片并執行回調接口。
loadImageSync(…) 表示同步加載圖片。
以上三類接口最終都會調用到這個函數進行圖片加載。函數參數解釋如下:
uri: 圖片的 uri。uri 支持多種來源的圖片,包括 http、https、file、content、assets、drawable 及自定義,具體介紹可見ImageDownloader。
imageAware: 一個接口,表示需要加載圖片的對象,可包裝 View。
options: 圖片顯示的配置項。比如加載前、加載中、加載失敗應該顯示的占位圖片,圖片是否需要在磁盤緩存,是否需要在內存緩存等。
listener: 圖片加載各種時刻的回調接口,包括開始加載、加載失敗、加載成功、取消加載四個時刻的回調函數。
progressListener: 圖片加載進度的回調接口。
函數流程圖如下:
ImageLoader的配置信息,包括圖片最大尺寸、線程池、緩存、下載器、解碼器等等。
主要屬性:
程序本地資源訪問器,用于加載DisplayImageOptions中設置的一些 App 中圖片資源。
內存緩存的圖片最大寬度。
內存緩存的圖片最大高度。
磁盤緩存的圖片最大寬度。
磁盤緩存的圖片最大高度。
圖片處理器,用于處理從磁盤緩存中讀取到的圖片。
ImageLoaderEngine中用于執行從源獲取圖片任務的 Executor。
ImageLoaderEngine中用于執行從緩存獲取圖片任務的 Executor。
用戶是否自定義了上面的 taskExecutor。
用戶是否自定義了上面的 taskExecutorForCachedImages。
上面兩個默認線程池的核心池大小,即最大并發數。
上面兩個默認線程池的線程優先級。
上面兩個默認線程池的線程隊列類型。目前只有 FIFO, LIFO 兩種可供選擇。
圖片內存緩存。
圖片磁盤緩存,一般放在 SD 卡。
圖片下載器。
圖片解碼器,內部可使用我們常用的BitmapFactory.decode(…)將圖片資源解碼成Bitmap對象。
圖片顯示的配置項。比如加載前、加載中、加載失敗應該顯示的占位圖片,圖片是否需要在磁盤緩存,是否需要在內存緩存等。
不允許訪問網絡的圖片下載器。
慢網絡情況下的圖片下載器。
Builder 模式,用于構造參數繁多的ImageLoaderConfiguration。
其屬性與ImageLoaderConfiguration類似,函數多是屬性設置函數。
主要函數及含義:
按照配置,生成 ImageLoaderConfiguration。代碼如下:
public ImageLoaderConfiguration build() { initEmptyFieldsWithDefaultValues(); return new ImageLoaderConfiguration(this); }
初始化值為null的屬性。若用戶沒有配置相關項,UIL 會通過調用DefaultConfigurationFactory中的函數返回一個默認值當配置。
taskExecutorForCachedImages、taskExecutor及ImageLoaderEngine的taskDistributor的默認值如下:
parameters | taskDistributor | taskExecutorForCachedImages/taskExecutor |
---|---|---|
corePoolSize | 0 | 3 |
maximumPoolSize | Integer.MAX_VALUE | 3 |
keepAliveTime | 60 | 0 |
unit | SECONDS | MILLISECONDS |
workQueue | SynchronousQueue | LIFOLinkedBlockingDeque / LinkedBlockingQueue |
priority | 5 | 3 |
diskCacheFileNameGenerator默認值為HashCodeFileNameGenerator。
memoryCache默認值為LruMemoryCache。如果內存緩存不允許緩存一張圖片的多個尺寸,則用FuzzyKeyMemoryCache做封裝,同一個圖片新的尺寸會覆蓋緩存中該圖片老的尺寸。
diskCache默認值與diskCacheSize和diskCacheFileCount值有關,如果他們有一個大于 0,則默認為LruDiskCache,否則使用無大小限制的UnlimitedDiskCache。
downloader默認值為BaseImageDownloader。
decoder默認值為BaseImageDecoder。
詳細及其他屬性默認值請到DefaultConfigurationFactory中查看。
設置內存緩存不允許緩存一張圖片的多個尺寸,默認允許。
后面會講到 View 的 getWidth() 在初始化前后的不同值與這個設置的關系。
設置磁盤緩存的最大字節數,如果大于 0 或者下面的maxFileCount大于 0,默認的DiskCache會用LruDiskCache,否則使用無大小限制的UnlimitedDiskCache。
設置磁盤緩存文件夾下最大文件數,如果大于 0 或者上面的maxCacheSize大于 0,默認的DiskCache會用LruDiskCache,否則使用無大小限制的UnlimitedDiskCache。
不允許訪問網絡的圖片下載器,實現了ImageDownloader接口。
實現也比較簡單,包裝一個ImageDownloader對象,通過在 getStream(…) 函數中禁止 Http 和 Https Scheme 禁止網絡訪問,如下:
@Override public InputStream getStream(String imageUri, Object extra) throws IOException { switch (Scheme.ofUri(imageUri)) { case HTTP: case HTTPS: throw new IllegalStateException(); default: return wrappedDownloader.getStream(imageUri, extra); } }
慢網絡情況下的圖片下載器,實現了ImageDownloader接口。
通過包裝一個ImageDownloader對象實現,在 getStream(…) 函數中當 Scheme 為 Http 和 Https 時,用FlushedInputStream代替InputStream處理慢網絡情況,具體見后面FlushedInputStream的介紹。
LoadAndDisplayImageTask和ProcessAndDisplayImageTask任務分發器,負責分發任務給具體的線程池。
主要屬性:
ImageLoader的配置信息,可包括圖片最大尺寸、線程池、緩存、下載器、解碼器等等。
用于執行從源獲取圖片任務的 Executor,為configuration中的 taskExecutor,如果為null,則會調用DefaultConfigurationFactory.createExecutor(…)根據配置返回一個默認的線程池。
用于執行從緩存獲取圖片任務的 Executor,為configuration中的 taskExecutorForCachedImages,如果為null,則會調用DefaultConfigurationFactory.createExecutor(…)根據配置返回一個默認的線程池。
任務分發線程池,任務指LoadAndDisplayImageTask和ProcessAndDisplayImageTask,因為只需要分發給上面的兩個 Executor 去執行任務,不存在較耗時或阻塞操作,所以用無并發數(Int 最大值)限制的線程池即可。
ImageAware與內存緩存 key 對應的 map,key 為ImageAware的 id,value 為內存緩存的 key。
圖片正在加載的重入鎖 map,key 為圖片的 uri,value 為標識其正在加載的重入鎖。
是否被暫停。如果為true,則所有新的加載或顯示任務都會等待直到取消暫停(為false)。
是否不允許訪問網絡,如果為true,通過ImageLoadingListener.onLoadingFailed(…)獲取圖片,則所有不在緩存中需要網絡訪問的請求都會失敗,返回失敗原因為網絡訪問被禁止。
是否是慢網絡情況,如果為true,則自動調用SlowNetworkImageDownloader下載圖片。
暫停的等待鎖,可在engine被暫停后調用這個鎖等待。
主要函數:
添加一個LoadAndDisplayImageTask。直接用taskDistributor執行一個 Runnable,在 Runnable 內部根據圖片是否被磁盤緩存過確定使用taskExecutorForCachedImages還是taskExecutor執行該 task。
添加一個ProcessAndDisplayImageTask。直接用taskExecutorForCachedImages執行該 task。
暫停圖片加載任務。所有新的加載或顯示任務都會等待直到取消暫停(為false)。
繼續圖片加載任務。
暫停所有加載和顯示圖片任務并清除這里的內部屬性值。
taskDistributor立即執行某個任務。
得到某個 uri 的重入鎖,如果不存在則新建。
調用DefaultConfigurationFactory.createExecutor(…)創建一個線程池。
得到某個imageAware正在加載的圖片 uri。
準備開始一個Task。向cacheKeysForImageAwares中插入ImageAware的 id 和圖片在內存緩存中的 key。
取消一個顯示任務。從cacheKeysForImageAwares中刪除ImageAware對應元素。
設置是否不允許網絡訪問。
設置是否慢網絡情況。
為ImageLoaderConfiguration及ImageLoaderEngine提供一些默認配置。
主要函數:
創建線程池。
threadPoolSize表示核心池大小(最大并發數)。
threadPriority表示線程優先級。
tasksProcessingType表示線程隊列類型,目前只有 FIFO, LIFO 兩種可供選擇。
內部實現會調用createThreadFactory(…)返回一個支持線程優先級設置,并且以固定規則命名新建的線程的線程工廠類DefaultConfigurationFactory.DefaultThreadFactory。
為ImageLoaderEngine中的任務分發器taskDistributor提供線程池,該線程池為 normal 優先級的無并發大小限制的線程池。
返回一個HashCodeFileNameGenerator對象,即以 uri HashCode 為文件名的文件名生成器。
創建一個 Disk Cache。如果 diskCacheSize 或者 diskCacheFileCount 大于 0,返回一個LruDiskCache,否則返回無大小限制的UnlimitedDiskCache。
創建一個 Memory Cache。返回一個LruMemoryCache,若 memoryCacheSize 為 0,則設置該內存緩存的最大字節數為 App 最大可用內存的 1/8。
這里 App 的最大可用內存也支持系統在 Honeycomb 之后(ApiLevel >= 11) application 中android:largeHeap="true"的設置。
創建圖片下載器,返回一個BaseImageDownloader。
創建圖片解碼器,返回一個BaseImageDecoder。
創建圖片顯示器,返回一個SimpleBitmapDisplayer。
默認的線程工廠類,為
DefaultConfigurationFactory.createExecutor(…)
和
DefaultConfigurationFactory.createTaskDistributor(…)
提供線程工廠。支持線程優先級設置,并且以固定規則命名新建的線程。
PS:重命名線程是個很好的習慣,它的一大作用就是方便問題排查,比如性能優化,用 TraceView 查看線程,根據名字很容易分辨各個線程。
需要顯示圖片的對象的接口,可包裝 View 表示某個需要顯示圖片的 View。
主要函數:
得到被包裝的 View,圖片在該 View 上顯示。
得到寬度高度,在計算圖片縮放比例時會用到。
得到唯一標識 id。ImageLoaderEngine中用這個 id 標識正在加載圖片的ImageAware和圖片內存緩存 key 的對應關系,圖片請求前會將內存緩存 key 與新的內存緩存 key 進行比較,如果不相等,則之前的圖片請求會被取消。這樣當ImageAware被復用時就不會因異步加載(前面任務未取消)而造成錯亂了。
封裝 Android View 來顯示圖片的抽象類,實現了ImageAware接口,利用Reference來 Warp View 防止內存泄露。
主要函數:
構造函數。
view表示需要顯示圖片的對象。
checkActualViewSize表示通過getWidth()和getHeight()獲取圖片寬高時返回真實的寬和高,還是LayoutParams的寬高,true 表示返回真實寬和高。
如果為true會導致一個問題,View在還沒有初始化完成時加載圖片,這時它的真實寬高為 0,會取它LayoutParams的寬高,而圖片緩存的 key 與這個寬高有關,所以當View初始化完成再次需要加載該圖片時,getWidth()和getHeight()返回的寬高都已經變化,緩存 key 不一樣,從而導致緩存命中失敗會再次從網絡下載一次圖片。可通過ImageLoaderConfiguration.Builder.denyCacheImageMultipleSizesInMemory()設置不允許內存緩存緩存一張圖片的多個尺寸。
如果當前操作在主線程并且 View 沒有被回收,則調用抽象函數setImageDrawableInto(Drawable drawable, View view)去向View設置圖片。
如果當前操作在主線程并且 View 沒有被回收,則調用抽象函數setImageBitmapInto(Bitmap bitmap, View view)去向View設置圖片。
封裝 Android ImageView 來顯示圖片的ImageAware,繼承了ViewAware,利用Reference來 Warp View 防止內存泄露。
如果getWidth()函數小于等于 0,會利用反射獲取mMaxWidth的值作為寬。
如果getHeight()函數小于等于 0,會利用反射獲取mMaxHeight的值作為高。
僅包含處理圖片相關信息卻沒有需要顯示圖片的 View 的ImageAware,實現了ImageAware接口。常用于加載圖片后調用回調接口而不是顯示的情況。
圖片顯示的配置項。比如加載前、加載中、加載失敗應該顯示的占位圖片,圖片是否需要在磁盤緩存,是否需要在 memory 緩存等。
主要屬性及含義:
圖片正在加載中的占位圖片的 resource id,優先級比下面的imageOnLoading高,當存在時,imageOnLoading不起作用。
空 uri 時的占位圖片的 resource id,優先級比下面的imageForEmptyUri高,當存在時,imageForEmptyUri不起作用。
加載失敗時的占位圖片的 resource id,優先級比下面的imageOnFail高,當存在時,imageOnFail不起作用。
加載中的占位圖片的 drawabled 對象,默認為 null。
空 uri 時的占位圖片的 drawabled 對象,默認為 null。
加載失敗時的占位圖片的 drawabled 對象,默認為 null。
在加載前是否重置 view,通過 Builder 構建的對象默認為 false。
是否緩存在內存中,通過 Builder 構建的對象默認為 false。
是否緩存在磁盤中,通過 Builder 構建的對象默認為 false。
圖片的縮放類型,通過 Builder 構建的對象默認為IN_SAMPLE_POWER_OF_2。
為 BitmapFactory.Options,用于BitmapFactory.decodeStream(imageStream, null, decodingOptions)得到圖片尺寸等信息。
設置在開始加載前的延遲時間,單位為毫秒,通過 Builder 構建的對象默認為 0。
是否考慮圖片的 EXIF 信息,通過 Builder 構建的對象默認為 false。
下載器需要的輔助信息。下載時傳入ImageDownloader.getStream(String, Object)的對象,方便用戶自己擴展,默認為 null。
緩存在內存之前的處理程序,默認為 null。
緩存在內存之后的處理程序,默認為 null。
圖片的顯示方式,通過 Builder 構建的對象默認為SimpleBitmapDisplayer。
handler 對象,默認為 null。
是否同步加載,通過 Builder 構建的對象默認為 false。
Builder 模式,用于構造參數繁多的DisplayImageOptions。
其屬性與DisplayImageOptions類似,函數多是屬性設置函數。
圖片加載各種時刻的回調接口,可在圖片加載的某些點做監聽。
包括開始加載(onLoadingStarted)、加載失敗(onLoadingFailed)、加載成功(onLoadingComplete)、取消加載(onLoadingCancelled)四個回調函數。
實現ImageLoadingListener接口,不過各個函數都是空實現,表示不在 Image 加載過程中做任何回調監聽。
ImageLoader.displayImage(…)函數中當入參listener為空時的默認值。
Image 加載進度的回調接口。其中抽象函數
void onProgressUpdate(String imageUri, View view, int current, int total)
會在獲取圖片存儲到文件系統時被回調。其中total表示圖片總大小,為網絡請求結果Response Header中content-length字段,如果不存在則為 -1。
顯示圖片的Task,實現了Runnable接口,必須在主線程調用。
主要函數:
首先判斷imageAware是否被 GC 回收,如果是直接調用取消加載回調接口ImageLoadingListener.onLoadingCancelled(…);
否則判斷imageAware是否被復用,如果是直接調用取消加載回調接口ImageLoadingListener.onLoadingCancelled(…);
否則調用displayer顯示圖片,并將imageAware從正在加載的 map 中移除。調用加載成功回調接口ImageLoadingListener.onLoadingComplete(…)。
對于 ListView 或是 GridView 這類會緩存 Item 的 View 來說,單個 Item 中如果含有 ImageView,在滑動過程中可能因為異步加載及 View 復用導致圖片錯亂,這里對imageAware是否被復用的判斷就能很好的解決這個問題。原因類似:Android ListView 滑動過程中圖片顯示重復錯位閃爍問題原因及解決方案。
處理并顯示圖片的Task,實現了Runnable接口。
主要函數:
主要通過 imageLoadingInfo 得到BitmapProcessor處理圖片,并用處理后的圖片和配置新建一個DisplayBitmapTask在ImageAware中顯示圖片。
加載并顯示圖片的Task,實現了Runnable接口,用于從網絡、文件系統或內存獲取圖片并解析,然后調用DisplayBitmapTask在ImageAware中顯示圖片。
主要函數:
獲取圖片并顯示,核心代碼如下:
bmp = configuration.memoryCache.get(memoryCacheKey); if (bmp == null || bmp.isRecycled()) { bmp = tryLoadBitmap(); ... ... ... if (bmp != null && options.isCacheInMemory()) { L.d(LOG_CACHE_IMAGE_IN_MEMORY, memoryCacheKey); configuration.memoryCache.put(memoryCacheKey, bmp); } } …… DisplayBitmapTask displayBitmapTask = new DisplayBitmapTask(bmp, imageLoadingInfo, engine, loadedFrom); runTask(displayBitmapTask, syncLoading, handler, engine);
從上面代碼段中可以看到先是從內存緩存中去讀取 bitmap 對象,若 bitmap 對象不存在,則調用 tryLoadBitmap() 函數獲取 bitmap 對象,獲取成功后若在 DisplayImageOptions.Builder 中設置了 cacheInMemory(true), 同時將 bitmap 對象緩存到內存中。
最后新建DisplayBitmapTask顯示圖片。
函數流程圖如下:
判斷圖片的內存緩存是否存在,若存在直接執行步驟 8;
判斷圖片的磁盤緩存是否存在,若存在直接執行步驟 5;
從網絡上下載圖片;
將圖片緩存在磁盤上;
將圖片 decode 成 bitmap 對象;
根據DisplayImageOptions配置對圖片進行預處理(Pre-process Bitmap);
將 bitmap 對象緩存到內存中;
根據DisplayImageOptions配置對圖片進行后處理(Post-process Bitmap);
執行DisplayBitmapTask將圖片顯示在相應的控件上。
流程圖可以參見`3. 流程圖`。
從磁盤緩存或網絡獲取圖片,核心代碼如下:
File imageFile = configuration.diskCache.get(uri); if (imageFile != null && imageFile.exists()) { ... bitmap = decodeImage(Scheme.FILE.wrap(imageFile.getAbsolutePath())); } if (bitmap == null || bitmap.getWidth() <= 0 || bitmap.getHeight() <= 0) { ... String imageUriForDecoding = uri; if (options.isCacheOnDisk() && tryCacheImageOnDisk()) { imageFile = configuration.diskCache.get(uri); if (imageFile != null) { imageUriForDecoding = Scheme.FILE.wrap(imageFile.getAbsolutePath()); } } checkTaskNotActual(); bitmap = decodeImage(imageUriForDecoding); ... }
首先根據 uri 看看磁盤中是不是已經緩存了這個文件,如果已經緩存,調用 decodeImage 函數,將圖片文件 decode 成 bitmap 對象; 如果 bitmap 不合法或緩存文件不存在,判斷是否需要緩存在磁盤,需要則調用tryCacheImageOnDisk()函數去下載并緩存圖片到本地磁盤,再通過decodeImage(imageUri)函數將圖片文件 decode 成 bitmap 對象,否則直接通過decodeImage(imageUriForDecoding)下載圖片并解析。
下載圖片并存儲在磁盤內,根據磁盤緩存圖片最長寬高的配置處理圖片。
loaded = downloadImage();
主要就是這一句話,調用下載器下載并保存圖片。
如果你在ImageLoaderConfiguration中還配置了maxImageWidthForDiskCache或者maxImageHeightForDiskCache,還會調用resizeAndSaveImage()函數,調整圖片尺寸,并保存新的圖片文件。
下載圖片并存儲在磁盤內。調用getDownloader()得到ImageDownloader去下載圖片。
從磁盤緩存中得到圖片,重新設置大小及進行一些處理后保存。
根據ImageLoaderEngine配置得到下載器。
如果不允許訪問網絡,則使用不允許訪問網絡的圖片下載器NetworkDeniedImageDownloader;如果是慢網絡情況,則使用慢網絡情況下的圖片下載器SlowNetworkImageDownloader;否則直接使用ImageLoaderConfiguration中的downloader。
加載和顯示圖片任務需要的信息。
String uri 圖片 url。
String memoryCacheKey 圖片緩存 key。
ImageAware imageAware 需要加載圖片的對象。
ImageSize targetSize 圖片的顯示尺寸。
DisplayImageOptions options 圖片顯示的配置項。
ImageLoadingListener listener 圖片加載各種時刻的回調接口。
ImageLoadingProgressListener progressListener 圖片加載進度的回調接口。
ReentrantLock loadFromUriLock 圖片加載中的重入鎖。
圖片下載接口。待實現函數
getStream(String imageUri, Object extra)
表示通過 uri 得到 InputStream。
通過內部定義的枚舉Scheme, 可以看出 UIL 支持哪些圖片來源。
HTTP("http"), HTTPS("https"), FILE("file"), CONTENT("content"), ASSETS("assets"), DRAWABLE("drawable"), UNKNOWN("");
ImageDownloader的具體實現類。得到上面各種Scheme對應的圖片 InputStream。
主要函數
在getStream(…)函數內根據不同Scheme類型獲取圖片輸入流。
@Override public InputStream getStream(String imageUri, Object extra) throws IOException { switch (Scheme.ofUri(imageUri)) { case HTTP: case HTTPS: return getStreamFromNetwork(imageUri, extra); case FILE: return getStreamFromFile(imageUri, extra); case CONTENT: return getStreamFromContent(imageUri, extra); case ASSETS: return getStreamFromAssets(imageUri, extra); case DRAWABLE: return getStreamFromDrawable(imageUri, extra); case UNKNOWN: default: return getStreamFromOtherSource(imageUri, extra); } }
具體見下面各函數介紹。
通過HttpURLConnection從網絡獲取圖片的InputStream。支持 response code 為 3xx 的重定向。這里有個小細節代碼如下:
try { imageStream = conn.getInputStream(); } catch (IOException e) { // Read all data to allow reuse connection (http://bit.ly/1ad35PY) IoUtils.readAndCloseStream(conn.getErrorStream()); throw e; }
在發生異常時會調用conn.getErrorStream()繼續讀取 Error Stream,這是為了利于網絡連接回收及復用。但有意思的是在 Froyo(2.2) 之前,HttpURLConnection 有個重大 Bug,調用 close() 函數會影響連接池,導致連接復用失效,不少庫通過在 2.3 之前使用 AndroidHttpClient 解決這個問題。
從文件系統獲取圖片的InputStream。如果 uri 是 video 類型,則需要多帶帶得到 video 的縮略圖返回,否則按照一般讀取文件操作返回。
從 ContentProvider 獲取圖片的InputStream。
如果是 video 類型,則先從MediaStore得到 video 的縮略圖返回;
如果是聯系人類型,通過ContactsContract.Contacts.openContactPhotoInputStream(res, uri)讀取內容返回。
否則通過 ContentResolver.openInputStream(…) 讀取內容返回。
從 Assets 中獲取圖片的InputStream。
從 Drawable 資源中獲取圖片的InputStream。
UNKNOWN(自定義)類型的處理,目前是直接拋出不支持的異常。
Bitmap 內存緩存接口,需要實現的接口包括 get(…)、put(…)、remove(…)、clear()、keys()。
實現了MemoryCache主要函數的抽象類,以 Map
protected abstract ReferencecreateReference(Bitmap value)
表示根據 Bitmap 創建一個 Reference
以WeakReference
實現了BaseMemoryCache的createReference(Bitmap value)函數,直接返回一個new WeakReference
限制總字節大小的內存緩存,繼承自BaseMemoryCache的抽象類。
會在 put(…) 函數中判斷總體大小是否超出了上限,是則循環刪除緩存對象直到小于上限。刪除順序由抽象函數
protected abstract Bitmap removeNext()
決定。抽象函數
protected abstract int getSize(Bitmap value)
表示每個元素大小。
限制總字節大小的內存緩存,會在緩存滿時優先刪除 size 最大的元素,繼承自LimitedMemoryCache。
實現了LimitedMemoryCache緩存removeNext()函數,總是返回當前緩存中 size 最大的元素。
限制總字節大小的內存緩存,會在緩存滿時優先刪除使用次數最少的元素,繼承自LimitedMemoryCache。
實現了LimitedMemoryCache緩存removeNext()函數,總是返回當前緩存中使用次數最少的元素。
限制總字節大小的內存緩存,會在緩存滿時優先刪除最近最少使用的元素,繼承自LimitedMemoryCache。
通過new LinkedHashMap
實現了LimitedMemoryCache緩存removeNext()函數,總是返回第一個元素,即最近最少使用的元素。
限制總字節大小的內存緩存,會在緩存滿時優先刪除先進入緩存的元素,繼承自LimitedMemoryCache。
實現了LimitedMemoryCache緩存removeNext()函數,總是返回最先進入緩存的元素。
以上所有LimitedMemoryCache子類都有個問題,就是 Bitmap 雖然通過WeakReference
限制總字節大小的內存緩存,會在緩存滿時優先刪除最近最少使用的元素,實現了MemoryCache。LRU(Least Recently Used) 為最近最少使用算法。
以new LinkedHashMap
在put(…)函數中通過trimToSize(int maxSize)函數判斷總體大小是否超出了上限,是則刪除第緩存池中第一個元素,即最近最少使用的元素,直到總體大小小于上限。
LruMemoryCache功能上與LRULimitedMemoryCache類似,不過在實現上更加優雅。用簡單的實現接口方式,而不是不斷繼承的方式。
限制了對象最長存活周期的內存緩存。
MemoryCache的裝飾者,相當于為MemoryCache添加了一個特性。以一個MemoryCache內存緩存和一個 maxAge 做為構造函數入參。在 get(…) 時判斷如果對象存活時間已經超過設置的最長時間,則刪除。
可以將某些原本不同的 key 看做相等,在 put 時刪除這些相等的 key。
MemoryCache的裝飾者,相當于為MemoryCache添加了一個特性。以一個MemoryCache內存緩存和一個 keyComparator 做為構造函數入參。在 put(…) 時判斷如果 key 與緩存中已有 key 經過Comparator比較后相等,則刪除之前的元素。
根據 uri 得到文件名的接口。
以 uri 的 hashCode 作為文件名。
以 uri 的 MD5 值作為文件名。
圖片的磁盤緩存接口。
主要函數:
根據原始圖片的 uri 去獲取緩存圖片的文件。
保存 imageStream 到磁盤中,listener 表示保存進度且可在其中取消某些段的保存。
保存圖片到磁盤。
根據圖片 uri 刪除緩存圖片。
關閉磁盤緩存,并釋放資源。
清空磁盤緩存。
得到磁盤緩存的根目錄。
一個無大小限制的本地圖片緩存,實現了DiskCache主要函數的抽象類。
圖片緩存在cacheDir文件夾內,當cacheDir不可用時,則使用備庫reserveCacheDir。
主要函數:
先根據imageUri得到目標文件,將imageStream先寫入與目標文件同一文件夾的 .tmp 結尾的臨時文件內,若未被listener取消且寫入成功則將臨時文件重命名為目標文件并返回 true,否則刪除臨時文件并返回 false。
先根據imageUri得到目標文件,通過Bitmap.compress(…)函數將bitmap先寫入與目標文件同一文件夾的 .tmp 結尾的臨時文件內,若寫入成功則將臨時文件重命名為目標文件并返回 true,否則刪除臨時文件并返回 false。
根據 imageUri 和 fileNameGenerator得到文件名,返回cacheDir內該文件,若cacheDir不可用,則使用備庫reserveCacheDir。
限制了緩存對象最長存活周期的磁盤緩存,繼承自BaseDiskCache。
在 get(…) 時判斷如果緩存對象存活時間已經超過設置的最長時間,則刪除。在 save(…) 時保存當存時間作為對象的創建時間。
一個無大小限制的本地圖片緩存。與BaseDiskCache無異,只是用了個意思明確的類名。
限制總字節大小的內存緩存,會在緩存滿時優先刪除最近最少使用的元素。
通過緩存目錄下名為journal的文件記錄緩存的所有操作,并在緩存open時讀取journal的文件內容存儲到LinkedHashMap
LRU 的實現跟上面內存緩存類似,lruEntries為new LinkedHashMap
來源于 JakeWharton 的開源項目 DiskLruCache,具體分析請等待 DiskLruCache 源碼解析 完成。
限制總字節大小的內存緩存,會在緩存滿時優先刪除最近最少使用的元素,實現了DiskCache。
內部有個DiskLruCache cache屬性,緩存的存、取操作基本都是由該屬性代理完成。
通過readLine()函數從InputStream中讀取一行,目前僅用于磁盤緩存操作記錄文件journal的解析。
工具類。
String readFully(Reader reader)讀取 reader 中內容。
deleteContents(File dir)遞歸刪除文件夾內容。
InputStream的裝飾者,可通過available()函數得到 InputStream 對應數據源的長度(總字節數)。主要用于計算文件存儲進度即圖片下載進度時的總進度。
圖片下載及顯示時的錯誤原因,目前包括:
IO_ERROR 網絡連接或是磁盤存儲錯誤。
DECODING_ERROR decode image 為 Bitmap 時錯誤。
NETWORK_DENIED 當圖片不在緩存中,且設置不允許訪問網絡時的錯誤。
OUT_OF_MEMORY 內存溢出錯誤。
UNKNOWN 未知錯誤。
為了解決早期 Android 版本BitmapFactory.decodeStream(…)在慢網絡情況下 decode image 異常的 Bug。
主要通過重寫FilterInputStream的 skip(long n) 函數解決,確保 skip(long n) 始終跳過了 n 個字節。如果返回結果即跳過的字節數小于 n,則不斷循環直到 skip(long n) 跳過 n 字節或到達文件尾。
Image 的縮放類型,目前包括:
NONE不縮放。
NONE_SAFE根據需要以整數倍縮小圖片,使得其尺寸不超過 Texture 可接受最大尺寸。
IN_SAMPLE_POWER_OF_2根據需要以 2 的 n 次冪縮小圖片,使其尺寸不超過目標大小,比較快的縮小方式。
IN_SAMPLE_INT根據需要以整數倍縮小圖片,使其尺寸不超過目標大小。
EXACTLY根據需要縮小圖片到寬或高有一個與目標尺寸一致。
EXACTLY_STRETCHED根據需要縮放圖片到寬或高有一個與目標尺寸一致。
ImageAware的 ScaleType。
將 ImageView 的 ScaleType 簡化為兩種FIT_INSIDE和CROP兩種。FIT_INSIDE表示將圖片縮放到至少寬度和高度有一個小于等于 View 的對應尺寸,CROP表示將圖片縮放到寬度和高度都大于等于 View 的對應尺寸。
表示圖片寬高的類。
scaleDown(…) 等比縮小寬高。
scale(…) 等比放大寬高。
圖片來源枚舉類,包括網絡、磁盤緩存、內存緩存。
將圖片轉換為 Bitmap 的接口,抽象函數:
Bitmap decode(ImageDecodingInfo imageDecodingInfo) throws IOException;
表示根據ImageDecodingInfo信息得到圖片并根據參數將其轉換為 Bitmap。
實現了ImageDecoder。調用ImageDownloader獲取圖片,然后根據ImageDecodingInfo或圖片 Exif 信息處理圖片轉換為 Bitmap。
主要函數:
調用ImageDownloader獲取圖片,再調用defineImageSizeAndRotation(…)函數得到圖片的相關信息,調用prepareDecodingOptions(…)得到圖片縮放的比例,調用BitmapFactory.decodeStream將 InputStream 轉換為 Bitmap,最后調用considerExactScaleAndOrientatiton(…)根據參數將圖片放大、翻轉、旋轉為合適的樣子返回。
得到圖片真實大小以及 Exif 信息(設置考慮 Exif 的條件下)。
得到圖片 Exif 信息中的翻轉以及旋轉角度信息。
得到圖片縮放的比例。
如果scaleType等于ImageScaleType.NONE,則縮放比例為 1;
如果scaleType等于ImageScaleType.NONE_SAFE,則縮放比例為 (int)Math.ceil(Math.max((float)srcWidth / maxWidth, (float)srcHeight / maxHeight));
否則,調用ImageSizeUtils.computeImageSampleSize(…)計算縮放比例。
在 computeImageSampleSize(…) 中
如果viewScaleType等于ViewScaleType.FIT_INSIDE;
1.1 如果`scaleType`等于`ImageScaleType.IN_SAMPLE_POWER_OF_2`,則縮放比例從 1 開始不斷 *2 直到寬或高小于最大尺寸; 1.2 否則取寬和高分別與最大尺寸比例中較大值,即`Math.max(srcWidth / targetWidth, srcHeight / targetHeight)`。
如果scaleType等于ViewScaleType.CROP;
2.1 如果`scaleType`等于`ImageScaleType.IN_SAMPLE_POWER_OF_2`,則縮放比例從 1 開始不斷 *2 直到寬和高都小于最大尺寸。 2.2 否則取寬和高分別與最大尺寸比例中較小值,即`Math.min(srcWidth / targetWidth, srcHeight / targetHeight)`。
最后判斷寬和高是否超過最大值,如果是 *2 或是 +1 縮放。
根據參數將圖片放大、翻轉、旋轉為合適的樣子返回。
Image Decode 需要的信息。
String imageKey 圖片。
String imageUri 圖片 uri,可能是緩存文件的 uri。
String originalImageUri 圖片原 uri。
ImageSize targetSize 圖片的顯示尺寸。
imageScaleType 圖片的 ScaleType。
ImageDownloader downloader 圖片的下載器。
Object extraForDownloader 下載器需要的輔助信息。
boolean considerExifParams 是否需要考慮圖片 Exif 信息。
Options decodingOptions 圖片的解碼信息,為 BitmapFactory.Options。
在ImageAware中顯示 bitmap 對象的接口。可在實現中對 bitmap 做一些額外處理,比如加圓角、動畫效果。
圖片淡入方式顯示在ImageAware中,實現了BitmapDisplayer接口。
為圖片添加圓角顯示在ImageAware中,實現了BitmapDisplayer接口。主要通過BitmapShader實現。
為圖片添加漸變效果的圓角顯示在ImageAware中,實現了BitmapDisplayer接口。主要通過RadialGradient實現。
直接將圖片顯示在ImageAware中,實現了BitmapDisplayer接口。
圖片處理接口。可用于對圖片預處理(Pre-process Bitmap)和后處理(Post-process Bitmap)。抽象函數:
public interface BitmapProcessor { Bitmap process(Bitmap bitmap); }
用戶可以根據自己需求去實現它。比如你想要為你的圖片添加一個水印,那么可以自己去實現 BitmapProcessor 接口,在DisplayImageOptions中配置 Pre-process 階段預處理圖片,這樣設置后存儲在文件系統以及內存緩存中的圖片都是加了水印后的。如果只希望在顯示時改變不動原圖片,可以在BitmapDisplayer中處理。
可在 View 滾動過程中暫停圖片加載的 Listener,實現了 OnScrollListener 接口。
它的好處是防止滾動中不必要的圖片加載,比如快速滾動不希望滾動中的圖片加載。在 ListView 或 GridView 中 item 加載圖片最好使用它,簡單的一行代碼:
gridView.setOnScrollListener(new PauseOnScrollListener(ImageLoader.getInstance(), false, true));
主要的成員變量:
pauseOnScroll 觸摸滑動(手指依然在屏幕上)過程中是否暫停圖片加載。
pauseOnFling 甩指滾動(手指已離開屏幕)過程中是否暫停圖片加載。
externalListener 自定義的 OnScrollListener 接口,適用于 View 原來就有自定義 OnScrollListener 情況設置。
實現原理:
重寫onScrollStateChanged(…)函數判斷不同的狀態下暫停或繼續圖片加載。
OnScrollListener.SCROLL_STATE_IDLE表示 View 處于空閑狀態,沒有在滾動,這時候會加載圖片。
OnScrollListener.SCROLL_STATE_TOUCH_SCROLL表示 View 處于觸摸滑動狀態,手指依然在屏幕上,通過pauseOnScroll變量確定是否需要暫停圖片加載。這種時候大都屬于慢速滾動瀏覽狀態,所以建議繼續圖片加載。
OnScrollListener.SCROLL_STATE_FLING表示 View 處于甩指滾動狀態,手指已離開屏幕,通過pauseOnFling變量確定是否需要暫停圖片加載。這種時候大都屬于快速滾動狀態,所以建議暫停圖片加載以節省資源。
任務隊列的處理類型,包括FIFO先進先出、LIFO后進先出。
后進先出阻塞隊列。重寫LinkedBlockingDeque的offer(…)函數如下:
@Override public boolean offer(T e) { return super.offerFirst(e); }
讓LinkedBlockingDeque插入總在最前,而remove()本身始終刪除第一個元素,所以就變為了后進先出阻塞隊列。
實際一般情況只重寫offer(…)函數是不夠的,但因為ThreadPoolExecutor默認只用到了BlockingQueue的offer(…)函數,所以這種簡單重寫后做為ThreadPoolExecutor的任務隊列沒問題。
LIFOLinkedBlockingDeque.java包下的LinkedBlockingDeque.java、BlockingDeque.java、Deque.java都是 Java 1.6 源碼中的,這里不做分析。
磁盤緩存工具類,可用于查找或刪除某個 uri 對應的磁盤緩存。
內存緩存工具類。可用于根據 uri 生成內存緩存 key,緩存 key 比較,根據 uri 得到所有相關的 key 或圖片,刪除某個 uri 的內存緩存。
generateKey(String imageUri, ImageSize targetSize)
根據 uri 生成內存緩存 key,key 規則為[imageUri]_[width]x[height]。
得到圖片 SD 卡緩存目錄路徑。
緩存目錄優先選擇/Android/data/[app_package_name]/cache;若無權限或不可用,則選擇 App 在文件系統的緩存目錄context.getCacheDir();若無權限或不可用,則選擇/data/data/[app_package_name]/cache。
如果緩存目錄選擇了/Android/data/[app_package_name]/cache,則新建.nomedia文件表示不允許類似 Galley 這些應用顯示此文件夾下圖片。不過在 4.0 系統有 Bug 這種方式不生效。
用于計算圖片尺寸、縮放比例相關的工具類。
IO 相關工具類,包括 stream 拷貝,關閉等。
Log 工具類。
5. 雜談 聊聊 LRUUIL 的內存緩存默認使用了 LRU 算法。 LRU: Least Recently Used 近期最少使用算法, 選用了基于鏈表結構的 LinkedHashMap 作為存儲結構。
假設情景:內存緩存設置的閾值只夠存儲兩個 bitmap 對象,當 put 第三個 bitmap 對象時,將近期最少使用的 bitmap 對象移除。
圖 1: 初始化 LinkedHashMap, 并按使用順序來排序, accessOrder = true;
圖 2: 向緩存池中放入 bitmap1 和 bitmap2 兩個對象。
圖 3: 繼續放入第三個 bitmap3,根據假設情景,將會超過設定緩存池閾值。
圖 4: 釋放對 bitmap1 對象的引用。
圖 5: bitmap1 對象被 GC 回收。
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/70576.html
摘要:中簡單搞定接口訪問,以及簡析掘金最近總結的一些經驗,對于或中使用接口的一些心得。這里,本文將數據結構之學習總結掘金前言前面介紹了的數據結構,今天抽空學習總結一下另一種數據結構。淺析事件傳遞掘金中的事件傳遞主要涉及三個方法和。 Android 系統中,那些能大幅提高工作效率的 API 匯總(持續更新中...) - 掘金前言 條條大路通羅馬。工作中,實現某個需求的方式往往不是唯一的,這些不...
閱讀 1800·2021-11-22 09:34
閱讀 3083·2019-08-30 15:55
閱讀 663·2019-08-30 15:53
閱讀 2053·2019-08-30 15:52
閱讀 3000·2019-08-29 18:32
閱讀 1989·2019-08-29 17:15
閱讀 2391·2019-08-29 13:14
閱讀 3557·2019-08-28 18:05