2023-05-25 Retrofit 基础使用

Android Retrofit 是一个基于 OkHttp 的 HTTP/REST API 客户端,我们可以通过retrofit将我们的相关接口api更容易的封装成便于我们控制的结构,而且结合Rxjava也可以更好的控制我们的相关线程.

基础步骤

1 增加依赖
2 创建api接口
3 初始化retrofit
4 创建API实例
5 发起请求......

1 添加相关依赖

    // retrofit基础依赖
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    //数据解析
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    //rxjava 
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'

2创建api接口(基础实例)

public interface DownloadApi {

    @GET("users/{user}/repos")
    Call<List<Repo>> listRepos(@Path("user") String user);//get请求

    @POST("/ota/v1/req")
    Observable<ResponseBean> checkApp(@Header("sign") String sign, @Body RequestBean requestBean);//基础post请求

    @POST
    Observable<ResponseBody> downloadApp(@Url String url, @Header("sign") String sign, @Header("Range") String range, @Body DownLoadRequestBean downLoadRequestBean);//动态设置url  并且添加多个header
 
}

3 初始化Retrofit实例并且创建API实例

    Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("平台接口地址url")
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .addConverterFactory(GsonConverterFactory.create())
        .build();
    DownloadApi  downloadApi =  retrofit.create(DownloadApi.class);

4 发起网络请求实例

//用于处理post请求的单线程,请求发起和接受都在当前线程中处理
  public static ExecutorService upgradeService = Executors.newSingleThreadExecutor(new ThreadFactory() {
        @Override
        public Thread newThread(Runnable r) {
            Thread thread = new Thread(r);
            thread.setName("upgradeService" + thread.getId());
            return thread;
        }
    });

   Call<ResponseBean> call = downloadApi.listRepos("test");
        call.enqueue(new Callback<ResponseBean>() {
            @Override
            public void onResponse(Call<ResponseBean> call, Response<ResponseBean> response) {

            }

            @Override
            public void onFailure(Call<ResponseBean> call, Throwable t) {

            }
        });
//构建自己的请求bean
  RequestBean requestBean = new RequestBean();
  String sing = "添加你得http请求的head头内容";
  downloadApi.checkApp(sign,requestBean)
                .subscribeOn(Schedulers.from(upgradeService))//接口请求发起的线程
                .observeOn(Schedulers.from(upgradeService))//收到结果处理的线程
                .onErrorResumeNext(new Function<Throwable, ObservableSource<? extends ResponseBean>>() {
                    @Override
                    public ObservableSource<? extends ResponseBean> apply(Throwable throwable) throws Exception {
                        //接口异常处理
                        return Observable.empty();
                    }
                }).concatMap(new Function<ResponseBean, ObservableSource<?>>() {
                    @Override
                    public ObservableSource<?> apply(ResponseBean responseBean) throws Exception {
                       //正常业务逻辑处理
                       return Observable.empty();
                    }
                }).subscribe();

 downloadApi.downloadApp("动态url",sign,range,downLoadRequestBean)
                .subscribeOn(Schedulers.from(UpgradeConstant.upgradeService))
                .observeOn(Schedulers.from(UpgradeConstant.upgradeService))
                .onErrorResumeNext(new Function<Throwable, ObservableSource<? extends ResponseBody>>() {
                    @Override
                    public ObservableSource<? extends ResponseBody> apply(Throwable throwable) throws Exception {
                        Log.e(TAG,"throwable:"+throwable.toString());
                        callMessage(11,throwable.toString());
                        return Observable.empty();
                    }
                }).concatMap(new Function<ResponseBody, ObservableSource<?>>() {
                    @Override
                    public ObservableSource<?> apply(ResponseBody response) throws Exception {
                      return Observable.empty();
                    }
                }).subscribe();

以上是一个简单的retrofit的基础使用,结合Rxjava使用的话效果更佳,需要对Rxjava有点儿基础,后续我会把我对rxjava的基础使用做个简单总结,关于retrofit的一些注解如下所示:

@GET - 用于定义一个 GET 请求

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

@POST - 用于定义一个 POST 请求。

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

@PUT - 用于定义一个 PUT 请求。

@PUT("users/{id}")
Call<User> updateUser(@Path("id") int id, @Body User user);

@DELETE - 用于定义一个 DELETE 请求。

@DELETE("users/{id}")
Call<Void> deleteUser(@Path("id") int id);

@Query - 用于在请求 URL 中添加查询参数。

@GET("search")
Call<List<Movie>> searchMovies(@Query("q") String query);

@Path - 用于替换 URL 中的占位符。

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

@Body - 用于传递请求体数据。

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

@Header - 用于添加请求头部信息。

@GET("users/{user}")
Call<User> getUser(@Path("user") String user, @Header("Authorization") String token);

以上是 Retrofit 常用的注解介绍,你可以根据具体需求进行使用。其实,Retrofit 还提供了许多其他注解以及配置选项,结合实际业务灵活运用吧。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容