微信公眾號:馮文議(ID:fwy-world)
HTTP請求,在日常開發(fā)中,還是比較常見的,今天給大家分享HttpUtils如何使用。
閱讀本文,你將收獲:
- 簡單總結(jié)HTTP請求常用配置;
- JavaLib中HttpUtils如何使用;
- 如何封裝HTTP請求工具類。
第一部分:簡單總結(jié)HTTP請求常用配置
大家好,在 Java 開發(fā)中,經(jīng)常遇到需要調(diào)用第三方提供的接口服務(wù),常見的形式是 HTTP + JSON,下面,就對 http 請求常見的設(shè)置,做一個說明
http提供多種請求方式,以滿足我們?nèi)粘P枰劝凑埱蠓绞絹碜稣f明:
- GET
- POST
- PUT
- PATCH
- DELETE
在 RESTful API 開發(fā)中,我們可以根據(jù)這些請求方式設(shè)計我們的API接口。舉例:
- GET:獲取資源
- POST:提交資源
- PUT:更新完整資源
- PATCH:更新部分資源
- DELETE:刪除資源
參數(shù)格式
- form表單
- json
其他
- 超時時間設(shè)置
第二部分:使用JavaLib的HttpUtils
簡單的get請求
System.out.println(HttpUtils.get("https://www.baidu.com"));
響應(yīng)結(jié)果:
<!DOCTYPE html><!--STATUS OK--><html> <head><meta http-equiv=content-type content=text/html;charset=utf-8><meta http-equiv=X-UA-Compatible content=IE=Edge><meta content=always name=referrer><link rel=stylesheet type=text/css href=https://ss1.bdstatic.com/5eN1bjq8AAUYm2zgoY3K/r/www/cache/bdorz/baidu.min.css><title>百度一下,你就知道</title></head> <body link=#0000cc> <div id=wrapper> <div id=head> <div class=head_wrapper> <div class=s_form> <div class=s_form_wrapper> <div id=lg> <img hidefocus=true src=//www.baidu.com/img/bd_logo1.png width=270 height=129> </div> <form id=form name=f action=//www.baidu.com/s class=fm> <input type=hidden name=bdorz_come value=1> <input type=hidden name=ie value=utf-8> <input type=hidden name=f value=8> <input type=hidden name=rsv_bp value=1> <input type=hidden name=rsv_idx value=1> <input type=hidden name=tn value=baidu><span class="bg s_ipt_wr"><input id=kw name=wd class=s_ipt value maxlength=255 autocomplete=off autofocus=autofocus></span><span class="bg s_btn_wr"><input type=submit id=su value=百度一下 class="bg s_btn" autofocus></span> </form> </div> </div> <div id=u1> <a href=http://news.baidu.com name=tj_trnews class=mnav>新聞</a> <a href=https://www.hao123.com name=tj_trhao123 class=mnav>hao123</a> <a href=http://map.baidu.com name=tj_trmap class=mnav>地圖</a> <a href=http://v.baidu.com name=tj_trvideo class=mnav>視頻</a> <a href=http://tieba.baidu.com name=tj_trtieba class=mnav>貼吧</a> <noscript> <a href=http://www.baidu.com/bdorz/login.gif?login&tpl=mn&u=http%3A%2F%2Fwww.baidu.com%2f%3fbdorz_come%3d1 name=tj_login class=lb>登錄</a> </noscript> <script>document.write('<a + encodeURIComponent(window.location.href+ (window.location.search === "" ? "?" : "&")+ "bdorz_come=1")+ '" name="tj_login" class="lb">登錄</a>'); </script> <a href=//www.baidu.com/more/ name=tj_briicon class=bri style="display: block;">更多產(chǎn)品</a> </div> </div> </div> <div id=ftCon> <div id=ftConw> <p id=lh> <a href=http://home.baidu.com>關(guān)于百度</a> <a href=http://ir.baidu.com>About Baidu</a> </p> <p id=cp>©2017 Baidu <a href=http://www.baidu.com/duty/>使用百度前必讀</a> <a href=http://jianyi.baidu.com/ class=cp-feedback>意見反饋</a> 京ICP證030173號 <img src=//www.baidu.com/img/gs.gif> </p> </div> </div> </div> </body> </html>
通過簡單嘗試,證明兩點:
- 一是,這個還是可以使用的;
- 二是,原來使用如此簡單。
如果要你手寫一個http請求,或許你腦海里一篇空白,會去搜索各種資料。
我們再試一個復(fù)雜的
接口:
接口地址:https://erwin-api.fengwenyi.com/erwin/blog/page
請求方法:GET
參數(shù):currentPage,pageSize
參數(shù)格式:form
響應(yīng):application/json
String url = "https://erwin-api.fengwenyi.com/erwin/bookmark/page?currentPage=1&pageSize=10";
Request request = new Request();
request.setUrl(url);
request.setMethod(Request.Method.GET);
Map<String, String> headerMap = new HashMap<>();
headerMap.put("Accept", "application/json");
Request.Option option = new Request.Option();
option.setHeaders(headerMap);
try {
System.out.println(HttpUtils.execute(request, option));
} catch (IOException e) {
throw new RuntimeException(e);
}
響應(yīng)結(jié)果:
{
"code":"SUCCESS",
"message":"Success",
"success":true,
"header":null,
"body":{
"currentPage":1,
"pageSize":10,
"totalRows":661,
"totalPages":67,
"content":[
{
"id":"1634772578877935617",
"timestamp":1678595130000,
"enabledState":null,
"name":"VScode 中文顯示出現(xiàn)黃色方框的解決方法_vscode漢字被框住_YJer的博客-CSDN博客",
"url":"https://blog.csdn.net/qq_33249042/article/details/123252625",
"icon":null,
"classifyName":"軟件",
"classifyId":"1522587269600481281"
},
{
"id":"1632640455110922241",
"timestamp":1678086792000,
"enabledState":null,
"name":"Spring中init-method和destroy-method的四種方式_星夜孤帆的博客-CSDN博客",
"url":"https://blog.csdn.net/qq_38826019/article/details/117387398",
"icon":null,
"classifyName":"Spring",
"classifyId":"1522586360887742466"
},
{
"id":"1631597310596190209",
"timestamp":1677838087000,
"enabledState":null,
"name":"vue3 + elemenplus實現(xiàn)導(dǎo)航欄 - 掘金",
"url":"https://juejin.cn/post/7084871748608327687",
"icon":null,
"classifyName":"前端",
"classifyId":"1525554881275990018"
},
{
"id":"1631593154401636354",
"timestamp":1677837096000,
"enabledState":null,
"name":"Spring bean 創(chuàng)建過程源碼解析 - 騰訊云開發(fā)者社區(qū)-騰訊云",
"url":"https://cloud.tencent.com/developer/article/1631160",
"icon":null,
"classifyName":"Spring",
"classifyId":"1522586360887742466"
},
{
"id":"1631592987673858050",
"timestamp":1677837056000,
"enabledState":null,
"name":"SpringBoot之容器啟動源碼分析與Bean加載_springboot加載bean 源碼_minemine0418的博客-CSDN博客",
"url":"https://blog.csdn.net/minemine0418/article/details/102308912",
"icon":null,
"classifyName":"Spring Boot",
"classifyId":"1522586446766116865"
},
{
"id":"1631586585454678018",
"timestamp":1677835530000,
"enabledState":null,
"name":"Spring-Bean生命周期 - 知乎",
"url":"https://zhuanlan.zhihu.com/p/158468104",
"icon":null,
"classifyName":"Spring",
"classifyId":"1522586360887742466"
},
{
"id":"1631579732104548354",
"timestamp":1677833896000,
"enabledState":null,
"name":"一文讀懂 Spring Bean 的生命周期_spring bean的生命周期_老周聊架構(gòu)的博客-CSDN博客",
"url":"https://blog.csdn.net/riemann_/article/details/118500805",
"icon":null,
"classifyName":"Spring",
"classifyId":"1522586360887742466"
},
{
"id":"1630768897186697218",
"timestamp":1677640578000,
"enabledState":null,
"name":"MySQL同時統(tǒng)計多個條件的記錄條數(shù)_ztnhnr的博客-CSDN博客",
"url":"https://blog.csdn.net/ztnhnr/article/details/107165942",
"icon":null,
"classifyName":"MySQL",
"classifyId":"1522586805693681666"
},
{
"id":"1630768792098410497",
"timestamp":1677640553000,
"enabledState":null,
"name":"sql查詢近七天,近兩周,近一個月的數(shù)據(jù)_sql最近一周數(shù)據(jù)_心誠則靈'的博客-CSDN博客",
"url":"https://blog.csdn.net/wenchangwenliu/article/details/119891790",
"icon":null,
"classifyName":"MySQL",
"classifyId":"1522586805693681666"
},
{
"id":"1630480535938764801",
"timestamp":1677571827000,
"enabledState":null,
"name":"開源流程引擎哪個好,如何選型? - 知乎",
"url":"https://zhuanlan.zhihu.com/p/369761832",
"icon":null,
"classifyName":"Java",
"classifyId":"1522586296119300097"
}
]
}
}
響應(yīng)結(jié)果,還是符合預(yù)期的。
當然,HTTP還有其他,比如超時等等,下面看看完整版的請求示例:
Map<String, Object> paramMap = new HashMap<>();
paramMap.put("currentPage", 1);
paramMap.put("pageSize", 10);
Map<String, String> headerMap = new HashMap<>();
headerMap.put("Accept", "application/json");
Request request = new Request();
request.setUrl("https://erwin-api.fengwenyi.com/erwin/bookmark/page");
request.setParam(paramMap);
request.setMethod(Request.Method.GET);
request.setUtil(Request.Util.OkHttp);
Request.Option option = new Request.Option();
option.setHeaders(headerMap);
option.setConnectTimeoutSecond(3);
option.setReadTimeoutSecond(5);
option.setLogLevel(Request.LogLevel.DEBUG);
try {
String result = HttpUtils.execute(request, option);
System.out.println(result);
} catch (IOException e) {
throw new RuntimeException(e);
}
響應(yīng)結(jié)果也是跟上面一樣的。
第三部分:分享HttpUtils是如何封裝的
首先是 Request
和 Response
對應(yīng)HTTP的請求和響應(yīng),包路徑如下:
- com.fengwenyi.javalib.http.Request
- com.fengwenyi.javalib.http.Response
另外,com.fengwenyi.javalib.http.Request.Option
來存放HTTP參數(shù)配置。
這一部分的思路來源是 Spring Cloud OpenFeign。
為了兼容多種HTTP工具實現(xiàn)請求,引入了 HttpClientFactory
,其他工具類,只要實現(xiàn) HttpClient
接口,就行。
- com.fengwenyi.javalib.http.client.HttpClient
- com.fengwenyi.javalib.http.client.HttpClientFactory
歐克,下面我們就以代碼來看看:
HttpUtils#execute
public static String execute(Request request, Request.Option option) throws IOException {
check(request);
HttpClient httpClient = HttpClientFactory.get(request.getUtil());
Response response = httpClient.execute(request, option);
return handleResponse(response);
}
HttpClientFactory#get
public static HttpClient get(Request.Util httpUtil) {
if (Request.Util.JDK == httpUtil) {
return new JdkHttpClient();
} else if (Request.Util.OkHttp == httpUtil) {
return new OkHttpClient();
} else {
throw new RuntimeException("not find http util: " + httpUtil.name());
}
}
所以,只需要實現(xiàn) HttpClient#execute
接口就行。
Response execute(Request request, Request.Option option) throws IOException;
源碼:https://github.com/fengwenyi/JavaLib
好了,今天的分享就到這里了。我是小馮,一名Java程序員,專注于程序設(shè)計和開發(fā),如果你在開發(fā)上遇到問題,歡迎一起交流,微信公眾號:馮文議(ID:fwy-world)。