栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Android开发之Https网络请求实践

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Android开发之Https网络请求实践

Android开发之Https网络请求实践

文章目录
  • 前言
  • 一、引入okhttp
  • 二、创建MyTrustManager类
    • 2.1 建一个类为MyTrustManager,实现接口X509TrustManager
  • 三.新建OkHttpUtil类实现Get、Post方法
    • 3.1 类中需定义全局OkHttpClient和MediaType:
    • 3.2 定义createSSLSocketFactory方法,用于创建SSLSocketFactory
    • 3.3 定义getX509TrustManager方法用于获取X509TrustManager
    • 3.4 实现静态模块初始化util
    • 3.5 新建一个方法实现通过okhttp的excute获取Response
    • 3.6 创建get请求方法
    • 3.7 创建post请求方法
    • 3.8 OkHttpUtil完整代码如下:
  • 四.创建PostCallBack接口,用于处理请求完成后的处理委托
  • 五.创建NetHandler类
    • 5.1 新建NetHandler类并实现Runnable接口:
    • 5.2 声明成员:
    • 5.3 NetHandler构造方法中给成员赋值:
    • 5.4 实现Runnable接口的run方法
    • 5.5 NetHandler 完整代码:
  • 六.实例引用
  • 总结


前言

最近使用VisualStudio开发APP,涉及的网络请求数据源来自于Https网络,在此进行记录,初研阶段,大神轻喷,谢谢。


一、引入okhttp

网络请求组件我们使用okhttp组件,在Module层的build.gradle中引入

implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.7'

并点击gradle上方的Sync进行同步

二、创建MyTrustManager类 2.1 建一个类为MyTrustManager,实现接口X509TrustManager

代码如下(示例):

import android.annotation.SuppressLint;

import java.security.cert.X509Certificate;

import javax.net.ssl.X509TrustManager;

public class MyTrustManager implements X509TrustManager {
    @SuppressLint("TrustAllX509TrustManager")
    @Override
    public void checkClientTrusted(X509Certificate[] chain, String authType) {
        // TODO Auto-generated method stub
    }
    @SuppressLint("TrustAllX509TrustManager")
    @Override
    public void checkServerTrusted(X509Certificate[] chain, String authType) {
        // TODO Auto-generated method stub
    }
    @Override
    public X509Certificate[] getAcceptedIssuers() {
        // TODO Auto-generated method stub
        return null;
    }

}
三.新建OkHttpUtil类实现Get、Post方法 3.1 类中需定义全局OkHttpClient和MediaType:
    private static final OkHttpClient mOkHttpClient;
    public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
3.2 定义createSSLSocketFactory方法,用于创建SSLSocketFactory
    private static SSLSocketFactory createSSLSocketFactory() {
        SSLSocketFactory ssfFactory = null;
        try {
            SSLContext sc = SSLContext.getInstance("TLS");
            sc.init(null, new TrustManager[]{new MyTrustManager()}, new SecureRandom());
            ssfFactory = sc.getSocketFactory();
        } catch (Exception e) {
            e.printStackTrace();
        }

        return ssfFactory;
    }
3.3 定义getX509TrustManager方法用于获取X509TrustManager
    public static X509TrustManager getX509TrustManager() {
        X509TrustManager trustManager = null;
        try {
            TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
            trustManagerFactory.init((KeyStore) null);
            TrustManager[] trustManagers = trustManagerFactory.getTrustManagers();
            if (trustManagers.length != 1 || !(trustManagers[0] instanceof X509TrustManager)) {
                throw new IllegalStateException("Unexpected default trust managers:" + Arrays.toString(trustManagers));
            }
            trustManager = (X509TrustManager) trustManagers[0];
        } catch (Exception e) {
            e.printStackTrace();
        }

        return trustManager;
    }
3.4 实现静态模块初始化util
    static {
        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        builder.protocols(Collections.singletonList(Protocol.HTTP_1_1));
        builder.connectTimeout(30, TimeUnit.SECONDS);


        
        builder.sslSocketFactory(createSSLSocketFactory(),getX509TrustManager());
        builder.hostnameVerifier((hostname, session) -> true);

        mOkHttpClient = builder.build();
    }
3.5 新建一个方法实现通过okhttp的excute获取Response
    public static Response execute(Request request) throws IOException {
        return mOkHttpClient.newCall(request).execute();
    }
3.6 创建get请求方法
    public static String get(String url) throws IOException {
        Request request = new Request.Builder().url(url).build();
        Response response = mOkHttpClient.newCall(request).execute();
        if (response.isSuccessful()) {
            response.body();
            return response.body().string();
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }
3.7 创建post请求方法

下面是提交Json数据的方法:

    public static String post(String url, String jsonString) throws IOException {
        RequestBody body = RequestBody.Companion.create(jsonString, JSON);
        Request request = new Request.Builder()
                .url(url)
                .post(body)
                .build();
        Response response = mOkHttpClient.newCall(request).execute();
        if (response.isSuccessful()) {
            response.body();
            return response.body().string();
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }

//我们也可以实现一个提交FormBody的方法:
public static String post(String url, FormBody body) throws IOException 		 {
        Request request = new Request.Builder()
                .url(url)
                .addHeader("Content-type", "application/json")
                .patch(body)
                .post(body)
                .build();
        Response response = mOkHttpClient.newCall(request).execute();
        if (response.isSuccessful()) {
            response.body();
            return response.body().string();
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }
3.8 OkHttpUtil完整代码如下:
import android.util.Log;

import androidx.annotation.NonNull;

import java.io.IOException;
import java.security.KeyStore;
import java.security.SecureRandom;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import javax.net.ssl.X509TrustManager;

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.FormBody;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.OkHttpClient;
import okhttp3.Protocol;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class OkHttpUtil  {
    public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
    private static final OkHttpClient mOkHttpClient;

    private static SSLSocketFactory createSSLSocketFactory() {
        SSLSocketFactory ssfFactory = null;
        try {
            SSLContext sc = SSLContext.getInstance("TLS");
            sc.init(null, new TrustManager[]{new MyTrustManager()}, new SecureRandom());
            ssfFactory = sc.getSocketFactory();
        } catch (Exception e) {
            e.printStackTrace();
        }

        return ssfFactory;
    }




    public static X509TrustManager getX509TrustManager() {
        X509TrustManager trustManager = null;
        try {
            TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
            trustManagerFactory.init((KeyStore) null);
            TrustManager[] trustManagers = trustManagerFactory.getTrustManagers();
            if (trustManagers.length != 1 || !(trustManagers[0] instanceof X509TrustManager)) {
                throw new IllegalStateException("Unexpected default trust managers:" + Arrays.toString(trustManagers));
            }
            trustManager = (X509TrustManager) trustManagers[0];
        } catch (Exception e) {
            e.printStackTrace();
        }

        return trustManager;
    }

    static {
        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        builder.protocols(Collections.singletonList(Protocol.HTTP_1_1));
        builder.connectTimeout(30, TimeUnit.SECONDS);


                builder.sslSocketFactory(createSSLSocketFactory(),getX509TrustManager());
        builder.hostnameVerifier((hostname, session) -> true);

        mOkHttpClient = builder.build();
    }

    public static Response execute(Request request) throws IOException {
        return mOkHttpClient.newCall(request).execute();
    }

    public static String post(String url, FormBody body) throws IOException {
        Request request = new Request.Builder()
                .url(url)
                .addHeader("Content-type", "application/json")
                .patch(body)
                .post(body)
                .build();
        Response response = mOkHttpClient.newCall(request).execute();
        if (response.isSuccessful()) {
            response.body();
            return response.body().string();
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }

    public static String post(String url, String jsonString) throws IOException {
        Log.d("liuwz", "post: "+url+"njsonString:"+jsonString);
        
//        RequestBody body = RequestBody.create(JSON, jsonString);
        RequestBody body = RequestBody.Companion.create(jsonString, JSON);
        Request request = new Request.Builder()
                .url(url)
                .post(body)
                .build();
        Response response = mOkHttpClient.newCall(request).execute();
        if (response.isSuccessful()) {
            response.body();
            return response.body().string();
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }

    public static String get(String url) throws IOException {
        Request request = new Request.Builder().url(url).build();
        Response response = mOkHttpClient.newCall(request).execute();
        if (response.isSuccessful()) {
            response.body();
            return response.body().string();
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }

}

四.创建PostCallBack接口,用于处理请求完成后的处理委托
public interface PostCallBack {
    void OnError(Context context, String IsSuccess, String RetMessage);
    void OnSuccess(Context context,String IsSuccess,String RetMessage,String Result) throws JSONException;
}

五.创建NetHandler类

由于网络请求不能放在主线程,我们一般都会采用线程的形式去请求,因此先创建一个NetHandler类一般委托线程处理请求:

5.1 新建NetHandler类并实现Runnable接口:
public class NetHandler implements Runnable{
}
5.2 声明成员:

其中,url为请求地址;jsonString为请求数据,Context为当前Activity的上下文,PostCallBack为请求完成后的处理方法

    private final String url;
    private final String jsonString;
    private final Context context;
    private final PostCallBack postCallBack;
5.3 NetHandler构造方法中给成员赋值:
    public NetHandler(final String url, final Object jsonObject, final Context context, final PostCallBack postCallBack) {
        this.url = url;
        if (jsonObject instanceof JSONObject) {
            this.jsonString = jsonObject.toString();
        } else {
            this.jsonString = new Gson().toJson(jsonObject);
        }
        this.context = context;
        this.postCallBack = postCallBack;
    }
5.4 实现Runnable接口的run方法
    @Override
    public void run() {
        try {
            String result = OkHttpUtil.post(url, jsonString);
            JSONObject resJson = new JSONObject(result);
            String IsSuccess = resJson.get("IsSuccess").toString();
            String RetMessage = resJson.get("RetMessage").toString();

            if (Looper.myLooper() == null) {
                Looper.prepare();
            }

            if (IsSuccess.equals("true")) {
                postCallBack.OnSuccess(context, IsSuccess, RetMessage, result);
            } else {

                if (!resJson.isNull("ErrorException")) {
                    JSONObject errExc = resJson.getJSONObject("ErrorException");
                    RetMessage = RetMessage + ":" + errExc.getString("Message");
                }
                postCallBack.OnError(context, IsSuccess, RetMessage);
                if (RetMessage.equals("身份校验失败:异常错误")) {
                    Intent intent = new Intent();
                    intent.setClass(context, MainActivity.class);
                    context.startActivity(intent);
                }
            }
            Looper.loop();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

5.5 NetHandler 完整代码:
import android.content.Context;
import android.content.Intent;
import android.os.Looper;

import com.google.gson.Gson;
import com.yiqiyunju.ssa.MainActivity;

import org.json.JSONObject;

public class NetHandler implements Runnable {
    private final String url;
    private final String jsonString;
    private final Context context;
    private final PostCallBack postCallBack;


    @Override
    public void run() {
        try {
            String result = OkHttpUtil.post(url, jsonString);
            JSONObject resJson = new JSONObject(result);
            String IsSuccess = resJson.get("IsSuccess").toString();
            String RetMessage = resJson.get("RetMessage").toString();

            if (Looper.myLooper() == null) {
                Looper.prepare();
            }

            if (IsSuccess.equals("true")) {
                postCallBack.OnSuccess(context, IsSuccess, RetMessage, result);
            } else {

                if (!resJson.isNull("ErrorException")) {
                    JSONObject errExc = resJson.getJSONObject("ErrorException");
                    RetMessage = RetMessage + ":" + errExc.getString("Message");
                }
                postCallBack.OnError(context, IsSuccess, RetMessage);
                if (RetMessage.equals("身份校验失败:异常错误")) {
                    Intent intent = new Intent();
                    intent.setClass(context, MainActivity.class);
                    context.startActivity(intent);
                }
            }
            Looper.loop();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public NetHandler(final String url, final Object jsonObject, final Context context, final PostCallBack postCallBack) {
        this.url = url;
        if (jsonObject instanceof JSONObject) {
            this.jsonString = jsonObject.toString();
        } else {
            this.jsonString = new Gson().toJson(jsonObject);
        }
        this.context = context;
        this.postCallBack = postCallBack;
    }

}

六.实例引用

此处为了代码简化我将请求地址和具体逻辑进行了简化,具体实现需要根据实际情况进行返回结果的解析。
我服务器范围的Json格式是这样的:

{
    "IsSuccess": true,
    "RetMessage": "登录成功。",
    "RetData": [{
    "XXX":"xxx",
    ...
    }
    ],
    "ErrorException": null
}
        String url = "https://XXXXX";
        new Thread(new NetHandler(url, new JSONObject(), context, new PostCallBack() {
            @Override
            public void OnError(Context context, String IsSuccess, String RetMessage) {
                Toast.makeText(context, RetMessage, Toast.LENGTH_SHORT).show();
            }

            @Override
            public void OnSuccess(Context context, String IsSuccess, String RetMessage, String Result) throws JSONException {

                JSONObject jsonObject = new JSONObject(Result);
                JSONObject resJson = (JSONObject) jsonObject.getJSONArray("RetData").get(0);

                String strUserCnt = resJson.getString("XXX");
                txtCustomerNumber.post(new Runnable() {
                    @Override
                    public void run() {
                        txtCustomerNumber.setText(String.format("请求结果:%s", strCustomerCnt));
                    }
                });

            }
        })).start();

总结

本文采用okhttp进行网络请求,使用X509TrustManager进行跳过证书验证,使用了JSONObject对数据进行了封装。
文中将OkHttpUtil进行了静态化,各位也可以取消静态化二采用单例模式添加静态方法 CreateInstance来实例化OkHttpUtil具体此处不在赘述。
最后附上项目架构仅供参考:

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/936585.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号