HttpUtils工具类（三）OKHttpClient使用详细教程

用户734402819342
0 阅读4分钟

在本篇教程中，我们将介绍如何使用OKHttpClient，一个广泛使用的HTTP客户端库，来进行网络请求操作。OKHttp是一个高效的HTTP客户端库，支持HTTP/2、连接池、透明压缩和其他高级功能，使得它在Android开发以及Java 后端开发中被广泛采用。

一、OKHttpClient概述 OKHttp是Square公司开发的一个开源项目，主要用于处理HTTP请求和响应。它与标准的Java HttpURLConnection相比，提供了更高效、简单、灵活的API，支持同步和异步请求。

OKHttp的特点： 支持HTTP/2。 内建连接池，减少TCP连接的开销。 支持透明的GZIP压缩和响应缓存。 支持同步和异步请求。 支持WebSocket和拦截器功能。 二、OKHttpClient的基本使用

  1. 添加依赖 首先，你需要在项目中添加OKHttp的依赖。以下是Gradle配置：

dependencies { implementation("com.squareup.okhttp3:okhttp:4.9.0") }

  1. 创建OkHttpClient实例 OKHttpClient是执行请求的核心类。它是线程安全的，通常在整个应用中创建一个单例的OkHttpClient实例进行复用。

import okhttp3.OkHttpClient;

public class HttpClient { private static OkHttpClient client;

public static OkHttpClient getClient() {
    if (client == null) {
        client = new OkHttpClient();
    }
    return client;
}

}

  1. 创建请求 Request对象表示一个HTTP请求，可以通过Request.Builder来构建请求。下面是一个简单的GET请求：

import okhttp3.Request;

public class HttpUtils {

public static Request createGetRequest(String url) {
    return new Request.Builder()
            .url(url) // 设置请求url
            .build(); // 构建请求
}

}

  1. 执行请求 执行请求可以通过同步（execute）或异步（enqueue）的方式进行。

同步请求： 同步请求会阻塞当前线程直到收到响应。适用于不需要在UI线程中进行的任务（如后台任务）。

import okhttp3.Response; import java.io.IOException;

public class HttpUtils {

public static String executeRequest(Request request) throws IOException {
    OkHttpClient client = HttpClient.getClient(); // 获取OkHttpClient实例
    Response response = client.newCall(request).execute(); // 执行请求
    if (response.isSuccessful()) {
        return response.body().string(); // 返回响应体内容
    } else {
        return null; // 请求失败，返回null
    }
}

}

异步请求： 异步请求不会阻塞线程，可以在请求完成后通过回调来处理响应。

import okhttp3.Callback; import okhttp3.Response; import java.io.IOException;

public class HttpUtils {

public static void executeRequestAsync(Request request, Callback callback) {
    OkHttpClient client = HttpClient.getClient();
    client.newCall(request).enqueue(callback); // 异步执行请求
}

}

  1. 回调处理 当使用异步请求时，你需要实现Callback接口来处理响应。这里是一个异步请求的例子：

import okhttp3.Call; import okhttp3.Callback; import okhttp3.Response; import java.io.IOException;

public class HttpUtils {

public static void executeRequestAsync(Request request) {
    OkHttpClient client = HttpClient.getClient();
    client.newCall(request).enqueue(new Callback() {
        @Override
        public void onFailure(Call call, IOException e) {
            // 请求失败的回调
            e.printStackTrace();
        }

        @Override
        public void onResponse(Call call, Response response) throws IOException {
            if (response.isSuccessful()) {
                // 请求成功的回调
                String responseBody = response.body().string();
                System.out.println(responseBody);
            }
        }
    });
}

}

三、请求方法：GET、POST、PUT、DELETE OKHttp支持多种HTTP请求方法，下面分别介绍如何发送GET、POST、PUT、DELETE请求。

  1. GET 请求 GET请求用于从服务器获取资源。

import okhttp3.Request;

public class HttpUtils {

public static void sendGetRequest(String url) throws IOException {
    Request request = new Request.Builder()
            .url(url)
            .build(); // 构建GET请求

    String response = executeRequest(request); // 执行请求
    System.out.println(response); // 输出响应结果
}

}

  1. POST 请求 POST请求用于向服务器发送数据。

import okhttp3.FormBody; import okhttp3.Request;

public class HttpUtils {

public static void sendPostRequest(String url, String param1, String param2) throws IOException {
    FormBody formBody = new FormBody.Builder()
            .add("param1", param1)
            .add("param2", param2)
            .build(); // 构建POST请求体

    Request request = new Request.Builder()
            .url(url)
            .post(formBody) // 设置POST请求方法
            .build();

    String response = executeRequest(request);
    System.out.println(response);
}

}

  1. PUT 请求 PUT请求用于更新资源。

import okhttp3.RequestBody; import okhttp3.Request;

public class HttpUtils {

public static void sendPutRequest(String url, String jsonBody) throws IOException {
    RequestBody body = RequestBody.create(jsonBody, MediaType.parse("application/json; charset=utf-8"));
    Request request = new Request.Builder()
            .url(url)
            .put(body) // 使用PUT方法
            .build();

    String response = executeRequest(request);
    System.out.println(response);
}

}

  1. DELETE 请求 DELETE请求用于删除服务器上的资源。

import okhttp3.Request;

public class HttpUtils {

public static void sendDeleteRequest(String url) throws IOException {
    Request request = new Request.Builder()
            .url(url)
            .delete() // 设置DELETE请求方法
            .build();

    String response = executeRequest(request);
    System.out.println(response);
}

}

四、添加请求头和处理响应

  1. 添加请求头 你可以使用Request.Builder的addHeader方法向请求中添加自定义请求头。

import okhttp3.Request;

public class HttpUtils {

public static void sendRequestWithHeaders(String url) throws IOException {
    Request request = new Request.Builder()
            .url(url)
            .addHeader("Authorization", "Bearer your-token") // 添加自定义header
            .build();

    String response = executeRequest(request);
    System.out.println(response);
}

}

  1. 处理响应 响应包含了状态码、响应体等信息。你可以通过Response对象获取这些数据。

import okhttp3.Response; import java.io.IOException;

public class HttpUtils {

public static String getResponseBody(Response response) throws IOException {
    if (response.isSuccessful()) {
        return response.body().string(); // 获取响应体
    } else {
        return "Request failed with status code: " + response.code();
    }
}

}

五、总结 在本篇教程中，我们详细介绍了如何使用OKHttpClient进行HTTP请求。OKHttp提供了强大且易用的功能，可以帮助我们轻松处理HTTP请求和响应。我们学习了如何使用GET、POST、PUT、DELETE等方法，并介绍了如何添加请求头、处理响应以及如何发送同步和异步请求。

OKHttpClient的核心优势： 高效：支持连接池、HTTP/2等优化，提高网络请求的效率。 灵活：支持同步与异步请求，可以通过回调机制处理网络请求结果。 简单易用：提供简洁的API接口，易于集成与使用。 OKHttp是一个功能强大的HTTP客户端，适用于需要高效网络请求的Java和Android项目。如果你还没有使用过，推荐在项目中尝试一下。

avatar
文章
阅读
粉丝