Android-OKGO简单使用(后续更新更多使用方法)

原创 2018年04月17日 14:51:30

支持的常用功能:


  • 一般的 get,post,put,delete,head,options请求
  • 基于Post的大文本数据上传,postString(),postJson()等
  • 多文件和多参数统一的表单上传(允许监听上传进度)
  • 支持一个key上传一个文件,也可以一个Key上传多个文件
  • 大文件下载和下载进度回调
  • 大文件上传和上传进度回调
  • 支持cookie的内存存储和持久化存储,支持传递自定义cookie
  • 提供网络缓存功能,默认支持304缓存协议,并额外扩展了三种本地缓存模式
  • 支持301、302重定向
  • 支持链式调用
  • 支持可信证书和自签名证书的https访问
  • 支持根据Tag取消网络请求
  • 支持自定义泛型Callback,自动根据泛型返回对象

1.添加依赖

compile 'com.lzy.net:okgo:2.1.4'

2.简单使用

  1. 进行全局配置,一般在 Aplication,或者基类的onCreate方法中,只需要调用一次即可,可以配置调试开关,全局的超时时间,公共的请求头和请求参数等信息。如果在Aplication中初始化,需要在清单文件中注册 Aplication。

    //---------这里给出的是示例代码,告诉你可以这么传,实际使用的时候,根据需要传,不需要就不传-------------//
       HttpHeaders headers = new HttpHeaders();
       headers.put("commonHeaderKey1", "commonHeaderValue1");    //header不支持中文
       headers.put("commonHeaderKey2", "commonHeaderValue2");
       HttpParams params = new HttpParams();
       params.put("commonParamsKey1", "commonParamsValue1");     //param支持中文,直接传,不要自己编码
       params.put("commonParamsKey2", "这里支持中文参数");
       //-----------------------------------------------------------------------------------//
    
    
       //必须调用初始化
       OkGo.init(this);
    
       //以下设置的所有参数是全局参数,同样的参数可以在请求的时候再设置一遍,那么对于该请求来讲,请求中的参数会覆盖全局参数
       //好处是全局参数统一,特定请求可以特别定制参数
       try {
           //以下都不是必须的,根据需要自行选择,一般来说只需要 debug,缓存相关,cookie相关的 就可以了
           OkGo.getInstance()
    
               // 打开该调试开关,打印级别INFO,并不是异常,是为了显眼,不需要就不要加入该行
               // 最后的true表示是否打印okgo的内部异常,一般打开方便调试错误
               .debug("OkGo", Level.INFO, true)
    
               //如果使用默认的 60秒,以下三行也不需要传
               .setConnectTimeout(OkGo.DEFAULT_MILLISECONDS)  //全局的连接超时时间
               .setReadTimeOut(OkGo.DEFAULT_MILLISECONDS)     //全局的读取超时时间
               .setWriteTimeOut(OkGo.DEFAULT_MILLISECONDS)    //全局的写入超时时间
    
               //可以全局统一设置缓存模式,默认是不使用缓存,可以不传,具体其他模式看 github 介绍 https://github.com/jeasonlzy/
               .setCacheMode(CacheMode.NO_CACHE)
    
               //可以全局统一设置缓存时间,默认永不过期,具体使用方法看 github 介绍
               .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)
    
               //可以全局统一设置超时重连次数,默认为三次,那么最差的情况会请求4次(一次原始请求,三次重连请求),不需要可以设置为0
               .setRetryCount(3)
    
               //如果不想让框架管理cookie(或者叫session的保持),以下不需要
       //      .setCookieStore(new MemoryCookieStore())            //cookie使用内存缓存(app退出后,cookie消失)
               .setCookieStore(new PersistentCookieStore())        //cookie持久化存储,如果cookie不过期,则一直有效
    
               //可以设置https的证书,以下几种方案根据需要自己设置
               .setCertificates()                                  //方法一:信任所有证书,不安全有风险
       //      .setCertificates(new SafeTrustManager())            //方法二:自定义信任规则,校验服务端证书
       //      .setCertificates(getAssets().open("srca.cer"))      //方法三:使用预埋证书,校验服务端证书(自签名证书)
       //              //方法四:使用bks证书和密码管理客户端证书(双向认证),使用预埋证书,校验服务端证书(自签名证书)
       //      .setCertificates(getAssets().open("xxx.bks"), "123456", getAssets().open("yyy.cer"))//
    
               //配置https的域名匹配规则,详细看demo的初始化介绍,不需要就不要加入,使用不当会导致https握手失败
       //      .setHostnameVerifier(new SafeHostnameVerifier())
    
               //可以添加全局拦截器,不需要就不要加入,错误写法直接导致任何回调不执行
       //      .addInterceptor(new Interceptor() {
       //            @Override
       //            public Response intercept(Chain chain) throws IOException {
       //                 return chain.proceed(chain.request());
       //            }
       //       })
    
               //这两行同上,不需要就不要加入
               .addCommonHeaders(headers)  //设置全局公共头
               .addCommonParams(params);   //设置全局公共参数
    
       } catch (Exception e) {
           e.printStackTrace();
       }    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
    • 30
    • 31
    • 32
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 42
    • 43
    • 44
    • 45
    • 46
    • 47
    • 48
    • 49
    • 50
    • 51
    • 52
    • 53
    • 54
    • 55
    • 56
    • 57
    • 58
    • 59
    • 60
    • 61
    • 62
    • 63
    • 64
    • 65
    • 66
  2. 使用get请求获取数据;

     /**
       * get请求获取数据
       * @param url
       */
      private void getByOkGo(String url){
          OkGo.get(url)                            // 请求方式和请求url
                  .tag(this)                       // 请求的 tag, 主要用于取消对应的请求
                  .cacheKey("cacheKey")            // 设置当前请求的缓存key,建议每个不同功能的请求设置一个
                  .cacheMode(CacheMode.DEFAULT)    // 缓存模式,详细请看缓存介绍
                  .execute(new StringCallback() {
                      @Override
                      public void onSuccess(String s, Call call, Response response) {
                          mTextView2.setText(s);
                      }
                  });
      }
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
  3. post请求获取数据,其中params方法用来添加请求参数,params添加参数的时候,最后一个isReplace为可选参数,默认为true,即代表相同key的时候,后添加的会覆盖先前添加的;

     /**
       * post请求
       * @param url
       */
      private void postByOkGo(String url){
          OkGo.post(url)
                  .tag(this)
                  .cacheKey("cachePostKey")
                  .cacheMode(CacheMode.DEFAULT)
                  .params("method", "album.item.get")
                  .params("appKey", "myKey")
                  .params("format", "json")
                  .params("albumId", "Lqfme5hSolM")
                  .params("pageNo", "1")
                  .params("pageSize", "2")
                  .execute(new StringCallback() {
                      @Override
                      public void onSuccess(String s, Call call, Response response) {
                          mTextView2.setText(s);
                      }
    
                      @Override
                      public void onError(Call call, Response response, Exception e) {
                          super.onError(call, response, e);
                          mTextView2.setText(e.getMessage());
                      }
                  });
      }
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
  4. 文件下载,FileCallback具有三个重载的构造方法,文件目录如果不指定,默认下载的目录为 sdcard/download/,文件名如果不指定,则按照以下规则命名:

    • 首先检查用户是否传入了文件名,如果传入,将以用户传入的文件名命名
    • 如果没有传入,那么将会检查服务端返回的响应头是否含有Content-Disposition=attachment;filename=FileName.txt该种形式的响应头,如果有,则按照该响应头中指定的文件名命名文件,如FileName.txt
    • 如果上述响应头不存在,则检查下载的文件url,例如:http://image.baidu.com/abc.jpg,那么将会自动以abc.jpg命名文件
    • 如果url也把文件名解析不出来,那么最终将以nofilename命名文件; 
      /**
       * 下载文件
       * @param url 下载地址
       * @param destFileDir 保存文件路径
       * @param destFileName 保存文件名
       */
      private void downLoad(String url, String destFileDir, String destFileName){
          OkGo.get(url)//
                  .tag(this)//
                  .execute(new FileCallback(destFileDir, destFileName) {  //文件下载时,可以指定下载的文件目录和文件名
                      @Override
                      public void onSuccess(File file, Call call, Response response) {
                          // file 即为文件数据,文件保存在指定目录
                      }
      
                      @Override
                      public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
                          //这里回调下载进度(该回调在主线程,可以直接更新ui)
                          //currentSize totalSize以字节byte为单位
                      }
                  });
      }
      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14
      • 15
      • 16
      • 17
      • 18
      • 19
      • 20
      • 21
      • 22
  5. 大文件上传;

    /**
    * 多文件上传
    * @param url
    * @param keyName
    * @param files 文件集合
    */
    private void uploadFiles(String url, String keyName, List<File> files){
      OkGo.post(url)//
              .tag(this)//
              //.isMultipart(true)       // 强制使用 multipart/form-data 表单上传(只是演示,不需要的话不要设置。默认就是false)
              //.params("param1", "paramValue1")        // 这里可以上传参数
              //.params("file1", new File("filepath1"))   // 可以添加文件上传
              //.params("file2", new File("filepath2"))     // 支持多文件同时添加上传
              .addFileParams(keyName, files)    // 这里支持一个key传多个文件
              .execute(new StringCallback() {
                  @Override
                  public void onSuccess(String s, Call call, Response response) {
                      //上传成功
                      Toast.makeText(getApplicationContext(), "上传成功", Toast.LENGTH_SHORT).show();
                  }
    
                  @Override
                  public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
                      //这里回调上传进度(该回调在主线程,可以直接更新ui)
                      mProgressBar.setProgress((int) (100 * progress));
                      mTextView2.setText("已上传" + currentSize/1024/1024 + "MB, 共" + totalSize/1024/1024 + "MB;");
                  }
              });
    }
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
    • 16
    • 17
    • 18
    • 19
    • 20
    • 21
    • 22
    • 23
    • 24
    • 25
    • 26
    • 27
    • 28
    • 29
  6. 请求加载图片;

    /**
     * 请求网络图片
     * @param url
     */
    private void getBitmap(String url) {
        OkGo.get(url)//
                .tag(this)//
                .execute(new BitmapCallback() {
                    @Override
                    public void onSuccess(Bitmap bitmap, Call call, Response response) {
                        // bitmap 即为返回的图片数据
                        mImageView.setImageBitmap(bitmap);
                    }
                });
    }
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
    • 11
    • 12
    • 13
    • 14
    • 15
  7. 取消请求。每个请求前都设置了一个参数tag,取消则通过OkGo.cancel(tag)执行。 例如:在Activity中,当Activity销毁取消请求,可以在onDestory里面统一取消;

    @Override
    protected void onDestroy() {
        super.onDestroy();
    
        //根据 Tag 取消请求
        OkGo.getInstance().cancelTag(this);
    
        //取消所有请求
        OkGo.getInstance().cancelAll();
    }
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8
    • 9
    • 10
  8. 其他细节还是多看官方文档,写的还是非常详细的。

Xbanner的简单使用

//1.添加Gradle依赖 dependencies { compile 'com.xhb:xbanner:1.2.2' compile 'com.nineoldandroid...
  • liu461211527
  • liu461211527
  • 2017-09-20 15:53:50
  • 273

RecyclerView 的简单使用方法

1.RecyclerView的使用方法(使用的Android Studio开发) 首先是recyclerview的配置问题,recyclerview是要导入android.support.v7....
  • sun18612393433
  • sun18612393433
  • 2016-11-13 19:01:55
  • 1644

slenium的java版以及对应的chorm的驱动

  • 2016年10月24日 11:40
  • 29.38MB
  • 下载

ViewPager简单使用步骤

前言:感觉和listView使用一样。 1.xml文件中布局 2.Actvity中实例化ViewPager 3.自定义Adapter,这里具体实现稍有不同,也有些暂时不懂的地方 4.Adapt...
  • zinjin_woxin
  • zinjin_woxin
  • 2015-09-02 16:41:32
  • 2444

Log4j的简单使用方法

Log4j说明: 1、Log4j简介   作用: 1、跟踪代码的运行轨迹。 2、输出调试信息 三大组成: 1、Logger类-生成日志。 2、Appender类-定义日志输出的目...
  • zuosixiaonengshou
  • zuosixiaonengshou
  • 2017-02-22 19:22:23
  • 393

EMLOG-鱼叔首款自适应瀑布流板子T2

  • 2013年03月11日 13:32
  • 79KB
  • 下载

持续集成工具是怎样炼成的?持续集成工具实战

敏捷大师Martin Fowler对持续集成的定义是:持续集成是一种软件开发实践,即团队开发成员经常集成它们的工作,通常每个成员每天至少集成一次,也就意味着每天可能会发生多次集成。每次集成都通过自动化...
  • ibmfahsion
  • ibmfahsion
  • 2012-09-01 22:16:16
  • 539

CSS @page 打印规则示例

  • 2018年01月05日 16:54
  • 989B
  • 下载

dede更新出现:读取频道信息失败,无法进行后续操作

今天小编在做dede二次开发的时候 ,使用一个现成的数据库 在更新的时候就出现了读取频道信息失败,无法进行后续操作! 提示字眼 下面小编整合下,一些常用的解决办法 和自己最终的解决办法 1、de...
  • needayeah_com
  • needayeah_com
  • 2015-01-18 09:51:27
  • 1891
收藏助手
不良信息举报
您举报文章:Android-OKGO简单使用(后续更新更多使用方法)
举报原因:
原因补充:

(最多只允许输入30个字)