Kotlin程式設計之Glide V4（使用OkHttp3作為傳輸層）。
阿新 • • 發佈：2019-01-08
Android Glide4 非同步圖片框架
前言：
Glide預設使用HttpUrlConnection的網路堆疊，也可以使用Google的Volley庫和Squareas的OkHttp庫來替代。
Integration Libraries(整合庫)
1. volley-integration庫：
介紹：
Volley不是非常高效的載入影象，因為Volley是將遠端伺服器返回的資料複製到位元組陣列中。雖然Volley嘗試重新使用這些位元組陣列，但是對於中等或者超大影象，他的回收率相對較差。故，當Volley與Glide一起結合使用時，Volley會佔用大量記憶體來載入影象。與Glide的預設網路庫相比較，Volley具備在網路較差可以重試的優勢。
注意點：
在使用volley-integration庫時候，要禁用Volley的磁碟快取或者Glide的磁碟快取(二選一)，若是不這樣，Volley與Glide會在磁碟中快取相同的資料。
Gradle 中新增整合庫:
compile "com.github.bumptech.glide:volley-integration:4.0.0-RC1"
2. okhttp3-integration庫:
介紹：
OkHttp是一個比Cronet或者Volley更低API使用的網路庫，同時還支援SPDY。OkHttp與Glide結合使用會有更好的效能，載入圖佔用的記憶體比Volley少，產生更少的垃圾。OkHttp是一個很合理的選擇，它支援任何一個Android系統版本中使用，同時OkHttp具備其他強大的功能，你會在專案中使用到它。
Gradle 中新增整合庫:
compile "com.github.bumptech.glide:okhttp3-integration:4.0.0-RC1"
除了此之外，Glide還具備recyclerview-integration庫，這裡不做介紹。
根據專案需求，自定義Glide整合OkHttp3庫
需求：
當Glide自帶的整合庫，可以滿足專案中大部分需求。當整合庫滿足不了專案需求的時候，就該自己手寫自定義的整合庫。
思路分析：
使用Glide v4的Generated API，需要自定義一個 AppGlideModule。
整合第三方網路庫OkHttp，需要自定義一個LibraryGlideModule 。
前期配置：
1.新增依賴庫：
新增專案中使用到的外掛和依賴庫.例如 : Kotlin-Android擴充套件外掛，Kotlin-kapt外掛，Glidev4和OkHttp3的依賴。
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'//擴充套件外掛
apply plugin: 'kotlin-kapt'//kapt3外掛
//.....省略部分程式碼
dependencies {
compile fileTree(include: ['*.jar'], dir: 'libs')
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
exclude group: 'com.android.support', module: 'support-annotations'
})
compile 'com.android.support:appcompat-v7:26.+'
compile 'com.android.support.constraint:constraint-layout:1.0.2'
testCompile 'junit:junit:4.12'
compile "org.jetbrains.kotlin:kotlin-stdlib-jre7:$kotlin_version"
//Glide v4
compile 'com.github.bumptech.glide:glide:4.0.0-RC1'
//在Kotlin中Glide的註解,kapt是 Kotlin內建的註解處理器
kapt 'com.github.bumptech.glide:compiler:4.0.0-RC1'
//OkHttp3
compile 'com.squareup.okhttp3:okhttp:3.8.1'
compile 'com.squareup.okhttp3:logging-interceptor:3.8.1'
}
repositories {
mavenCentral()
}2.新增混淆規則：
新增Glide和OkHttp的混淆規則。
#Glide庫的混淆
-keep public class * extends com.bumptech.glide.module.AppGlideModule
-keep class com.bumptech.glide.GeneratedAppGlideModuleImpl
-keep public enum com.bumptech.glide.load.resource.bitmap.ImageHeaderParser$** {
**[] $VALUES;
public *;
}
#OkHttp庫的混淆
-dontwarn okio.**
-dontwarn javax.annotation.Nullable
-dontwarn javax.annotation.ParametersAreNonnullByDefault
3.新增許可權：
新增聯網許可權。
<uses-permission android:name="android.permission.INTERNET"></uses-permission>使用Kotlin程式設計來編寫專案程式碼
1. 自定義AppGlideModule
為運用程式定義一個帶有@GlideModule註解的AppGlideModule，運用程式會使用和AppGlideMoudle同一個包下的GlideApp類。通過GlideApp.with()方式使用Glide的Generated API。
@GlideModule
internal class CustomAppGlideModule : AppGlideModule() {
/**
* 設定記憶體快取大小10M
*/
val cacheSize=10*1024*1024
override fun applyOptions(context: android.content.Context?, builder: com.bumptech.glide.GlideBuilder) {
builder.setMemoryCache(LruResourceCache(cacheSize))
}
/**
* 註冊一個String型別的BaseGlideUrlLoader
*/
override fun registerComponents(context: android.content.Context?, registry: com.bumptech.glide.Registry) {
registry.append(String::class.java, java.io.InputStream::class.java,
CustomBaseGlideUrlLoader.Companion.factory)
}
/**
* 關閉解析AndroidManifest
*/
override fun isManifestParsingEnabled(): Boolean {
return false
}
}2. 自定義自定義BaseGlideUrlLoader
根據帶有圖片尺寸的URl,來獲取合適比例的圖片資源。通過指定String型別的Model, BaseGliUrlLOader中getgetURL()來覆蓋原本的帶有http或者htpps的URL. 這裡處理方式來源於，Google IO App.
internal class CustomBaseGlideUrlLoader(concreteLoader: ModelLoader<GlideUrl, InputStream>, modelCache: ModelCache<String, GlideUrl>): BaseGlideUrlLoader<String>(concreteLoader,modelCache){
/**
* Url的匹配規則
*/
val patern= Pattern.compile("__w-((?:-?\\d+)+)__")
/**
* 控制需要載入圖片的尺寸大小
*/
override fun getUrl(model: String, width: Int, height: Int, options: Options): String {
var m=patern.matcher(model)
var bestBucket=0
if (m.find()){
var found=m.group(1).split("-")
for (item in found){
bestBucket=item.toInt()
if (bestBucket>=width) break
}
}
return model
}
override fun handles(model: String?)=true
companion object{
val urlCache= ModelCache<String, GlideUrl>(150)
val factory=object: ModelLoaderFactory<String, InputStream> {
override fun build(multiFactory: MultiModelLoaderFactory): ModelLoader<String, InputStream> {
return CustomBaseGlideUrlLoader(multiFactory.build(GlideUrl::class.java, InputStream::class.java), urlCache)
}
override fun teardown() {
}
}
}
3. 自定義LibraryGlideModule
自定義一個OkHttp3整合的GlideModule，註冊OkHttp相關型別。運用程式使用了整合其他網路庫，則會包含一個AppGlideModule和Glide`註解，而本類將會自動包含。
@GlideModule
internal class CustomOkHttpGlideModule : LibraryGlideModule(){
override fun registerComponents(context: Context?, registry: Registry) {
registry.replace(GlideUrl::class.java,
InputStream::class.java,OkHttpUrlLoader.factory)
}
}4. 自定義ModelLoader：
一個簡單的載入器，用於使用OkHttp通過http/https獲取的流。
class OkHttpUrlLoader(var client:Call.Factory) :ModelLoader<GlideUrl,InputStream>{
override fun buildLoadData(model: GlideUrl, width: Int, height: Int, options: Options?): ModelLoader.LoadData<InputStream>? {
return ModelLoader.LoadData(model,OkHttpStreamFetcher(client,model))
}
override fun handles(model: GlideUrl?)=true
companion object{
/**
* 一個OkHttpUrlLoader的工廠
*/
var factory=object :ModelLoaderFactory<GlideUrl,InputStream>{
@Volatile private var internalClient: Call.Factory? = null
private var client: Call.Factory? = null
init {
client=getInternalClient()
}
private fun getInternalClient(): Call.Factory? {
if (internalClient == null) {
synchronized(this) {
if (internalClient == null) {
internalClient = OkHttpProvider.createOkHttpClient()
}
}
}
return internalClient
}
override fun build(multiFactory: MultiModelLoaderFactory?)
: ModelLoader<GlideUrl, InputStream> {
return OkHttpUrlLoader(client!!)
}
override fun teardown() {
}
}
}
}5. 自定義DataFetcher
重寫DataFetcher，獲取OkHttp庫的資料流。
class OkHttpStreamFetcher(var client: Call.Factory, var url: GlideUrl) : DataFetcher<InputStream> {
var tag = OkHttpStreamFetcher::class.java.simpleName
@Synthetic var stream: InputStream? = null
@Synthetic var responseBody: ResponseBody? = null
@Volatile private var call: Call? = null
override fun loadData(priority: Priority, callback: DataFetcher.DataCallback<in InputStream>) {
var requestBuilder = Request.Builder().url(url.toStringUrl())
//新增header
for (headerEntry in url.headers.entries) {
requestBuilder.addHeader( headerEntry.key, headerEntry.value)
}
var request = requestBuilder.build()
call = client.newCall(request)
call?.enqueue(object : Callback {
override fun onFailure(call: Call?, e: IOException) {
callback.onLoadFailed(e)
}
override fun onResponse(call: Call, response: Response) {
responseBody= response.body()
if (response.isSuccessful) {//請求成功
var contentLength = responseBody!!.contentLength()
stream = ContentLengthInputStream.obtain(
responseBody?.byteStream(), contentLength)
callback.onDataReady(stream)
} else {//請求失敗
callback.onLoadFailed(HttpException(response.message(), response.code()))
}
}
})
}
override fun getDataSource(): DataSource {
return DataSource.REMOTE
}
/**
* 清空
*/
override fun cleanup() {
try {
stream?.close()
}catch (e: IOException){
e.printStackTrace()
}
responseBody?.close()
}
override fun getDataClass(): Class<InputStream> {
return InputStream::class.java
}
/**
* 取消
*/
override fun cancel() {
var localCall=call
if (localCall!=null){
localCall.cancel()
}
}
}6. OkHttp的相關配置（重點）
這裡只是簡單的配置了OkHttp日誌 , 還可以配置連線時間，攔截器，Https的配置。更多具體配置，請閱讀OkHttp官網。
internal class OkHttpProvider{
companion object{
/**
* 自定義配置OkHttpClient
*/
fun createOkHttpClient(): OkHttpClient {
var builder= OkHttpClient.Builder()
var loggingInterceptor= HttpLoggingInterceptor()
loggingInterceptor.level= HttpLoggingInterceptor.Level.BODY
builder.addInterceptor(loggingInterceptor)
return builder.build()
}
}
}7.確保GlideApp類正常引用：
當配置完以上步驟後，發覺不能使用GlideApp類。
解決方式：在AndroidStudio中Build–>Make Project–>將會出現build/generated/source中，便可以使用GlideApp。
8. 使用GlideApp類載入圖片：
這裡使用Kotlin Android擴充套件外掛，省略了findviewbyid()。
import kotlinx.android.synthetic.main.activity_main.*
class MainActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
GlideApp.with(this)
.load("https://github.com/bumptech/glide/raw/master/static/glide_logo.png")
.placeholder(R.mipmap.ic_launcher)
.error(R.mipmap.ic_launcher)
.centerCrop()
.into(main_iv)
}
}AnroidStudio上執行專案
執行結果,打印出日誌資料：
1. Request的body和header：
07-31 01:20:22.419 5601-5601/com.xingen.glideokhttp D/NetworkSecurityConfig: No Network Security Config specified, using platform default
07-31 01:20:22.470 5601-5631/com.xingen.glideokhttp D/OkHttp: --> GET https://github.com/bumptech/glide/raw/master/static/glide_logo.png http/1.1
07-31 01:20:22.470 5601-5631/com.xingen.glideokhttp D/OkHttp: User-Agent: Dalvik/2.1.0 (Linux; U; Android 7.0; Android SDK built for x86 Build/NYC)
07-31 01:20:22.470 5601-5631/com.xingen.glideokhttp D/OkHttp: Accept-Encoding: identity
07-31 01:20:22.470 5601-5631/com.xingen.glideokhttp D/OkHttp: --> END GET
2. Response的資料：
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: <-- 200 OK https://raw.githubusercontent.com/bumptech/glide/master/static/glide_logo.png (1583ms)
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Content-Security-Policy: default-src 'none'; style-src 'unsafe-inline'
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Strict-Transport-Security: max-age=31536000
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Content-Type-Options: nosniff
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Frame-Options: deny
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-XSS-Protection: 1; mode=block
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: ETag: "f9f4d799446f67d505d5e8aa4a4f3adc7e0d558b"
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Content-Type: image/png
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Cache-Control: max-age=300
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Geo-Block-List:
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-GitHub-Request-Id: 7ECA:275E9:454068:4AEB18:597E8546
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Content-Length: 13002
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Accept-Ranges: bytes
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Date: Mon, 31 Jul 2017 01:20:11 GMT
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Via: 1.1 varnish
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Connection: keep-alive
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Served-By: cache-nrt6130-NRT
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Cache: HIT
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Cache-Hits: 1
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Timer: S1501464011.294124,VS0,VE1
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Vary: Authorization,Accept-Encoding
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Access-Control-Allow-Origin: *
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: X-Fastly-Request-ID: 36b5d30a2d33ec2e614c0af64205f7b3ae4d3183
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Expires: Mon, 31 Jul 2017 01:25:11 GMT
07-31 01:20:24.053 5601-5631/com.xingen.glideokhttp D/OkHttp: Source-Age: 133
07-31 01:20:24.063 5601-5631/com.xingen.glideokhttp D/OkHttp: <-- END HTTP (binary 13002-byte body omitted)
執行效果如下：
資源參考：