Java中使用 okhttp3 发送 Post 和 Get 请求

Java中使用 okhttp3 发送 Post 和 Get 请求

---

---

一、引入okhttp3的依赖

 <dependency>
     <groupId>com.squareup.okhttp3</groupId>
     <artifactId>okhttp</artifactId>
     <version>4.9.1</version>
 </dependency>

二、编写代码

	/**
	 * 发送 POST 请求
	 *
	 * @param url 请求的 URL
	 * @param params 请求参数的 Map
	 * @return 响应的 JSON 对象
	 * @throws IOException 如果请求失败
	 */
	public static JSONObject sendPostRequest(String url, Map<String, String> params) throws IOException {
		// 创建 OkHttpClient 实例
		OkHttpClient client = new OkHttpClient.Builder()
				.connectTimeout(30, TimeUnit.SECONDS)  // 设置连接超时时间
				.writeTimeout(30, TimeUnit.SECONDS)    // 设置写超时时间
				.readTimeout(60, TimeUnit.SECONDS)     // 设置读超时时间
				.build();

		RequestBody requestBody;
		if (params != null && !params.isEmpty()) {
			// 构建请求体
			FormBody.Builder formBuilder = new FormBody.Builder();
			// 将 Map 中的键值对添加到请求体中
			for (Map.Entry<String, String> entry : params.entrySet()) {
				formBuilder.add(entry.getKey(), entry.getValue());
			}
			requestBody = formBuilder.build();
		} else {
			// 如果没有参数，构建一个空的请求体
			requestBody = RequestBody.create("", null);
		}

		// 构建请求
		Request request = new Request.Builder()
				.url(url)          // 设置请求 URL
				.post(requestBody) // 设置请求方法为 POST，并传入请求体
				.build();

		// 发送请求并处理响应
		try (Response response = client.newCall(request).execute()) {
			if (response.isSuccessful()) {
				// 如果响应成功，返回响应体字符串并解析为 JSON 对象
				String data = Objects.requireNonNull(response.body()).string();
				return new JSONObject(data);
			} else {
				// 如果响应失败，抛出异常
				throw new IOException("Unexpected code " + response);
			}
		}
	}


	/**
	 * 发送 GET 请求
	 *
	 * @param url 请求的 URL
	 * @param params 请求参数的 Map
	 * @return 响应的 JSON 对象
	 * @throws IOException 如果请求失败
	 */
	public static JSONObject sendGetRequest(String url, Map<String, String> params) throws IOException {
		// 创建 OkHttpClient 实例
		OkHttpClient client = new OkHttpClient.Builder()
				.connectTimeout(30, TimeUnit.SECONDS)  // 设置连接超时时间
				.writeTimeout(30, TimeUnit.SECONDS)    // 设置写超时时间
				.readTimeout(60, TimeUnit.SECONDS)     // 设置读超时时间
				.build();

		// 构建带参数的 URL
		String fullUrl = buildUrlWithParams(url, params);

		// 构建请求
		Request request = new Request.Builder()
				.url(fullUrl)      // 设置请求 URL
				.get()             // 设置请求方法为 GET
				.build();

		// 发送请求并处理响应
		try (Response response = client.newCall(request).execute()) {
			if (response.isSuccessful()) {
				// 如果响应成功，返回响应体字符串并解析为 JSON 对象
				String data = Objects.requireNonNull(response.body()).string();
				return new JSONObject(data);
			} else {
				// 如果响应失败，抛出异常
				throw new IOException("Unexpected code " + response);
			}
		}
	}


	/**
	 * 构建带参数的 URL
	 *
	 * @param url 基础 URL
	 * @param params 参数的 Map
	 * @return 带参数的完整 URL
	 */
	private static String buildUrlWithParams(String url, Map<String, String> params) {
		if (params == null || params.isEmpty()) {
			return url;
		}

		StringBuilder urlBuilder = new StringBuilder(url);
		if (!url.contains("?")) {
			urlBuilder.append("?");
		} else if (!url.endsWith("&") && !url.endsWith("?")) {
			urlBuilder.append("&");
		}

		try {
			for (Map.Entry<String, String> entry : params.entrySet()) {
				urlBuilder.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8.name()));
				urlBuilder.append("=");
				urlBuilder.append(URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8.name()));
				urlBuilder.append("&");
			}
		} catch (IOException e) {
			throw new RuntimeException("Error encoding URL parameters", e);
		}

		urlBuilder.setLength(urlBuilder.length() - 1); // 移除最后一个 "&"

		return urlBuilder.toString();
	}

三、调用示例

public static void main(String[] args) {
        // 请求 URL
        String postUrl = "https://example.com/api";
        String getUrl = "https://example.com/api";

        // 请求参数
        Map<String, String> params = Map.of(
                "param1", "value1",
                "param2", "value2"
        );

        // 发送 POST 请求
        try {
            JSONObject postResponse = sendPostRequest(postUrl, params);
            System.out.println("POST Response: " + postResponse.toString());
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 发送 GET 请求
        try {
            JSONObject getResponse = sendGetRequest(getUrl, params);
            System.out.println("GET Response: " + getResponse.toString());
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 发送不带参数的 POST 请求
        try {
            JSONObject postResponseNoParams = sendPostRequest(postUrl, null);
            System.out.println("POST Response without params: " + postResponseNoParams.toString());
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 发送不带参数的 GET 请求
        try {
            JSONObject getResponseNoParams = sendGetRequest(getUrl, null);
            System.out.println("GET Response without params: " + getResponseNoParams.toString());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }