Retrofit自定义请求转换器

写之前不得提下接口,接口的设计是这样的

@ActivityScope
public class RequestParam<T> {
    public HeaderEntity header;
    public T            body;

    @Inject
    public RequestParam(HeaderEntity header, T body) {
        this.header = header;
        this.params = body;
    }
}

简单说下,接口请求是application/json;,每个请求参数里面包含一个通用的 header里面有一些api、设备和token信息,通常这部分是定义到 Http请求头header里面的,可能我们的接口比较任性...

header里面我们写一个OkHttp拦截器 然后加header 就可以了,请求体里面拦截器就无能为力了。所以我们用到了请求转换器。

我们在RetrofitApiService把 参数类req 定义为 body,通过自定义转换器给body加上header组装成 包含headerbody 的完整对象param
以一个登录接口为例,说明下。
定义在ApiService的方法

    @POST(LOGIN_URL)
    Observable<ResultWrapper<UserLoginResultDto>> login(@Body UserLoginSearchDto dto);
@ActivityScope
public class UserLoginSearchDto {
    public String  account;
    @NeedMD5
    public String  password;//md5 加密
    @Inject
    public UserLoginSearchDto() {}
}
    public void login(BaseActivity activity, UserLoginSearchDto dto, Subscriber<UserLoginResultDto> subscriber) {
        service.login(dto)
               .map(new GetResponseData<>())
               //持久化
               .doOnNext(user -> App.getApp().getAppComponent().userManager().persist(user))
               .compose(activity.bindUntilEvent(ActivityEvent.DESTROY))
               .compose(applySchedulers())
               .subscribe(subscriber);
    }

调用,可以看到,我们的参数UserLoginSearchDto并没有定义header信息。这时自定义转换器就上场了。Retrofit 的代理实现类会通过请求转化器会把我们在ApiService定义的@Body UserLoginSearchDto dto序列化为json

public class RequestConvertFactory extends Converter.Factory {


    public static RequestConvertFactory create() {
        return create(new Gson());
    }

    public static RequestConvertFactory create(Gson gson) {
        return new RequestConvertFactory(gson);
    }

    private final Gson gson;

    private RequestConvertFactory(Gson gson) {
        if (gson == null) throw new NullPointerException("gson == null");
        this.gson = gson;
    }

    @Override
    public Converter<?, RequestBody> requestBodyConverter(
            Type type,
            Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
//RequestParam 就是包含 header 和 body 的完整参数类
        TypeToken<RequestParam<Type>> typeToken = new TypeToken<RequestParam<Type>>() {};
        TypeAdapter<RequestParam<Type>> adapter = gson.getAdapter(typeToken);
        return new MyGsonRequestBodyConverter<>(gson, adapter);
    }
}
public class MyGsonRequestBodyConverter<T> implements Converter<T, RequestBody> {
    private static final MediaType MEDIA_TYPE = MediaType.parse("application/json; charset=UTF-8");
    private static final Charset   UTF_8      = Charset.forName("UTF-8");

    private final Gson                         gson;
    private final TypeAdapter<RequestParam<T>> adapter;

    MyGsonRequestBodyConverter(Gson gson, TypeAdapter<RequestParam<T>> adapter) {
        this.gson = gson;
        this.adapter = adapter;
    }

    @Override
    public RequestBody convert(T value) throws IOException {
        Buffer buffer = new Buffer();
        Writer writer = new OutputStreamWriter(buffer.outputStream(), UTF_8);
        JsonWriter jsonWriter = gson.newJsonWriter(writer);
        //head头参数
        HeaderEntity header = App.getApp().getAppComponent().header();
        //实际的参数实体
        RequestParam<T> param = new RequestParam<>(header, value);
        //时间戳 md5
        header.refreshVkey();

        UserManager userManager = App.getApp().getAppComponent().userManager();

        boolean login = value instanceof UserLoginSearchDto;
        header.token = login ? null : userManager.getToken();
        header.userId = login ? 0 : userManager.getUserId();

        //处理 base64
        Class<?> paramClass = value.getClass();
        Field[] fields = paramClass.getFields();
        Field needMD5 = null;
        for (int i = 0; i < fields.length; i++) {
            Field field = fields[i];
            NeedMD5 annotation = field.getAnnotation(NeedMD5.class);
            if (annotation != null) {
                needMD5 = field;
                break;
            }
        }
        if (needMD5 != null) {
            try {
                needMD5.set(value, EncryptUtil.encryptMD5(String.valueOf(needMD5.get(value))));
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        adapter.write(jsonWriter, param);
        jsonWriter.close();
        //把组装好的完整 param序列化
        return RequestBody.create(MEDIA_TYPE, buffer.readByteString());
    }
}

别忘了注册自定义转换器RequestConvertFactory.create

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

推荐阅读更多精彩内容