自定义Retrofit的Converter使其去除json中非法字符

在写天气预报的练手项目时，使用新框架Retrofit遇到的问题记录

和风天气获取城市天气预报的json文件中有着类似这样的字符出现

{"HeWeather data service 3.0":[{"aqi":{"city":{"aqi":"32","pm10":"21","pm25":"12","qlty":"优"}},"basic":{"city"...

发现”HeWeather data service 3.0”中含有空格，逗号，数字出现，这样GsonFormat和Gson是无法解析的，GsonFormat直接出现parse err的错误

出现这样的情况

1.使用Gson的@SerializedName注解在序列化成Json的时候，将名字序列化成注解的value属性指定的值

2.直接对获取的json数据进行修改。

第一种方法因为Gson的使用不是太深入了解，只能尝试第二种方法了。但是在Retrofit中回调直接就得到bean类的结果，仔细观察Retrofit的用法，决定在Converter中入手。

首先，Retrofit的初始化过程是这样的

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build();              

addConverterFactory()方法添加了一个gson的转换工厂，gson肯定要拿到源json数据才能解析的。根据GsonConverterFactory的源代码分析我们可以直接创建一个Converter，解决json中非法字符的问题

---

首先先要更正json的bean类，删除空格，逗号，数字，使GsonFormat正常生成bean类

然后开始自定义Converter，新建JsonConverterFactory使其继承Converter.Factory

public class JsonConverterFactory extends Converter.Factory {

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

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

    private final Gson gson;

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

    /**
     * 返回响应ResponseBody
     * @param type
     * @param annotations
     * @param retrofit
     * @return
     */
    @Override
    public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
        TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
        return new JsonRequestBodyConverter<>(gson,adapter);
    }
}

然后创建JsonRequestBodyConverter并继承接口Converter

   /**
     * 自定义响应ResponseBody
     * @param <T>
     */
    public class JsonRequestBodyConverter<T> implements Converter<ResponseBody, T> {

        private Gson mGson;
        private TypeAdapter<T> mAdapter;

        public JsonRequestBodyConverter(Gson gson, TypeAdapter<T> adapter) {
            this.mGson = gson;
            this.mAdapter = adapter;
        }

        @Override
        public T convert(ResponseBody value) throws IOException {
            //清除错误的字段
            String str = Utils.deleteErrData(value.string());
            CityWeatherBean bean = gson.fromJson(str, CityWeatherBean.class);
            return (T) bean;
        }
    }

移除json非法字符方法

/**
     * 由于城市天气json中字段含有违规字符，所以去除（空格，点，数字）
     *
     * @param str
     * @return
     */
    public static String deleteErrData(String str){
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < str.length(); i++) {
            sb.append(str.charAt(i));
        }
        sb.deleteCharAt(11);
        sb.deleteCharAt(15);
        sb.delete(22, 26);
        return sb.toString();
    }

最后修改成自定义的Converter

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(baseUrl)
                //自定义的JsonConverterFactory
                .addConverterFactory(JsonConverterFactory.create())
                .build();

结果显示正常