devbox
opred
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Android项目中okhttp3的简易封装和使用_android okhttp3

作者：opred | 2024-01-29 23:46:38

赞

踩

android okhttp3

1、所有文件：

2、OkHttpUtil类

这个类主要用于初始化okhttp和发送http请求。

  1. public class OkHttpUtil{
  2.     private static OkHttpClient mOkHttpClient = null;
  3.  
  4.     //Call this method in the Application class. ---> onCreate() method.
  5.     //Thus we can get only one instance of httpClient in the whole app.
  6.     public static void init(){
  7.         if (mOkHttpClient == null) {
  8.             OkHttpClient.Builder builder = new OkHttpClient().newBuilder()
  9.                     .connectTimeout(5000, TimeUnit.MILLISECONDS)
  10.                     .readTimeout(5000, TimeUnit.MILLISECONDS)
  11.                     .writeTimeout(5000, TimeUnit.MILLISECONDS)
  12.                     .sslSocketFactory(RxUtils.createSSLSocketFactory(),new RxUtils.TrustAllManager())
  13.                     .hostnameVerifier(new RxUtils.TrustAllHostnameVerifier());
  14.             mOkHttpClient = builder.build();
  15.         }
  16.     }
  17.  
  18.  
  19.     //If GET method needs some other params, just need to add a HaspMap. Refer to:https://www.imooc.com/video/18685
  20.     public static void get(String url, OkHttpCallBack okHttpCallback){
  21.         Call call = null;
  22.  
  23.         try{
  24.             Request request = new Request.Builder().url(url).build();
  25.             call = mOkHttpClient.newCall(request);
  26.             call.enqueue(okHttpCallback);
  27.  
  28.         }catch(Exception ex){
  29.             ex.printStackTrace();
  30.         }
  31.     }
  32.  
  33.     public static void post(String url, OkHttpCallBack okHttpCallback, HashMap<String, String> bodyMap){
  34.         Call call = null;
  35.         try{
  36.             FormBody.Builder builder = new FormBody.Builder();
  37.             for (HashMap.Entry<String, String> entry : bodyMap.entrySet()) {
  38.                 builder.add(entry.getKey(), entry.getValue());
  39.             }
  40.             RequestBody body = builder.build();
  41.             Request.Builder builderRequest = new Request.Builder();
  42. //            builderRequest.headers(new Headers())
  43.             Request request = builderRequest.post(body).url(url).build();
  44.             call = mOkHttpClient.newCall(request);
  45.             call.enqueue(okHttpCallback);
  46.  
  47.         }catch(Exception ex){
  48.             ex.printStackTrace();
  49.         }
  50.     }
  51.     public static void postHasFile(String url, OkHttpCallBack okHttpCallback, HashMap<String, String> bodyMap, String filesKey, List<File> files){
  52.         Call call = null;
  53.         try{
  54.  
  55.             MultipartBody.Builder multipartBodyBuilder = new MultipartBody.Builder();
  56.             multipartBodyBuilder.setType(MultipartBody.FORM);
  57.             for (HashMap.Entry<String, String> entry : bodyMap.entrySet()) {
  58.                 multipartBodyBuilder.addFormDataPart(entry.getKey(), entry.getValue());
  59.             }
  60.             //遍历paths中所有图片绝对路径到builder，并约定key如“upload”作为后台接受多张图片的key
  61.             if (files != null){
  62.                 for (File file : files) {
  63.                     multipartBodyBuilder.addFormDataPart(filesKey, file.getName(), RequestBody.create(MediaType.parse("image/png"), file));
  64.                 }
  65.             }
  66.             RequestBody body = multipartBodyBuilder.build();
  67.             Request.Builder builderRequest = new Request.Builder();
  68. //            builderRequest.headers(new Headers())
  69.             Request request = builderRequest.post(body).url(url).build();
  70.             call = mOkHttpClient.newCall(request);
  71.             call.enqueue(okHttpCallback);
  72.  
  73.         }catch(Exception ex){
  74.             ex.printStackTrace();
  75.         }
  76.     }
  77.  
  78. }

1、在application中调用init方法初始化okhttp。

2、使用post方法：

（1）第一个（post）是不上传图片的请求，只需传入请求url、map形式的上传参数，一个请求监听。

（2）第二个（postHasFile）为上传文件请求，本人项目中只需上传一个图片列表，所以只增加了

String filesKey, List<File> files

两个参数。如果有其他需求，可以修改此处代码：

MultipartBody.Builder multipartBodyBuilder = new MultipartBody.Builder();
multipartBodyBuilder.setType(MultipartBody.FORM);
for (HashMap.Entry<String, String> entry : bodyMap.entrySet()) {
    multipartBodyBuilder.addFormDataPart(entry.getKey(), entry.getValue());
}
//遍历paths中所有图片绝对路径到builder，并约定key如“upload”作为后台接受多张图片的key
if (files != null){
    for (File file : files) {
        multipartBodyBuilder.addFormDataPart(filesKey, file.getName(), RequestBody.create(MediaType.parse("image/png"), file));
    }
}

2、OkHttpCallBack

这个类简单封装了Okhttp的callback方法并以jsonObject回调给请求。

  1. import android.util.Log;
  2.  
  3. import com.google.gson.Gson;
  4.  
  5. import org.json.JSONException;
  6. import org.json.JSONObject;
  7. import org.json.JSONTokener;
  8.  
  9. import java.io.IOException;
  10.  
  11. import okhttp3.Call;
  12. import okhttp3.Callback;
  13. import okhttp3.Response;
  14.  
  15. //The class to deal with the OkHttpCallback
  16. public abstract class OkHttpCallBack implements Callback {
  17.  
  18.     public abstract void onSuccess(final Call call, JSONObject jsonObject);
  19.  
  20.     @Override
  21.     public void onResponse(Call call, Response response) throws IOException {
  22.         Log.d("OkHttpCallBackResponse：",call.toString()+"\r\n//reponse"+response.toString()+"\r\nresponse.headers:"+response.headers()
  23.                 +"\r\nreponse.message:"+response.message());
  24.         if (response != null) {
  25.             String str = response.body().string().trim();
  26.             Log.d("OkHttpCallBackResponse","//body::"+str);
  27.             if (response.isSuccessful()) {
  28.                 try{
  29.                     JSONObject object = (JSONObject)new JSONTokener(str).nextValue();
  30.                     if (object != null) {
  31.                         onSuccess(call, object);
  32.                     }else{
  33.                         onFailure(call, null);
  34.                     }
  35.                 }catch(JSONException e) {
  36.                     e.printStackTrace();
  37.                     onFailure(call, null);
  38.                 }
  39.  
  40.             }else{
  41.                 onFailure(call, null);
  42.             }
  43.         }
  44.     }
  45.  
  46.  
  47.     @Override
  48.     public void onFailure(Call call, IOException e){
  49.         Log.d("OkHttpCallBackFail",call.toString()+"//"+e.toString());
  50.     }
  51. }

3、RxUtils 

这个类是为了配置请求证书 （https需要）。

  1. import java.security.SecureRandom;
  2. import java.security.cert.CertificateException;
  3. import java.security.cert.X509Certificate;
  4.  
  5. import javax.net.ssl.HostnameVerifier;
  6. import javax.net.ssl.SSLContext;
  7. import javax.net.ssl.SSLSession;
  8. import javax.net.ssl.SSLSocketFactory;
  9. import javax.net.ssl.TrustManager;
  10. import javax.net.ssl.X509TrustManager;
  11.  
  12. //在okhttp中设置信任所有证书
  13. public class RxUtils {
  14.  
  15.     @SuppressLint("TrulyRandom")
  16.     public static SSLSocketFactory createSSLSocketFactory() {
  17.         SSLSocketFactory sSLSocketFactory = null;
  18.         try {
  19.             SSLContext sc = SSLContext.getInstance("TLS");
  20.             sc.init(null, new TrustManager[]{new TrustAllManager()},
  21.                     new SecureRandom());
  22.             sSLSocketFactory = sc.getSocketFactory();
  23.         } catch (Exception ignored) {
  24.         }
  25.         return sSLSocketFactory;
  26.     }
  27.  
  28.     public static class TrustAllManager implements X509TrustManager {
  29.         @SuppressLint("TrustAllX509TrustManager")
  30.         @Override
  31.         public void checkClientTrusted(X509Certificate[] chain, String authType)
  32.                 throws CertificateException {
  33.         }
  34.  
  35.         @SuppressLint("TrustAllX509TrustManager")
  36.         @Override
  37.         public void checkServerTrusted(X509Certificate[] chain, String authType)
  38.                 throws CertificateException {
  39.         }
  40.  
  41.         @Override
  42.         public X509Certificate[] getAcceptedIssuers() {
  43.             return new X509Certificate[0];
  44.         }
  45.     }
  46.  
  47.     public static class TrustAllHostnameVerifier implements HostnameVerifier {
  48.         @SuppressLint("BadHostnameVerifier")
  49.         @Override
  50.         public boolean verify(String hostname, SSLSession session) {
  51.             return true;
  52.         }
  53.     }
  54. }

4、 NetConfig

此类主要写了baseurl和各个请求接口url。

  1. public class NetConfig {
  2.  
  3.     
  4.     public static String BASE_URL = "http://111.111.1.111:8081/";
  5.  
  6.     //登录
  7.     public static String LOGIN = BASE_URL+"mobileApi/user/login";
  8. }

5、ApiUtil

这个类为每个请求的基类

  1. import android.os.Handler;
  2. import android.os.Message;
  3. import android.util.Log;
  4.  
  5. import androidx.annotation.NonNull;
  6.  
  7. import org.json.JSONObject;
  8.  
  9. import java.io.File;
  10. import java.io.IOException;
  11. import java.util.HashMap;
  12. import java.util.List;
  13.  
  14. import okhttp3.Call;
  15.  
  16. public  abstract class ApiUtil {
  17.     private ApiListener mApiListener = null;
  18.     private static final int SUCCESS = 1;
  19.     private static final int FAIRURE = 2;
  20.     private Handler handler = new Handler(){
  21.         @Override
  22.         public void handleMessage(@NonNull Message msg) {
  23.             super.handleMessage(msg);
  24.             switch (msg.what){
  25.                 case SUCCESS:
  26.                     mApiListener.success(ApiUtil.this);
  27.                     break;
  28.                 case FAIRURE:
  29.                     mApiListener.failrure(ApiUtil.this);
  30.                     break;
  31.             }
  32.         }
  33.     };
  34.     public boolean mStatus = false;
  35.     public String msg = "请求失败";
  36.     public String TAG = this.getClass().toString();
  37.     private OkHttpCallBack mSendListener = new OkHttpCallBack(){
  38.  
  39.         @Override
  40.         public void onSuccess(Call call, JSONObject jsonObject) {
  41.             ApiUtil.this.mStatus = jsonObject.optBoolean("status");
  42.             ApiUtil.this.msg = jsonObject.optString("msg");
  43.             if (mStatus) {
  44.                 try{
  45.                     parseData(jsonObject);
  46.                     handler.sendEmptyMessage(SUCCESS);
  47.  
  48.                 }catch(IOException e){
  49.                     handler.sendEmptyMessage(FAIRURE);
  50.                     e.printStackTrace();
  51.                 } catch (Exception e) {
  52.                     handler.sendEmptyMessage(FAIRURE);
  53.                     e.printStackTrace();
  54.                 }
  55.  
  56.             }else{
  57.                 handler.sendEmptyMessage(FAIRURE);
  58.             }
  59.         }
  60.  
  61.         @Override
  62.         public void onFailure(Call call, IOException e){
  63.             ApiUtil.this.msg = "链接失败";
  64.             ApiUtil.this.mStatus = false;
  65.             handler.sendEmptyMessage(FAIRURE);
  66.         }
  67.     };
  68.  
  69. //    public boolean isSuccess(){
  70. //        return "0".equals(mStatus) || "200".equals(mStatus);
  71. //    }
  72.  
  73.     protected abstract void parseData(JSONObject jsonObject) throws Exception;
  74.  
  75.     protected abstract String getUrl();
  76.  
  77.     //Send GET request
  78.     //Listener: Tell the app whether the GET reqeust is success.
  79.     public void get(ApiListener listener){
  80.         mApiListener = listener;
  81.         OkHttpUtil.get(getUrl(), mSendListener);
  82.     }
  83.  
  84.  
  85.     private HashMap<String, String> mBodyMap = new HashMap<>();
  86.     public void addParams(String key, String value){
  87.         mBodyMap.put(key, value);
  88.     }
  89.     public void clearParams(){
  90.         mBodyMap.clear();
  91.     }
  92.  
  93.     //Send POST request
  94.     //Listener: Tell the app whether the POST reqeust is success.
  95.     public void post(ApiListener listener){
  96.         mApiListener = listener;
  97.         OkHttpUtil.post(getUrl(), mSendListener, mBodyMap);
  98.     }
  99.     public void postFiles(ApiListener listener, String fileKey, List<File> fileList){
  100.         mApiListener = listener;
  101.  
  102.         OkHttpUtil.postHasFile(getUrl(),mSendListener,mBodyMap,fileKey,fileList);
  103.     }
  104.     @Override
  105.     public String toString() {
  106.         return "ApiUtil{" +
  107.                 "mApiListener=" + mApiListener +
  108.                 ", mStatus=" + mStatus +
  109.                 ", msg='" + msg + '\'' +
  110.                 ", TAG='" + TAG + '\'' +
  111.                 ", mSendListener=" + mSendListener +
  112.                 ",\r\n mBodyMap=" + mBodyMap +
  113.                 '}';
  114.     }
  115. }

1、设置参数请求

public void addParams(String key, String value){
    mBodyMap.put(key, value);
}

2、发送请求

public void post(ApiListener listener){
    mApiListener = listener;
    OkHttpUtil.post(getUrl(), mSendListener, mBodyMap);
}
public void postFiles(ApiListener listener, String fileKey, List<File> fileList){
    mApiListener = listener;

    OkHttpUtil.postHasFile(getUrl(),mSendListener,mBodyMap,fileKey,fileList);
}

以登陆接口为例

  1. public class PostLogin extends ApiUtil {
  2.  
  3.     public UserBeans mResponse;
  4.     public PostLogin(String userName, String passWord){
  5.         addParams("userCode", userName);
  6.         addParams("userPassword", passWord);
  7.     }
  8.     @Override
  9.     protected void parseData(JSONObject jsonObject) throws Exception {
  10.         mResponse = new Gson().fromJson(jsonObject.optString("data"),UserBeans.class);
  11.     }
  12.  
  13.     @Override
  14.     protected String getUrl() {
  15.         return NetConfig.LOGIN;
  16.     }
  17. }

1、可以在初始化时添加参数，或者生成postLogin实例后传参。

2、在getUrl()方法中回调给父类请求URL。 

3、可以在parseData(JSONObject jsonObject)中解析返回的数据，然后定义实体类作为接收：

public UserBeans mResponse;

@Override
protected void parseData(JSONObject jsonObject) throws Exception {
    mResponse = new Gson().fromJson(jsonObject.optString("data"),UserBeans.class);
}

在LoginActivity中调用

  1. private void login() {
  2.         if (TextUtils.isEmpty(edtUserName.getText().toString())) {
  3.             toShortToast("请输入用户名");
  4.             return;
  5.         }
  6.         if (TextUtils.isEmpty(edtPassword.getText().toString())) {
  7.             toShortToast("请输入密码");
  8.             return;
  9.         }
  10.         showLoadingDialog("登录中...");
  11.         new PostLogin(edtUserName.getText().toString(), edtPassword.getText().toString()).post(new ApiListener() {
  12.             @Override
  13.             public void success(ApiUtil apiUtil) {
  14.                 toShortToast(apiUtil.msg);
  15.                 PostLogin postLogin = (PostLogin) apiUtil;
  16.                 SPUtil.put(context, SpKeys.KEY_LOGIN_USER_NAME, edtUserName.getText().toString());
  17.                 SPUtil.put(context, SpKeys.KEY_USER_ID, postLogin.mResponse.getUserId());
  18.                 SPUtil.put(context, SpKeys.KEY_USER_TYPE, postLogin.mResponse.getUserType());
  19.                 if (isRememberPw) {
  20.                     SPUtil.put(context, SpKeys.KEY_LOGIN_PASSWORD, edtPassword.getText().toString());
  21.                 } else {
  22.                     SPUtil.put(context, SpKeys.KEY_LOGIN_PASSWORD, "");
  23.                 }
  24.                 Intent intent = new Intent();
  25.                 intent.setClass(context, MainActivity.class);
  26.                 context.startActivity(intent);
  27.                 stopLoadingDialog();
  28.                 finish();
  29.             }
  30.  
  31.             @Override
  32.             public void failrure(ApiUtil apiUtil) {
  33.                 stopLoadingDialog();
  34.                 toShortToast(apiUtil.msg);
  35.             }
  36.         });
  37.  
  38.     }

请求监听接口中 success(ApiUtil apiUtil)方法回调 接收的数据

PostLogin postLogin = (PostLogin) apiUtil;

postLogin.mResponse为已经解析好的实体类。

后补：ApiListener 

  1. public interface ApiListener {
  2.  
  3.     //Request success
  4.     void success(ApiUtil apiUtil);
  5.  
  6.     //Request failed
  7.     void failrure(ApiUtil apiUtil);
  8.  
  9.  
  10. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/article/detail/45664
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号