美文网首页
Retrofit使用文档

Retrofit使用文档

作者: Will222 | 来源:发表于2017-03-01 15:57 被阅读0次

    Retrofit

    A type-safe HTTP client for Android and Java

    介绍

    Retrofit将你的 HTTP接口转换为Java interface.

    public interface GitHubService {
      @GET("users/{user}/repos")
      Call<List<Repo>> listRepos(@Path("user") String user);
    }
    

    The Retrofit的实例生成GitHubService的对象

    Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://api.github.com/")
        .build();
    
    GitHubService service = retrofit.create(GitHubService.class);
    

    GitHubService创建的Call可以发送一个同步或者异步的Http请求到远程服务器

    Call<List<Repo>> repos = service.listRepos("octocat");
    
    使用注解的方式去描述一个HTTP请求:

    URL参数替换和查询参数的支持
    对象转换为请求主体(e.g., JSON, protocol buffers)
    多部分请求主体和文件上传

    API Declaration

    注解的接口方法及其参数指示如何处理一个请求。

    请求方法

    每个方法必须有HTTP的注解,然后注解提供请求方法和相关的URL。一共五个内置注释:GET, POST, PUT, DELETE, 和HEAD,相关的URL可以指定在注释中。

    @GET("users/list")
    

    或者把查询的参数写在URL中

    @GET("users/list?sort=desc")
    

    URL操作

    请求URL使用替换块和参数可以动态更新方法,替换块请使用{}包裹着,相应的参数必须与@ path注释使用相同的字符串。

    @GET("group/{id}/users")
    Call<List<User>> groupList(@Path("id") int groupId);
    

    查询参数也可以被添加。

     @GET("group/{id}/users")
     Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);
    

    对于复杂的查询参数组合可以使用Map。

    @GET("group/{id}/users")
    Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
    

    请求BODY(REQUEST BODY)

    可以指定一个对象作为HTTP请求体,使用@Body注释。

    @POST("users/new")
    Call<User> createUser(@Body User user);
    

    指定的对象也将使用一个转换器转换的Retrofit实例。如果没有添加转换器,只有RequestBody能被使用。

    表单编码和多部分(FORM ENCODED AND MULTIPART)

    方法也可以声明发送表单编码和多部分数据。
    表单数据发送,需要在方法中写上@FormUrlEncoded。每个键-值对,键是注释@Field包含名称,值是对象调用时加入

    @FormUrlEncoded
    @POST("user/edit")
    Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);
    

    多部分请求时使用@Multipart存在的方法。部分使用@Part注释声明。

    @Multipart
    @PUT("user/photo")
    Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);
    

    请求头操作(HEADER MANIPULATION)

    你可以设置使用@Headers注释静态头的方法。

    @Headers("Cache-Control: max-age=640000")
    @GET("widget/list")
    Call<List<Widget>> widgetList();
    
    @Headers({
        "Accept: application/vnd.github.v3.full+json",
        "User-Agent: Retrofit-Sample-App"
    })
    @GET("users/{username}")
    Call<User> getUser(@Path("username") String username);
    

    相关文章

      网友评论

          本文标题:Retrofit使用文档

          本文链接:https://www.haomeiwen.com/subject/ithhwttx.html