Retrofit2 使用FastJson作为Converter

Retortfit2

Retrofit是由Square公司出品的针对于Android和Java的类型安全的Http客户端，网络服务基于OkHttp 。 个人觉得更为准确的说法是，Retrofit是OkHttp的一个包装工具类，可以更加方便的调用Restful API。

Retrofit2 默认提供的Converter

Gson: com.squareup.retrofit2:converter-gson

Jackson: com.squareup.retrofit2:converter-jackson

Moshi: com.squareup.retrofit2:converter-moshi

Protobuf: com.squareup.retrofit2:converter-protobuf

Wire: com.squareup.retrofit2:converter-wire

Simple XML: com.squareup.retrofit2:converter-simplexml

Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

那么问题来了，服务器端使用FastJson进行数据的序列化，正常使用和Gson，JackSon都差不多，但是当FastJson发现有循环引用的话，会使用自己定义的一个数据格式$ref这样的，那么解析的时候就会报错。（当然也可以不让FastJson使用这种引用格式的方法，参见https://github.com/alibaba/fastjson/wiki/%E5%BE%AA%E7%8E%AF%E5%BC%95%E7%94%A8）

如果条件很苛刻，只能客户端进行修改，那么修改方式就有两种。

一种是返回String，自行使用FastJson进行解析，这个也很容易实现。

第二种当然是扩展Converter。

下面就来讲解如何扩展

首先创建FastJsonConverterFactory 类，并继承Converter.Factory，重写其中的responseBodyConverter方法与requestBodyConverter方法。

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import retrofit2.Converter;
import retrofit2.Retrofit;

/**
* <b>类名称：</b> FastJsonConverterFactory <br/>
* <b>类描述：</b> FastJsonCoverter<br/>
* <b>创建人：</b> Lincoln <br/>
* <b>修改人：</b> Lincoln <br/>
* <b>修改时间：</b> 2016年03月08日 下午3:48<br/>
* <b>修改备注：</b> <br/>
*
* @version 1.0.0 <br/>
*/
public class FastJsonConverterFactory extends Converter.Factory{

public static FastJsonConverterFactory create() {
return new FastJsonConverterFactory();
}

/**
* 需要重写父类中responseBodyConverter，该方法用来转换服务器返回数据
*/
@Override
public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
return new FastJsonResponseBodyConverter<>(type);
}

/**
* 需要重写父类中responseBodyConverter，该方法用来转换发送给服务器的数据
*/
@Override
public Converter<?, RequestBody> requestBodyConverter(Type type, Annotation[] parameterAnnotations, Annotation[] methodAnnotations, Retrofit retrofit) {
return new FastJsonRequestBodyConverter<>();
}

}

创建FastJsonResponseBodyConverter 类

import okhttp3.ResponseBody;
import okio.BufferedSource;
import okio.Okio;
import retrofit2.Converter;

/**
* <b>类名称：</b> FastJsonResponseBodyConverter <br/>
* <b>类描述：</b> ResponseBody转换器<br/>
* <b>创建人：</b> Lincoln <br/>
* <b>修改人：</b> Lincoln <br/>
* <b>修改时间：</b> 2016年03月08日 下午3:58<br/>
* <b>修改备注：</b> <br/>
*
* @version 1.0.0 <br/>
*/
public class FastJsonResponseBodyConverter<T> implements Converter<ResponseBody, T> {
private final Type type;

public FastJsonResponseBodyConverter(Type type) {
this.type = type;
}

/*
* 转换方法
*/
@Override
public T convert(ResponseBody value) throws IOException  {
BufferedSource bufferedSource = Okio.buffer(value.source());
String tempStr = bufferedSource.readUtf8();
bufferedSource.close();
return JSON.parseObject(tempStr, type);

}
}

创建FastJsonRequestBodyConverter

import com.alibaba.fastjson.JSON;

import java.io.IOException;

import okhttp3.MediaType;
import okhttp3.RequestBody;
import retrofit2.Converter;

/**
* <b>类名称：</b> FastJsonRequestBodyConverter <br/>
* <b>类描述：</b> RequestBody转换器<br/>
* <b>创建人：</b> Lincoln <br/>
* <b>修改人：</b> Lincoln <br/>
* <b>修改时间：</b> 2016年03月08日 下午5:02<br/>
* <b>修改备注：</b> <br/>
*
* @version 1.0.0 <br/>
*/
public class FastJsonRequestBodyConverter<T> implements Converter<T, RequestBody> {
private static final MediaType MEDIA_TYPE = MediaType.parse("application/json; charset=UTF-8");

@Override
public RequestBody convert(T value) throws IOException {
return RequestBody.create(MEDIA_TYPE, JSON.toJSONBytes(value));
}
}

使用方法

retrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.client(CustomerOkHttpClient.getClient())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
//在此处声明使用FastJsonConverter做为转换器
.addConverterFactory(FastJsonConverterFactory.create())
.build();

以上就是使用FastJson作为Retrofit2转换器的全部代码。

github上写了一个Demo项目，有兴趣的可以看看

https://github.com/ChineseLincoln/BaseProject

依赖项目

今天（2016-07-05），去逛github，结果看见这段代码已经有人上传到了maven 中央仓库，使用AS的亲们可以直接使用依赖引用。

compile 'org.ligboy.retrofit2:converter-fastjson-android:2.1.0'

Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.example.com")
.addConverterFactory(FastJsonConverterFactory.create())
.build();