參考:https://blog.csdn.net/fightingxia/article/details/70947701
一,OKHttp介紹
okhttp是一個第三方類庫峡迷,用于android中請求網(wǎng)絡(luò)。
如果想了解原碼可以在github上下載票编,地址是:https://github.com/square/okhttp
在線集成依賴包并添加網(wǎng)絡(luò)權(quán)限:
app\build.grade中:
dependencies里添加
implementation 'com.squareup.okhttp3:okhttp:3.9.1'
manifest中:
<uses-permission android:name="android.permission.INTERNET"></uses-permission>
二,get請求的使用方法
使用OKHttp進(jìn)行網(wǎng)絡(luò)請求支持兩種方式,一種是同步請求闺魏,一種是異步請求非洲。下面分情況進(jìn)行介紹鸭限。
1,get的同步請求
對于同步請求在請求時需要開啟子線程两踏,請求成功后需要跳轉(zhuǎn)到UI線程修改UI败京。
使用示例如下:
public void getDatasync(){
new Thread(new Runnable() {
@Override
public void run() {
try {
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象
Request request = new Request.Builder()
.url("http://www.baidu.com")//請求接口。如果需要傳參拼接到接口后面梦染。
.build();//創(chuàng)建Request 對象
Response response = null;
response = client.newCall(request).execute();//得到Response 對象
if (response.isSuccessful()) {
Log.d("kwwl","response.code()=="+response.code());
Log.d("kwwl","response.message()=="+response.message());
Log.d("kwwl","res=="+response.body().string());
//此時的代碼執(zhí)行在子線程赡麦,修改UI的操作請使用handler跳轉(zhuǎn)到UI線程。
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
此時打印結(jié)果如下:
response.code()==200帕识;
response.message()==OK泛粹;
res=={“code”:200,”message”:success};
注意事項:
1,Response.code是http響應(yīng)行中的code渡冻,如果訪問成功則返回200.這個不是服務(wù)器設(shè)置的戚扳,而是http協(xié)議中自帶的。res中的code才是服務(wù)器設(shè)置的族吻。注意二者的區(qū)別帽借。
2,response.body().string()本質(zhì)是輸入流的讀操作超歌,所以它還是網(wǎng)絡(luò)請求的一部分砍艾,所以這行代碼必須放在子線程。
3巍举,java.lang.IllegalStateException: closed
調(diào)用了兩次response.body().string()脆荷。流已經(jīng)關(guān)閉,所以無法再進(jìn)行操作。
ResponseBody 類的string()方法的源代碼如下:
public final String string() throws IOException {
BufferedSource source = source();
try {
Charset charset = Util.bomAwareCharset(source, charset());
return source.readString(charset);
} finally {
Util.closeQuietly(source);
}
}
注意finally中的Util.closeQuietly(source);它是一個關(guān)閉流的工具方法懊悯。
2蜓谋,get的異步請求
這種方式不用再次開啟子線程,但回調(diào)方法是執(zhí)行在子線程中炭分,所以在更新UI時還要跳轉(zhuǎn)到UI線程中桃焕。
使用示例如下:
private void getDataAsync() {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("http://www.baidu.com")
.build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
if(response.isSuccessful()){//回調(diào)的方法執(zhí)行在子線程。
Log.d("kwwl","獲取數(shù)據(jù)成功了");
Log.d("kwwl","response.code()=="+response.code());
Log.d("kwwl","response.body().string()=="+response.body().string());
}
}
});
}
異步請求的打印結(jié)果與注意事項與同步請求時相同捧毛。最大的不同點(diǎn)就是異步請求不需要開啟子線程观堂,enqueue方法會自動將網(wǎng)絡(luò)請求部分放入子線程中執(zhí)行让网。
注意事項:
1,回調(diào)接口的onFailure方法和onResponse執(zhí)行在子線程师痕。
2溃睹,response.body().string()方法也必須放在子線程中。當(dāng)執(zhí)行這行代碼得到結(jié)果后胰坟,再跳轉(zhuǎn)到UI線程修改UI因篇。
三,post請求的使用方法
Post請求也分同步和異步兩種方式腕铸,同步與異步的區(qū)別和get方法類似惜犀,所以此時只講解post異步請求的使用方法。
使用示例如下:
private void postDataWithParame() {
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象狠裹。
FormBody.Builder formBody = new FormBody.Builder();//創(chuàng)建表單請求體
formBody.add("username","zhangsan");//傳遞鍵值對參數(shù)
Request request = new Request.Builder()//創(chuàng)建Request 對象。
.url("http://www.baidu.com")
.post(formBody.build())//傳遞請求體
.build();
client.newCall(request).enqueue(new Callback() {汽烦。涛菠。。});//回調(diào)方法的使用與get異步請求相同撇吞,此時略俗冻。
}
看完代碼我們會發(fā)現(xiàn):post請求中并沒有設(shè)置請求方式為POST,回憶在get請求中也沒有設(shè)置請求方式為GET牍颈,那么是怎么區(qū)分請求方式的呢迄薄?重點(diǎn)是Request.Builder類的post方法,在Request.Builder對象創(chuàng)建最初默認(rèn)是get請求煮岁,所以在get請求中不需要設(shè)置請求方式讥蔽,當(dāng)調(diào)用post方法時把請求方式修改為POST。所以此時為POST請求画机。
四冶伞,POST請求傳遞參數(shù)的方法總結(jié)
在post請求使用方法中講了一種傳遞參數(shù)的方法,就是創(chuàng)建表單請求體對象步氏,然后把表單請求體對象作為post方法的參數(shù)响禽。post請求傳遞參數(shù)的方法還有很多種,但都是通過post方法傳遞的荚醒。下面我們看一下Request.Builder類的post方法的聲明:
public Builder post(RequestBody body)1
由方法的聲明可以看出芋类,post方法接收的參數(shù)是RequestBody 對象,所以只要是RequestBody 類以及子類對象都可以當(dāng)作參數(shù)進(jìn)行傳遞界阁。FormBody就是RequestBody 的一個子類對象侯繁。
1,使用FormBody傳遞鍵值對參數(shù)
這種方式用來上傳String類型的鍵值對
使用示例如下:
private void postDataWithParame() {
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象铺董。
FormBody.Builder formBody = new FormBody.Builder();//創(chuàng)建表單請求體
formBody.add("username","zhangsan");//傳遞鍵值對參數(shù)
Request request = new Request.Builder()//創(chuàng)建Request 對象巫击。
.url("http://www.baidu.com")
.post(formBody.build())//傳遞請求體
.build();
client.newCall(request).enqueue(new Callback() {禀晓。。坝锰。});//此處省略回調(diào)方法粹懒。
}
2,使用RequestBody傳遞Json或File對象
RequestBody是抽象類顷级,故不能直接使用凫乖,但是他有靜態(tài)方法create,使用這個方法可以得到RequestBody對象弓颈。
這種方式可以上傳Json對象或File對象帽芽。
上傳json對象使用示例如下:
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象。
MediaType JSON = MediaType.parse("application/json; charset=utf-8");//數(shù)據(jù)類型為json格式翔冀,
String jsonStr = "{"username":"lisi","nickname":"李四"}";//json數(shù)據(jù).
RequestBody body = RequestBody.create(JSON, josnStr);
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {导街。。纤子。});//此處省略回調(diào)方法搬瑰。1
上傳File對象使用示例如下:
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象。
MediaType fileType = MediaType.parse("File/*");//數(shù)據(jù)類型為json格式控硼,
File file = new File("path");//file對象.
RequestBody body = RequestBody.create(fileType , file );
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {泽论。。卡乾。});//此處省略回調(diào)方法翼悴。1
3,使用MultipartBody同時傳遞鍵值對參數(shù)和File對象
這個字面意思是多重的body幔妨。我們知道FromBody傳遞的是字符串型的鍵值對鹦赎,RequestBody傳遞的是多媒體,那么如果我們想二者都傳遞怎么辦陶冷?此時就需要使用MultipartBody類钙姊。
使用示例如下:
OkHttpClient client = new OkHttpClient();
MultipartBody multipartBody =new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("groupId",""+groupId)//添加鍵值對參數(shù)
.addFormDataPart("title","title")
.addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/*"), file))//添加文件
.build();
final Request request = new Request.Builder()
.url(URLContant.CHAT_ROOM_SUBJECT_IMAGE)
.post(multipartBody)
.build();
client.newCall(request).enqueue(new Callback() {。埂伦。煞额。});
4,自定義RequestBody實現(xiàn)流的上傳
在上面的分析中我們知道沾谜,只要是RequestBody類以及子類都可以作為post方法的參數(shù)膊毁,下面我們就自定義一個類,繼承RequestBody基跑,實現(xiàn)流的上傳婚温。
使用示例如下:
首先創(chuàng)建一個RequestBody類的子類對象:
RequestBody body = new RequestBody() {
@Override
public MediaType contentType() {
return null;
}
@Override
public void writeTo(BufferedSink sink) throws IOException {//重寫writeTo方法
FileInputStream fio= new FileInputStream(new File("fileName"));
byte[] buffer = new byte[1024*8];
if(fio.read(buffer) != -1){
sink.write(buffer);
}
}
};
然后使用body對象:
OkHttpClient client = new OkHttpClient();//創(chuàng)建OkHttpClient對象。
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {媳否。栅螟。荆秦。});
以上代碼的與眾不同就是body對象,這個body對象重寫了write方法力图,里面有個sink對象步绸。這個是OKio包中的輸出流,有write方法吃媒。使用這個方法我們可以實現(xiàn)上傳流的功能瓤介。
使用RequestBody上傳文件時,并沒有實現(xiàn)斷點(diǎn)續(xù)傳的功能赘那。我可以使用這種方法結(jié)合RandomAccessFile類實現(xiàn)斷點(diǎn)續(xù)傳的功能刑桑。
五,設(shè)置請求頭
OKHttp中設(shè)置請求頭特別簡單募舟,在創(chuàng)建request對象時調(diào)用一個方法即可祠斧。
使用示例如下:
Request request = new Request.Builder()
.url("http://www.baidu.com")
.header("User-Agent", "OkHttp Headers.java")
.addHeader("token", "myToken")
.build();1
其他部分代碼略。
六胃珍,下載文件
在OKHttp中并沒有提供下載文件的功能梁肿,但是在Response中可以獲取流對象,有了流對象我們就可以自己實現(xiàn)文件的下載觅彰。代碼如下:
這段代碼寫在回調(diào)接口CallBack的onResponse方法中:
try{
InputStream is = response.body().byteStream();//從服務(wù)器得到輸入流對象
long sum = 0;
File dir = new File(mDestFileDir);
if (!dir.exists()){
dir.mkdirs();
}
File file = new File(dir, mdestFileName);//根據(jù)目錄和文件名得到file對象
FileOutputStream fos = new FileOutputStream(file);
byte[] buf = new byte[1024*8];
int len = 0;
while ((len = is.read(buf)) != -1){
fos.write(buf, 0, len);
}
fos.flush();
return file;
}
七,對于OKHttp的使用封裝
由于okhttp是偏底層的網(wǎng)絡(luò)請求類庫钮热,返回結(jié)果的回調(diào)方法仍然執(zhí)行在子線程中填抬,需要自己跳轉(zhuǎn)到UI線程,使用麻煩隧期。為了使用方便需要對OKHttp進(jìn)行再次封裝飒责。對于OKHttp的封裝首推的就是hongyang大神的OKHttpUtils。我個人在看過OKHttp的原碼和借鑒各大神的封裝源碼后封裝了一套自己的OKHttpUtils仆潮。這套OKHttpUtils最大的優(yōu)點(diǎn)是簡單和便于使用宏蛉,這是我項目中實際用的網(wǎng)絡(luò)請求工具類,完全可以說拿來即用性置。而且代碼簡單拾并,可供學(xué)習(xí)使用。
github的地址是:https://github.com/guozhengXia/OkHttpUtils
封裝的功能有:
- 一般的get請求
- 一般的post請求
- 上傳單個文件(包含進(jìn)度)
- 上傳list集合文件
- 上傳map集合文件
- 文件下載(包含進(jìn)度)
- 圖片下載(實現(xiàn)了圖片的壓縮)