Android網(wǎng)絡(luò)編程之9Retrofit2前篇[基本使用]

Nosee 發(fā)布于2019-08-16 10:51 / 1954人閱讀

摘要：創(chuàng)建增加返回值為的支持這里的加上之前定義的參數(shù)形成完整的請(qǐng)求地址用于指定返回的參數(shù)數(shù)據(jù)類型，這里我們支持和類型。完整的代碼如下增加返回值為的支持請(qǐng)求參數(shù)上文講了訪問網(wǎng)絡(luò)的基本方法，接下來(lái)我們來(lái)了解下常用的請(qǐng)求參數(shù)。

前言

Retrofit是Square公司開發(fā)的一款針對(duì)Android網(wǎng)絡(luò)請(qǐng)求的框架，Retrofit2底層基于OkHttp實(shí)現(xiàn)的，而OkHttp現(xiàn)在已經(jīng)得到Google官方認(rèn)可，不了解OKHttp的請(qǐng)查看本系列的前作。

1.使用前準(zhǔn)備

老生長(zhǎng)談，先配置build.gradle：

dependencies {
  ...
    compile "com.squareup.retrofit2:retrofit:2.1.0"
    compile "com.squareup.retrofit2:converter-gson:2.1.0"
    compile "com.squareup.retrofit2:converter-scalars:2.1.0"http://ConverterFactory的String依賴包
}

當(dāng)然別忘了在manifest加入訪問網(wǎng)絡(luò)的權(quán)限：

這次我們?cè)L問的網(wǎng)站產(chǎn)生了變化，我們用淘寶ip庫(kù)，里面有訪問接口的說明：
1. 請(qǐng)求接口（GET）：
/service/getIpInfo.php?ip=[ip地址字串]

2. 響應(yīng)信息：
（json格式的）國(guó)家、?。ㄗ灾螀^(qū)或直轄市）、市（縣）、運(yùn)營(yíng)商

3. 返回?cái)?shù)據(jù)格式：

{
    “code”: 0,
    ”data”: {
        “ip”: ”210.75.225.254”,
        ”country”: ”u4e2du56fd”,
        ”area”: ”u534eu5317”,
        “region”: ”u5317u4eacu5e02”,
        ”city”: ”u5317u4eacu5e02”,
        ”county”: ”“,
        ”isp”: ”u7535u4fe1”,
        “country_id”: ”86”,
        ”area_id”: ”100000”,
        ”region_id”: ”110000”,
        ”city_id”: ”110000”,
        “county_id”: ”-1”,
        ”isp_id”: ”100017”
    }
}

其中code的值的含義為，0：成功，1：失敗。

2.用Retrofit異步訪問網(wǎng)絡(luò) 編寫實(shí)體類

我們可以用JSON字符串轉(zhuǎn)換成Java實(shí)體類(POJO)這個(gè)網(wǎng)站將Json轉(zhuǎn)為實(shí)體類，經(jīng)過修改的實(shí)體類如下：

IpModel.java：

public class IpModel {
    private int code;
    private IpData data;
    public void setCode(int code) {
        this.code = code;
    }
    public int getCode() {
        return this.code;
    }
    public void setData(IpData data) {
        this.data = data;
    }
    public IpData getData() {
        return this.data;
    }
}

IpData.java：

public class IpData {
    private String country;
    private String country_id;
    private String area;
    private String area_id;
    private String region;
    private String region_id;
    private String city;
    private String city_id;
    private String county;
    private String county_id;
    private String isp;
    private String isp_id;
    private String ip;
    public void setCountry(String country) {
        this.country = country;
    }
    public String getCountry() {
        return this.country;
    }
    public void setCountry_id(String country_id) {
        this.country_id = country_id;
    }
    ...
 }

請(qǐng)求網(wǎng)絡(luò)接口

public interface IpService{
    @GET("getIpInfo.php")
    Call getIpMsg(@Query("ip")String ip);
}

Retrofit提供的請(qǐng)求方式注解有@GET和@POST等，分別代表GET請(qǐng)求和POST請(qǐng)求，我們?cè)谶@里訪問的界面是“getIpInfo.php”。參數(shù)注解有@PATH和@Query等，@Query就是我們的請(qǐng)求的鍵值對(duì)的設(shè)置，在這里@Query("ip")代表鍵，“String ip”則代表值。

創(chuàng)建Retrofit

   String url = "http://ip.taobao.com/service/";
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)
                //增加返回值為String的支持
                .addConverterFactory(ScalarsConverterFactory.create())
                .addConverterFactory(GsonConverterFactory.create())
                .build();

這里的baseUrl加上之前@GET("getIpInfo.php")定義的參數(shù)形成完整的請(qǐng)求地址；addConverterFactory用于指定返回的參數(shù)數(shù)據(jù)類型，這里我們支持String和Gson類型。

用Retrofit創(chuàng)建接口文件

 IpService ipService = retrofit.create(IpService.class);
 Callcall=ipService.getIpMsg(ip);

用retrofit創(chuàng)建我們之前定義的IpService接口對(duì)象，并調(diào)用該接口定義的getIpMsg方法得到Call對(duì)象。

用Call請(qǐng)求網(wǎng)絡(luò)并處理回調(diào)

 call.enqueue(new Callback() {
            @Override
            public void onResponse(Call call, Response response) {
               String country= response.body().getData().getCountry();
                Log.i("wangshu","country"+country);
                Toast.makeText(getApplicationContext(),country,Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call call, Throwable t) {

            }
        });

這里是異步請(qǐng)求網(wǎng)絡(luò)，回調(diào)的Callback是運(yùn)行在主線程的。得到返回的Response后將返回?cái)?shù)據(jù)的country字段用Toast顯示出來(lái)。如果想同步請(qǐng)求網(wǎng)絡(luò)請(qǐng)使用 call.execute()，如果想中斷網(wǎng)絡(luò)請(qǐng)求則可以使用 call.cancel()。

完整的代碼如下：

public class MainActivity extends AppCompatActivity {
    private Button bt_request;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        bt_request = (Button) findViewById(R.id.bt_request);
        bt_request.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                getIpInformation("59.108.54.37");
            }
        });
    }

    private void getIpInformation(String ip) {
        String url = "http://ip.taobao.com/service/";
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)
                //增加返回值為String的支持
                .addConverterFactory(ScalarsConverterFactory.create())
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        IpService ipService = retrofit.create(IpService.class);
        Callcall=ipService.getIpMsg(ip);
        call.enqueue(new Callback() {
            @Override
            public void onResponse(Call call, Response response) {
               String country= response.body().getData().getCountry();
                Log.i("wangshu","country"+country);
                Toast.makeText(getApplicationContext(),country,Toast.LENGTH_SHORT).show();
            }

            @Override
            public void onFailure(Call call, Throwable t) {

            }
        });
    }

3.請(qǐng)求參數(shù)

上文講了Retrofit訪問網(wǎng)絡(luò)的基本方法，接下來(lái)我們來(lái)了解下Retrofit常用的請(qǐng)求參數(shù)。

請(qǐng)求方法

請(qǐng)求方法除了上文講到的@GET，還有@POST、@PUT、@DELETE、@HEAD、@OPTIONS、@PATCH、@HTTP。其中@HTTP用來(lái)替換以上7個(gè)，其他的分別對(duì)應(yīng)著不同的請(qǐng)求方法，不明白的請(qǐng)查看Android網(wǎng)絡(luò)編程（一）HTTP協(xié)議原理這一篇文章。

@Query

前面的例子就用了Query用來(lái)查詢參數(shù)。

public interface IpService{
    @GET("getIpInfo.php")
    Call getIpMsg(@Query("ip")String ip);
}

@QueryMap

如果Query參數(shù)比較多，那么可以通過@QueryMap方式將所有的參數(shù)集成在一個(gè)Map統(tǒng)一傳遞。

public interface BlueService {
    @GET("book/search")
    Call getSearchBooks(@QueryMap Map options);
}

@Path

@Path用來(lái)替換路徑。

public interface ApiStores {
    @GET("adat/sk/{cityId}.html")
    Call getWeather(@Path("cityId") String cityId);
}

@Body

@Body與@POST注解一起使用，提供查詢主體內(nèi)容，其中ApiInfo是一個(gè)bean類。

public interface ApiStores {
        @POST("client/shipper/getCarType")
        Call getCarType(@Body ApiInfo apiInfo);
    }

@Headers

interface SomeService {
 @GET("some/endpoint")
 @Headers("Accept-Encoding: application/json")
 Call getCarType();
}

@Headers用來(lái)添加頭部信息，上面用的是固定頭部，也可以采用動(dòng)態(tài)頭部：

interface SomeService {
 @GET("some/endpoint")
 Call someEndpoint(
 @Header("Location") String location);
}

@Multipart

@Multipart用來(lái)上傳文件

public interface FileUploadService {  
    @Multipart
    @POST("upload")
    Call upload(@Part("description") RequestBody description,
                              @Part MultipartBody.Part file);
}

github源碼下載

參考資料
Retrofit 2.0文件上傳
RxJava 與 Retrofit 結(jié)合的最佳實(shí)踐
Retrofit2使用初探
android 介紹Retrofit的簡(jiǎn)單使用
Retrofit框架使用筆記
Retrofit 解析 JSON 數(shù)據(jù)
用 Retrofit 2 簡(jiǎn)化 HTTP 請(qǐng)求
Android Retrofit 2.0使用

云服務(wù)器 GPU云服務(wù)器前篇 python基本使用 linux基本使用 hbase基本使用

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/70585.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

Nosee

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

天冷了，任務(wù)欄養(yǎng)只貓吧「GitHub 熱點(diǎn)速覽 v.21.46」

閱讀 2919·2021-11-15 18:02
程序猿的武林秘籍,使用vscode一鍵調(diào)試代碼

閱讀 3814·2021-10-14 09:43
新網(wǎng)：限時(shí)7個(gè)域名(.xyz,.ltd,.fun,.online,.shop,.site,.spac

閱讀 3753·2021-09-08 10:41
最近遇到的前端面試題(2017.03.08更新版)

閱讀 2529·2019-08-30 15:53
CSS常用功能代碼集錦

閱讀 1812·2019-08-30 14:14
畫布、拖放事件、音視頻

閱讀 1958·2019-08-29 16:12
雜談 CSS IN JS

閱讀 3153·2019-08-29 14:03
提高 Web開發(fā)性能的 10 個(gè)方法

閱讀 1286·2019-08-29 13:46

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

Android網(wǎng)絡(luò)編程之9Retrofit2前篇[基本使用]

相關(guān)文章

*Android**網(wǎng)絡(luò)編程7之源碼解析OkHttp前篇[請(qǐng)求網(wǎng)絡(luò)*]

*Android**網(wǎng)絡(luò)*編程10之Retrofit2后篇[請(qǐng)求參數(shù)]

Swoole協(xié)程之旅-前篇

發(fā)表評(píng)論

0條評(píng)論

Nosee

男|高級(jí)講師

TA的文章

天冷了，任務(wù)欄養(yǎng)只貓吧「GitHub 熱點(diǎn)速覽 v.21.46」

程序猿的武林秘籍,使用vscode一鍵調(diào)試代碼

新網(wǎng)：限時(shí)7個(gè)域名(.xyz,.ltd,.fun,.online,.shop,.site,.spac

最近遇到的前端面試題(2017.03.08更新版)

CSS常用功能代碼集錦

畫布、拖放事件、音視頻

雜談 CSS IN JS

提高 Web開發(fā)性能的 10 個(gè)方法

最新活動(dòng)

資訊專欄INFORMATION COLUMN

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！

Android網(wǎng)絡(luò)編程之9Retrofit2前篇[基本使用]

相關(guān)文章

發(fā)表評(píng)論

0條評(píng)論

男|高級(jí)講師

TA的文章

最新活動(dòng)

上云采購(gòu)季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長(zhǎng)期優(yōu)惠，快來(lái)選購(gòu)！