okHttp简单封装使用

最新推荐文章于 2024-06-25 01:20:52 发布
最新推荐文章于 2024-06-25 01:20:52 发布
阅读量2.6k 收藏 2
点赞数
文章标签： 微信 加密 okHttp 二次封装
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u013620054/article/details/51377109
版权

最近一个项目在使用okhttp 这里记录一下使用过程，关于okhttp的使用网上已经有很多讲解，下面说一下本人在项目中使用过程中对其进行的简单封装

直接进入主题

使用okhttp首先要在gradle.build里面加入  

compile 'com.squareup.okhttp:okhttp:2.6.0'


我定义了一个接口api规范一下我的请求函数

import android.content.Context;


/**
 * Created by lkk on 2016/5/10.
 */
public interface Api {
   
<span style="white-space:pre">	</span>// API域名
    public static final String API_BASE_DOCTOR = "";// 
    /**
     * 登陆
     *
     * @param context
     * @param vCode   验证码
     * @param phone   手机号
     */
    void login(Context context, String vCode, String phone, ResultCallback callback);


    /**
     * 发送验证码
     *
     * @param context
     * @param phone   手机号
     */
    void sendCode(Context context, String phone, ResultCallback callback);

}
这里简单定义了两个请求，  Context参数是因为后面提取header信息要用到， ResultCallback用来回调通知请求结果看代码 

import com.google.gson.internal.$Gson$Types;
import com.squareup.okhttp.Request;

import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;

/**
 * Created by Administrator on 2015/12/5 0005.
 * <p/>
 * 回调函数
 * 请求事件结果通知
 */
public abstract class ResultCallback<T> {

    public Type mType;

    public ResultCallback() {

        mType = getSuperclassTypeParameter(getClass());
    }

    Type getSuperclassTypeParameter(Class<?> subclass) {

        Type superclass = subclass.getGenericSuperclass();
        if (superclass instanceof Class) {
            throw new RuntimeException("Missing type parameter.");
        }
        ParameterizedType parameterized = (ParameterizedType) superclass;
        return $Gson$Types.canonicalize(parameterized.getActualTypeArguments()[0]);
    }

    /**
     * 网路请求失败
     *
     * @param request
     * @param e
     */
    public void onFailure(Request request, Exception e) {
    }

    /**
     * 网路请求错误
     *
     * @param code
     * @param message
     */
    public void onError(int code, String message) {
    }

    /**
     * 请求服务器成功
     *
     * @param response
     */
    public void onResponse(T response) {
    }

    /**
     * 请求完成
     */
    public void onFinish() {
    }

    /**
     * 请求开始
     */
    public void onStart() {
    }

}
mType是拿到数据gson解析成的对象类型，有了它string变对象模型就easy了，这里我定义了 onStart和onFinish回调函数是因为我要在这里处理progressDialog

 下面是我定义的一个抽象类来收集请求参数数据

import android.content.Context;

import com.squareup.okhttp.Request;

import java.util.TreeMap;


/**
 * Created by lkk on 2016/5/10.
 *  代理操作  收集请求数据
 *  调用实现
 */
public abstract class AbsGateway implements Api {

    /** 登录 */
    String API_LOGIN = "";
    /**发送验证码*/
    private static final String API_SEND_CODE = "";

    private static AbsGateway mInstance;

    public static AbsGateway getInstance() {
        synchronized (AbsGateway.class){
            if (mInstance == null) {
                mInstance = new GatewayImp();
            }
        }
        return mInstance;
    }


    @Override
    public void login(Context context, String vCode, String phone, ResultCallback callback) {
        TreeMap<String, String> mParam = new TreeMap<String, String>();
        mParam.put("verify_code", vCode);
        mParam.put("phone", phone);
        deliveryResult(context, callback, getOrderParamString(context, API_LOGIN, mParam));
    }

    @Override
    public void sendCode(Context context, String phone, ResultCallback callback) {
        TreeMap<String, String> mParam = new TreeMap<String, String>();
        mParam.put("phone", phone);
        deliveryResult(context, callback, getOrderParamString(context, API_SEND_CODE, mParam));
    }

    /**
     * 发出请求 以及处理返回结果执行回调
     * @param cxt
     * @param callback
     * @param request
     */
    abstract void deliveryResult(Context cxt, ResultCallback callback, Request request);

    /**
     * 参数 排序加密处理
     * @param context
     * @param url 接口地址（不包含域名）
     * @param mParam 参数集合
     * @return 返回Request对象
     */
    abstract Request getOrderParamString(Context context, String url, TreeMap mParam);
}
这里定义了我的接口地址和接口请求回调上面两个抽象函数注释已经很明确了就不介绍了， 由于加密前需要对参数进行字母表顺序排序所以我用了TreeMap进行存储

再来看下面的实现类

import android.content.Context;
import android.os.Build;
import android.os.Handler;
import android.os.Looper;
import android.text.TextUtils;
import android.widget.Toast;

import com.google.gson.Gson;
import com.squareup.okhttp.Callback;
import com.squareup.okhttp.FormEncodingBuilder;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response;

import java.io.IOException;
import java.net.CookieManager;
import java.net.CookiePolicy;
import java.util.Iterator;
import java.util.TreeMap;



/**
 * Created by lkk on 2016/5/10.
 *
 * 实现发起网络请求事件
 * 实现请求数据排序加密操作
 * 处理网络请求返回的数据
 * 执行回调事件
 */
public class GatewayImp extends AbsGateway{

   

    protected OkHttpClient client = new OkHttpClient();

    public Handler mHandle;
    public Gson mGson;

    public GatewayImp() {
        client = new OkHttpClient();
        //cookie enabled
        client.setCookieHandler(new CookieManager(null, CookiePolicy.ACCEPT_ORIGINAL_SERVER));
        mHandle = new Handler(Looper.getMainLooper());
        mGson = new Gson();
    }

    @Override
    void deliveryResult(final Context cxt, final ResultCallback callback, Request request) {
        if (!SystemInfo.isNetworkConnected(cxt)) {
            Toast.makeText(cxt,
                    cxt.getString(R.string.toast_not_network), Toast.LENGTH_SHORT).show();
            return;
        }
        if (callback != null) {
            callback.onStart();
        }
        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(final Request request, final IOException e) {
                
                onFailuerMessage(callback, request, e);
            }

            @Override
            public void onResponse(final Response response) {
                try {
                   
                    if (response.code() != 200) {
                        onErrorMessage(callback, response.code(), response.message());
                        return;
                    }
                    String str = response.body().string().toString();
                   
                    if (!TextUtils.isEmpty(str.trim())) {
                        Result mResult = mGson.fromJson(str, callback.mType);
                        parse(cxt, callback, mResult);
                    }
                } catch (Exception e) {
                    LogInfo.e("parse exception is: " + e.toString());
                }
            }
        });
    }

    @Override
    Request getOrderParamString(Context context, String url, TreeMap mParam) {
        FormEncodingBuilder builder = new FormEncodingBuilder();
        String timestamp = String.valueOf(System.currentTimeMillis());
        String uuid = SystemInfo.getIMEI(context);//获取IMEI
        String version = PackageUtils.getAppVersion(context);//这里获取版本号
        String app_key = "加密协议字符串";
        Iterator<String> iter = mParam.keySet().iterator();
        String key;
        while (iter.hasNext()) {
            key = iter.next();
            builder.add(key, String.valueOf(mParam.get(key)));
        }
        String paramsStr = URLEncodedUtils.format(mParam, HTTP.UTF_8);
        String signature = Tools.getMD5(Config.PLATFORM + app_key + uuid + version + paramsStr + timestamp);
        
        return buildRequest(context, builder, API_BASE_DOCTOR + url, version, uuid, signature, timestamp);
    }


    /**
     * <br>post异步请求<br>
     * 获取请求头信息
     *
     * @param url
     * @return
     */
    private Request buildRequest(Context cxt, FormEncodingBuilder builder, String url, String version, String uuid, String signature, String timestamp) {
        Request request = new Request.Builder()
                .url(url)
                .header("User-Agent", "OkHttp Headers.java")
                .addHeader("Accept", "application/json; q=0.5")
                .addHeader("Accept", "application/vnd.github.v3+json")
                .addHeader("X-VERSION", version)
                .addHeader("X-VerName", version)
                .addHeader("X-VerCode", version)
                .addHeader("X-Platform", Config.PLATFORM)
                .addHeader("X-Device", Build.DEVICE)
                .addHeader("X-Uuid", uuid)
                .addHeader("X-BuildVersion", Build.VERSION.RELEASE)
                .addHeader("timestamp", timestamp)
                .addHeader("signature", signature)
                .post(builder.build())
                .build();
        return request;
    }

    /**
     * 服务器没有响应
     *
     * @param callback
     * @param request
     * @param e
     */
    private void onFailuerMessage(final ResultCallback callback, final Request request, final IOException e) {
        mHandle.post(new Runnable() {
            @Override
            public void run() {
                callback.onFailure(request, e);
                callback.onFinish();
            }
        });
    }


    /**
     * 服务器没有响应
     *
     * @param callback
     * @param code
     * @param message
     */
    private void onErrorMessage(final ResultCallback callback, final int code, final String message) {
        mHandle.post(new Runnable() {
            @Override
            public void run() {
                callback.onError(code, message);
                callback.onFinish();
            }
        });
    }

    /**
     * 解析数据
     * 转成主线程回调
     *
     * @param callback
     * @param mResult
     */
    private void parse(final Context cxt, final ResultCallback callback, final Result mResult) {
        mHandle.post(new Runnable() {
            @Override
            public void run() {
               
                if (mResult.getCode() == 1) {
                    callback.onResponse(mResult);
                   
                } else {
                    callback.onResponse(mResult.getCode(), mResult.getMsg());
                   
                }<pre name="code" class="java"><span style="white-space:pre">		</span>callback.onFinish();
} }); } 

 该类完成了父类定义的两个抽象类的实现 ， 后面再添加接口这里就不用改动的 

 

deliveryResult  执行我的okhttp请求 并对请求回来的数据进行解析，  callback.mType 就是前面提到的数据对象类型
 

getOrederParamString 完成参数加密逻辑
 

buildRequest  添加头信息参数
 

parse     请求成功拿到数据 进行回调， 由于okHttp已经处理好了异步请求，包含回调也是异步这里我用了一个handle当作主线程回调
 

该实现类完成之后后面增加请求接口只需在api里面定义，  在抽象类里调用就ok了， 
 

 

请求时这样调用：
 

 

  private void reqLogin(){

        AbsGateway.getInstance().login(this, "", "", callback);
    }
    
    ResultCallback callback = new ResultCallback<User>(){

        @Override
        public void onStart() {
            //显示 progressDialog
        }

        @Override
        public void onResponse(User response) {
<span style="white-space:pre">		</span>//请求到数据
        }

        @Override
        public void onFinish() {
            // 关闭 progressDialog
        }
    };
 

 注： 这里只是实现了okHttp的post请求， 还有get请求和HTTP方式文件上传 ， 好像android4.4源码里 
HttpURLConnection已经被okHttp替代了更说明了它的潜力 

 


 

                

        

        

    

  


    

      

        

            

              
                
                  liangkunkun
                
              
            

            

                关注
              
            

        

        

          
      

      









                



	

		

			

				
					
OkHttp的简单封装

				
			

			

				

					chen1459的博客
				

				

					07-08
					
					352
					
				

			

		

		

			
				
代码复用强，少写多余的代码+节省系统的资源(只有一个Client对象)
单例的gongju类:构造私有化+自行实例化+提供公开的方法

导依赖：

implementation 'com.squareup.okhttp3:okhttp:3.12.1'



package com.example.day3_okhttp;

import android.util.Log;

import jav...

			
		

	



                

              
                



	

		

			

				
					
Android实战——okhttp3的使用和封装

				
			

			

				

					05-22
				

			

		

		

			
				
本文将深入探讨OkHttp3的使用和封装，旨在帮助开发者更好地理解和掌握这一强大的网络请求工具。  首先，让我们了解OkHttp的基本概念。OkHttp是由Square公司开发的，它提供了一个高效的HTTP客户端接口，具有缓存、...

			
		

	



                


  
              

                


	

		

			

				
					
Okhttp实用封装

				
			

			

				

					findhappy117的博客
				

				

					02-23
					
					231
					
				

			

		

		

			
				
对okhttp的get，put,delete，post请求简单封装，减少了不必要的冗余代码

			
		

	





	

		

			

				
					
OkHttpUtils - 封装了okhttp的网络框架

					
最新发布

				
			

			

				

					2401_85730312的博客
				

				

					06-25
					
					498
					
				

			

		

		

			
				
小编这些年深知大多数初中级Android工程师，想要提升自己，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频，并且后续会持续更新一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人。

			
		

	



		

			
		



	

		

			

				
					
Okhttp的简单封装与使用

				
			

			

				

					时代新人的博客
				

				

					11-26
					
					593
					
				

			

		

		

			
				
Okhttp是一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso)，用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里已移除HttpClient,现在已经打不出来)。

下面就对Okhttp的单独使用做一个简单的封装（在App版本更新的例子里抽取出来的，里面的一些名字...

			
		

	





	

		

			

				
					
[Android]OkHttp的简单封装－辅助框架

					
热门推荐

				
			

			

				

					QiuJuer
				

				

					01-13
					
					1万+
					
				

			

		

		

			
				
序言

OkHttp 的强大算是毋庸置疑了；OkHttp 基本在网络层能完成任何事情，适用任何情况；正因为如此 OkHttp 每次构建一个请求的时候不得不写大量的代码来完成相应的配置。在这里分享一个极限封装OkHttp的辅助框架，通过该框架能最大程度简化你的开发负担。

			
		

	





	

		

			

				
					
简单的封装okhttp

				
			

			

				

					wyjlovecr7的博客
				

				

					04-28
					
					236
					
				

			

		

		

			
				
对于网络访问就简单的用okhttp封装了一些需要的方法，比较简单。

			
		

	





	

		

			

				
					
okhttp简单封装

				
			

			

				

					jackzhouyu的专栏
				

				

					04-10
					
					341
					
				

			

		

		

			
				
okhttp使用简单封装库简介okhttp执行网络请求时是自动开子线程进行的，但是处理网络数据回调回来时，也在子线程中，而我们日常开发主要是在主线程中更新UI，这样是极不方便的，为了解决这个问题和简化okhttp的使用难度，本库对okhttp做了一个简单的封装版本说明：okhttp版本信息：3.6.0使用说明本库分为三个类： 
        1. OkHttpManager – 网络底层类，执行网

			
		

	





	

		

			

				
					
Android OkHttp的简单使用和封装详解

				
			

			

				

					01-03
				

			

		

		

			
				
昨天把okHttp仔细的看了一下，以前都是调用同事封装好了的网络框架，直接使用很容易，但自己封装却不是那么简单，还好，今天就来自我救赎一把，就和大家写写从最基础的OKHttp的简单get、post的使用，再到它的封装。...

			
		

	





	

		

			

				
					
okhttp简单封装源码

				
			

			

				

					01-28
				

			

		

		

			
				
一个okhttp简单的封装的工具类，使用此方法，可以不必每次请求都去写大量的代码了，减少了代码的冗余和，结构严谨

			
		

	





	

		

			

				
					
okhttp3简单封装使用

				
			

			

				

					05-15
				

			

		

		

			
				
以上就是关于OkHttp3简单封装使用的详细介绍，通过这个基础，你可以根据项目的具体需求进行更深入的定制和优化，让网络请求更符合你的项目逻辑。在实际应用中，理解并熟练掌握OkHttp的使用，能大大提高开发效率和...

			
		

	





	

		

			

				
					
OKHttp网络请求封装

				
			

			

				

					10-25
				

			

		

		

			
				
在开发过程中有时候一个项目可能会用两三个网络请求框架，使用自己的规范来封装三方库。我这是封装OKHttp实现该接口，当然你也可以使用别的三方库来实现在接口。

			
		

	





	

		

			

				
					
okhttp的简单封装

				
			

			

				

					Steven_Zheng_0107的博客
				

				

					10-10
					
					444
					
				

			

		

		

			
				
最近在做项目时，网络请求同事想用okhttp，让我封装一下okhttp，我之前没有封装过这些东西，就在网上找了一些资料，于是做了一下基础的封装，暂时够自己使用，写的不好的地方希望大家指出： 
public class OkHttpUtil { 
    private static OkHttpClient okHttpClient; 
    private static Handler hand

			
		

	





	

		

			

				
					
okhttp 封装

				
			

			

				

					无问西东的博客
				

				

					08-29
					
					2734
					
				

			

		

		

			
				
okhttp get/post基本用法

okhttp upload/download 上传和下载

对应的项目下载地址：NetFramework

全部单例模式创建方式：单例模式例子中用到了静态内部类创建单例，对此不了解的可以参考这篇

前两篇文章实践了使用okhttp3.0进行简单的网络交互、获取网络资源等操作，但是可以预料代码会有冗余的情况，我们可以写的更加优雅一点，例子中只是个别的网络请...

			
		

	





	

		

			

				
					
okhttp封装

				
			

			

				

					AI_LWT的博客
				

				

					10-13
					
					160
					
				

			

		

		

			
				
#okhttpcontenuitls
…
/**


原则：代码复用性+只有一个Client对象




*/
public class OkhttpUtils {
private OkHttpClient okHttpClient;//在构造方法里面创建
//单例模式：构造私有化
private OkhttpUtils(){//只会创建一次
//log拦截器
HttpLoggingInterceptor httpLoggingInterceptor=new HttpLoggingInterceptor()

			
		

	





	

		

			

				
					
okHttp的简单封装

				
			

			

				

					yufeng95的博客
				

				

					04-14
					
					463
					
				

			

		

		

			
				
工具类：


 
import android.os.Handler;
import android.os.Looper;
import java.io.IOException;
import java.util.Map;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.FormBody;
import okhttp3.O...

			
		

	





	

		

			

				
					
OKHttp的封装

				
			

			

				

					weixin_43860442的博客
				

				

					12-31
					
					124
					
				

			

		

		

			
				
1.导依赖
 implementation 'com.squareup.okhttp3:okhttp:3.12.1'

2.在MVP的model层写代码
public class LoginModel implements ILoginContract.ILoginModel {

@Override
//M层接受数据的方法
public void containLoginResponData(S...

			
		

	





	

		

			

				
					
android中okhttp3封装使用

				
			

			

				

					05-11
				

			

		

		

			
				
下面是一个简单的封装使用示例：  1. 在app/build.gradle文件中添加OkHttp3依赖：   ```  implementation 'com.squareup.okhttp3:okhttp:4.9.0'  ```  2. 创建一个OkHttpUtil类，封装OkHttp3网络请求：   ```  ...

			
		

	



              




          




        



    





    



      

      

        
      

      





	

		
评论 3

	

	
	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

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

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

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

              

            

          

      

      余额充值