Android Retrofit2 知识总结

1 开始使用

//retrofit:2.3.0 里面引用了 okhttp:3.8.0
    compile 'com.squareup.retrofit2:retrofit:2.3.0'
    //converter-gson:2.3.0 里面引用了 gson:2.7.0
    compile 'com.squareup.retrofit2:converter-gson:2.3.0'

Retrofit 是遵循 RESTful API 规则的网络请求的封装，底层就是OkHttp

请求封装为interface，并通过“注解”来声明api的相关信息

  • 其中一种普通 API 设计规则
xxx.com/api/createUser
xxx.com/api/getUser
xxx.com/api/updateUser
xxx.com/api/deleteUser
  • RESTful API 设计规则

RESTful的核心思想做一个最简练的总结，那就是：所谓”资源”，就是网络上的一个实体，或者说是网络上的一个具体信息。那么我们访问API的本质就是与网络上的某个资源进行互动而已。那么，因为我们实质是访问资源，所以RESTful设计思想的提出者Fielding认为：
URI当中不应当出现动词，因为”资源“表示一种实体，所以应该用名词表示，而动词则应该放在HTTP协议当中。

[POST]xxx.com/api/User
[GET] xxx.com/api/User
[PUT]xxx.com/api/User
[DELETE]xxx.com/api/User
序号 注解 用途
qq1 @POST post 请求
qq2 @DELETE delete 请求
qq3 @PUT put 请求
qq4 @GET get 请求
qq5 @PATCH patch请求，该请求是对put请求的补充，用于更新局部资源
qq6 @HEAD head请求
qq7 @OPTIONS option请求
qq8 @HTTP http 请求 可以设置达到上面任意请求
cs1 @Url 指定
cs2 @Path url 替换
cs3 @Query 查询字符串
cs4 @QueryMap 比较多的查询字符串集合
cs5 @Field 表单参数
cs6 @FieldMap 表单参数集合
cs7 @Headers 为方法添加请求响应头
cs8 @Header 为方法参数添加请求响应头
cs9 @Part 与Multipart注解结合使用,适合文件上传
cs10 @PartMap 默认接受的类型是Map<String,RequestBody>
cs11 @Body 请求上传的对象，发送非表单数据，如 传递json格式数据
bj1 @FormUrlEncoded Form表单数据，每个键值对需要使用@Field注解
bj2 @Multipart 发送multipart数据，需要配合使用@Part @PartMap
bj3 @Streaming 响应用字节流的形式返回.多用于下载大文件
  • step1 创建 接口，加入一个方法
public interface GitHubService {
        @GET("/")
        Call<GitHubApiBean> listGitHubApis();
}
  • step2 创建 一个Retrofit
  String url = "https://api.github.com/";
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(url)//url必须以‘/’结尾
                .addConverterFactory(GsonConverterFactory.create())
                .build();
  • step3 执行请求
//retrofit.create来生成一个接口实现类
    GitHubService gitHubService=retrofit.create(GitHubService.class);
    //调用指定方法
      Call<GitHubApiBean> gitHubBeanCall=gitHubService.listGitHubApis();
      //执行请求
      gitHubBeanCall.enqueue(new Callback<GitHubApiBean>() {
            @Override
            public void onResponse(Call<GitHubApiBean> call, Response<GitHubApiBean> response) {
               String authorizations_url= response.body().getAuthorizations_url();
               String team_url= response.body().getTeam_url();
            }

            @Override
            public void onFailure(Call<GitHubApiBean> call, Throwable t) {
                Log.i("zfq", t.getMessage());
            }
        });

请求注解

qq1 @POST 增

  • 意味 增
@POST("api/users")
        Call<UserBean> newUser(@Body UserBean user);

Call<UserBean> call = gitHubService.newUser(new UserBean("tsr","male",24));

qq2 @DELETE 删

  • 意味 删
@DELETE("api/users/{id}")
        Call<String> deleteUser(@Path("id") String userid);

Call<String> call = gitHubService.deleteUser("24");

qq3 @PUT 改

  • 意味 改
@PUT("api/users/{id}")
        Call<String> updateUser(@Path("id") String userid);

Call<String> call = gitHubService.updateUser("24");

qq4 @GET 查

  • 意味 查
 @GET("/")
        Call<GitHubApiBean> listGitHubApis();

  Call<GitHubApiBean> gitHubBeanCall=gitHubService.listGitHubApis();

qq5 @PATCH

  • patch请求，该请求是对put请求的补充，用于更新局部资源
  • 暂略

qq6 @HEAD

  • head 请求
  • 暂略

qq7 @OPTIONS

  • options 请求
  • 暂略

qq8 @HTTP

  • HTTP注解则可以代替以上方法中的任意一个注解
 /**
     * method 表示请求的方法，区分大小写
     * path表示路径
     * hasBody表示是否有请求体
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<ResponseBody> getBlog(@Path("id") int id);

参数注解

cs1 @Url 指定url

  • 使用动态的请求的网址，会复写之前的baseUrl，值得注意的是@Url需要在所有参数之前
@POST
    Call<ResultBean> postSayHelloByURL(@Url String url,@Query("username") String username, @Query("age") String age);

cs2 @Path url中值替换

  • 适合用于RESTful api
  • @Path 路径中需要替换{}的情况，{}内要和@Path("")内对应一致
@GET("users/{user}")
        Call<UserBean> listUser(@Path("user") String user);
        

   Call<UserBean> userBeanCall=gitHubService.listUser("louisgeek");

cs3 @Query 查询字符串

旧的方式依旧可行 毋庸置疑的 【查询 “okhttp”】

 @GET("/search/users?q=okhttp")
        Call<SearchResultBean> searchUser();

Call<SearchResultBean> searchResultBeanCall=gitHubService.searchUser();

@Query 方式 【查询 “activity”】

        @GET("/search/users")
        Call<SearchResultBean> searchUsers(@Query("q") String search);

   Call<SearchResultBean> searchResultBeanCall2=gitHubService.searchUsers("activity");

cs4 @QueryMap 查询字符串组

  • 查询集合 即多个参数组成的Map数组
 @GET("/search/users")
        Call<SearchResultBean> searchUsers(@QueryMap Map<String,String> params);

Map<String,String> params =new HashMap<>();
        params.put("param1","value1");
        params.put("param2","value2");
        Call<SearchResultBean> call = gitHubService.searchUsers(params);

cs5 @Field 表单参数

  • 需要和@FormUrlEncoded配合使用
@FormUrlEncoded
@POST("themelist/essenceAsk")
Call<ResponseBody> getFirstBlog(@Field("page") String PAGE,@field("pageSize") String String);
}

cs6 @FieldMap 表单参数组

  • 需要和@FormUrlEncoded配合使用
@FormUrlEncoded
@POST("/url")
Call<T> postForm(@FieldMap Map<String , Object> maps);

cs7 @Headers 为方法添加请求响应头

@Headers("Content-type:application/x-www-form-urlencoded;charset=UTF-8")
        @FormUrlEncoded
        @POST("api/users")
        Call<UserBean> uploadNewUser(@Field("username") String username,@Field("gender") String male);

cs8 @Header 为方法参数添加请求响应头

  @FormUrlEncoded
    @POST("api/users")
    Call<UserBean> uploadNewUser(@Header("Content-Type") String contentType,@Field("username") String username,@Field("gender") String male,@Field("age") int age);
}

// 调用
Call<ResponseInfo> call = service.uploadNewUser("application/x-www-form-urlencoded;charset=UTF-8","张德帅","male",24);

cs9 @Part

  • 用于上传文件，与@MultiPart注解结合使用
@Multipart
@POST("/url")
Call<ResponseBody> uploadFlie(
      @Part("description") RequestBody description,
      @Part("files") MultipartBody.Part file);

cs10 @PartMap

  • 用于上传文件，与@MultiPart注解结合使用,默认接受的类型是Map<String,RequestBody>，可用于实现多文件上传
@Multipart
@POST("{url}")
Call<T> uploadFiles(
      @Path("url") String url,
      @PartMap() Map<String, RequestBody> maps);

cs11 @Body

  • 非表单数据,比如想要以post方式传递json格式数据
  • 被@Body注解的的UserBean将会被Gson转换成RequestBody发送到服务器
@POST("api/users")
        Call<UserBean> uploadNewUser(@Body UserBean user);

Call<UserBean> call = gitHubService.uploadNewUser(new UserBean("tsr","male",24));

标记注解

bj1 @FormUrlEncoded

  • 以form表单方式上传
  • @Field
  • @FieldMap 使用类似@QueryMap
        @FormUrlEncoded
        @POST("api/users")
        Call<UserBean> uploadNewUser(@Field("username") String username, @Field("gender") String male, @Field("age") int age);

        @FormUrlEncoded
        @POST("api/users")
        Call<UserBean> uploadNewUser(@FieldMap Map<String,String> fields);

bj2 @Multipart

  • 表示请求发送multipart数据，需要配合使用@Part @PartMap
@Multipart
@POST("/url")
Call<ResponseBody> uploadFlie(
      @Part("description") RequestBody description,
      @Part("files") MultipartBody.Part file);

@Multipart
    @POST("test/upload")
    Call<ResultBean> upload(@Part("file\"; filename=\"launcher_icon.png") RequestBody file);

File file = new File(getExternalFilesDir(null), "launcher_icon.png");
        RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), file);
        Call<ResultBean> doubanCall = myTestApiService.upload(fileBody);

        doubanCall.enqueue(new Callback<ResultBean>() {
            @Override
            public void onResponse(Call<ResultBean> call, Response<ResultBean> response) {

                if (response.isSuccessful()) {
                    Log.d(TAG, response.body().toString());
                    resultTextView.setText("" + response.body().toString());
                }

            }

            @Override
            public void onFailure(Call<ResultBean> call, Throwable t) {
//                Log.d(TAG, response.body().toString());
                resultTextView.setText("" + "error:" + t.getMessage());
            }
        });

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

// 创建 RequestBody，用于封装构建RequestBody
RequestBody requestFile =
        RequestBody.create(MediaType.parse("multipart/form-data"), file);

// MultipartBody.Part  和后端约定好Key，这里的partName是用image
MultipartBody.Part body =
        MultipartBody.Part.createFormData("image", file.getName(), requestFile);

// 添加描述
String descriptionString = "hello, 这是文件描述";
RequestBody description =
        RequestBody.create(
                MediaType.parse("multipart/form-data"), descriptionString);

// 执行请求
Call<ResponseBody> call = service.upload(description, body);
call.enqueue(new Callback<ResponseBody>() {
    @Override
    public void onResponse(Call<ResponseBody> call,
                           Response<ResponseBody> response) {
        Log.v("Upload", "success");
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
        Log.e("Upload error:", t.getMessage());
      }
    });
}

 @POST()
Call<ResponseBody> upLoad(
   @Url() String url,
   @Body RequestBody Body);

 //构建body
   RequestBody requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM)
      .addFormDataPart("name", name)
      .addFormDataPart("name", psd)
      .addFormDataPart("file", file.getName(), RequestBody.create(MediaType.parse("image/*"), file))
      .build();

   Call<ResponseBody> call = service.upload(url, requestBody );
  // 执行
 call.enqueue(new Callback<ResponseBody>() {
   @Override
   public void onResponse(Call<ResponseBody> call,
    Response<ResponseBody> response) {
       Log.v("Upload", "success");
    }

   @Override
    public void onFailure(Call<ResponseBody> call, Throwable t) {
      Log.e("Upload error:", t.getMessage());
    }
  });

bj3 @Streaming

  • 表示响应用字节流的形式返回.如果没使用该注解,默认会把数据全部载入到内存中.该注解在在下载大文件的特别有用
 @Streaming
    @GET
    Call<ResponseBody> downloadFileByDynamicUrlAsync(@Url String downloadUrl);

  new Thread(new Runnable() {
          @Override
          public void run() {
    
    
      Call<ResponseBody> call = myTestApiService.downloadFileByDynamicUrlAsync(API_BASE_URL.concat("/res/atom-amd64.deb"));
              try {
                    Response<ResponseBody> response = call.execute();
                    boolean writtenToDisk = writeResponseBodyToDisk(response.body());
                    Log.d(TAG, "下载文件 " + writtenToDisk);
                } catch (IOException e) {
                    e.printStackTrace();
                }
                
    
   //
          }
      }).start();
      
      ……
      
      //写入到磁盘根目录
    private boolean writeResponseBodyToDisk(ResponseBody body) {
        try {
            File futureStudioIconFile = new File(Environment.getExternalStorageDirectory() + File.separator + "atom.deb");
            InputStream inputStream = null;
            OutputStream outputStream = null;

            try {
                byte[] fileReader = new byte[4096];

                final long fileSize = body.contentLength();
                long fileSizeDownloaded = 0;

                inputStream = body.byteStream();
                outputStream = new FileOutputStream(futureStudioIconFile);
                while (true) {
                    int read = inputStream.read(fileReader);

                    if (read == -1) {
                        break;
                    }

                    outputStream.write(fileReader, 0, read);

                    fileSizeDownloaded += read;

                    Log.d(TAG, "file download: " + fileSizeDownloaded + " of " + fileSize);

                    final long finalFileSizeDownloaded = fileSizeDownloaded;
                    runOnUiThread(new Runnable() {
                        @Override
                        public void run() {
                            resultTextView.setText("file download: " + finalFileSizeDownloaded + " of " + fileSize);
                        }
                    });
                }

                outputStream.flush();

                return true;
            } catch (IOException e) {
                return false;
            } finally {
                if (inputStream != null) {
                    inputStream.close();
                }

                if (outputStream != null) {
                    outputStream.close();
                }
            }
        } catch (IOException e) {
            return false;
        }
    }

参考文章

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 159,835评论 4赞 364
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 67,598评论 1赞 295
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 109,569评论 0赞 244
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 44,159评论 0赞 213
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,533评论 3赞 287
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,710评论 1赞 222
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,923评论 2赞 313
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,674评论 0赞 203
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,421评论 1赞 246
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2赞 245
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1赞 260
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,428评论 2赞 254
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 33,114评论 3赞 238
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0赞 197
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2赞 276
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2赞 271

推荐阅读更多精彩内容