Retrofit 基础篇

一、Retrofit 网络请求接口的注解类型:网络请求方法、标记类、网络请求参数

(1)网络请求方法

@GET  //采用get方法发送网络请求
@POST  //采用post方法发送网络请求
@PUT  //采用put方法发送网络请求
@DELETE  //采用delete方法发送网络请求
@PATCH  //patch请求,该请求是对put请求的补充,用于更新局部资源
@HEAD  //采用head方法发送网络请求
@OPTIONS  //采用options方法发送网络请求
@HTTP  //用于替换以上七个注解的作用及更多功能的扩展。其拥有三个属性:method:表示请求的方法,不区分大小写、path:path表示路径、hasBody:表示是否有请求体

(2)标记类

@FormUrlEncoded  //表示请求体是一个Form表单
@Multipart  //表示请求体是一个支持文件上传的Form表单
@Streaming  //表示返回的数据已流的形式返回(适用于返回数据较大的场景)默认会把数据全部载入到内存中.该注解在下载大文件特别有用

(3)网络请求参数

@Body  //用于post请求发送非表单数据,比如想要以post方式传递json格式数据
@Field  //用于post请求中表单字段,Filed和FieldMap需要FormUrlEncoded结合使用
@FieldMap  //和@Filed作用一致,用于不确定表单参数
@Part  //用于表单字段,Part和PartMap与Multipart注解结合使用,适合文件上传的情况
@PartMap  //用于表单字段,可用于实现多文件上传
@Path  //用于url中的占位符
@Query  //用于Get中指定参数
@QueryMap  //和Query使用类似
@Url  //指定请求路径

二、OkHttpClient拦截器

(1)日志拦截器

Application Interceptors应用程序拦截器:addInterceptor添加的是应用拦截器Application Interceptor他只会在response被调用一次。主要用于查看请求信息及返回信息,如链接地址、头信息、参数信息等。
    private static HttpLoggingInterceptor getHttpLoggingInterceptor() {
        HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(
                new HttpLoggingInterceptor.Logger() {
                    @Override
                    public void log(String message) {
                        LogUtils.Le("OkHttp", "log = " + message);
                    }
                });
        loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
        return loggingInterceptor;
    }

添加应用拦截器
方式一:在OkHttpClient.Builder中添加
new OkHttpClient.Builder().addInterceptor(getHttpLoggingInterceptor())
方式二:在okHttpClient中直接添加
okHttpClient.interceptors().add(getHttpLoggingInterceptor())
(2)请求头拦截器

Network Interceptors网络拦截器:addNetworkInterceptor添加的是网络拦截器Network Interceptors它会在request和response时分别被调用一次。主要用于添加、删除或替换请求头信息,还可以改变的请求携带的实体。
    private static Interceptor getRequestHeader() {
        Interceptor headerInterceptor = new Interceptor() {
            @Override
            public okhttp3.Response intercept(Chain chain) throws IOException {
                Request originalRequest = chain.request();
                Request.Builder builder = originalRequest.newBuilder();
                //使用addHeader()不会覆盖之前设置的header,若使用header()则会覆盖之前的header
                builder.addHeader("Accept", "application/json");
                builder.addHeader("Content-Type", "application/json; charset=utf-8");
                builder.removeHeader("User-Agent");
                builder.method(originalRequest.method(), originalRequest.body());
                Request.Builder requestBuilder =
                        builder.method(originalRequest.method(), originalRequest.body());
                Request request = requestBuilder.build();
                return chain.proceed(request);
            }
        };
        return headerInterceptor;
    }

添加网络拦截器
方式一:在OkHttpClient.Builder中添加
new OkHttpClient.Builder().addNetworkInterceptor(getRequestHeader() )
方式二:在okHttpClient中直接添加
okHttpClient. networkInterceptors().add(getRequestHeader() )
(3)统一的请求参数截器

    private static Interceptor commonParamsInterceptor() {
        Interceptor commonParams = new Interceptor() {
            @Override
            public okhttp3.Response intercept(Chain chain) throws IOException {
                Request originRequest = chain.request();
                Request request;
                HttpUrl httpUrl = originRequest.url().newBuilder().
                        addQueryParameter("paltform", "android").
                        addQueryParameter("version", "1.0.0").build();
                request = originRequest.newBuilder().url(httpUrl).build();
                return chain.proceed(request);
            }
        };
        return commonParams;
    }

(4)在无网络的情况下读取缓存,有网络的情况下根据缓存的过期时间重新请求

    public static Interceptor getCacheInterceptor() {
        Interceptor commonParams = new Interceptor() {
            @Override
            public okhttp3.Response intercept(Chain chain) throws IOException {
                Request request = chain.request();
                if (!NetworkUtils.isConnected()) {
                    //无网络下强制使用缓存,无论缓存是否过期,此时该请求实际上不会被发送出去。
                    request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE)
                            .build();
                }
                okhttp3.Response response = chain.proceed(request);
                if (NetworkUtils.isConnected()) {//有网络情况下,根据请求接口的设置,配置缓存。
                    //这样在下次请求时,根据缓存决定是否真正发出请求。
                    String cacheControl = request.cacheControl().toString();
                    //当然如果你想在有网络的情况下都直接走网络,那么只需要
                    //将其超时时间这是为0即可:String cacheControl="Cache-Control:public,max-age=0"
                    int maxAge = 60 * 60; // read from cache for 1 minute
                    return response.newBuilder()
//                            .header("Cache-Control", cacheControl)
                            .header("Cache-Control", "public, max-age=" + maxAge)
                            .removeHeader("Pragma")
                            .build();
                } else {
                    //无网络
                    int maxStale = 60 * 60 * 24 * 28; // tolerate 4-weeks stale
                    return response.newBuilder()
                            .header("Cache-Control", "public,only-if-cached,max-stale=" + maxStale)
                            .removeHeader("Pragma")
                            .build();
                }

            }
        };
        return commonParams;
    }

三、Retrofit使用步骤

(1)创建接收服务器返回数据的类

public class User {
    private int code;
    private String message;
    //code...
}

(2)创建用于描述网络请求的接口

public interface Request_Interface {
    String HOST = "http://192.168.45.30:2005/";

    @POST()
    Call<User> postBody(@Url String url, @Body RequestBody body);
}

(3)创建Retrofit实例并配置网络请求参数

public class RetrofitManager {
    private static volatile Request_Interface request_interface = null;

    //创建网络请求接口实例
    public static Request_Interface getRequestInterface() {
        if (request_interface == null) {
            synchronized (Request_Interface.class) {
                request_interface = provideRetrofit().create(Request_Interface.class);
            }
        }
        return request_interface;
    }

    //初始化必要对象和参数
    public static Retrofit provideRetrofit() {
        OkHttpClient client = new OkHttpClient.Builder()
                .cache(new Cache(new File(CPApplication.getContext().getExternalCacheDir(), "test_cache"), 10 * 1024 * 1024))
                .addInterceptor(getHttpLoggingInterceptor())//Application拦截器
                .addNetworkInterceptor(getRequestHeader())//Network拦截器
                .addNetworkInterceptor(commonParamsInterceptor())
                .addNetworkInterceptor(getCacheInterceptor())
                .build();
        Retrofit retrofit = new Retrofit
                .Builder()
                .client(client)
                .baseUrl(Request_Interface.HOST)//设置网络请求的Url地址
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())//支持RxJava平台
                .addConverterFactory(GsonConverterFactory.create())//设置数据解析器
                .build();
        return retrofit;
    }
    //code...
}

(4)发送网络请求

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

推荐阅读更多精彩内容