Android之HTTPURLConnection、OkHttp、Velloy、Retrofit等网络请求框架

最新推荐文章于 2024-03-09 23:50:11 发布

Doctor舒畅

最新推荐文章于 2024-03-09 23:50:11 发布

阅读量1.2k

点赞数 1

分类专栏： Android开发项目发布 Java开发文章标签：网络请求框架

本文链接：https://blog.csdn.net/qq_36326332/article/details/86650819

版权

Java开发同时被 3 个专栏收录

82 篇文章 0 订阅

订阅专栏

项目发布

35 篇文章 0 订阅

订阅专栏

Android开发

4 篇文章 0 订阅

订阅专栏

HttpURLConnection

HttpURLConnection是一种多用途、轻量极的HTTP客户端，使用它来进行HTTP操作可以适用于大多数的应用程序。

HttpURLConnection使用：

Get请求实现：

private void requestGet(HashMap<String, String> paramsMap) {

        try {

            String baseUrl = "https://xxx.com/getUsers?";

            StringBuilder tempParams = new StringBuilder();

            int pos = 0;

            for (String key : paramsMap.keySet()) {

                if (pos > 0) {

                    tempParams.append("&");

                }

                tempParams.append(String.format("%s=%s", key, URLEncoder.encode(paramsMap.get(key),"utf-8")));

                pos++;

            }

            String requestUrl = baseUrl + tempParams.toString();

            // 新建一个URL对象

            URL url = new URL(requestUrl);

            // 打开一个HttpURLConnection连接

            HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();

            // 设置连接主机超时时间

            urlConn.setConnectTimeout(5 * 1000);

            //设置从主机读取数据超时

            urlConn.setReadTimeout(5 * 1000);

            // 设置是否使用缓存  默认是true

            urlConn.setUseCaches(true);

            // 设置为Post请求

            urlConn.setRequestMethod("GET");

            //urlConn设置请求头信息

            //设置请求中的媒体类型信息。

            urlConn.setRequestProperty("Content-Type", "application/json");

            //设置客户端与服务连接类型

            urlConn.addRequestProperty("Connection", "Keep-Alive");

            // 开始连接

            urlConn.connect();

            // 判断请求是否成功

            if (urlConn.getResponseCode() == 200) {

                // 获取返回的数据

                String result = streamToString(urlConn.getInputStream());

                Log.e(TAG, "Get方式请求成功，result--->" + result);

            } else {

                Log.e(TAG, "Get方式请求失败");

            }

            // 关闭连接

            urlConn.disconnect();

        } catch (Exception e) {

            Log.e(TAG, e.toString());

        }

    }

POST请求实现：

private void requestPost(HashMap<String, String> paramsMap) {

        try {

            String baseUrl = "https://xxx.com/getUsers";

            //合成参数

            StringBuilder tempParams = new StringBuilder();

            int pos = 0;

            for (String key : paramsMap.keySet()) {

                if (pos > 0) {

                    tempParams.append("&");

                }

                tempParams.append(String.format("%s=%s", key,  URLEncoder.encode(paramsMap.get(key),"utf-8")));

                pos++;

            }

            String params =tempParams.toString();

            // 请求的参数转换为byte数组

            byte[] postData = params.getBytes();

            // 新建一个URL对象

            URL url = new URL(baseUrl);

            // 打开一个HttpURLConnection连接

            HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();

            // 设置连接超时时间

            urlConn.setConnectTimeout(5 * 1000);

            //设置从主机读取数据超时

            urlConn.setReadTimeout(5 * 1000);

            // Post请求必须设置允许输出 默认false

            urlConn.setDoOutput(true);

            //设置请求允许输入 默认是true

            urlConn.setDoInput(true);

            // Post请求不能使用缓存

            urlConn.setUseCaches(false);

            // 设置为Post请求

            urlConn.setRequestMethod("POST");

            //设置本次连接是否自动处理重定向

            urlConn.setInstanceFollowRedirects(true);

            // 配置请求Content-Type

            urlConn.setRequestProperty("Content-Type", "application/json");

            // 开始连接

            urlConn.connect();

            // 发送请求参数

            DataOutputStream dos = new DataOutputStream(urlConn.getOutputStream());

            dos.write(postData);

            dos.flush();

            dos.close();

            // 判断请求是否成功

            if (urlConn.getResponseCode() == 200) {

                // 获取返回的数据

                String result = streamToString(urlConn.getInputStream());

                Log.e(TAG, "Post方式请求成功，result--->" + result);

            } else {

                Log.e(TAG, "Post方式请求失败");

            }

            // 关闭连接

            urlConn.disconnect();

        } catch (Exception e) {

            Log.e(TAG, e.toString());

        }

    }

处理网络流：将输入流转换成字符串

/**

     * 将输入流转换成字符串

     *

     * @param is 从网络获取的输入流

     * @return

     */

    public String streamToString(InputStream is) {

        try {

            ByteArrayOutputStream baos = new ByteArrayOutputStream();

            byte[] buffer = new byte[1024];

            int len = 0;

            while ((len = is.read(buffer)) != -1) {

                baos.write(buffer, 0, len);

            }

            baos.close();

            is.close();

            byte[] byteArray = baos.toByteArray();

            return new String(byteArray);

        } catch (Exception e) {

            Log.e(TAG, e.toString());

            return null;

        }

    }

以上就是HttpConnection的get、post的简单实现，如何实现文件的下载和上传呢？

文件下载：

private void downloadFile(String fileUrl){

        try {

            // 新建一个URL对象

            URL url = new URL(fileUrl);

            // 打开一个HttpURLConnection连接

            HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();

            // 设置连接主机超时时间

            urlConn.setConnectTimeout(5 * 1000);

            //设置从主机读取数据超时

            urlConn.setReadTimeout(5 * 1000);

            // 设置是否使用缓存  默认是true

            urlConn.setUseCaches(true);

            // 设置为Post请求

            urlConn.setRequestMethod("GET");

            //urlConn设置请求头信息

            //设置请求中的媒体类型信息。

            urlConn.setRequestProperty("Content-Type", "application/json");

            //设置客户端与服务连接类型

            urlConn.addRequestProperty("Connection", "Keep-Alive");

            // 开始连接

            urlConn.connect();

            // 判断请求是否成功

            if (urlConn.getResponseCode() == 200) {

                String filePath="";

                File  descFile = new File(filePath);

                FileOutputStream fos = new FileOutputStream(descFile);;

                byte[] buffer = new byte[1024];

                int len;

                InputStream inputStream = urlConn.getInputStream();

                while ((len = inputStream.read(buffer)) != -1) {

                    // 写到本地

                    fos.write(buffer, 0, len);

                }

            } else {

                Log.e(TAG, "文件下载失败");

            }

            // 关闭连接

            urlConn.disconnect();

        } catch (Exception e) {

            Log.e(TAG, e.toString());

        }

    }

文件上传：

private void upLoadFile(String filePath, HashMap<String, String> paramsMap) {

        try {

            String baseUrl = "https://xxx.com/uploadFile";

            File file = new File(filePath);

            //新建url对象

            URL url = new URL(baseUrl);

            //通过HttpURLConnection对象,向网络地址发送请求

            HttpURLConnection urlConn = (HttpURLConnection) url.openConnection();

            //设置该连接允许读取

            urlConn.setDoOutput(true);

            //设置该连接允许写入

            urlConn.setDoInput(true);

            //设置不能适用缓存

            urlConn.setUseCaches(false);

            //设置连接超时时间

            urlConn.setConnectTimeout(5 * 1000);   //设置连接超时时间

            //设置读取超时时间

            urlConn.setReadTimeout(5 * 1000);   //读取超时

            //设置连接方法post

            urlConn.setRequestMethod("POST");

            //设置维持长连接

            urlConn.setRequestProperty("connection", "Keep-Alive");

            //设置文件字符集

            urlConn.setRequestProperty("Accept-Charset", "UTF-8");

            //设置文件类型

            urlConn.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + "*****");

            String name = file.getName();

            DataOutputStream requestStream = new DataOutputStream(urlConn.getOutputStream());

            requestStream.writeBytes("--" + "*****" + "\r\n");

            //发送文件参数信息

            StringBuilder tempParams = new StringBuilder();

            tempParams.append("Content-Disposition: form-data; name=\"" + name + "\"; filename=\"" + name + "\"; ");

            int pos = 0;

            int size=paramsMap.size();

            for (String key : paramsMap.keySet()) {

                tempParams.append( String.format("%s=\"%s\"", key, paramsMap.get(key), "utf-8"));

                if (pos < size-1) {

                    tempParams.append("; ");

                }

                pos++;

            }

            tempParams.append("\r\n");

            tempParams.append("Content-Type: application/octet-stream\r\n");

            tempParams.append("\r\n");

            String params = tempParams.toString();

            requestStream.writeBytes(params);

            //发送文件数据

            FileInputStream fileInput = new FileInputStream(file);

            int bytesRead;

            byte[] buffer = new byte[1024];

            DataInputStream in = new DataInputStream(new FileInputStream(file));

            while ((bytesRead = in.read(buffer)) != -1) {

                requestStream.write(buffer, 0, bytesRead);

            }

            requestStream.writeBytes("\r\n");

            requestStream.flush();

            requestStream.writeBytes("--" + "*****" + "--" + "\r\n");

            requestStream.flush();

            fileInput.close();

            int statusCode = urlConn.getResponseCode();

            if (statusCode == 200) {

                // 获取返回的数据

                String result = streamToString(urlConn.getInputStream());

                Log.e(TAG, "上传成功，result--->" + result);

            } else {

                Log.e(TAG, "上传失败");

            }

        } catch (IOException e) {

            Log.e(TAG, e.toString());

        }

    }

权限：

<uses-permission android:name="android.permission.INTERNET"/>

网络请求框架 OkHttp 的使用

I.简介

HTTP是现代应用常用的一种交换数据和媒体的网络方式，高效地使用HTTP能让资源加载更快，节省带宽。

一个处理网络请求的开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso)

用于替代HttpUrlConnection和Apache HttpClient(android API23 6.0里已移除HttpClient)。

II.使用

OkHttp的使用是非常简单的. 它的请求/响应 API 使用构造器模式builders来设计，它支持阻塞式的同步请求和带回调的异步请求。

1.1. 异步GET请求

new OkHttpClient;
构造Request对象；
通过前两步中的对象构建Call对象；
通过Call#enqueue(Callback)方法来提交异步请求；

String url = "http://wwww.baidu.com";

OkHttpClient okHttpClient = new OkHttpClient();

final Request request = new Request.Builder()

        .url(url)

        .get()//默认就是GET请求，可以不写

        .build();

Call call = okHttpClient.newCall(request);

call.enqueue(new Callback() {

    @Override

    public void onFailure(Call call, IOException e) {

        Log.d(TAG, "onFailure: ");

    }



    @Override

    public void onResponse(Call call, Response response) throws IOException {

        Log.d(TAG, "onResponse: " + response.body().string());

    }

});

异步发起的请求会被加入到 Dispatcher 中的 runningAsyncCalls双端队列中通过线程池来执行。

1.2. 同步GET请求

前面几个步骤和异步方式一样，只是最后一部是通过 Call#execute() 来提交请求，注意这种方式会阻塞调用线程，所以在Android中应放在子线程中执行，否则有可能引起ANR异常，Android3.0 以后已经不允许在主线程访问网络。

String url = "http://wwww.baidu.com";

OkHttpClient okHttpClient = new OkHttpClient();

final Request request = new Request.Builder()

        .url(url)

        .build();

final Call call = okHttpClient.newCall(request);

new Thread(new Runnable() {

    @Override

    public void run() {

        try {

            Response response = call.execute();

            Log.d(TAG, "run: " + response.body().string());

        } catch (IOException e) {

            e.printStackTrace();

        }

    }

}).start();

2.1. POST方式提交String

这种方式与前面的区别就是在构造Request对象时，需要多构造一个RequestBody对象，用它来携带我们要提交的数据。在构造 RequestBody 需要指定MediaType，用于描述请求/响应 body 的内容类型，关于 MediaType 的更多信息可以查看 RFC 2045，RequstBody的几种构造方式：

MediaType mediaType = MediaType.parse("text/x-markdown; charset=utf-8");

String requestBody = "I am Jdqm.";

Request request = new Request.Builder()

        .url("https://api.github.com/markdown/raw")

        .post(RequestBody.create(mediaType, requestBody))

        .build();

OkHttpClient okHttpClient = new OkHttpClient();

okHttpClient.newCall(request).enqueue(new Callback() {

    @Override

    public void onFailure(Call call, IOException e) {

        Log.d(TAG, "onFailure: " + e.getMessage());

    }



    @Override

    public void onResponse(Call call, Response response) throws IOException {

        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());

        Headers headers = response.headers();

        for (int i = 0; i < headers.size(); i++) {

            Log.d(TAG, headers.name(i) + ":" + headers.value(i));

        }

        Log.d(TAG, "onResponse: " + response.body().string());

    }

});

2.2 POST方式提交流

RequestBody requestBody = new RequestBody() {

    @Nullable

    @Override

    public MediaType contentType() {

        return MediaType.parse("text/x-markdown; charset=utf-8");

    }



    @Override

    public void writeTo(BufferedSink sink) throws IOException {

        sink.writeUtf8("I am Jdqm.");

    }

};



Request request = new Request.Builder()

        .url("https://api.github.com/markdown/raw")

        .post(requestBody)

        .build();

OkHttpClient okHttpClient = new OkHttpClient();

okHttpClient.newCall(request).enqueue(new Callback() {

    @Override

    public void onFailure(Call call, IOException e) {

        Log.d(TAG, "onFailure: " + e.getMessage());

    }



    @Override

    public void onResponse(Call call, Response response) throws IOException {

        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());

        Headers headers = response.headers();

        for (int i = 0; i < headers.size(); i++) {

            Log.d(TAG, headers.name(i) + ":" + headers.value(i));

        }

        Log.d(TAG, "onResponse: " + response.body().string());

    }

});

2.3. POST提交文件

MediaType mediaType = MediaType.parse("text/x-markdown; charset=utf-8");

OkHttpClient okHttpClient = new OkHttpClient();

File file = new File("test.md");

Request request = new Request.Builder()

        .url("https://api.github.com/markdown/raw")

        .post(RequestBody.create(mediaType, file))

        .build();

okHttpClient.newCall(request).enqueue(new Callback() {

    @Override

    public void onFailure(Call call, IOException e) {

        Log.d(TAG, "onFailure: " + e.getMessage());

    }



    @Override

    public void onResponse(Call call, Response response) throws IOException {

        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());

        Headers headers = response.headers();

        for (int i = 0; i < headers.size(); i++) {

            Log.d(TAG, headers.name(i) + ":" + headers.value(i));

        }

        Log.d(TAG, "onResponse: " + response.body().string());

    }

});

2.4. POST方式提交表单

OkHttpClient okHttpClient = new OkHttpClient();

RequestBody requestBody = new FormBody.Builder()

        .add("search", "Jurassic Park")

        .build();

Request request = new Request.Builder()

        .url("https://en.wikipedia.org/w/index.php")

        .post(requestBody)

        .build();



okHttpClient.newCall(request).enqueue(new Callback() {

    @Override

    public void onFailure(Call call, IOException e) {

        Log.d(TAG, "onFailure: " + e.getMessage());

    }



    @Override

    public void onResponse(Call call, Response response) throws IOException {

        Log.d(TAG, response.protocol() + " " +response.code() + " " + response.message());

        Headers headers = response.headers();

        for (int i = 0; i < headers.size(); i++) {

            Log.d(TAG, headers.name(i) + ":" + headers.value(i));

        }

        Log.d(TAG, "onResponse: " + response.body().string());

    }

});

提交表单时，使用 RequestBody 的实现类FormBody来描述请求体，它可以携带一些经过编码的 key-value 请求体。

网络编程的最佳实践

因为一个应用程序很可能会在许多地方使用到网络功能，而发送HTTP请求的代码基本都是相同的，如果我没每次都去编写一遍发送HTTP请求的代码，这显然是非常极差的做法；通常情况下我们都应该将这些通用的网络操作提取到一个公共的类里，并提供静态方法，当想要发起网络请求的时候，只需简单地调用一下这个方法即可。如：

Java的回调机制：

public interface HttpCallbackListener{

void onFinish(String response);

void onError(Exception e);

}

工具类：

public class HttpUtil{

    //HtpURLConnection网络请求

    public static String sendHttpRequest(final String address,final HttpCallbackListener listener){

        new Thread(ne Runnable(){

            @ovreride

            public void run(){

                HttpURLConnection connection = null;

                try{

                    URL url = new URL(address);

                    HttpURLConnection connection= (HttpURLConnection) url.openConnection();

                    connection.setRequestMethod("GET");

                    connection.setConnectTimeout(5 * 1000);

                    connection.setReadTimeout(5 * 1000);

                    connection.setDoInput(true);

                    connection.setDoOutput(true);

                    InputStream in = connection.getInputStream();

                    BufferedReader reader = new BufferedReader(new InputStreamReader(in));

                    StringBuilder response = new StringBuilder();

                    String line;

                    while((line = reader.readLine())!=null){

                        response.append(line);

                    }

                    if(listener != null){

                        //回调onFinish方法

                        listener.onFinish(response.toString);

                    }

                } catch (Exception e) {

                     if(listener != null){

                        //回调onError方法

                        listener.onError(e);

                    }   

                }finally{

                    if(connection != null){

                        connection.disconnect();

                    }

                }

            }

        }).start();        

    }

//OkHttpClient网络请求

//参数okhttp3.Callback是OkHttp库中自带的一个回调接口

public static void sendOkHttpRequest(String address,okhttp3.Callback callBack){

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()

.url(address)

.build();

//OkHttp在enqueue()方法的内部已经帮我们开好了子线程了，然后会在子线程中去执行HTTP请求，并将最终的请求结果回调到okhttp3.Callback当中。

cilent.newCall(request).enqueue(callback);

}

使用工具类：

//HtpURLConnection网络请求

HttpUtil.sendHttpRequest(address,new HttpCallbackListener(){//回调机制

@Override

public void onFinish(String response){

//在这里根据返回内容执行具体的逻辑

}

public void onError(Exception e){

//在这里对异常情况进行处理

}

});

//OkHttpClient网络请求

HttpUtil.sendOkHttpRequest(address,new okhttp3.Callback(){

@override

public void onResponse(Call call, Response response) throws IOException {

//得到服务器返回的具体内容

String responseData = response.body().toString();

}

@override

public void onFailure(Call call, IOException e) {

//在这里对异常情况进行处理

}

});

HTTPClient

Retrofit网络请求

OkHttpClient.Builder okHttpClient = new OkHttpClient.Builder()

        .addInterceptor(new Interceptor() {

            @Override

            public Response intercept(Chain chain) throws IOException {

                Request request = chain.request()

                        .newBuilder()

                        .addHeader("X-Token", token)

                        .build();

                return chain.proceed(request);

            }



        })

        .connectTimeout(30, TimeUnit.MINUTES) // connect timeout

        .writeTimeout(30, TimeUnit.MINUTES) // write timeout

        .readTimeout(30, TimeUnit.MINUTES); // read timeout



Retrofit retrofit = new Retrofit.Builder()

        .baseUrl(BuildConfig.SERVER_URL)

        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())

        .addConverterFactory(GsonConverterFactory.create())

        .client(okHttpClient.build())

        .build();

FileUploadService fileUploadService = retrofit.create(FileUploadService.class);

Doctor舒畅

关注

1
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
Android之HTTPURLConnection、OkHttp、Velloy、Retrofit等网络请求框架

HttpURLConnection HttpURLConnection是一种多用途、轻量极的HTTP客户端，使用它来进行HTTP操作可以适用于大多数的应用程序。HttpURLConnection使用： Get请求实现：private void requestGet(HashMap&lt;String, String&gt; paramsMap) {t...
复制链接

扫一扫