Retrofit注解学习

2018-06-01 本文已影响0人天上下雪不下雨

retrofit的注解一共3种类型,分别为网络请求方法注解,标记类注解和网络请求参数注解

网络请求方法注解
- @GET
- @POST
- @PUT
- @DELETE
- @PATCH
- @HEAD
- @OPTIONS
- @HTTP
标记类注解
- @FormUrlEncoded
- @Multipart
- @Streaming
网络请求参数注解
- @Header
- @headers
- @URL
- @Body
- @Path
- @Field
- @FieldMap
- @Part
- @PartMap
- @Query
- @QueryMap

详细解释

网络请求方法注解即对应了对应的网络请求方法

例如

@POST("GetWorkArea")
Observable<BaseResult<ArrayList<PDIC>>> GetWorkArea();

tips: retrofit的url分为2部分配置一部分是我们这里的请求方法注解内容GetWorkArea
还有一部分在构建retrofit的地方

 Retrofit retrofit = new Retrofit.Builder()
                .client(client)
                .baseUrl(baseUrl)
                .addConverterFactory(ScalarsConverterFactory.create())//请求结果转换为基本类型，一般为String
                .addConverterFactory(GsonConverterFactory.create())//请求的结果转为实体类
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())//适配RxJava2.0,
                .build();

这里的baseurl以及注解请求方法里的url组成请求的url,这里的请求规则如下

path是一个完整的url,则设置baseurl的时候不设置,请求的url就是path
path是绝对路径,如 path="/GetWorkArea" 那么请求的url为baseurl的host地址+/path,例如baseurl为 http://www.testhost.com/a/b/c/d ,组合出来的url为 http://www.testhost.com/GetWorkArea
path为相对路径,如path="GetWorkArea" 如baseurl为 http://www.testhost.com/a/b/c/d/,组合出来的路径为http://www.testhost.com/a/b/c/d/GetWorkArea
path为相对路径,baseurl为文件形式,例如baseurl为http://www.testhost.com/a/b.png,path为"c.png"组合出来为http://www.testhost.com/a/c.png

一般使用第三种方式...

@HTTP()是一个例外 ,可以代替其他的注解使用方式如下
@HTTP(method = "GET", path = "blog/{id}", hasBody = false)

标记类
- @FormUrlEncoded 作用：表示发送form-encoded的数据(每个键值对需要用@Filed来注解键名，随后的对象需要提供值)
- @Multipart 作用：表示发送form-encoded的数据（适用于有文件上传的场景） (每个键值对需要用@Part来注解键名，随后的对象需要提供值。 )
- @Streaming 表示请求的数据以流的形式返回(使用于数据较大,如果没有该注解,数据会全部加载到内存,之后取数据也是从内存中取)

网络请求参数
- @Header&@Headers 添加请求头 &添加不固定的请求头
```
    // @Header
    @GET("user")
    Call<User> getUser(@Header("Authorization") String authorization)
    
    // @Headers
    @Headers("Authorization: authorization")
    @GET("user")
    Call<User> getUser()
```
- @Body
  作用：以 Post方式传递自定义数据类型给服务器(如果提交的是一个Map，那么作用相当于 @Field )
- @Field & @FieldMap 发送 Post请求时提交请求的表单字段(必须要和@FormUrlEncoded配合使用)
- @Part & @PartMap, 与@Field的区别：功能相同，但携带的参数类型更加丰富，包括数据流，所以适用于有文件上传的场景(与 @Multipart配合做上传等)
- @Query和@QueryMap ,作用：用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value）会拼接到url上
- @Path 使用url中的缺省值,例如
```
 @GET("users/{user}/repos")
    Call<ResponseBody>  getBlog（@Path("user") String user ）;
```
相当于是补足url
- @Url 当有@url的时候 @get的参数就可以省略
```
@GET
Observable<TestBean> testAction(@Url String url);
```

Retrofit注解学习

猜你喜欢

热点阅读