okhttp在java中的使用

本文介绍了OkHttp库的设计理念及其实现方式,重点讲解如何利用OkHttp进行高效的网络请求操作。文章提供了详细的代码示例,包括如何配置OkHttp客户端、发起GET、POST请求等,并展示了如何处理请求和响应的日志。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

OkHttp 库的设计和实现的首要目标是高效。这也是选择 OkHttp 的重要理由之一。OkHttp 提供了对最新的 HTTP 协议版本 HTTP/2 和 SPDY 的支持,这使得对同一个主机发出的所有请求都可以共享相同的套接字连接。如果 HTTP/2 和 SPDY 不可用,OkHttp 会使用连接池来复用连接以提高效率。OkHttp 提供了对 GZIP 的默认支持来降低传输内容的大小。OkHttp 也提供了对 HTTP 响应的缓存机制,可以避免不必要的网络请求。

废话不说。看代码

先加入jar

	<!-- https://mvnrepository.com/artifact/com.squareup.okhttp3/okhttp -->
		<dependency>
			<groupId>com.squareup.okhttp3</groupId>
			<artifactId>okhttp</artifactId>
			<version>3.7.0</version>
            <!-- 在java中使用,要把android依赖排除掉-->
			<exclusions>
				<exclusion>
					<groupId>com.google.android</groupId>
					<artifactId>android</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

这里为了方面,我引入了lombok。lombok是啥?使用Lombok可以减少很多重复代码的书写。比如说getter/setter/toString等方法的编写。这里不过多介绍,可以自行百度。当然不用也是没有问题的

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.0</version>
		</dependency>

 

okhttp工具类,拿来直接可用:

/*
 * 文件名:OkHttpUtil.java 版权:Copyright by www.poly.com 描述: 修改人:gogym 修改时间:2018年7月30日 跟踪单号: 修改单号: 修改内容:
 */

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;

import lombok.Builder;
import lombok.ToString;

import org.apache.commons.collections.MapUtils;
import org.apache.commons.lang.ArrayUtils;
import org.springframework.util.StringUtils;

import com.alibaba.fastjson.JSON;
import com.poly.rbl.exception.GlobalException;

import okhttp3.ConnectionPool;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

/**
 * 
 * okhttp请求类
 * @author gogym
 * @version 2018年8月2日
 * @see OkHttpUtil
 * @since
 */
public class OkHttpUtil
{

    public final static String GET = "GET";

    public final static String POST = "POST";

    public final static String PUT = "PUT";

    public final static String DELETE = "DELETE";

    public final static String PATCH = "PATCH";

    private final static String UTF8 = "UTF-8";

    private final static String GBK = "GBK";

    private final static String DEFAULT_CHARSET = UTF8;

    private final static String DEFAULT_METHOD = GET;

    private final static String DEFAULT_MEDIA_TYPE = "application/json";

    private final static boolean DEFAULT_LOG = false;

    private final static OkHttpClient client = new OkHttpClient.Builder().connectionPool(
        new ConnectionPool(20, 5, TimeUnit.MINUTES)).readTimeout(20, TimeUnit.SECONDS).connectTimeout(
        20, TimeUnit.SECONDS).build();

    
    
    //测试一波
    public static void main(String[] args)
    {
        Map<String, String> map = new HashMap<>();
        map.put("k", "v");
        try
        {
            String s = execute(OkHttp.builder().url("http://www.baidu.com").method(GET).requestLog(
                true).responseLog(true).build());
            System.out.println(s);
        }
        catch (Exception e)
        {
            e.printStackTrace();
        }
    }

    /**
     * GET请求
     * 
     * @param url
     *            URL地址
     * @return
     */
    public static String get(String url)
        throws Exception
    {
        return execute(OkHttp.builder().url(url).build());
    }

    /**
     * GET请求
     * 
     * @param url
     *            URL地址
     * @return
     */
    public static String get(String url, String charset)
        throws Exception
    {
        return execute(OkHttp.builder().url(url).responseCharset(charset).build());
    }

    /**
     * 带查询参数的GET查询
     * 
     * @param url
     *            URL地址
     * @param queryMap
     *            查询参数
     * @return
     */
    public static String get(String url, Map<String, String> queryMap)
        throws Exception
    {
        return execute(OkHttp.builder().url(url).queryMap(queryMap).build());
    }

    /**
     * 带查询参数的GET查询
     * 
     * @param url
     *            URL地址
     * @param queryMap
     *            查询参数
     * @return
     */
    public static String get(String url, Map<String, String> queryMap, String charset)
        throws Exception
    {
        return execute(OkHttp.builder().url(url).queryMap(queryMap).responseCharset(charset).build());
    }

    /**
     * POST application/json
     * 
     * @param url
     * @param obj
     * @return
     */
    public static String postJson(String url, Object obj)
        throws Exception
    {
        return execute(OkHttp.builder().url(url).method(POST).data(JSON.toJSONString(obj)).mediaType(
            "application/json").build());
    }

    /**
     * POST application/x-www-form-urlencoded
     * 
     * @param url
     * @param formMap
     * @return
     */
    public static String postForm(String url, Map<String, String> formMap)
        throws Exception
    {
        String data = "";
        if (MapUtils.isNotEmpty(formMap))
        {
            data = formMap.entrySet().stream().map(
                entry -> String.format("%s=%s", entry.getKey(), entry.getValue())).collect(
                Collectors.joining("&"));
        }
        return execute(OkHttp.builder().url(url).method(POST).data(data).mediaType(
            "application/x-www-form-urlencoded").build());
    }

    private static String post(String url, String data, String mediaType, String charset)
        throws Exception
    {
        return execute(OkHttp.builder().url(url).method(POST).data(data).mediaType(mediaType).responseCharset(
            charset).build());
    }

    /**
     * 通用执行方法
     */
    private static String execute(OkHttp okHttp)
        throws Exception
    {
        if (StringUtils.isEmpty(okHttp.requestCharset))
        {
            okHttp.requestCharset = DEFAULT_CHARSET;
        }
        if (StringUtils.isEmpty(okHttp.responseCharset))
        {
            okHttp.responseCharset = DEFAULT_CHARSET;
        }
        if (StringUtils.isEmpty(okHttp.method))
        {
            okHttp.method = DEFAULT_METHOD;
        }
        if (StringUtils.isEmpty(okHttp.mediaType))
        {
            okHttp.mediaType = DEFAULT_MEDIA_TYPE;
        }
        if (okHttp.requestLog)
        {// 记录请求日志
            LoggerUtils.info(OkHttpUtil.class, okHttp.toString());
        }

        // 获取请求URL
        String url = okHttp.url;
        // 创建请求
        Request.Builder builder = new Request.Builder();

        if (MapUtils.isNotEmpty(okHttp.queryMap))
        {
            String queryParams = okHttp.queryMap.entrySet().stream().map(
                entry -> String.format("%s=%s", entry.getKey(), entry.getValue())).collect(
                Collectors.joining("&"));
            url = String.format("%s%s%s", url, url.contains("?") ? "&" : "?", queryParams);
        }
        builder.url(url);

        // 设置请求头
        if (MapUtils.isNotEmpty(okHttp.headerMap))
        {
            okHttp.headerMap.forEach(builder::addHeader);
        }

        // 设置请求类型
        String method = okHttp.method.toUpperCase();
        String mediaType = String.format("%s;charset=%s", okHttp.mediaType, okHttp.requestCharset);

        if (method.equals(GET))
        {
            builder.get();
        }
        else if (ArrayUtils.contains(new String[] {POST, PUT, DELETE, PATCH}, method))
        {
            RequestBody requestBody = RequestBody.create(MediaType.parse(mediaType), okHttp.data);
            builder.method(method, requestBody);
        }
        else
        {
            throw new GlobalException("未设置请求method");
        }

        // 返回值
        String result = "";
        try
        {
            Response response = client.newCall(builder.build()).execute();
            byte[] bytes = response.body().bytes();
            result = new String(bytes, okHttp.responseCharset);
            if (okHttp.responseLog)
            {// 记录返回日志
                LoggerUtils.info(OkHttpUtil.class, result);
            }
        }
        catch (Exception e)
        {
            LoggerUtils.error(OkHttpUtil.class, e.getMessage(), e);
        }
        return result;
    }

    /**
     * 一个内部类
     * 
     * @author gogym
     * @version 2018年7月30日
     * @see OkHttp
     * @since
     */

    @Builder
    @ToString(exclude = {"requestCharset", "responseCharset", "requestLog", "responseLog"})
    static class OkHttp
    {
        private String url;

        private String method = DEFAULT_METHOD;

        private String data;

        private String mediaType = DEFAULT_MEDIA_TYPE;

        private Map<String, String> queryMap;

        private Map<String, String> headerMap;

        private String requestCharset = DEFAULT_CHARSET;

        private boolean requestLog = DEFAULT_LOG;

        private String responseCharset = DEFAULT_CHARSET;

        private boolean responseLog = DEFAULT_LOG;
    }

}

 

 

 

 

### 如何在Java项目中使用OkHttp发起HTTP请求 #### 添加依赖项 为了能够在Java项目中使用OkHttp库,需要先引入Maven或Gradle中的相应依赖。对于Maven构建工具而言,在`pom.xml`文件内加入如下配置[^1]: ```xml <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>4.9.3</version> </dependency> ``` 而对于采用Gradle作为构建系统的项目,则应在`build.gradle`里添加下面这行代码来声明对外部库的依赖关系[^2]: ```groovy implementation 'com.squareup.okhttp3:okhttp:4.9.3' ``` #### 创建同步GET请求实例 当完成上述准备工作之后就可以编写简单的程序片段来进行一次基本的GET方式访问远程服务器资源的操作了。这里给出一段完整的例子用于说明怎样通过同步调用来获取网页内容并打印到控制台上显示出来。 ```java import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; public class OkHttpGetExample { public static void main(String[] args) throws Exception { OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.example.com") .build(); try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) throw new RuntimeException("Request failed with code " + response.code()); System.out.println(response.body().string()); } } } ``` 这段代码展示了创建一个`OkHttpClient`对象以及定义了一个指向目标URL地址的新建请求的过程;接着执行该请求并将返回的结果封装成`Response`类的形式处理。如果响应状态码表示成功则读取其主体部分的数据流转换为字符串形式输出给用户查看[^3]。 #### 发起异步POST请求样例 除了支持阻塞式的I/O操作外,OkHttp还允许开发者利用回调机制实现非阻塞性质的任务调度模式——即所谓的“异步”。下面提供了一段关于如何发送带有JSON负载体参数表单数据类型的POST方法调用的实际应用场景下的源代码: ```java import okhttp3.Call; import okhttp3.Callback; import okhttp3.MediaType; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.RequestBody; import okhttp3.Response; import java.io.IOException; public class OkHttpPostAsyncExample { private final OkHttpClient client = new OkHttpClient(); public void run() throws IOException, InterruptedException { MediaType JSON = MediaType.get("application/json; charset=utf-8"); String json = "{\"name\":\"John\",\"age\":30}"; RequestBody body = RequestBody.create(json, JSON); Request request = new Request.Builder() .url("https://jsonplaceholder.typicode.com/posts") .post(body) .build(); Call call = client.newCall(request); call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e){ e.printStackTrace(); // Handle error here. } @Override public void onResponse(Call call, Response response)throws IOException{ if(!response.isSuccessful()){ throw new IOException("Unexpected code "+ response); }else{ System.out.println(response.body().string()); // Process successful response here. } } }); Thread.sleep(5000); // Wait for the asynchronous operation to complete. } } ``` 此案例中不仅包含了设置自定义头部信息的功能而且还实现了错误情况下的异常捕获逻辑以便于更好地管理和维护整个应用程序生命周期内的稳定性与可靠性[^4]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值