Retrofit2.0初始化

最新推荐文章于 2022-03-15 17:16:25 发布

伊豆&豌豆&小豆苗

最新推荐文章于 2022-03-15 17:16:25 发布

阅读量634

点赞数

文章标签： Android Retrofit Retrofit2.0

使用介绍
步骤1：在 Gradle加入Retrofit库的依赖

   // Retrofit库
    implementation 'com.squareup.retrofit2:retrofit:2.1.0'
    // Okhttp库
    implementation 'com.squareup.okhttp3:okhttp:3.10.0'
    //Gson解析
    implementation'com.squareup.retrofit2:converter-gson:2.1.0'

步骤2：在AndroidManifest.xml 里面添加网络权限
<uses-permission android:name="android.permission.INTERNET"/>

步骤3：创建数据bean来接收服务器返回的数据类型.

public class Translation {


    /**
     * query : car
     * errorCode : 30
     */

    private String query;
    private int errorCode;

    public String getQuery() {
        return query;
    }

    public void setQuery(String query) {
        this.query = query;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }
}

步骤4：创建网络请求接口
1.因为Retrofit 把Http请求抽象成 Java 接口,主要采用注解的方式进行配置网络请求的方式跟参数. (1). 用到动态代理 ,把接口的注解翻译成一个Http请求,最后执行Http请求的.
(2)注意一点在接口中每一个方法需要用注解来标注,不然会报错的.

/**
*Translation ---> 这是数据解析的bean 
@GET ---> 这是请求的方式 在()里面是url 路径  这里可以写绝对路径
getDataFromNet  ---> 这是请求的方法 .@Query  是标识请求参数
*/
public interface NewsApi {
//接口
@GET("toutiao/index?key=a2924a746f129e1f4b37d81dc5fea156")
Call<Translation > getDataFromNet(@Query("type") String type);
}

注解类型

第一类：网络请求方法

特意说明URL的组成：Retrofit把网络请求的URL 分成了两部分设置：

// 第1部分：在网络请求接口的注解设置
 @GET("openapi.do?keyfrom=Yanzhikai&key=2032414398&type=data&doctype=json&version=1.1&q=car")
Call<Translation>  getCall();

// 第2部分：在创建Retrofit实例时通过.baseUrl()设置
Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") //设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) //设置数据解析器
                .build();

// 从上面看出：一个请求的URL可以通过 替换块 和 请求方法的参数 来进行动态的URL更新。
// 替换块是由 被{}包裹起来的字符串构成
// 即：Retrofit支持动态改变网络请求根目录

@HTTP
作用：替换@GET、@POST、@PUT、@DELETE、@HEAD注解的作用及更多功能拓展
具体使用：通过属性method、path、hasBody进行设置

public interface GetRequest_Interface {
    /**
     * method：网络请求的方法（区分大小写）
     * path：网络请求地址路径
     * hasBody：是否有请求体
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<ResponseBody> getCall(@Path("id") int id);
    // {id} 表示是一个变量
    // method 的值 retrofit 不会做处理，所以要自行保证准确
}

请求头的添加
@Header & @Headers

作用：添加请求头 &添加不固定的请求头
具体使用如下：

// @Header
@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)

// @Headers
@Headers("Authorization: authorization")
@GET("user")
Call<User> getUser()

// 以上的效果是一致的。
// 区别在于使用场景和使用方式
// 1. 使用场景：@Header用于添加不固定的请求头，@Headers用于添加固定的请求头
// 2. 使用方式：@Header作用于方法的参数；@Headers作用于方法

@Body ; 主要用于Post 请求 ,还可以通过map 来提交，那么作用相当于@Field
不过Map要经过 FormBody.Builder 类处理成为符合 Okhttp 格式的表单
栗子
FormBody.Builder builder = new FormBody.Builder(); builder.add("key","value");

1.
@POST("toutiao/index?key=a2924a746f129e1f4b37d81dc5fea156")
Call<NewsBean> getDataByPost(@Body ApiBean aPiBean);
2.
@FormUrlEncoded               //别丢了
@POST("/zjvo/login")          //接口字段
Call<Bean> login(@Field("phonenum")String phoneNum,@Field("password")String password,@Field("ltype")String ltype);

@Field & @FieldMap 作用:发送 Post请求时提交请求的表单字段,主要需要配合@FormUrlEncoded 注解
栗子

public interface GetRequest_Interface {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * <code>Field("username")</code> 表示将后面的 <code>String name</code> 中name的取值作为 username 的值
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);

/**
         * Map的key作为表单的键
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);

}

// 具体使用
         // @Field
        Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

        // @FieldMap
        // 实现的效果与上面相同，但要传入Map
        Map<String, Object> map = new HashMap<>();
        map.put("username", "Carson");
        map.put("age", 24);
        Call<ResponseBody> call2 = service.testFormUrlEncoded2(map);

@Part & @PartMap 作用:发送 Post请求时提交请求的表单字段与 @Multipart 注解配合使用
与@Field的区别：功能相同，但携带的参数类型更加丰富，包括数据流，所以适用于有文件上传的场景
栗子

public interface GetRequest_Interface {

          /**
         * {@link Part} 后面支持三种类型，{@link RequestBody}、{@link okhttp3.MultipartBody.Part} 、任意类型
         * 除 {@link okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({@link okhttp3.MultipartBody.Part} 中已经包含了表单字段的信息)，
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

        /**
         * PartMap 注解支持一个Map作为参数，支持 {@link RequestBody } 类型，
         * 如果有其它的类型，会被{@link retrofit2.Converter}转换，如后面会介绍的 使用{@link com.google.gson.Gson} 的 {@link retrofit2.converter.gson.GsonRequestBodyConverter}
         * 所以{@link MultipartBody.Part} 就不适用了,所以文件只能用<b> @Part MultipartBody.Part </b>
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload2(@PartMap Map<String, RequestBody> args, @Part MultipartBody.Part file);

        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload3(@PartMap Map<String, RequestBody> args);
}

// 具体使用
 MediaType textType = MediaType.parse("text/plain");
        RequestBody name = RequestBody.create(textType, "Carson");
        RequestBody age = RequestBody.create(textType, "24");
        RequestBody file = RequestBody.create(MediaType.parse("application/octet-stream"), "这里是模拟文件的内容");

        // @Part
        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
        Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
        ResponseBodyPrinter.printResponseBody(call3);

        // @PartMap
        // 实现和上面同样的效果
        Map<String, RequestBody> fileUpload2Args = new HashMap<>();
        fileUpload2Args.put("name", name);
        fileUpload2Args.put("age", age);
        //这里并不会被当成文件，因为没有文件名(包含在Content-Disposition请求头中)，但上面的 filePart 有
        //fileUpload2Args.put("file", file);
        Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart); //单独处理文件
        ResponseBodyPrinter.printResponseBody(call4);
}

@Query和@QueryMap 作用: 用于 @GET 方法的查询参数（Query = Url 中 ‘?’ 后面的 key-value）
栗子是多参数的也可以直接在后面添加

public interface NewsApi {
//接口
@GET("toutiao/index?")
Call<NewsBean> getDataFromNet(@QueryMap Map<String,String> params);
}
//使用
 HashMap<String, String> params = new HashMap<>();
    params.put("type","top");
    params.put("key","a2924a746f129e1f4b37d81dc5fea156");

    Call<NewsBean> call = newsApi.getDataFromNet(params);

@Path 作用URL地址的缺省值
栗子

public interface GetRequest_Interface {

        @GET("users/{user}/repos")
        Call<ResponseBody>  getBlog（@Path("user") String user ）;
        // 访问的API是：https://api.github.com/users/{user}/repos
        // 在发起请求时， {user} 会被替换为方法的第一个参数 user（被@Path注解作用）
    }

@Url 作用:直接传入一个请求的 URL变量用于URL设置
栗子

public interface GetRequest_Interface {

        @GET
        Call<ResponseBody> testUrlAndQuery(@Url String url, @Query("showAll") boolean showAll);
       // 当有URL注解时，@GET传入的URL就可以省略
       // 当GET、POST...HTTP等方法中没有设置Url时，则必须使用 {@link Url}提供

}

现在开始创建Retrofit 实例

/**
*  Retrofit2 的baseUlr 必须以 /（斜线） 结束，不然会抛出一个IllegalArgumentException 异常
*/

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://fanyi.youdao.com/") // 设置网络请求的Url地址
                .addConverterFactory(GsonConverterFactory.create()) // 设置数据解析器
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava平台
                .build();

现在网络请求接口实例

// 创建 网络请求接口 的实例
    /**
      *注意，这里是interface不是class，所以我们是无法直接调用该方法，我们需要用Retrofit创建一个GetRequest_Interface的代理对象。
      */
        GetRequest_Interface request = retrofit.create(GetRequest_Interface.class);

        //对 发送请求 进行封装
        Call<Reception> call = request.getCall();

发送网络请求（异步 / 同步）

//发送网络请求(异步)
        call.enqueue(new Callback<Translation>() {
            //请求成功时回调
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                //请求处理,输出结果
                response.body().show();
            }

            //请求失败时候的回调
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("连接失败");
            }
        });

// 发送网络请求（同步）
Response<Reception> response = call.execute();

处理返回数据

//发送网络请求(异步)
        call.enqueue(new Callback<Translation>() {
            //请求成功时回调
            @Override
            public void onResponse(Call<Translation> call, Response<Translation> response) {
                // 对返回数据进行处理
                response.body().show();
            }

            //请求失败时候的回调
            @Override
            public void onFailure(Call<Translation> call, Throwable throwable) {
                System.out.println("连接失败");
            }
        });

// 发送网络请求（同步）
  Response<Reception> response = call.execute();
  // 对返回数据进行处理
  response.body().show();

伊豆&豌豆&小豆苗

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Retrofit2.0初始化

使用介绍步骤1：在 Gradle加入Retrofit库的依赖 // Retrofit库 implementation 'com.squareup.retrofit2:retrofit:2.1.0' // Okhttp库 implementation 'com.squareup.okhttp3:okhttp:3.10.0' //Gson解析 implem...
复制链接

扫一扫