一行代码搞定 HTTP 请求,强得离谱~

OKHttpUtil

Java的世界中,Http客户端之前一直是Apache家的HttpClient占据主导,但是由于此包较为庞大,API又比较难用,因此并不使用很多场景。而新兴的OkHttp、Jodd-http固然好用,但是面对一些场景时,学习成本还是有一些的。

很多时候,我们想追求轻量级的Http客户端,并且追求简单易用。而OKHttp是一套处理 HTTP 网络请求的依赖库,由 Square 公司设计研发并开源,目前可以在 Java 和 Kotlin 中使用。

对于 Android App来说,OkHttp 现在几乎已经占据了所有的网络请求操作,对于服务器端请求外部接口也是必备的选择 。针对OKHttp,OkHttpUtil做了一层封装,使Http请求变得无比简单。

OKHttpUtil 功能

  • 根据URL自动判断是请求HTTP还是HTTPS,不需要单独写多余的代码。
  • 默认情况下Cookie自动记录,比如可以实现模拟登录,即第一次访问登录URL后后续请求就是登录状态。
  • 自动识别304跳转并二次请求
  • 支持代理配置
  • 支持referer配置
  • 支持User-Agent配置
  • 自动识别并解压Gzip格式返回内容
  • 支持Springboot 配置文件
  • 极简的封装调用

OKHttpUtil使用

maven引入

<dependency>  
    <groupId>io.github.admin4j</groupId>  
    <artifactId>http</artifactId>  
    <version>0.4.0</version>  
</dependency>  

最新版查询:

https://search.maven.org/artifact/io.github.admin4j/http

GET

最简单的使用莫过于用HttpUtil工具类快速请求某个接口:

Response response = HttpUtil.get("https://github.com/search", Pair.of("q""okhttp"));  
System.out.println("response = " + response);  

POST

一行代码即可搞定,当然Post请求也很简单:

# JSON 格式的body  
Response post = HttpUtil.post("https://oapi.dingtalk.com/robot/send?access_token=27f5954ab60ea8b2e431ae9101b1289c138e85aa6eb6e3940c35ee13ff8b6335""{"msgtype": "text","text": {"content":"【反馈提醒】我就是我, 是不一样的烟火"}}");  
System.out.println("post = " + post);  
  
# form 请求  
Map<String, Object> formParams = new HashMap<>(16);  
formParams.put("username""admin");  
formParams.put("password""admin123");  
Response response = HttpUtil.postForm("http://192.168.1.13:9100/auth/login",  
                formParams  
);  
System.out.println("response = " + response);  

返回格式为JSON的 可以使用 HttpJsonUtil 自动返回JsonObject

JSONObject object=HttpJsonUtil.get("https://github.com/search",  
Pair.of("q","http"),  
Pair.of("username","agonie201218"));  
System.out.println("object = "+object);  

文件上传

File file=new File("C:\Users\andanyang\Downloads\Sql.txt");  
Map<String, Object> formParams=new HashMap<>();  
formParams.put("key","test");  
formParams.put("file",file);  
formParams.put("token","WXyUseb-D4sCum-EvTIDYL-mEehwDtrSBg-Zca7t:qgOcR2gUoKmxt-VnsNb657Oatzo=:eyJzY29wZSI6InpoYW56aGkiLCJkZWFkbGluZSI6MTY2NTMwNzUxNH0=");  
Response response=HttpUtil.upload("https://upload.qiniup.com/",formParams);  
System.out.println(response);  

下载文件

HttpUtil.down("https://gitee.com/admin4j/common-http","path/");  

HttpRequest 链式请求

# get  
Response response=HttpRequest.get("https://search.gitee.com/?skin=rec&type=repository")  
.queryMap("q","admin4j")  
.header(HttpHeaderKey.USER_AGENT,"admin4j")  
.execute();  
System.out.println("response = "+response);  
  
# post form  
Response response=HttpRequest.get("http://192.168.1.13:9100/auth/login")  
.queryMap("q","admin4j")  
.header(HttpHeaderKey.USER_AGENT,"admin4j")  
.form("username","admin")  
.form("password","admin123")  
.execute();  
System.out.println("response = "+response);  

post form 日志

16:49:14.092[main]DEBUG io.github.admin4j.http.core.HttpLogger- -->GET http://192.168.1.13:9100/auth/login?q=admin4j http/1.1  
16:49:14.094[main]DEBUG io.github.admin4j.http.core.HttpLogger-User-Agent:admin4j  
16:49:14.094[main]DEBUG io.github.admin4j.http.core.HttpLogger-Host:192.168.1.13:9100  
16:49:14.094[main]DEBUG io.github.admin4j.http.core.HttpLogger-Connection:Keep-Alive  
16:49:14.094[main]DEBUG io.github.admin4j.http.core.HttpLogger-Accept-Encoding:gzip  
16:49:14.094[main]DEBUG io.github.admin4j.http.core.HttpLogger- -->END GET  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-<--200OK http://192.168.1.13:9100/auth/login?q=admin4j (575ms)  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-transfer-encoding:chunked  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-Vary:Origin  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-Vary:Access-Control-Request-Method  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-Vary:Access-Control-Request-Headers  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-Vary:Origin  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-Vary:Access-Control-Request-Method  
16:49:14.670[main]DEBUG io.github.admin4j.http.core.HttpLogger-Vary:Access-Control-Request-Headers  
16:49:14.671[main]DEBUG io.github.admin4j.http.core.HttpLogger-Content-Type:application/json;charset=utf-8  
16:49:14.671[main]DEBUG io.github.admin4j.http.core.HttpLogger-Date:Tue,08Nov 2022 08:49:14GMT  
16:49:14.671[main]DEBUG io.github.admin4j.http.core.HttpLogger-  
16:49:14.671[main]DEBUG io.github.admin4j.http.core.HttpLogger-{"code":406,"msg":"Full authentication is required to access this resource"}  
16:49:14.671[main]DEBUG io.github.admin4j.http.core.HttpLogger-<--END HTTP(76-byte body)  
response=Response{protocol=http/1.1,code=200,message=OK,url=http://192.168.1.13:9100/auth/login?q=admin4j}  

SpringBoot 中使用

maven引入

<dependency>  
    <groupId>io.github.admin4j</groupId>  
    <artifactId>common-http-starter</artifactId>  
    <version>0.4.0</version>  
</dependency>  

最新版查询 io.github.admin4j:common-http-starter

spring 版可以对 OkHttp进行个性化配置

配置详见

public class HttpConfig {  
    /**  
     * 日志等级  
     */
  
    private HttpLoggingInterceptor.Level loggLevel = HttpLoggingInterceptor.Level.BODY;  
  
    /**  
     * 读取超时时间,秒  
     */
  
    private long readTimeout = 30;  
    /**  
     * 链接超时时间  
     */
  
    private long connectTimeout = 30;  
  
    private boolean followRedirects = false;  
  
    /**  
     * 最大的连接数  
     */
  
    private int maxIdleConnections = 5;  
  
    /**  
     * 最大的kepAlive 时间 秒  
     */
  
    private long keepAliveDuration = 5;  
  
    private String userAgent = "OKHTTP";  
    /**  
     * 是否支持cookie  
     */
  
    private boolean cookie = false;  
    private ProxyConfig proxy;  
  
  
    @Data  
    public static class ProxyConfig {  
  
        private Proxy.Type type = Proxy.Type.HTTP;  
        private String host;  
        private Integer port = 80;  
        private String userName;  
        private String password;  
    }  
}  

如何快速封装外部接口

以实体项目为例,封装 ebay接口

public class EbayClient extends ApiJsonClient {  
  
    /**  
     * 店铺配置  
     *  
     * @param storeId  
     */
  
    public EbayClient(Long storeId) {  
  
        //TODO 获取店铺相关配置  
        Map<String, String> config = new HashMap<>();  
  
        basePath = "https://api.ebay.com";  
        defaultHeaderMap.put("Authorization""Bearer " + config.get("accessToken"));  
        defaultHeaderMap.put("X-EBAY-C-MARKETPLACE-ID", config.get("marketplaceId"));  
    }  
}  

EbayClient 封装ebay api请求 基础类

/**  
 * ebay 库存相关api  
 * @author andanyang  
 */
  
public class EbayInventoryClient extends EbayClient {  
  
    /**  
     * 店铺配置  
     *  
     * @param storeId  
     */
  
    public EbayInventoryClient(Long storeId) {  
        super(storeId);  
    }  
  
    /**  
     * 库存列表  
     *  
     * @param limit  
     * @param offset  
     * @return  
     * @throws IOException  
     */
  
    public JSONObject inventoryItem(Integer limit, Integer offset) throws IOException {  
  
        Map<String, Object> queryMap = new HashMap(2);  
        queryMap.put("limit", limit);  
        queryMap.put("offset", offset);  
        return get("/sell/inventory/v1/inventory_item", queryMap);  
    }  
}  

EbayInventoryClient 封装ebay 库存 api请求

使用

EbayInventoryClient ebayInventoryClient=new EbayInventoryClient(1L);  
JSONObject jsonObject=ebayInventoryClient.inventoryItem(0,10);  
/**  
 * 订单相关api  
 * @author andanyang  
 */
  
public class EbayOrderClient extends EbayClient {  
  
  
    /**  
     * 店铺配置  
     *  
     * @param storeId  
     */
  
    public EbayOrderClient(Long storeId) {  
        super(storeId);  
    }  
  
    /**  
     * 订单列表  
     *  
     * @param beginTime  
     * @param endTime  
     * @param limit  
     * @param offset  
     * @return  
     */
  
    public JSONObject orders(String beginTime, String endTime, int limit, int offset) {  
  
        final String path = "/sell/fulfillment/v1/order";  
  
        String filter = MessageFormat.format("lastmodifieddate:[{0}..{1}]", beginTime, endTime);  
  
        //  
        Map<String, Object> queryMap = new HashMap<>(8);  
        queryMap.put("filter", filter);  
        queryMap.put("limit", limit);  
        queryMap.put("offset", offset);  
  
        return get("/sell/inventory/v1/inventory_item", queryMap);  
    }  
}  

库存相关的使用EbayInventoryClient,订单相关的使用EbayOrderClient,是不是很清晰

源码位置:

  • https://github.com/admin4j/common-http

来源:blog.csdn.net/agonie201218/

article/details/127755025

推荐

Java面试题宝典

技术内卷群,一起来学习!!

一行代码搞定 HTTP 请求,强得离谱~

PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。“在看”支持我们吧!

原文始发于微信公众号(Java知音):一行代码搞定 HTTP 请求,强得离谱~

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/142008.html

(0)
小半的头像小半

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!