Retrofit2简单使用教程

简介

Retrofit是Square开 发的一个Android和Java的REST客户端库。这个库非常简单并且具有很多特性，相比其他的网络库，更容易让初学者快速掌握。它可以处理GET、 POST、PUT、DELETE...等请求

概述

1429351394587168.png

• ** POJO或模型实体类 : **从服务器获取的JSON数据将被填充到这种类的实例中。

public class UserModel {
　　private int id;
　　private String login;
　　private String avatar_url;
　　private String gravatar_id;
　　private String url;
　　...
}

• **接口 : **我们需要创建一个接口来管理像GET,POST…等请求的URL，这是一个服务类。

public interface ApiService {
    String BASE_API = "https://api.github.com";

    @GET("/users")
    Call<UserModel> getUser();
}

• **RestAdapter类 : **这是一个REST客户端(RestClient)类，retrofit中默认用的是Gson来解析JSON数据，你也可以设置自己的JSON解析器，比如jackson，Gson等。

　　Retrofit retrofit=new Retrofit.Builder()
　　        .addConverterFactory(GsonConverterFactory.create())
　　        .baseUrl(ApiService.BASE_API)
　　        .build();

　　ApiService service=retrofit.create(ApiService.class);
　　Call<UserModel> call = service.getUser();
　　call.enqueue(new Callback<UserModel>() {
　　    @Override
　　    public void onResponse(Call<UserModel> call, Response<UserModel> response) {
　　    }
　　    @Override
　　    public void onFailure(Call<UserModel> call, Throwable t) {
　　    }
　　});

Retrofit的使用

首先，在使用Retrofit之前还是老规矩，导包

compile 'com.squareup.retrofit2:retrofit:2.1.0'
//只是使用retrofit不解析数据可以不导下面这个包
compile'com.squareup.retrofit2:converter-gson:2.1.0'

Retrofit支持的基本的HTTP请求

在Retrofit中使用注解的方式来区分请求类型.比如:
@GET("")表示一个GET请求,括号中的内容为请求的地址.

格式	含义
@GET	表示这是一个GET请求
@POST	表示这个一个POST请求
@PUT	表示这是一个PUT请求
@DELETE	表示这是一个DELETE请求
@HEAD	表示这是一个HEAD请求
@OPTIONS	表示这是一个OPTION请求
@PATCH	表示这是一个PAT请求

Retrofit的简单实现

直接请求型

1. 如果是直接请求某一地址:

@GET("/users")
Call<List<UserModel>> getUserList();

2.如果是组合后直接请求:

@GET("/users/{user}")
Call<UserModel> getUser(@Path("user") String user);

带参查询型

//    https://api.github.com/search/users?q=retrofit&page=1&per_page=2
    @GET("/search/users")
    Call<BaseModel> groupList(@Query("q") String query, @Query("page") String page, @Query("per_page") int per_page);

带Header型

比如要更新某个账户信息,其接口地址为/info,需要带的Header有设备信息device,系统版本version,还要带请求参数要更新账户的id,如下:

@POST("/info")
Call<Object> updateInfo(@Header("device") String device, @Header("version") int version, @Field("id") String id);

基础URL

构建Retrofit实例如下:

Retrofit retrofit = new Retrofit.Builder()
        .addConverterFactory(GsonConverterFactory.create())//添加Gson解析数据
        .baseUrl(ApiService.BASE_API)
        .build();

获取Github用户列表

ApiService service=retrofit.create(ApiService.class);
Call<List<UserModel>> call = service.getUserList();
call.enqueue(new Callback<List<UserModel>>() {
    @Override
    public void onResponse(Call<List<UserModel>> call, Response<List<UserModel>> response) {
        if (response.isSuccessful()){//请求解析成功判断
            mTxt.append("\n name:\t"+response.body().get(0).getLogin());
            mTxt.append("\n type:\t"+response.body().get(0).getType());
            mTxt.append("\n admin:\t"+response.body().get(0).isSite_admin());
        }
    }
    @Override
    public void onFailure(Call<List<UserModel>> call, Throwable t) {
        mTxt.setText(t.getMessage());
    }
});

Github的接口基础地址为:https://api.github.com/ ，具体的接口点击链接自行查看。