新聞中心
前言
在項(xiàng)目開發(fā)中,后端會(huì)經(jīng)常去請(qǐng)求一些已經(jīng)開發(fā)好的服務(wù)接口獲取數(shù)據(jù)。直接使用okhttp、httpClient發(fā)起http請(qǐng)求,既繁瑣又不方便統(tǒng)一管理。在這里推薦一個(gè)適用于Spring Boot項(xiàng)目的輕量級(jí)HTTP客戶端框架retrofit,使用非常簡(jiǎn)單方便。retrofit是一款類型安全的HTTP客戶端,其最大的特性的是支持通過(guò)接口的方式發(fā)起HTTP請(qǐng)求 。

成都創(chuàng)新互聯(lián)公司長(zhǎng)期為近千家客戶提供的網(wǎng)站建設(shè)服務(wù),團(tuán)隊(duì)從業(yè)經(jīng)驗(yàn)10年,關(guān)注不同地域、不同群體,并針對(duì)不同對(duì)象提供差異化的產(chǎn)品和服務(wù);打造開放共贏平臺(tái),與合作伙伴共同營(yíng)造健康的互聯(lián)網(wǎng)生態(tài)環(huán)境。為可克達(dá)拉企業(yè)提供專業(yè)的網(wǎng)站建設(shè)、做網(wǎng)站,可克達(dá)拉網(wǎng)站改版等技術(shù)服務(wù)。擁有十年豐富建站經(jīng)驗(yàn)和眾多成功案例,為您定制開發(fā)。
準(zhǔn)備
使用前期講到的Spring Boot可視化接口開發(fā)工具magic-api部署兩個(gè)http服務(wù)接口,不知道可視化接口開發(fā)工具的可以翻看前期的文章,這里不再過(guò)多說(shuō)明。
get接口
http://127.0.0.1:9999/user/select?id=15
post接口
http://127.0.0.1:9999/user/update
{
"id":15,
"name": "九天銀河聊編程",
"age": 35,
"address": "天津"
}
retrofit開發(fā)
引入依賴
org.springframework.boot
spring-boot-starter-test
test
配置文件
server:
port: 8080
retrofit:
global-log:
enable: true
log-level: info
HttpClient:
BaseUrl: "http://127.0.0.1:9999/"
編寫參數(shù)實(shí)體
根據(jù)接口的輸入?yún)?shù)編寫相關(guān)實(shí)體,代碼略!
http接口定義
@RetrofitClient(baseUrl = "${HttpClient.BaseUrl}")
public interface Api {
@GET("user/select")
Result1 getUser(@Query("id") Integer id);
@POST("user/update")
Result2 updateUser(@Body User user);
}
使用
@RestController
@RequestMapping("user/")
public class RetrofitController {
@Autowired
private Api api;
@GetMapping("/select")
public User[] select() {
Result1 result = api.getUser(15);
return result.getData();
}
@GetMapping("/update")
public String update() {
User user = new User();
user.setId(15);
user.setAge(35);
user.setName("九天銀河聊編程");
user.setAddress("天津");
Result2 result = api.updateUser(user);
return result.getData();
}
}
調(diào)用服務(wù)
控制臺(tái)輸出:
控制臺(tái)輸出:
大功告成,是不是很簡(jiǎn)單?
常用注解說(shuō)明
方法注解
|
@GET |
GET請(qǐng)求 |
|
@POST |
POST請(qǐng)求 |
|
@HTTP |
作用于方法,用于發(fā)送一個(gè) 自定義的HTTP請(qǐng)求 |
標(biāo)記注解
@FormUrlEncoded:
請(qǐng)求體是 From 表單 @POST比起@GET多了一個(gè)@FromUrlEncoded的注解。
@Multipart:
請(qǐng)求體是支持文件上傳的 From 表單
@Streaming:
響應(yīng)體的數(shù)據(jù)用流的形式返回,未使用該注解,默認(rèn)會(huì)把數(shù)據(jù)全部載入內(nèi)存,之后通過(guò)流獲取數(shù)據(jù)也是讀取內(nèi)存中數(shù)據(jù),所以返回?cái)?shù)據(jù)較大時(shí),需要使用該注解。
參數(shù)注解
@Query:
用于Get請(qǐng)求數(shù)據(jù),用于拼接在拼接在Url路徑后面的查詢參數(shù),一個(gè)@Query相當(dāng)于拼接一個(gè)參數(shù),多個(gè)參數(shù)中間用,隔開
@Body:
非表單請(qǐng)求體,是結(jié)合post請(qǐng)求的
@Field:
表單字段,@Field的用法類似于@Query,不同的是@Field主要用于Post請(qǐng)求數(shù)據(jù)。
@Part:
表單字段,與 PartMap 配合,適合文件上傳情況
@PartMap:
表單字段,與 Part 配合,適合文件上傳情況;默認(rèn)接受 Map
其它注解
@Url:
@Url是動(dòng)態(tài)的Url請(qǐng)求數(shù)據(jù)的注解。需要注意的是使用@Url時(shí),path對(duì)應(yīng)的路徑不能包含”/”,不然每個(gè)加到host Url后面的東西都會(huì)被省略掉。千萬(wàn)注意了
@Path:
@Path主要用于Get請(qǐng)求,用于替換Url路徑中的變量字符。
踩坑記錄
當(dāng)POST請(qǐng)求時(shí),@FormUrlEncoded和@Field簡(jiǎn)單的表單鍵值對(duì)。兩個(gè)需要結(jié)合使用,否則會(huì)報(bào)錯(cuò)。
其它調(diào)用例子
RestFul方式請(qǐng)求:
@GET("group/{id}/users")
Call> groupList(@Path("id") int groupId, @Query("sort") String sort);
map作為請(qǐng)求體:
@GET("group/{id}/users")
Call> groupList(@Path("id") int groupId, @QueryMap Map options);
表單提交:
@FormUrlEncoded
@POST("user/edit")
CallupdateUser(@Field("first_name") String first, @Field("last_name") String last);
Multipart請(qǐng)求:
@Multipart
@PUT("user/photo")
CallupdateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
高級(jí)應(yīng)用
注解式攔截器
對(duì)http請(qǐng)求執(zhí)行統(tǒng)一的攔截處理邏輯,基于url路徑的匹配攔截 。使用的步驟主要分為2步:
- 繼承BasePathMatchInterceptor編寫攔截處理器;
- 接口上使用@Intercept進(jìn)行標(biāo)注。如需配置多個(gè)攔截器,在接口上標(biāo)注多個(gè)@Intercept注解即可!
擴(kuò)展注解式攔截器
對(duì)攔截注解動(dòng)態(tài)傳入一些參數(shù),然后再執(zhí)行攔截的時(shí)候需要使用這個(gè)參數(shù)。自定義攔截注解必須使用@InterceptMark標(biāo)記,并且注解中必須包括include()、exclude()、handler()屬性信息 。使用的步驟主要分為3步:
- 自定義攔截注解
- 繼承BasePathMatchInterceptor編寫攔截處理器
- 接口上使用自定義攔截注解;
例如我們需要在請(qǐng)求頭里面動(dòng)態(tài)加入accessKeyId、accessKeySecret簽名信息才能正常發(fā)起http請(qǐng)求 ,這個(gè)時(shí)候可以自定義一個(gè)加簽攔截器注解@Sign來(lái)實(shí)現(xiàn)
請(qǐng)求重試
在接口或者方法上加上@Retry注解即可。@Retry支持重試次數(shù)maxRetries、重試時(shí)間間隔intervalMs以及重試規(guī)則retryRules配置
錯(cuò)誤解碼器
在HTTP發(fā)生請(qǐng)求錯(cuò)誤(包括發(fā)生異常或者響應(yīng)數(shù)據(jù)不符合預(yù)期)的時(shí)候,錯(cuò)誤解碼器可將HTTP相關(guān)信息解碼到自定義異常中。你可以在@RetrofitClient注解的errorDecoder()指定當(dāng)前接口的錯(cuò)誤解碼器,自定義錯(cuò)誤解碼器需要實(shí)現(xiàn)ErrorDecoder接口。
文章標(biāo)題:SpringBoot調(diào)用Http接口的簡(jiǎn)單方法
分享鏈接:http://www.dlmjj.cn/article/copeods.html


咨詢
建站咨詢
