OkHttp 用法解析

最新推荐文章于 2024-04-30 07:31:04 发布
最新推荐文章于 2024-04-30 07:31:04 发布
阅读量518 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shizhonghuo19870328/article/details/72867400
版权

一 简介

     学习完Volley框架， 开始学习OkHttp 网络框架。

     本文 是基于okhttp-3.2.0.jar 开发。

 首先下载jar 库，http://download.csdn.net/detail/shizhonghuo19870328/9861138

二  OkHttp 的重要参数和方法

     OkHttp 框架大部分是基于build 方式初始化。

      1.初始化 OkHttpClient

         OkHttpClient 最好用build 方式进行初始化。

   以下介绍OkHttpClient.build()提供的几个重要的方法：

   1）设置连接超时

public OkHttpClient.Builder connectTimeout(longtimeout, TimeUnit unit) 

   2）设置读取超时

public OkHttpClient.Builder readTimeout(long timeout, TimeUnit unit) 
     3）设置写入超时
public OkHttpClient.Builder writeTimeout(long timeout, TimeUnit unit)

   4）设置代理

public OkHttpClient.Builder proxy(Proxy proxy)

   5）设置缓存

public OkHttpClient.Builder cache(Cache cache)
     6） 设置DNS
public OkHttpClient.Builder dns(Dns dns)
     7) 建立OkHttpClient 
public OkHttpClient build()
     2. 初始化Request
     Request 同样用build 方式进行初始化。
     以下介绍Request.build() 的重要方法。
     1) 设置URL
public Request.Builder url(HttpUrl url);
public Request.Builder url(String url);
public Request.Builder url(URL url);
     2) 设置报头，会将原有的报头覆盖
public Request.Builder header(String name, String value);
     3）设置报头，在原有的报头之后添加
public Request.Builder addHeader(String name, String value);
     4) 设置缓存控制
public Request.Builder cacheControl(CacheControl cacheControl);
     CacheControl也可以从build() 初始化。 
     默认情况下， 首先会从缓存区查询命令结果， 如果有合适的结果，则返回缓存的结果， 如果在缓存区找不到结果，则进行网络查询。
     public static final CacheControl FORCE_NETWORK， 这种设置 不去查询缓存，直接进行网络查询。
     public static final CacheControl FORCE_CACHE; 这种设置值查询缓存。
     5) 设置连接请求的方法
public Request.Builder get() {
    return this.method("GET", (RequestBody)null);
}
 
public Request.Builder head() {
    return this.method("HEAD", (RequestBody)null);
}
public Request.Builder post(RequestBody body) {
    return this.method("POST", body);
}
public Request.Builder delete(RequestBody body) {
    return this.method("DELETE", body);
}
public Request.Builder put(RequestBody body) {
    return this.method("PUT", body);
}
public Request.Builder patch(RequestBody body) {
    return this.method("PATCH", body);
}
注意哪些方法需要设置RequestBody。
这里介绍一下FormBody, FormBody继承了RequestBody。 适用于哪些字符类RequestBody， 用build() 进行初始化。
    public static final class Builder {
        private final List<String> names = new ArrayList();
        private final List<String> values = new ArrayList();

        public Builder() {
        }

        public FormBody.Builder add(String name, String value) {
            this.names.add(HttpUrl.canonicalize(name, " \"\':;<=>@[]^`{}|/\\?#&!$(),~", false, false, true, true));
            this.values.add(HttpUrl.canonicalize(value, " \"\':;<=>@[]^`{}|/\\?#&!$(),~", false, false, true, true));
            return this;
        }

        public FormBody.Builder addEncoded(String name, String value) {
            this.names.add(HttpUrl.canonicalize(name, " \"\':;<=>@[]^`{}|/\\?#&!$(),~", true, false, true, true));
            this.values.add(HttpUrl.canonicalize(value, " \"\':;<=>@[]^`{}|/\\?#&!$(),~", true, false, true, true));
            return this;
        }

        public FormBody build() {
            return new FormBody(this.names, this.values);
        }
    }


    6) 建立request 
    public Request build() 
    3. 创建连接任务（call）并执行。
    OkHttp 框架需要将 request 和OkHttpClient建立一个RealCall, 由RealCall对连接请求进行调度和执行。
    我将一个call 理解为一个连接请求的任务。
    
    1) 创建连接任务
    Call call=mOkHttpClient.newCall(request);
    public Call newCall(Request request) {
        return new RealCall(this, request);
    }

    2） 执行任务，调用回调
     public void enqueue(Callback responseCallback)
     参数Callback 是执行结果的回调。
 

 

     Callback 是一个接口， 需要我们自己实现。
 

public interface Callback {
    void onFailure(Call var1, IOException var2);

    void onResponse(Call var1, Response var2) throws IOException;
}

onFailure（）方法是执行失败的回调


onResponse（）方法是执行成功的回调，Response  是返回的结果。

 

 

三 实例程序
 

 

public class MainActivity extends AppCompatActivity implements View.OnClickListener{
    private Button send,postsend,sendfile,downloadfile;
    private OkHttpClient mOkHttpClient;
    private URL url;

    /*public static final MediaType MEDIA_TYPE_MARKDOWN
            = MediaType.parse("text/x-markdown; charset=utf-8");*/

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        mOkHttpClient=initHttpClient();

        send=(Button)findViewById(R.id.send);
        postsend=(Button)findViewById(R.id.postsend);
        sendfile=(Button)findViewById(R.id.sendfile);
        downloadfile=(Button)findViewById(R.id.downloadfile);

        // 用activity 直接实现OnClickListener， 必须要有的设置
        send.setOnClickListener(this);
        postsend.setOnClickListener(this);
        sendfile.setOnClickListener(this);
        downloadfile.setOnClickListener(this);
        try {
            url = new URL("http://www.baidu.com");
        } catch(MalformedURLException e){
            e.printStackTrace();
        }
    }
    public void onClick(View v){

        switch(v.getId()){
            case R.id.send:
                send(url);
                break;
            case R.id.postsend:
                post();
                break;
            case  R.id.sendfile:
                //postAsynFile();
                break;
            case R.id.downloadfile:
                downAsynFile();
                break;
        }

    }

    private OkHttpClient initHttpClient(){
        File sdcache = getExternalCacheDir();
        int cacheSize = 10 * 1024 * 1024;
        OkHttpClient client =null;
        //推荐使用OkHttpClient.Builder() 去建立client.
        client=new OkHttpClient.Builder().connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(5,TimeUnit.SECONDS).writeTimeout(5,TimeUnit.SECONDS)
                .cache(new Cache(sdcache,cacheSize)).build();
        return client;
    }

    /*
    *执行get 命令
     */
    private void send(URL url){

        Request request=new Request.Builder().url(url).get()
                //.cacheControl(CacheControl.FORCE_NETWORK)   //缓存设置为每次都从网络重新获取
                .build();
        Call call=mOkHttpClient.newCall(request);
        call.enqueue(new Callback(){
            public void onFailure(Call var1, IOException var2){

            }

            public void onResponse(Call var1, Response var2) throws IOException{
                if (null != var2.cacheResponse()) {
                    String str = var2.cacheResponse().toString();
                    Log.i("wangshu", "cache---" + str);
                } else {
                    var2.body().string();
                    String str = var2.networkResponse().toString();
                    Log.i("wangshu", "network---" + str);
                }

            }
        });
    }
    /*
    * 执行post 命令
    */
    private void post(){
        //FormBody 继承了RequestBody
        FormBody foramBody=new FormBody.Builder().add("user","Li")
                .add("pass","123").build();
        Request request=new Request.Builder().url("http://www.baidu.com")
                .post(foramBody).build();
        Call call=mOkHttpClient.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                String str = response.body().string();
                Log.i("OKHttp", str);

                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        Toast.makeText(getApplicationContext(), "请求成功", Toast.LENGTH_SHORT).show();
                    }
                });
            }
        });
    }

    /*
    * 异步上传文件
    */
   /* private void postAsynFile(){
        File file=new File("/sdcard/download.txt");
        Request request=new Request.Builder()
                .url("https://api.github.com/markdown/raw")
                .post(RequestBody.create(MEDIA_TYPE_MARKDOWN,file))
                .build();
        mOkHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                Log.i("wangshu", response.body().string());
            }
        });
    }*/

   /*
   * 异步下载文件
   */
    private void downAsynFile(){
        String url="https://img-my.csdn.net/uploads/201603/26/1458988468_5804.jpg";
        Request request=new Request.Builder().url(url).build();
        Call call=mOkHttpClient.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                InputStream inputStream=response.body().byteStream();
                FileOutputStream fileOutputStream = null;

                try {
                    fileOutputStream=new FileOutputStream(new File("/sdcard/liyang.jpg"));
                    byte[ ] buffer=new byte[2018];
                    int len;
                    while((len= inputStream.read(buffer))!= -1){
                        fileOutputStream.write(buffer,0,len);
                    }
                    fileOutputStream.flush();
                }catch (IOException e){
                    e.printStackTrace();
                }
            }
        });
    }
}


 

 


                

        

        

    




    

      

        

            

              
                
                  shizhonghuo19870328
                
              
            

            

                关注
              
            

        

        

          
    
            
  • 
              
                
                
                
                
                      0
                
              
              
    点赞
    
            
    • 
            
  • 
              
                
                
                
              
              
    踩
    
            
    • 
            
  • 
              
                
                
                
                
                    0
                
              
              
    
                
    
                  
                    收藏
                  
                
    
              
    
              
    
                
    
                  觉得还不错?
                  
                    一键收藏
                  
                 
                
    
              
    
            
    • 
          
  • 
            
    
              
              
            
    
              
              
              
                    0
              
            
            
    评论
    
          
    • 
          
  • 
          
    • 
          
  • 
            
              
            
              
    
            
              
                
            
    
          
    • 
        

      

      










                



	

		

			

				
					
OkHttpClient发起请求异步和非异步使用详解

				
			

			

				

					lg_1996的博客
				

				

					03-10
					
					1485
					
				

			

		

		

			
				
在开发过程中我们难免会遇到多个项目或者调用其他厂商的接口进行交互数据，这时候个别项目我们需要通过http就可以解决此问题，下面我将介绍一种发起request的一种客户端模式，异步和非异步实例讲解：

非异步(同步)：


OkHttpClient.newCall(request).execute();//注意这种方式会阻塞调用线程，所以在Android中应放在子线程中执行，否则有可能引起ANR异常。web项目根据情况而定是否需要建子线程

代码实例：


1. //向CCS发送请求--直接使用
      

			
		

	



                

              
                



	

		

			

				
					
【OkHttp】OkHttp返回可能为空的问题分析

				
			

			

				

					cloverat的博客
				

				

					05-07
					
					4337
					
				

			

		

		

			
				
现象
最近使用OkHttp替换原Http请求方案，但是发现原先可用的第三方接口请求的出现相同的请求结构，请求内容不同的时候，返回可能为空的情况。
第三方接口分析
在第三方平台上测试接口，发现系统中有异常的接口，在平台上是正常的，进而对平台上的接口响应进行分析，比较后发现Response Headers中存在如下差异：
系统中获取到结果的Response Headers：
Content-Lengt...

			
		

	



                


  
              

                


	

		

			

				
					
android OKHttp 调用有返回值的方法，返回值为null

				
			

			

				

					wyz670083956的博客
				

				

					08-14
					
					6560
					
				

			

		

		

			
				
我调用一个有返回值的方法，可是返回的值为 null ；
我控制台输出了 一下，发现代码运行顺序 如下，(111111,2222,3333,44444)  还没取到值就已经 走 return 了(还没走4444，333就已经走了，所以还没取到值，就就已经return了)； 

初步猜测可能是异步请求的原因

			
		

	





	

		

			

				
					
OkHttp3源码详解(一) Request类

					
最新发布

				
			

			

				

					pCITv1C的博客
				

				

					04-30
					
					781
					
				

			

		

		

			
				
在这里，由于面试中MySQL问的比较多，因此也就在此以MySQL为例为大家总结分享。但是你要学习的往往不止这一点，还有一些主流框架的使用，Spring源码的学习，Mybatis源码的学习等等都是需要掌握的，我也把这些知识点都整理起来了③方式三：MultipartBody分块表单创建， 既可以添加表单,又可以也可以添加文件等二进制数据，我们就看几个重要的方法name=”);在这里，由于面试中MySQL问的比较多，因此也就在此以MySQL为例为大家总结分享。

			
		

	



		

			
		



	

		

			

				
					
Java封装OkHttp3工具类

				
			

			

				

					weixin_44421461的博客
				

				

					07-06
					
					603
					
				

			

		

		

			
				
点击上方“Java基基”，选择“设为星标”做积极的人，而不是积极废人！源码精品专栏原创 | Java 2020超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网...

			
		

	





	

		

			

				
					
OkHttp源码解析

				
			

			

				

					qq_24477797的博客
				

				

					11-02
					
					1450
					
				

			

		

		

			
				
先看OkHttp内部相关类图





通常请求:




OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .connectTimeout(60, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)
        .writeTimeout(30, ...

			
		

	





	

		

			

				
					
详解Android OkHttp完全解析

				
			

			

				

					09-01
				

			

		

		

			
				
本文将全面解析OkHttp的使用，包括基本的GET和POST请求，文件上传与下载，图片加载，以及请求回调等功能。  ### 一、OkHttp简介  OkHttp的优势在于它的连接池、缓存机制以及异步请求处理。连接池减少了建立和维护TCP...

			
		

	





	

		

			

				
					
Android中okhttp3使用详解

				
			

			

				

					08-29
				

			

		

		

			
				
Android 中 OkHttp3 使用详解  OkHttp3 是一个流行的基于 HTTP/2 的网络请求库，由 Square 公司开发，广泛应用于 Android 和 Java 项目中。OkHttp3 提供了强大的网络请求功能，支持同步和异步请求，能够满足大多数的...

			
		

	





	

		

			

				
					
OkHttp3使用详解

				
			

			

				

					03-27
				

			

		

		

			
				
下面将详细介绍 OkHttp3 的使用方法。  OkHttp3 的基本使用  OkHttp3 的基本使用主要包括以下几个步骤：  1. 导入 OkHttp3 相关包，包括 okhttp-2.7.5 和 okio-1.13.02。 2. 创建 OkHttpClient 实例，用于发起网络...

			
		

	





	

		

			

				
					
Android OkHttp基本使用详解

				
			

			

				

					08-27
				

			

		

		

			
				
"Android OkHttp基本使用详解"   OkHttp是一个相对成熟的解决方案，需要的朋友可以参考下。Android系统提供了两种HTTP通信类，HttpURLConnection和HttpClient。尽管Google在大部分安卓版本中推荐使用...

			
		

	





	

		

			

				
					
java  中OkHttp的使用方法及实例

				
			

			

				

					08-30
				

			

		

		

			
				
本文将详细介绍如何在Java项目中使用OkHttp，以及两种主要的请求方式。  首先，使用OkHttp前需要添加相应的依赖。通常，你可以通过Maven或Gradle来引入OkHttp及其依赖。在Maven的pom.xml文件中，你需要添加以下依赖...

			
		

	





	

		

			

				
					
okhttp的简单使用（一）

				
			

			

				

					qq_32749209的博客
				

				

					12-18
					
					436
					
				

			

		

		

			
				
okhttp的get访问方式的使用步骤： 
（1）获取一个全局的okhttpclient对象： 
//创建okHttpClient对象 
OkHttpClient mOkHttpClient = new OkHttpClient(); 
注意： 这里最好使用单例模式，为的是控制全局唯一的一个单例，将来你可以控制网络请求的暂停，继续等操作 
（2）获取Request对像，reques对象是okhttp

			
		

	





	

		

			

				
					
OkHttpClient用例

				
			

			

				

					Vazzz的博客
				

				

					11-15
					
					8177
					
				

			

		

		

			
				

								
					版权声明：本文为博主原创文章，未经博主允许不得转载。					https://blog.csdn.net/mazaiting/article/details/78129542				
								            
						
                
          Java OkHttp使用
本文使用eclipse编辑器，gradle依赖j...

			
		

	





	

		

			

				
					
使用OKHttp代替原生http请求调用微信支付及Okhttp常用方法

				
			

			

				

					qq_30729829的博客
				

				

					07-18
					
					1561
					
				

			

		

		

			
				
前言：每次看到原生的http请求，不只是看起来难受，使用起来也难受，因为刚毕业时开发了半年的android，okhttp+rxjava使用也是得心应手(后端比安卓舒服的一点是，直接请求即可，不用考虑网络请求会阻塞UI线程这种东西)，完全转后端后，偶尔也还是会用到http请求的，但是原生的确实难用，所以每次都是使用okhttp解决的，最近接触了一下微信支付，示例给的demo还是原生的，也是看的难受，...

			
		

	





	

		

			

				
					
使用OkHttp拦截器,添加统一参数

				
			

			

				

					wenyingzhi的博客
				

				

					05-30
					
					9927
					
				

			

		

		

			
				
场景大家的应用处于安全考虑,又没有加密呢?又没用一个一个加密参数做验证呢?如果没有那你们就太low了(当然对于懂逆向的这些都没啥用处),如果有你是如何做的呢?为何做验证处于安全考虑,http请求都是可以通过抓包工具抓取下来的(Fiddler),抓取下来,我就可以通过模拟请求发送你们的请求,做一款外挂,大伙也可以试试,抓别人的包,然后请求即可...,一般来说如何做呢?就是对一个参数经过一系列算法,然...

			
		

	





	

		

			

				
					
OkHttp的使用

				
			

			

				

					showdy的博客
				

				

					01-15
					
					2060
					
				

			

		

		

			
				
OkHttp的介绍:
Android为我们提供了两种HTTP交互的方式：HttpURLConnection 和 Apache HTTP Client，虽然两者都支持HTTPS，流的上传和下载，配置超时，IPv6和连接池，已足够满足我们各种HTTP请求的需求。但更高效的使用HTTP 可以让您的应用运行更快、更节省流量。而OkHttp库就是为此而生
OkHttp是个高效的HTTP库:支持SPDY,共享一

			
		

	





	

		

			

				
					
OKhttp3 简单使用，文件 表单post请求

				
			

			

				

					qq_26388117的博客
				

				

					06-12
					
					4785
					
				

			

		

		

			
				
Okhttp框架简单使用（这里只举例enqueue  post请求），本篇是基本的使用和认识都是非常简单的代码注释写的很清楚就不多废话了直接看代码片段吧！GET请求public void getRequest(){    try {        //构建request        Request request = new Request.Builder().url(url).get().bu...

			
		

	





	

		

			

				
					
（OkHttp3.x，FormEncodingBuilder已被FormBody取代）

				
			

			

				

					jwllls的博客
				

				

					09-06
					
					4577
					
				

			

		

		

			
				
（OkHttp3.x，FormEncodingBuilder已被FormBody取代）

			
		

	





	

		

			

				
					
【Java】okHttp3 简单使用

				
			

			

				

					u010900754的专栏
				

				

					08-01
					
					2473
					
				

			

		

		

			
				
之前用的RestTemplate，发现一个multipart的http请求始终发不成功，后面就试了下okHttp，发现真的好用，api太清爽了，记录一下使用：


package com.liyao;

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;

import org.jetbrains.annotations.NotNull;
import org.junit.Test;


			
		

	





	

		

			

				
					
okhttp排至详解

				
			

			

				

					08-03
				

			

		

		

			
				
在OkHttp中，execute方法表示同步请求，即在当前线程中执行网络请求，而enqueue方法表示异步请求，即使用OkHttp内置的线程池来执行网络请求。这涉及到OkHttp的任务分发器，它负责将请求任务分发给线程池中的线程来...

			
		

	



              



  
“相关推荐”对你有帮助么？

  

      
    
          
  • 
              
    
                  
                  
              
    
              
    非常没帮助
    
          
    • 
          
  • 
              
    
                  
                  
              
    
              
    没帮助
    
          
    • 
          
  • 
              
    
                  
                  
              
    
              
    一般
    
          
    • 
          
  • 
              
    
                  
                  
              
    
              
    有帮助
    
          
    • 
          
  • 
              
    
                  
                  
              
    
              
    非常有帮助
    
          
    • 
      

      

      

          
          提交
      

      

  




          




        



    





    



      

      

        
      

      





	

		评论	
	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

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

              

            

          

      

      余额充值