OkHttp3深入瞭解之Interceptors

張航發表於2019-01-01

OKHttp官網上面介紹:攔截器是一種強大的機制,可以監視,重寫和重試呼叫。這裡我們主要對攔截器的網路請求頭和資料請求的封裝。

  • 網路請求頭攔截器

    在Android應用中,我們通常需要獲取使用者手機的IMEI值和其他一些常用的引數,如果把他們封裝到請求頭裡面的話會非常的方便。
    既然是自定義攔截器,我們首先肯定要繼承OKHttp的攔截器,把這個自定義類設定成**final**型別的防止其他類繼承。

這裡需要在父類的intercept(Chain chain)方法中進行操作。在方法裡面得
Request.Builder物件然後新增請求頭。
建立一個BaseParam 物件,對請求頭的引數進行封裝。

public final class HeaderInterceptorTest implements Interceptor {

    /**
     * 請求頭引數基礎引數
     */
    private static final String HEADER_BASE_PARAM = "baseParam";
    private static String BASE_PARAM;

    @Override
    public Response intercept(Chain chain) throws IOException {

        Request.Builder builder = chain.request().newBuilder();

        builder.addHeader(HEADER_BASE_PARAM, BASE_PARAM);
        return chain.proceed(builder.build());
    }

    public static void initBaseParam(Context context) {
        BaseParam baseParam = new BaseParam();
        String imei;
        String imsi;
        try {
            imei = DeviceInfoUtil.getIMEI(context);
        } catch (Exception e) {
            imei = null;
        }
        if (null == imei || imei.equals("")) {
            imei = DeviceInfoUtil.getDeviceID(context);
            imsi = DeviceInfoUtil.getDeviceID(context);
        } else {
            imei = DeviceInfoUtil.getIMEI(context);
            imsi = DeviceInfoUtil.getIMSI(context);
        }
        baseParam.setImei(imei);
        baseParam.setImsi(imsi);
        baseParam.setMac(DeviceInfoUtil.getWifiMAC(context));
        baseParam.setVersion(DeviceInfoUtil.getVersion(context));
        baseParam.setModel(DeviceInfoUtil.getModel());
        baseParam.setBrand(DeviceInfoUtil.getBrand());
        BASE_PARAM = new Gson().toJson(baseParam).toString();
    }

    private static class BaseParam {
        /**
         * imei :
         * imsi :
         * mac :
         * version :
         * model :
         * brand :
         * city :
         */
        private String imei;
        private String imsi;
        private String mac;
        private String version;
        private String model;
        private String brand;
        private String city;

        public String getImei() {
            return imei;
        }

        public void setImei(String imei) {
            this.imei = imei;
        }

        public String getImsi() {
            return imsi;
        }

        public void setImsi(String imsi) {
            this.imsi = imsi;
        }

        public String getMac() {
            return mac;
        }

        public void setMac(String mac) {
            this.mac = mac;
        }

        public String getVersion() {
            return version;
        }

        public void setVersion(String version) {
            this.version = version;
        }

        public String getModel() {
            return model;
        }

        public void setModel(String model) {
            this.model = model;
        }

        public String getBrand() {
            return brand;
        }

        public void setBrand(String brand) {
            this.brand = brand;
        }

        public String getCity() {
            return city;
        }

        public void setCity(String city) {
            this.city = city;
        }
    }
}
  • 資料請求攔截器
    在進行資料請求的時候,一般都會定義一種固定的請求格式。在這裡我們直接通過攔截器,將這個固定的格式定義好,這樣使用起來可以統一管理。具體的使用方法其實和上面一樣。
    主要注意的是先得到,請求時設定的請求體,然後讓請求的資料封裝到和後端設定的請求格式裡面。
public class HttpDataPackInterceptorTest implements Interceptor {

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        Request.Builder requestBuilder = chain.request().newBuilder();
        //請求資料處理
        if (request.url().toString().contains("uploads")) {
            //特殊介面的引數不需要處理的
        } else {
            //需要處理請求引數的
            if (request.body() instanceof FormBody) {
                FormBody.Builder newFormBody = new FormBody.Builder();
                //得到請求時設定的請求體
                FormBody oldFormBody = (FormBody) request.body();
                Buffer buffer = new Buffer();
                oldFormBody.writeTo(buffer);
                String postParams = JsonUtils.getJsonStrFromPostParams(buffer.readString(Charset.forName("UTF-8")));
                String data = URLDecoder.decode(postParams, "UTF-8");
                if (TextUtils.isEmpty(data)) {
                    newFormBody.add("data", "");
                } else {
                    //將請求的資料封裝
                    newFormBody.add("data", data);
                }
                requestBuilder.method(request.method(), newFormBody.build());
            }
        }
        return chain.proceed(requestBuilder.build());
    }
}
  • 程式碼中呼叫
    在建立OkHttpClient 物件的時候,呼叫addInterceptor()方法新增倆個攔截器。
private OkHttpClient client;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_okhttp);
        HeaderInterceptorTest.initBaseParam(this);
        client= new OkHttpClient()
                .newBuilder()
                .addInterceptor(new HeaderInterceptorTest())
                .addInterceptor(new HttpDataPackInterceptorTest())
                .connectTimeout(60, TimeUnit.SECONDS)
                .writeTimeout(60, TimeUnit.SECONDS)
                .readTimeout(60, TimeUnit.SECONDS).build();
        okhttpAsyncPost();
    }

    private void okhttpAsyncPost(){
        RequestBody formBody = new FormBody.Builder()
                .add("page", "1")
                .add("count", "2")
                .add("type","video")
                .build();
        Request request = new Request.Builder()
                .url("https://api.apiopen.top/getJoke")
                .post(formBody)
                .build();

        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                Log.e("error","結果"+response.body().string());
                Log.e("error","方法"+response.request().toString());
                Log.e("error","請求頭"+response.request().headers().toString());
            }
        });
    }

列印的日誌

結果{"status":200,"msg":"OK","data":"{"count":"2","page":"1","type":"video"}"}
方法Request{method=POST, url=https://www.26uuun.com/list, tags={}}
請求頭baseParam: {"brand":"Xiaomi","city":"u4e1cu4eac","imei":"9fc70b16bf169075f556e6d67be9ef1a","imsi":"9fc70b16bf169075f556e6d67be9ef1a","mac":"02:00:00:00:00:00","model":"Mi Note 2","version":"1.0"}

OK,OKHttp3中Interceptors配置完成,小夥伴們,可以設定自己不同需求的其他的攔截器新增到請求中。
最近我會寫很多關於Android常用控制元件的使用,裡面都是一些很有用的知識,如果你感覺有用,請給我一個star,謝謝。程式碼例項

相關文章