OkHttp日常使用实战篇

最新推荐文章于 2024-05-22 23:01:36 发布
最新推荐文章于 2024-05-22 23:01:36 发布
阅读量3k 收藏 2
点赞数
分类专栏： OkHttp 文章标签： android OkHttp kotlin
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_35241409/article/details/118912417
版权

由于示例中使用的代码段都比较简单，详细的代码段以及响应日志都已经贴出，细节不再赘述。

一、初始化
  • 1、初始化OkHttpClient
val mClient = getOkClient()

private fun getOkClient(): OkHttpClient {
        return OkHttpClient.Builder().addInterceptor(LogInterceptor()).build()

}

  • 2、初始化Request
  private var mUrl2 = "https://www.baidu.com/"
  val mRequest = Request.Builder().url(mUrl2).build()
二、同步Get请求

由于网络请求不能在主线程进行，此处使用协程进行请求，防止主线程发生阻塞

  • 1、代码段
  mRequest?.let {
            GlobalScope.launch {
                mClient.newCall(it).execute().use { response ->
                        if (response.isSuccessful) {
                            for ((name, value) in response.headers) {
                                LogUtil.D(log = "name ===$name   value===$value")
                            }
                            LogUtil.D(log = "response body== ${response.body.toString()}")
                        }
                }

            }
        }
  • 2、response日志
2021-07-14 19:37:33.455 31188-31247/com.example.myapplication D/tag: name ===Cache-Control   value===private, no-cache, no-store, proxy-revalidate, no-transform
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Connection   value===keep-alive
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Content-Type   value===text/html
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Date   value===Wed, 14 Jul 2021 11:37:33 GMT
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Last-Modified   value===Mon, 23 Jan 2017 13:23:46 GMT
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Pragma   value===no-cache
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Server   value===bfe/1.0.8.18
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Set-Cookie   value===BDORZ=27315; max-age=86400; domain=.baidu.com; path=/
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: name ===Transfer-Encoding   value===chunked
2021-07-14 19:37:33.456 31188-31247/com.example.myapplication D/tag: response body== okhttp3.internal.http.RealResponseBody@72ab647

以上可见请求成功并打印了响应头

三、异步Get请求

通常实际项目中，使用异步的方式进行请求，

  • 1、代码段
   mRequest?.let {
            mClient.newCall(it).enqueue(object : Callback {
                override fun onFailure(call: Call, e: IOException) {
                    Log.d(TAG, "fail e===${e.message}   cause=== ${e.cause}")
                }

                override fun onResponse(call: Call, response: Response) {
                    Log.d(TAG, " get success  response=== ${response.body.toString()}")
                    updateText(response)
                    response.body?.close()
                }

            })
        }
  • 2、response日志
2021-07-14 19:43:40.671 31188-31469/com.example.myapplication D/tag:  get success  response=== okhttp3.internal.http.RealResponseBody@2b2273f
三、访问头文件
  • 1、设置header

OkHttp设置请求头时，使用header(name, value)设定的唯一键name值value
使用addHeader(name, value)添加一个头时，如果header中存在现有值，新值将覆盖旧值。

  • 2、读取header

读取响应头时，返回最后一次出现的header(name)命名值。通常键唯一，值唯一，并且一一对应。
如果不存在值，header(name)将返回 null。
如果想读取所有的header，可以使用headers(name).

  • 3、代码段
  val mRequest=Request.Builder()
            .url("https://api.github.com/repos/square/okhttp/issues")
            .header("User-Agent", "OkHttp Headers.java")
            .addHeader("Accept", "application/json; q=0.5")
            .addHeader("Accept", "application/vnd.github.v3+json")
            .build()

        GlobalScope.launch {
            mClient.newCall(mRequest).execute().use { response->
                if (!response.isSuccessful)LogUtil.D(log = "response error ==== ${response.code}")

                LogUtil.D(log="Server: ${response.header("Server")}")
                LogUtil.D(log="Date: ${response.header("Date")}")
                LogUtil.D(log="Vary: ${response.headers("Vary")}")
                // 查看header中哈哈哈为键的值
                LogUtil.D(log="哈哈哈: ${response.header("哈哈哈")}")
            }
        }
  • 4、response日志
2021-07-14 20:14:03.909 32142-32180/com.example.myapplication D/tag: Server: GitHub.com
2021-07-14 20:14:03.910 32142-32180/com.example.myapplication D/tag: Date: Wed, 14 Jul 2021 12:14:02 GMT
2021-07-14 20:14:03.910 32142-32180/com.example.myapplication D/tag: Vary: [Accept, Accept-Encoding, Accept, X-Requested-With]
2021-07-14 20:14:03.910 32142-32180/com.example.myapplication D/tag: 哈哈哈: null

通过日志可见，通过header的键获取到了相应的值，由于没有查询到哈哈哈对应的值，返回了null。

四、使用post请求发送string
  • 1、注意点

使用post请求发送请求体到服务端，一般限制不大于1M

  • 2、代码段
    val postBody = """
        |Releases
        |--------
        |
        | * _1.0_ May 6, 2013
        | * _1.1_ June 15, 2013
        | * _1.2_ August 11, 2013
        |""".trimMargin()

        val request = Request.Builder()
            .url("https://api.github.com/markdown/raw")
            .post(postBody.toRequestBody(MEDIA_TYPE_MARKDOWN))
            .build()

        GlobalScope.launch {
            mClient.newCall(request).execute().use { response ->
                if (!response.isSuccessful) throw IOException("Unexpected code $response")

                LogUtil.D(log = response.body!!.string())
            }
        }
  • 3、response响应
2021-07-14 20:31:25.498 32462-32509/com.example.myapplication D/tag: <h2>
    <a id="user-content-releases" class="anchor" href="#releases" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Releases</h2>
    <ul>
    <li>
    <em>1.0</em> May 6, 2013</li>
    <li>
    <em>1.1</em> June 15, 2013</li>
    <li>
    <em>1.2</em> August 11, 2013</li>
    </ul>
五、使用post发送流
  • 1、简介

示例中将请求体通过Okio的buffer sink直接转换成流进行传递，也可以使用OutputStream进行转换传递。

  • 2、代码段
    val requestBody = object : RequestBody() {
                override fun contentType() = MEDIA_TYPE_MARKDOWN
                
                /** Writes the content of this request to [sink]. */
                override fun writeTo(sink: BufferedSink) {
                    sink.writeUtf8("Numbers\n")
                    sink.writeUtf8("-------\n")
                    for (i in 2..10) {
                        sink.writeUtf8(String.format(" * $i = ${factor(i)}\n"))
                    }
                }

                // 因式分解
                private fun factor(n: Int): String {
                    for (i in 2 until n) {
                        val x = n / i
                        if (x * i == n) return "${factor(x)} × $i"
                    }
                    return n.toString()
                }
            }

            val request = Request.Builder()
                .url("https://api.github.com/markdown/raw")
                .post(requestBody)
                .build()

           GlobalScope.launch {
               mClient.newCall(request).execute().use { response ->
                   if (!response.isSuccessful) throw IOException("Unexpected code $response")

                   LogUtil.D(log=response.body!!.string())
           }

        }
  • 3、response日志
2021-07-14 20:53:51.098 1496-1551/com.example.myapplication D/tag: <h2>
    <a id="user-content-numbers" class="anchor" href="#numbers" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Numbers</h2>
    <ul>
    <li>2 = 2</li>
    <li>3 = 3</li>
    <li>4 = 2 × 2</li>
    <li>5 = 5</li>
    <li>6 = 3 × 2</li>
    <li>7 = 7</li>
    <li>8 = 2 × 2 × 2</li>
    <li>9 = 3 × 3</li>
    <li>10 = 5 × 2</li>
    </ul>
六、post上传文件
  • 1、示例代码
     val fileDir = File(Environment.getExternalStorageDirectory(),"test")
        if (!fileDir.exists()) {
            fileDir.mkdir()
        }
        val fileName="testConnectionFile.txt"
        val file=File(fileDir,fileName)
        val request = Request.Builder()
            .url("https://api.github.com/markdown/raw")
            .post(file.asRequestBody(MEDIA_TYPE_MARKDOWN))
            .build()

            request.let {
                mClient.newCall(it).enqueue(object : Callback {
                    override fun onFailure(call: Call, e: IOException) {
                        LogUtil.D(log = "response error=== ${e.cause} message=== ${e.message}")
                    }

                    override fun onResponse(call: Call, response: Response) {
                        LogUtil.D(log = response.body!!.string())
                    }
                })
        }
  • 2、response日志
// interceptor
2021-07-15 21:01:05.378 12489-12554/com.example.myapplication D/tag: Sending request url== https://api.github.com/markdown/raw  connection== Connection{api.github.com:443, proxy=DIRECT hostAddress=api.github.com/192.30.255.116:443 cipherSuite=TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 protocol=h2}  headers==Content-Type: text/x-markdown; charset=utf-8
    Content-Length: 78
    Host: api.github.com
    Connection: Keep-Alive
    Accept-Encoding: gzip
    User-Agent: okhttp/4.9.0
 
 // response
2021-07-15 21:01:05.719 12489-12554/com.example.myapplication D/tag: Received response url== https://api.github.com/markdown/raw  costTime== 342ms header== server: GitHub.com
    date: Thu, 15 Jul 2021 13:01:05 GMT
    content-type: text/html;charset=utf-8
    x-commonmarker-version: 0.21.0
    x-ratelimit-limit: 60
    x-ratelimit-remaining: 58
    x-ratelimit-reset: 1626357649
    x-ratelimit-used: 2
    x-ratelimit-resource: core
    access-control-expose-headers: ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset
    access-control-allow-origin: *
    strict-transport-security: max-age=31536000; includeSubdomains; preload
    x-frame-options: deny
    x-content-type-options: nosniff
    x-xss-protection: 0
    referrer-policy: origin-when-cross-origin, strict-origin-when-cross-origin
    content-security-policy: default-src 'none'
    vary: Accept-Encoding, Accept, X-Requested-With
    content-encoding: gzip
    x-github-request-id: 1964:7252:B6CA20:C2ED42:60F03180
    
2021-07-15 21:01:05.722 12489-12554/com.example.myapplication D/tag: <p>url===== <a href="http://mf.m.bch.leju.com/v70/show/index_feed.json" rel="nofollow">http://mf.m.bch.leju.com/v70/show/index_feed.json</a>   Time===  3438ms</p>
七、post上传form表单
  • 1、示例代码

向百度发送form表单

    val formData=FormBody.Builder()
            .add("search","Jurassic Park")
            .build()

        val request=Request.Builder()
            .url("https://www.baidu.com")
            .post(formData)
            .build()

            mClient.newCall(request).enqueue(object :Callback{
                override fun onFailure(call: Call, e: IOException) {
                    LogUtil.D(log="error  message ==== ${e.message}")
                }

                override fun onResponse(call: Call, response: Response) {
                    LogUtil.D(log="success response== ${response.body.toString()}")
                }

            })
  • 2、日志

通过日志查看请求成功了

// interceptor
2021-07-16 13:58:45.294 6510-6550/com.example.myapplication D/tag: Sending request url== https://www.baidu.com/  connection== Connection{www.baidu.com:443, proxy=DIRECT hostAddress=www.baidu.com/110.242.68.3:443 cipherSuite=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 protocol=http/1.1}  headers==Content-Type: application/x-www-form-urlencoded
    Content-Length: 22
    Host: www.baidu.com
    Connection: Keep-Alive
    Accept-Encoding: gzip
    User-Agent: okhttp/4.9.0
2021-07-16 13:58:45.323 6510-6550/com.example.myapplication D/tag: Received response url== https://www.baidu.com/  costTime== 30ms header== Connection: keep-alive
    Content-Length: 17931
    Content-Type: text/html
    Date: Fri, 16 Jul 2021 05:58:45 GMT
    Etag: "54d97483-460b"
    Server: bfe/1.0.8.18
    
    // response
2021-07-16 13:58:45.324 6510-6550/com.example.myapplication D/tag: success response== okhttp3.internal.http.RealResponseBody@c9f4522
八、post发送multipart request
  • 1、简介

MultipartBody.Builder可以构建与 HTML 文件上传表单兼容的复杂请求体。Multipart请求体的每个部分本身就是一个请求体，并且可以分别定义heder.

  • 2、代码示例
  // 将手机上文件通过formData 传递
        val requestBody=MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            .addFormDataPart("title","registry_list")
            .addFormDataPart("text","registry_list.txt",
                getFile("360/authshare","registry_list.txt").asRequestBody(MEDIA_TYPE_MARKDOWN))
            .build()

        val request = Request.Builder()
            .header("Authorization", "Client-ID $IMGUR_CLIENT_ID")
            .url("https://www.baidu.com")
            .post(requestBody)
            .build()

        mClient.newCall(request).enqueue(object :Callback{
            override fun onFailure(call: Call, e: IOException) {
                LogUtil.D(log="error  message ==== ${e.message}")
            }

            override fun onResponse(call: Call, response: Response) {
                LogUtil.D(log="success response   code==== ${response.code}    body===== ${response.body.toString()}")
            }

        })
  • 3、日志打印
// interceptor
2021-07-16 14:53:07.358 7932-7991/com.example.myapplication D/tag: Sending request url== https://www.baidu.com/  connection== Connection{www.baidu.com:443, proxy=DIRECT hostAddress=www.baidu.com/110.242.68.4:443 cipherSuite=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 protocol=http/1.1}  headers==Authorization: Client-ID 9199fdef135c122
    Content-Type: multipart/form-data; boundary=83bbd2e3-0504-4096-a833-e162d2ad91e2
    Content-Length: 368
    Host: www.baidu.com
    Connection: Keep-Alive
    Accept-Encoding: gzip
    User-Agent: okhttp/4.9.0
2021-07-16 14:53:07.429 7932-7991/com.example.myapplication D/tag: Received response url== https://www.baidu.com/  costTime== 71ms header== Connection: keep-alive
    Content-Length: 17931
    Content-Type: text/html
    Date: Fri, 16 Jul 2021 06:53:07 GMT
    Etag: "54d97483-460b"
    Server: bfe/1.0.8.18
    
 // response
2021-07-16 14:53:07.430 7932-7991/com.example.myapplication D/tag: success response   code==== 302    body===== okhttp3.internal.http.RealResponseBody@b30f288
九、响应缓存
  • 1、简介

要缓存响应，需要设置一个可以读取和写入的缓存目录，并对缓存大小的进行限制。缓存目录应该是私有的，不受信任的应用应该无法读取其内容

为了方便控制缓存增删，多个缓存同时访问的缓存目录应该独立

大多数应用程序使用同一个OkHttpClient，并配置缓存，应该在任何地方使用相同的实例。否则，这两个缓存实例将相互覆盖，破坏响应缓存，并可能使程序崩溃

可以通过配置缓存Header对缓存进行配置，OkHttp会使用配置的缓存header对缓存进行控制

  • 2、代码实例

代码中将缓存保存在文件夹customCache中

     val directory = File(Environment.getExternalStorageDirectory(),"customCache")
        val cacheClient = OkHttpClient().newBuilder().addNetworkInterceptor(CacheAgeInterceptor())
            .cache(Cache(directory = directory, maxSize = 2 * 1024 * 1024L))
            .build()

        // CacheControl.FORCE_CACHE 强制使用缓存
        // CacheControl.FORCE_NETWORK 强制使用网络

        val cc=CacheControl.Builder()
            // .noCache()  // 不使用缓存,但是会存储缓存数据
            // .noStore() // 不使用缓存，同时不存储缓存
            // .onlyIfCached() // 本地缓存时会使用缓存
            .minFresh(100,TimeUnit.SECONDS) // 10s刷新缓存
            .maxAge(1,TimeUnit.HOURS) // 1h最大有效时间
            .maxStale(50,TimeUnit.SECONDS) // 可以接受超时5s的响应
            .build()

        val request=Request.Builder().url(mUrl).cacheControl(cc).build()

        GlobalScope.launch {
            // 响应1
            val responseOne=cacheClient.newCall(request).execute().use { response ->
                if (response.isSuccessful){
                    LogUtil.D(log="request success   cacheResponse=== ${response.cacheResponse?.body?.contentType()}  " +
                            "networkResponse=== ${response.networkResponse}")
                }else{
                    LogUtil.D(log="requestOne error   errorCode ===${response.code}")
                }
            }

            // 响应2
            val responseTwo=cacheClient.newCall(request).execute().use { response ->
                if (response.isSuccessful){
                    LogUtil.D(log="request successTwo   cacheResponse=== ${response.cacheResponse?.body.toString()} " +
                            " networkResponse=== ${response.networkResponse}")
                }else{
                    LogUtil.D(log="requestTwo  error   errorCode ===${response.code}")
                }
            }

            LogUtil.D(log=" responseOne===responseTwo====${responseOne==responseTwo}")

        }
  • 3、日志查看
2021-07-16 16:40:45.072 13883-13933/com.example.myapplication D/tag: request success   cacheResponse=== null  networkResponse=== Response{protocol=http/1.1, code=200, message=OK, url=https://publicobject.com/helloworld.txt}
2021-07-16 16:40:45.106 13883-13933/com.example.myapplication D/tag: request successTwo   cacheResponse=== null  networkResponse=== null
2021-07-16 16:40:45.106 13883-13933/com.example.myapplication D/tag:  responseOne===responseTwo====true

通过日志查看，两次请求都成功了，但是第二次networkResponse为空，证明OkHttp帮我们使用了缓存

  • 4、缓存文件夹查看及缓存内容查看

  1. 缓存文件夹
    在这里插入图片描述

  2. 缓存数据

https://publicobject.com/helloworld.txt
GET
0
HTTP/1.1 200 OK
11
Server: nginx/1.10.3 (Ubuntu)
Date: Fri, 16 Jul 2021 08:40:44 GMT
Content-Type: text/plain
Content-Length: 1759
Last-Modified: Tue, 27 May 2014 02:35:47 GMT
Connection: keep-alive
ETag: "5383fa03-6df"
Accept-Ranges: bytes
Cache-Control: max-age=60
OkHttp-Sent-Millis: 1626424844597
OkHttp-Received-Millis: 1626424844986
TLSv1.2
  • 5、注意点

  1. 要防止响应使用缓存，可以使用CacheControl.FORCE_NETWORK. 要防止它使用网络，可以使用CacheControl.FORCE_CACHE.

  2. 如果您使用FORCE_CACHE并且响应需要网络，OkHttp 将返回一个504 Unsatisfiable Request响应。

十、取消请求
  • 1、简介
  1. 可以使用Call.cancel()方法来取消请求操作
  2. 该操作支持同步和异步请求的取消工作
  3. 如果当前取消的请求的线程正在执行写请求和读响应过程中，会报IOException
  • 2、代码实例

例子中使用Executors延迟5s取消请求

  // init
        val executor = Executors.newScheduledThreadPool(1)
        val request = Request.Builder()
            .url("https://www.baidu.com")
            .build()
        val startTime = System.currentTimeMillis()
        val mCall = mClient.newCall(request)

        // 延迟5s
        executor.schedule({
            LogUtil.D(log = "startCallTime=== ${System.currentTimeMillis() - startTime}")
            mCall.cancel()
        }, 5, TimeUnit.SECONDS)

        // 请求
        GlobalScope.launch {
            mCall.execute().use { response ->
                if (response.isSuccessful) {
                    LogUtil.D(log = "call success response=== ${response.body.toString()}")
                } else {
                    LogUtil.D(log = "call fail code is === ${response.code}")
                }
            }
        }
  • 3、日志
// interceptor
2021-07-19 16:16:15.950 31114-31162/com.example.myapplication D/tag: Sending request url== https://www.baidu.com/  connection== Connection{www.baidu.com:443, proxy=DIRECT hostAddress=www.baidu.com/110.242.68.3:443 cipherSuite=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 protocol=http/1.1}  headers==Host: www.baidu.com
    Connection: Keep-Alive
    Accept-Encoding: gzip
    User-Agent: okhttp/4.9.0
2021-07-19 16:16:15.977 31114-31162/com.example.myapplication D/tag: Received response url== https://www.baidu.com/  costTime== 27ms header== Cache-Control: private, no-cache, no-store, proxy-revalidate, no-transform
    Connection: keep-alive
    Content-Encoding: gzip
    Content-Type: text/html
    Date: Mon, 19 Jul 2021 08:16:15 GMT
    Last-Modified: Mon, 23 Jan 2017 13:23:46 GMT
    Pragma: no-cache
    Server: bfe/1.0.8.18
    Set-Cookie: BDORZ=27315; max-age=86400; domain=.baidu.com; path=/
    Transfer-Encoding: chunked
    
   // response
2021-07-19 16:16:15.979 31114-31162/com.example.myapplication D/tag: call success response=== okhttp3.internal.http.RealResponseBody@f6e4d64
2021-07-19 16:16:20.767 31114-31161/com.example.myapplication D/tag: startCallTime=== 5008
  • 通过日志查看延迟了5008ms，时间接近5s，但是不是很精确
十一、超时时间
  • 1、简介

当请求不可达时，可以使用超时策略来调用失败进行错误处理，OkHttp提供了设置连接、读、写和请求全过程超时时常策略。

  • 2、代码实例

具体的点在代码中都写了注释

 private var mUrl3 = "https://www.nytimes.com/"
 val client: OkHttpClient = OkHttpClient.Builder()
            .addNetworkInterceptor(LogInterceptor())
            .connectTimeout(5, TimeUnit.SECONDS) // 连接超时时间
            .writeTimeout(5, TimeUnit.SECONDS)      // 写超时时间
            .readTimeout(5, TimeUnit.SECONDS)       // 读超时时间
            .callTimeout(10, TimeUnit.SECONDS)      // 全过程超时时间
            .build()

        val request = Request.Builder()
            .url(mUrl3)
            .build()

        GlobalScope.launch {
            client.newCall(request).enqueue(object : Callback {
                override fun onFailure(call: Call, e: IOException) {
                    LogUtil.D(log = "Response error: ${e.message}")
                }

                override fun onResponse(call: Call, response: Response) {
                    LogUtil.D(log = "Response completed: ${response.body.toString()}")
                }

            })
        }
  • 3、日志
2021-07-19 16:54:56.181 4170-4240/com.example.myapplication D/tag: Response error: failed to connect to www.nytimes.com/103.252.115.53 (port 443) from /10.208.97.1 (port 47503) after 5000ms
  • 通过日志查看，连接超时
十二、为不同请求添加不同配置
  • 1、简介

OkHttpClient 提供了配置超时、缓存等方法，当需要不同的请求添加不同配置时，可以使用OKHttpClient.newBuilder()来进行配置。这时两个request请求会共享同一个Client的连接池、嗲调度器和配置。

  • 2、代码实例

我们基于mClient创建了两个request,requestOne设置了超时时间为500ms，requestTwo设置的超时时间为3000ms

   val request = Request.Builder()
            .url("https://httpbin.org/delay/1") 
            .build()

        // set timeout 500
        val clientOne = mClient.newBuilder()
            .readTimeout(500, TimeUnit.MILLISECONDS)
            .build()
            
        GlobalScope.launch {
            clientOne.newCall(request).enqueue(object :Callback{
                override fun onFailure(call: Call, e: IOException) {
                    LogUtil.D(log = "Response error: ${e.message}")
                }

                override fun onResponse(call: Call, response: Response) {
                    LogUtil.D(log = "Response completed: ${response.body.toString()}")
                }

            })
        }

        // set timeout 3000
        val clientTwo = mClient.newBuilder()
            .readTimeout(3000, TimeUnit.MILLISECONDS)
            .build()

        GlobalScope.launch {
            clientTwo.newCall(request).enqueue(object :Callback{
                override fun onFailure(call: Call, e: IOException) {
                    LogUtil.D(log = "Response error: ${e.message}")
                }

                override fun onResponse(call: Call, response: Response) {
                    LogUtil.D(log = "Response completed: ${response.body.toString()}")

                }

            })
        }
  • 3、日志
// interceptor
2021-07-19 18:46:35.927 12767-12814/com.example.myapplication D/tag: Sending request url== https://httpbin.org/delay/1  connection== Connection{httpbin.org:443, proxy=DIRECT hostAddress=httpbin.org/18.235.124.214:443 cipherSuite=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 protocol=h2}  headers==Host: httpbin.org
    Connection: Keep-Alive
    Accept-Encoding: gzip
    User-Agent: okhttp/4.9.0
2021-07-19 18:46:35.927 12767-12813/com.example.myapplication D/tag: Sending request url== https://httpbin.org/delay/1  connection== Connection{httpbin.org:443, proxy=DIRECT hostAddress=httpbin.org/18.235.124.214:443 cipherSuite=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 protocol=h2}  headers==Host: httpbin.org
    Connection: Keep-Alive
    Accept-Encoding: gzip
    User-Agent: okhttp/4.9.0
    
    // response 
    // 超时
2021-07-19 18:46:36.439 12767-12814/com.example.myapplication D/tag: Response error: timeout

2021-07-19 18:46:37.752 12767-12813/com.example.myapplication D/tag: Received response url== https://httpbin.org/delay/1  costTime== 1824ms header== date: Mon, 19 Jul 2021 10:46:37 GMT
    content-type: application/json
    content-length: 315
    server: gunicorn/19.9.0
    access-control-allow-origin: *
    access-control-allow-credentials: true
    
    // response success
2021-07-19 18:46:37.753 12767-12813/com.example.myapplication D/tag: Response completed: okhttp3.internal.http.RealResponseBody@d22b271

通过日志查看，请求全过程耗时1824ms，requestOne超时，requestTwo获取到了响应。

十三、认证处理
  • 1、简介

  1. 通常情况下，当响应码返回401时，OkHttp会自动向认证中心对未认证的请求进行认证重试。

  2. 配置认证代理的方法实现中要提供身份认证凭据，如果提供的身份认证凭据不可用时，返回null并跳过重试。

  3. 可以使用Response.challenges获取schemes和认证信息，当完成基础的challenge后，使用Credentials.basic(username, password)来对请求头进行编码。

  • 2、代码实例

代码中，通过authenticator设置了独立的认证凭据，当response返回code为401时将使用我们提供的认证凭据进行认证。

 val client = OkHttpClient.Builder()
            .authenticator(object : Authenticator {
                @Throws(IOException::class)
                override fun authenticate(route: Route?, response: Response): Request? {
                    if (response.request.header("Authorization") != null) {
                        return null
                    }

                    LogUtil.D(log = "Authenticating for response: $response")
                    LogUtil.D(log = "Challenges: ${response.challenges()}")
                     // 设置认证凭据
                    val credential = Credentials.basic("jesse", "password1")
                    return response.request.newBuilder()
                        .header("Authorization", credential)
                        .build()
                }
            })
            .build()

        val request = Request.Builder()
            .url("https://publicobject.com/secrets/hellosecret.txt")
            .build()

        client.newCall(request).enqueue(object : Callback {
            override fun onFailure(call: Call, e: IOException) {
                LogUtil.D(log = "Response error: ${e.message}")
            }

            override fun onResponse(call: Call, response: Response) {
                LogUtil.D(log = "Response completed: ${response.body.toString()}")
            }

        })
  • 3、日志
// interceptor
2021-07-19 19:26:04.941 13362-13404/com.example.myapplication D/tag: Authenticating for response: Response{protocol=http/1.1, code=401, message=Unauthorized, url=https://publicobject.com/secrets/hellosecret.txt}

//  challenge
2021-07-19 19:26:04.943 13362-13404/com.example.myapplication D/tag: Challenges: [Basic authParams={realm=OkHttp Secrets}]

// response
2021-07-19 19:26:05.130 13362-13404/com.example.myapplication D/tag: Response completed: okhttp3.internal.http.RealResponseBody@52fe3e2

通过日志可见返回了状态码401，使用本地配置的认证凭据进行认证后，获取到了响应。

  • 参考：https://square.github.io/okhttp/recipes/#canceling-a-call-kt-java
VipPeterGee
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
基于NB-IoT的智慧路灯监控系统（NB-IoT专栏—实战篇5:手机应用开发）
不脱发的程序猿
05-24 9571
目录 1、系统总体描述 2、使用技术 2.1、通用技术 2.2、核心技术 2.3、技术亮点 3、开发软件 3.1、开发软件 3.2、测试软件 3.3、打包发布软件 4、功能概述 4.1、系统导航 4.2、用户登录 4.3、扫码绑定 4.4、设备定位 4.5、设备状态 4.6、历史查询 4.7、设备控制 4.8、画像分析 4.9、系统设置 5、核心代码 5...
日常-okhttp
皮皮皮的代码
12-28 134
1. 背景 2. 介绍 3. 源码 4. 实战 5. FAQ 6. 参考资料
[AIGC] OkHttp3：概述与示例
最新发布
程序员三木的博客
05-22 416
OkHttp3 是一个开源的 HTTP 和 HTTP/2 客户端，用于构建高效的 app 网络请求。允许连接多个 IP 地址，如果某个 IP 连接失败，OkHttp 会尝试连接下一个 IP。提供了内存和流式磁盘缓存，以节省带宽和提高速度。提供了 HTTP/2 和 SPDY 的支持，来提高访问速度。提供了透明的 GZIP 来减少下载文件的大小。如果网络服务需要多个范围的请求，OkHttp 会合并它们到单独的请求中。
Android企业级项目实战——基础篇（系列文章）
EGM_NB的博客
07-07 1355
安卓开发企业级项目实战教学系列文章--基础篇
Java个人知识点总结（基础篇）(1)
2401_84407887的博客
04-18 318
每年转战互联网行业的人很多，说白了也是冲着高薪去的，不管你是即将步入这个行业还是想转行，学习是必不可少的。作为一个Java开发，学习成了日常生活的一部分，不学习你就会被这个行业淘汰，这也是这个行业残酷的现实。如果你对Java感兴趣，想要转行改变自己，那就要趁着机遇行动起来。或许，这份限量版的Java零基础宝典能够对你有所帮助。《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
android token机制_Android网络实战篇——Token添加、过期判定以及处理（全局自动刷新）...
weixin_34997006的博客
02-22 1758
Android日常开发中网络请求必不可少，一般来说每一个接口API都会设置Token，用来验证和做唯一识别，Token都会设置一个有效时间，那么Token失效了怎么办？怎样来更新Token？首先怎样来判断Token失效呢？与后端约定，保存到本地，约定时间到了就判定Token已过期后端返回HTTP Code 401，客户端接到401后判定Token已过期后端返回与客户端约定的自定义Code，客户端接...
对kotlin友好的现代 JSON 库 moshi 基本使用和实战
热门推荐
喻志强的博客
04-10 1万+
前言 上一篇博客我们聊了下gson在处理kotlin data class时的一些坑，感兴趣的可以了解一下：gson反序列化成data class时的坑 总结一下有一下两点 属性声明时值不能为null，结果反序列化后值为null，跟预期不符 默认值可能不生效，可能被null覆盖 在文章末尾也介绍了解决办法就是不要使用gson，因为gson主要还是针对java的库，没有对kotlin做单独的支持。 我们可以使用moshi或jackson来解决上面所说的问题。 jackson的是spring boot 默认
实战开发支付SDK —— 对接微信支付看这一篇文章就够啦（含源码）
贱男
12-27 9420
Table of Contents 一、引言 二、了解微信支付 2.1、支付方式 2.1.1、付款码支付 2.1.2、JSAPI支付 2.1.3、Native支付 2.1.4、APP支付 2.1.5、H5支付 2.1.6、小程序支付 2.1.7、人脸支付 2.2、名词解释 2.2.1、appid 2.2.2、openid 2.2.3、商户号以及密钥 三、同步 vs 异...
原来OkHttp的拦截器还能这样用
郭霖
06-10 577
/ 今日科技快讯 /围绕种族问题展开的抗议在全球多地发生，形成了一股舆论潮流。在此背景下，互联网巨头谷歌决定将在其浏览器中弃用一些可能引起种族歧视联想的表述。由于全球各地反对种族...
Android okHttp网络请求之Get/Post请求
jim1451的博客
09-04 3477
博客园新随笔管理 随笔-126  文章-0  评论-254  Android okHttp网络请求之Get/Post请求    前言：       之前项目中一直使用的Xutils开源框架，从xutils 2.1.5版本使用到最近的xutils 3.0，使用起来也是蛮方便的，只不过最近想着完善一下app中使用的开源框架，由于Xuti
Android中okhttp3使用详解
08-29
Android 中 OkHttp3 使用详解 OkHttp3 是一个流行的基于 HTTP/2 的网络请求库，由 Square 公司开发，广泛应用于 Android 和 Java 项目中。OkHttp3 提供了强大的网络请求功能，支持同步和异步请求，能够满足大多数的...
OkHttp的使用
07-14
OkHttp的使用涉及创建客户端实例、构建请求、发起请求等多个步骤。它支持各种HTTP操作，包括上传下载、GET和POST请求。通过合理的配置和使用，OkHttp可以帮助开发者构建高效、稳定的网络应用程序。在实际开发中，应...
OkHttp使用案例
12-07
本示例主要展示了如何在Android应用中使用OkHttp进行网络请求，通过一系列详细简单的测试代码，帮助开发者快速理解和应用。** 1. **OkHttp的安装与配置** - 首先，在`build.gradle`文件中添加OkHttp的依赖库。通常...
okHttp的使用
08-20
【OkHttp的使用】 OkHttp是Square公司推出的一款高效的HTTP客户端库，被广泛应用于Android开发中，用于处理网络请求。它的出现替代了Android原生的HttpURLConnection和HttpClient，提供了更强大的功能和更好的性能...
Android实战——okhttp3的使用和封装
05-22
本文将深入探讨OkHttp3的使用和封装，旨在帮助开发者更好地理解和掌握这一强大的网络请求工具。 首先，让我们了解OkHttp的基本概念。OkHttp是由Square公司开发的，它提供了一个高效的HTTP客户端接口，具有缓存、...
OkHttp中https处理
VipPetergee的博客
07-13 2106
一、Https处理 1、简介 OkHttp试图平衡两个互相竞争的问题 1）连接数 支持连接基于BoringSSL和OpenSSL尽可能多的host地址 2）安全性 支持证书验证和数据传输加密 在进行HTTPS服务器的连接时，OkHttp 需要知道要提供哪些TLS 版本和加密组件。 想要实现最大化连接的客户端，会使用过时的 TLS 版本和弱性能加密组件。 想要最大限度提高安全性的客户端将仅限于最新的 TLS 版本和性能最强的加密组件 BoringSSL BoringSSL 是谷歌创建的
OkHttp Events事件
VipPetergee的博客
07-07 1582
1、Events Events允许捕获应用程序的HTTP调用的指标，可以使用事件来监控以下参数： 应用发起的HTTP请求大小及频率 请求在底层网络上的性能 2、EventListener 在没有经过重定向和重试的网络请求数据流程图： EventListener使用示例代码 class OkEventListener : EventListener() { private val TAG = "tag" private var callStartTime: Long = 0
OkHttp4.9.0源码分析
VipPetergee的博客
08-09 813
通过前面的学习，我们已经对OKHttp有了简单的认识，并对使用有了详细的了解，下面我们将以一个同步Get请求为例进行OKHttp源码分析。 一、基础同步Get请求 private val mUrl = "https://www.baidu.com" // 1、createClient private val mClient = OkHttpClient() // createClientTwo private val mClient2 = OkHttpClient.Builder().buil.
okhttp封装使用
09-01
对于使用OkHttp进行封装，以下是一个基本的示例： 1. 首先，确保已经在项目中添加了OkHttp的依赖。在build.gradle文件中添加以下代码： ```groovy implementation 'com.squareup.okhttp3:okhttp:4.9.0' ``` 2. ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值