本人推薦使用idea編譯器锤躁，不建議使用eclipse
以下2種依賴堪遂，自行選擇一種
1赏表、使用gradle添加依賴
【注：】需要在build.gradle添加jcenter()倉庫
compile 'com.circlq:http-api:1.2.0'
2喊废、使用pom文件添加依賴
<dependency>
<groupId>com.circlq</groupId>
<artifactId>http-api</artifactId>
<version>1.2.0</version>
</dependency>
使用pom依賴會(huì)有java版本問題糯累，這邊截圖兩張自己看下
image.png
image.png
只需要簡(jiǎn)單的2步驟就能實(shí)現(xiàn)請(qǐng)求。
定義接口
//@DealAll
@DealClass(HttpDealMethodImpl.class)
@NetServiceClass("")
public interface NetService {
/**
* get的簡(jiǎn)單請(qǐng)求
*/
@GET("http://api.sdwhcn.com:5056/v1/temple")
String get(@Query("page")int page ,@Query("limit")int limit ,@Query("recommend")String recommend);
/**
* get請(qǐng)求(URL中帶有參數(shù))
*/
@GET("http://api.sdwhcn.com:5056/{version}/temple")
String get(@Path("version") String version, @Query("page")int page ,@Query("limit")int limit ,@Query("recommend")String recommend);
/**
* 表單提交
*/
@POST("http://a.szy.com:4480/SignManageServer/sign/appHandle")
String postForm(@Field("reqcode") String reqcode);
/**
* json提交
*/
@POST("http://public.api.fashionworldcn.com/api/my/login")
String postJson(@Param("mobile") String mobile, @Param("password") String password);
/**
* json 整串提交
*/
@POST("http://public.api.fashionworldcn.com/api/my/login")
String postJson(@Body String json);
/**
* json 實(shí)體類提交
*/
@POST("http://public.api.fashionworldcn.com/api/my/login")
String postJson(@Body LoginBuild json);
/**
* put 提交
*/
@PUT("http://api.sdwhcn.com:5056/v1/member")
String put(@Header("Authorization") String header, @Query("nickname") String nickname,@Query("signature") String signature,@Query("area") String area);
/**
* delete 提交
*/
@DELETE("http://api.sdwhcn.com:5056/v1/member_collect_article/{id}")
String delete(@Header("Authorization") String header, @Path("id") String id);
/**
* 文件下載
* 【注意】 文件下載的傳參比較特殊在辆，@Param 的key是按照服務(wù)端的字段來填寫的证薇，
* 而文件下載不需要，所以@Param 的keykey是固定的匆篓，
* filepath 代表文件路徑浑度，必填
* filename 代表文件名稱，如果下載沒帶后綴鸦概，可自行加上后綴箩张。
*/
@DOWNLOAD("https://ztjyupdate.ztjy61.com/333897c77ec9a86605006679c7a4b418-ZTJY")
void download(@Param("filepath") String filepath, @Param("filename") String filename, ProgressCallBack callBack);
/**
* 單張圖片上傳
*【注意】 @Param 的key 跟文件下載一樣是固定寫法
* @param filepath 代表文件路徑，必填
* @param filekey 代表文件key，必填
* @param filename 代表文件名稱 選填
*/
@UPLOAD("http://api.sdwhcn.com:5056/v1/member/avatar")
@Headers("Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjY4MDFmZjE1NTdlNWJhMzkzY2RlM2U0NjRiMGM0MzQ3MDkwNWYzMDYwZTZhZDFkOTQ4NTIyY2I3NDI2YjY0ZDFmODBiOWJkODY0YmEyM2UxIn0.eyJhdWQiOiIyIiwianRpIjoiNjgwMWZmMTU1N2U1YmEzOTNjZGUzZTQ2NGIwYzQzNDcwOTA1ZjMwNjBlNmFkMWQ5NDg1MjJjYjc0MjZiNjRkMWY4MGI5YmQ4NjRiYTIzZTEiLCJpYXQiOjE1NjEzNjI2ODcsIm5iZiI6MTU2MTM2MjY4NywiZXhwIjoxNTYxNDQ5MDg3LCJzdWIiOiIxIiwic2NvcGVzIjpbIioiXX0.RXUUxeLvYkkk1V-pmu-120N5JejjaDmTfG0zO0Zu3lMc5OChjlSvDiKm2jW6geCIp2gZeOrkC4HBNpSngjKue_v1l1UyyYudOofTZV3DUlF-hwhhwMJ2RKxp6yq2ecGfxCcg3ZED1dp0dAjmqmNCGUZViykQctSQC7FI3KXQeL-96wQj6G9YnN0n2sVOkeH2m1AYR2YjkXFW3C-lMujiqbfoH0i_DyRWqmvnH4IS67L8Ec0dWBNgWbDWyrO6Za6z9Im6VHfeqVkVYbvFdKrN8mtNuQQ0oioG_6vvuLE9zV-p2YT1t_WogqieFJHb9C6t9QZCqDopU7QBKiczoSk72tMffL0j_Byn1TlG7TlN0nvtnBB1kScz6tI6SvlkwgPOvHneBX-CHiDHPAlS_GOsnh1j5hVn1eRMbPS728sQpsTlVJ4WOpDP9AO1u4JG2ViU-4gohtpN5Lkc7FFbz30MSpi3aQQxXRjHslA--4Hbc-fqD1TjqgUyNfF4xK_paSUgihHwygIqNUeI6MuCltKKJCUR4eeNXItXPl9_GxSsWPYpetIw-0yFHwdrTWvr4fmy-gdteNrAtOv6DwDvGsgw52vnqoX8Sev_yWg9FBGKnFcRLIyMfkw9_7UQEn0-P9v0kqLxf63xk3QnGtdlhZNLA8l3OapCpHkYeZgcEX9UQFU")
void upload(@Param("filepath") String filepath, @Param("filekey") String filekey , @Param("filename") String filename, ProgressCallBack callBack);
/**
* 多圖上傳
* 【注意】 @Param 的key 跟文件下載一樣是固定寫法
* @param filepath 代表文件路徑先慷，必填
* @param filekey 代表文件key饮笛，必填
* @param filename 代表文件名稱 選填
* @param callBack
*/
@UPLOAD("http://api.sdwhcn.com:5056/v1/member/avatar")
@Headers("Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjY4MDFmZjE1NTdlNWJhMzkzY2RlM2U0NjRiMGM0MzQ3MDkwNWYzMDYwZTZhZDFkOTQ4NTIyY2I3NDI2YjY0ZDFmODBiOWJkODY0YmEyM2UxIn0.eyJhdWQiOiIyIiwianRpIjoiNjgwMWZmMTU1N2U1YmEzOTNjZGUzZTQ2NGIwYzQzNDcwOTA1ZjMwNjBlNmFkMWQ5NDg1MjJjYjc0MjZiNjRkMWY4MGI5YmQ4NjRiYTIzZTEiLCJpYXQiOjE1NjEzNjI2ODcsIm5iZiI6MTU2MTM2MjY4NywiZXhwIjoxNTYxNDQ5MDg3LCJzdWIiOiIxIiwic2NvcGVzIjpbIioiXX0.RXUUxeLvYkkk1V-pmu-120N5JejjaDmTfG0zO0Zu3lMc5OChjlSvDiKm2jW6geCIp2gZeOrkC4HBNpSngjKue_v1l1UyyYudOofTZV3DUlF-hwhhwMJ2RKxp6yq2ecGfxCcg3ZED1dp0dAjmqmNCGUZViykQctSQC7FI3KXQeL-96wQj6G9YnN0n2sVOkeH2m1AYR2YjkXFW3C-lMujiqbfoH0i_DyRWqmvnH4IS67L8Ec0dWBNgWbDWyrO6Za6z9Im6VHfeqVkVYbvFdKrN8mtNuQQ0oioG_6vvuLE9zV-p2YT1t_WogqieFJHb9C6t9QZCqDopU7QBKiczoSk72tMffL0j_Byn1TlG7TlN0nvtnBB1kScz6tI6SvlkwgPOvHneBX-CHiDHPAlS_GOsnh1j5hVn1eRMbPS728sQpsTlVJ4WOpDP9AO1u4JG2ViU-4gohtpN5Lkc7FFbz30MSpi3aQQxXRjHslA--4Hbc-fqD1TjqgUyNfF4xK_paSUgihHwygIqNUeI6MuCltKKJCUR4eeNXItXPl9_GxSsWPYpetIw-0yFHwdrTWvr4fmy-gdteNrAtOv6DwDvGsgw52vnqoX8Sev_yWg9FBGKnFcRLIyMfkw9_7UQEn0-P9v0kqLxf63xk3QnGtdlhZNLA8l3OapCpHkYeZgcEX9UQFU")
void upload(@Param("filepath") String[] filepath, @Param("filekey") String[] filekey , @Param("filename") String[] filename, ProgressCallBack callBack);
/**
* 請(qǐng)求跟返回經(jīng)過統(tǒng)一特殊處理。
*/
@POST("http://a.szy.com:4480/SignManageServer/sign/appHandle")
@Deal
String onDeal(@Field("reqcode")String reqcode,@Param("pageNo") String pageNo, @Param("pageSize") String pageSize, @Param("schoolId") String schoolId);
}
}
執(zhí)行請(qǐng)求论熙，返回類型支持java實(shí)體類福青，只需要在方法返回類型String換成java實(shí)體類，它會(huì)自動(dòng)給你轉(zhuǎn)化成實(shí)體類脓诡。
/**
* 表單提交
*/
public static void postForm() {
String result = HttpRequest.getNetService().postForm("10960");
log.info("postForm :" + result);
}
/**
* json提交
*/
public static void postJson() {
String mobile = "15060568265";
String password = "e10adc3949ba59abbe56e057f20f883e";
String result = HttpRequest.getNetService().postJson(mobile, password);
log.info("postJson :" + result);
}
強(qiáng)大的Json解析器
我們可以看到返回類型支持java實(shí)體類跟String類型无午，但是這邊建議使用String類型
然后解析的時(shí)候使用JsonUtils類，這是一個(gè)強(qiáng)大解析器
直接
int forum_id = JsonUtils.parse(json,Integer.class,"notice","forum_id");
我們可以看到直接解析出第二層forum_id里面的數(shù)據(jù)誉券，直接轉(zhuǎn)換成int類型指厌，
如果需要轉(zhuǎn)換實(shí)體類，直接在第二個(gè)參數(shù)改成 類名.class ,然后指定那一層就解析那一層數(shù)據(jù)轉(zhuǎn)化成實(shí)體類踊跟。
這樣是不是很方便踩验。
該例子是以同步請(qǐng)求為demo，如果需要異步請(qǐng)求則看下面的進(jìn)行下載demo查看
下面講解下商玫，如何使用箕憾。
1、添加依賴
compile 'com.circlq:http-api:1.2.0'
2拳昌、定義接口
如一張圖袭异，創(chuàng)建一個(gè)接口類，下面給一個(gè)完整接口定義炬藤，包含（get提交御铃，表單提交，json提交沈矿，還有統(tǒng)一接口處理）
@DealClass(HttpDealMethodImpl.class)
//@DealAll
@NetServiceClass("")
public interface NetService {
/**
* get的簡(jiǎn)單請(qǐng)求
*/
@GET("https://qybeta.321go.com/api/v1/home/index")
String get(@Query("cid") String cid, @Query("token") String token);
/**
* get請(qǐng)求(URL中帶有參數(shù))
*/
@GET("https://qybeta.321go.com/api/{version}/home/index")
String get(@Path("version") String version, @Query("cid") String cid, @Query("token") String token);
/**
* 表單提交
*/
@POST("https://marathonbeta.321go.com/api/v5/assis/user")
String postForm(@Field("token") String token, @Field("auid") String auid, @Field("step") String step, @Field("formId") String formId);
/**
* json提交
*/
@POST("http://public.api.fashionworldcn.com/api/my/login")
String postJson(@Param("mobile") String mobile, @Param("password") String password);
/**
* json 整串提交
*/
@POST("http://public.api.fashionworldcn.com/api/my/login")
String postJson(@Body String json);
/**
* json 實(shí)體類提交
*/
@POST("http://public.api.fashionworldcn.com/api/my/login")
String postJson(@Body LoginBuild json);
/**
* 請(qǐng)求跟返回經(jīng)過統(tǒng)一特殊處理上真。
*/
@POST("http://a.szy.com:4480/SignManageServer/sign/appHandle")
@Deal
String onDeal(@Field("reqcode") String reqcode, @Param("pageNo") String pageNo, @Param("pageSize") String pageSize, @Param("schoolId") String schoolId);
}
3、初始化NetService 類
public class HttpRequest {
private static NetService netService;
public static NetService getNetService() {
try {
if (netService == null) {
synchronized (HttpRequest.class) {
if (netService == null) {
netService = (NetService) Class.forName(ElementUtils.getImplName(NetService.class))
.getConstructor().newInstance();
}
}
}
} catch (Exception e) {
e.printStackTrace();
}
return netService;
}
}
4羹膳、然后就是用上面的的類直接獲取NetService 來調(diào)用請(qǐng)求睡互，HttpRequest.getNetService().postForm()
5、注解的使用陵像，我們按照第2點(diǎn)的定義接口的圖片按順序一個(gè)個(gè)解釋就珠，
NetServiceClass
@NetServiceClass("") ： 創(chuàng)建接口類的時(shí)候，這句話是必備的醒颖，括號(hào)里面可以填寫你們公司的域名妻怎，如：
@NetServiceClass("http://a.szy.com:4480/")
Query
用于retrofit就了解他的用法图贸，就是拼接在url后面的參數(shù)蹂季，如上圖的接口冕广，使用Query后疏日，url變成：
https://qybeta.321go.com/api/v1/home/index?cid=xxxxxx&token=xxxxx
Path
也是跟retrofit 一樣偿洁，就說我們url的中間有些值是動(dòng)態(tài)的，如圖的urlhttps://qybeta.321go.com/api/v1/home/index中的v1是動(dòng)態(tài)的沟优，寫法就是把v1寫成{version}涕滋，然后在參數(shù)@Path("version") String version 就可以動(dòng)態(tài)替換了
Field
看注釋我們寫著表單提交，那就是用于提交表單的字段
Param
這個(gè)retrofit 是沒有的挠阁，看注釋是用于json提交宾肺，但是只限制一層的json,
Body
@Body String json 就是用于整串的json格式
@Body LoginBuild json 就是json字符串轉(zhuǎn)化成實(shí)體類進(jìn)行隘谣，這個(gè)可能會(huì)很經(jīng)常使用
Deal增拥，
/**
* 請(qǐng)求跟返回經(jīng)過統(tǒng)一特殊處理。
*/
@POST("http://a.szy.com:4480/SignManageServer/sign/appHandle")
@Deal
String onDeal(@Field("reqcode")String reqcode,@Param("pageNo") String pageNo, @Param("pageSize") String pageSize, @Param("schoolId") String schoolId);
我們看到最后一個(gè)接口寻歧，我們有用到@Deal 掌栅，@Field ，@Param码泛，是不是很混亂猾封，
我們先來看下我們公司的請(qǐng)求：
我們每個(gè)接口都要自帶一個(gè)Cookies,然后提交是表單提交，然后有固定的值噪珊，又有變化的值晌缘，然后每個(gè)接口都需要，那我豈不是每次寫接口的時(shí)候痢站，每次都要寫這些參數(shù)磷箕，是不是很復(fù)雜，瑟押，最關(guān)鍵的body里面的值竟然是json傳搀捷。這種接口不封裝下豈能忍。
我們看到第2點(diǎn)的定義接口圖多望，最上面一行代碼嫩舟，如果不需統(tǒng)一處理，這句話可以不用寫怀偷，【注意這個(gè)類一定要實(shí)現(xiàn)HttpDealMethod接口家厌，不然他會(huì)提示你報(bào)錯(cuò)∽倒ぃ】
@DealClass(HttpDealMethodImpl.class)
然后在我們的定義接口的方法饭于，打上@Deal這樣的標(biāo)記蜀踏，就是代表該接口請(qǐng)求的時(shí)候要處理下，如果你需要每個(gè)接口都需要處理掰吕，那就在類上面打上@DealAll 代表該類下果覆，所以的接口請(qǐng)求，都需要統(tǒng)一處理殖熟。
如：
@POST("http://a.szy.com:4480/SignManageServer/sign/appHandle")
@Deal
String onDeal(@Field("reqcode")String reqcode,@Param("pageNo") String pageNo, @Param("pageSize") String pageSize, @Param("schoolId") String schoolId);
@NetServiceClass("")
@DealClass(HttpDealMethodImpl.class)
@DealAll
public interface NetService {
然后我們看下HttpDealMethodImpl類局待，就實(shí)現(xiàn)統(tǒng)一處理的類。
**
* 統(tǒng)一處理方法跟回調(diào)
*/
public class HttpDealMethodImpl implements HttpDealMethod {
@Override
public void init(OkHttpClient okHttpClient) {
}
/**
* 處理請(qǐng)求
* 如果處理后菱属，各種字段都有钳榨，則會(huì)優(yōu)先表單請(qǐng)求，然后再者json請(qǐng)求
* 注意一定要return dealParams 不然不處理
*/
@Override
public DealParams dealRequest(DealParams dealParams) {
//設(shè)置Cookie
Map<String, String> headers = dealParams.getHeaders();
headers.put("Cookie","JSESSIONID=AE7B1C9D73D448EEAECF5EC8363C55B0"
+ ";ClientVersion=6.8.1");
dealParams.setHeaders(headers);
//設(shè)置表單參數(shù)
Map<String, String> mapField = dealParams.getMapField();
mapField.put("reqcodeversion","6.8");
//獲取@Params里的參數(shù)纽门，然后設(shè)置成json串薛耻，設(shè)置到表單body里
Map<String, String> mapParams = dealParams.getParams();
JSONObject jb = new JSONObject();
String json = "";
for (Map.Entry<String, String> entry : mapParams.entrySet()) {
try {
jb.put(entry.getKey(), entry.getValue());
} catch (JSONException e) {
}
}
json = jb.toString();
mapField.put("body",json);
dealParams.setMapField(mapField);
return dealParams;
}
/**
* 處理回調(diào),
* 如果要設(shè)置返回錯(cuò)誤，則new CallBack(-1,"請(qǐng)求失敗") 赏陵，第一個(gè)參數(shù)不能為0即可饼齿，0代表成功
* 如果要請(qǐng)求成功，直接 new CallBack(json)
* return null 則不做任何處理
*/
@Override
public CallBack dealCallBack(String str) {
String json = null;
try {
JSONObject jsonObject = JSON.parseObject(str);
json = jsonObject.getString("body");
} catch (JSONException e) {
e.printStackTrace();
}
// return new CallBack(-1,"請(qǐng)求失敗");
return new CallBack(json);
}
}
我們看到兩個(gè)實(shí)現(xiàn)方法瘟滨，分別是dealRequest候醒，跟dealCallBack ，處理請(qǐng)求跟處理回調(diào)杂瘸。
我們?cè)偃タ聪挛覀児菊?qǐng)求圖片倒淫，需要每個(gè)接口添加Cookie
然后我們就在dealRequest里，看到
//設(shè)置Cookie
Map<String, String> headers = dealParams.getHeaders();
headers.put("Cookie","JSESSIONID=AE7B1C9D73D448EEAECF5EC8363C55B0"
+ ";ClientVersion=6.8.1");
dealParams.setHeaders(headers);
這樣我們就可以為我們需要的接口添加Cookie败玉，然后我們公司接口請(qǐng)求再去看下參數(shù)敌土，reqcodeversion是固定，然后直接
//設(shè)置表單參數(shù)
Map<String, String> mapField = dealParams.getMapField();
mapField.put("reqcodeversion","6.8");
body里面就有的復(fù)雜了运翼，我們?cè)賮砜聪率窃趺炊x接口返干，跟請(qǐng)求的圖片
/**
* 請(qǐng)求跟返回經(jīng)過統(tǒng)一特殊處理。
*/
@POST("http://a.szy.com:4480/SignManageServer/sign/appHandle")
@Deal
String onDeal(@Field("reqcode")String reqcode,@Param("pageNo") String pageNo, @Param("pageSize") String pageSize, @Param("schoolId") String schoolId);
image.png
我們看到參數(shù)里面有2種注解
@Field 跟,@Param
因?yàn)槲覀兘涌谑潜韱窝剩瑀eqcode是動(dòng)態(tài)變化的
所以@Field("reqcode")String reqcode,只要好理解矩欠，然后body里面的是一個(gè)json串，
這時(shí)候我們就可以使用@Param悠夯，這時(shí)候的@Param不再是上面解釋的那樣用于json提交癌淮。而是自定義參數(shù)，只要你們公司有規(guī)律性沦补，那么就可以用@Param乳蓄，因?yàn)槟阋呀?jīng)設(shè)置了統(tǒng)一處理，所以@Param變身為夕膀，任意形態(tài)的參數(shù)虚倒。
我們可以看到dealRequest里面dealParams.getParams();獲取@Param里的所以字段值美侦，然后循環(huán)取出里面的字段，轉(zhuǎn)換成json串魂奥，然后添加到body的里面菠剩，然后在dealParams.setMapField(mapField);設(shè)置表單的值，捧弃，這樣我們請(qǐng)求不必要寫的就不需要寫了赠叼，擦囊，簡(jiǎn)單的傳遞幾個(gè)參數(shù)就可以违霞，，具體的邏輯按你們公司的來瞬场，這里只是簡(jiǎn)單的舉個(gè)我們公司的例子买鸽。
dealCallBack
然后還要一個(gè)dealCallBack用于處理回調(diào)，比如我們可以在這里面統(tǒng)一處理下服務(wù)器返回的字段下是正確還是錯(cuò)誤贯被，然后取出你指定下的字段值眼五，比如我們公司的，我只取出body里面的參數(shù)進(jìn)行返回彤灶，其他參數(shù)不需要看幼。
init用于初始化，目前功能暫未開放幌陕，下次版本再弄诵姜，就是初始化一些參數(shù)，比如超時(shí)時(shí)間之類的設(shè)置
哦對(duì)了還一個(gè)注解忘記講了搏熄，那就是頭部棚唆，用法就
@GET("https://qybeta.321go.com/api/v1/home/index")
@Headers({"Content-Type:application/json; charset=utf-8"
,"Content-Type:application/json; charset=utf-8"})
String get(@Query("cid") String cid, @Query("token") String token);
如果是動(dòng)態(tài)的話那就是，弄在參數(shù)里面
@GET("https://qybeta.321go.com/api/v1/home/index")
String get(@Header("Content-Type")String headType, @Query("cid") String cid, @Query("token") String token);
如果不需要同步心例，需要異步的話宵凌，那就是吧String返回類型改成void類型，添加參數(shù)DataCallBack callBack
如：
@POST("https://marathonbeta.321go.com/api/v5/assis/user")
void postForm(@Field("token") String token, @Field("auid") String auid, @Field("step") String step, @Field("formId") String formId,DataCallBack callBack);
