读者们看到这个标题也许会感到奇怪,SpringMVC中默认的HttpMessageConverter不是Jackson吗,但是我在使用的过程中发现Jackson并不好用,如果有一些复杂的嵌套类型,当然更重要的是让Gson自动实例化抽象类对应的子类,Jackson并不能很好的转换为对应的Json,但是Gson却没有这个问题,可能我没有深入研究Jackson吧,因为之前开发过Android,那是Json转换一直使用的是Gson,通过查阅资料发现SpringMVC还是可以实现我的设想的。
我已经实现了这个功能,我们就倒推一些吧,看看我是如何做到的。简要介绍一下业务场景:我的代码中有一个AbstractDatabase的抽象类,它由OracleDatabase、HiveDatabase的子类,我们需要根据json文件中数据库的类型生成对应的子类。
修改spring-mvc.xml配置文件
我将SpringMVC的一些配置信息写到了spring-mvc.xml文件中,当然也包括HttpMessageConveter。
<bean id = "stringHttpMessageConverter" class = "org.springframework.http.converter.StringHttpMessageConverter">
<constructor-arg value="UTF-8" />
</bean>
<bean id="gsonHttpMessageConverter" class="org.springframework.http.converter.json.GsonHttpMessageConverter">
<property name="gson">
<bean class="tabletools.util.database.GsonDbFactory" factory-method="create"/>
</property>
</bean>
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
<property name="messageConverters">
<list>
<ref bean="gsonHttpMessageConverter" />
<ref bean= "stringHttpMessageConverter" />
</list>
</property>
</bean>
我们可以看到messageConverters中配置了两个bean,一个是关于编码的,另外一个就是关于Gson的,我们来看看这个id为gsonHttpMessageConverter的这个bean,它里面有一个GsonDbFactory的bean,这个说法不准确,因为它是一个工厂类,它会创造出一个Gson类供SpringMVC使用。
编写GsonDbFactory类
这个一个工厂类,代码也很少,这里我贴一下代码:
public class GsonDbFactory {
public static Gson create() {
return new GsonBuilder().registerTypeAdapter(AbstractDatabase.class, new DbTypeAdapter())
.registerTypeAdapter(AbstractTable.class, new TbTypeAdapter())
.registerTypeAdapter(AbstractValue.class,new ValueTypeAdapter()).create();
}
}
上面的代码我们使用GsonBuilder,向它注册相应的适配器。
编写TypeAdapter
GsonBuilder中我注册和很多适配器,这里我只介绍一个,剩下的原理都是一样的,我们来看看DbTypeAdapter是如何实现的:
public class DbTypeAdapter extends TypeAdapter<AbstractDatabase> {
@Override
public void write(JsonWriter out, AbstractDatabase value) throws IOException {
setDbByJsonWriter(out, value);
}
public static void setDbByJsonWriter(JsonWriter out, AbstractDatabase value) throws IOException {
out.beginObject();
if (value != null) {
out.name("name").value(value.getName());
out.name("host").value(value.getHost());
out.name("port").value(value.getPort());
out.name("userName").value(value.getUserName());
out.name("password").value(value.getPassword());
out.name("type").value(value.getType());
out.name("schema").value(value.getSchema());
out.name("catalog").value(value.getCatalog());
if(value instanceof OracleDatabase){
OracleDatabase database = (OracleDatabase) value;
out.name("sid").value(database.getSid());
}
} else {
out.nullValue();
}
out.endObject();
}
@Override
public AbstractDatabase read(JsonReader in) throws IOException {
return getDbByJsonReader(in);
}
public static AbstractDatabase getDbByJsonReader(JsonReader in) throws IOException {
String name = null;
String host = null;
int port = 0;
String userName = null;
String password = null;
String type = null;
String schema = null;
String catalog = null;
String sid = null;
AbstractDatabase database = null;
in.beginObject();
while (in.hasNext()) {
switch (in.nextName()) {
case "name":
name = in.nextString();
break;
case "host":
host = in.nextString();
break;
case "port":
port = in.nextInt();
break;
case "userName":
userName = in.nextString();
break;
case "password":
password = in.nextString();
break;
case "type":
type = in.nextString();
break;
case "schema":
schema = in.nextString();
break;
case "catalog":
catalog = in.nextString();
break;
case "sid":
sid = in.nextString();
}
}
if (type != null) {
switch (type) {
case JdbcValidate.TYPE_DATABASE_MYSQL:
database = new MySqlDatabase(name, host
, port, userName
, password, type
, schema);
break;
case JdbcValidate.TYPE_DATABASE_ORACLE:
database = new OracleDatabase(name, host
, port, userName
, password, type, sid);
break;
case JdbcValidate.TYPE_DATABASE_HIVE:
database = new HiveDatabase(name, host
, port, type
, schema);
break;
case JdbcValidate.TYPE_DATABASE_ODPS:
database = new OdpsDatabase(name, host
, port, userName
, password, type
, schema);
break;
}
if (database != null)
database.setCatalog(catalog);
}
in.endObject();
return database;
}
}
DbTypeAdapter继承了TypeAdapter这个类,它是Gson提供给我们的,它有两个抽象方法需要我们来实现,一个write,另外一个就是read。其中write主要是实现对象的序列化,也就是我们的Object已怎样的形式写入到Json文件中,read方法就是反序列化了,通过读入json实例化对应的Object。其实这两个方法和xml的解析方很像是,我记得xml有两种解析方式一种是DOM,还有一种是SAX解析解析(不一定准确),我们这里的适配器很像SAX解析,这种解析方式就是依次解析文本的每一行数据。如果你写的TypeAdapter报错,那很有可能是你的解析方式有问题,这里介绍一些JsonWriter和JsonReader中的一些方法。
- JsonWriter
out.beginObject() |这个是开始一个对象,对应json中的'{'符号
out.endObject()对应json中的'}'符号
out.name("name").value("long")对应json中的"name" : "long"
当然还有还有out.beginArray()对应的就是json中的'['标签了,out.endArray()对应json中的']'。 - JsonReader
in.beginObject()和in.endObject()表示的内容和JsonWriter一样,我们开看看不一样的,in.hasNext()试探后面是否还有内容,inNextName()读取json键值对中的key,然后根据我们知道的key在实体类中对应的数据类型调用相应的方法获取数据,比如有in.nextString()、in.nextInt()等方法供我们调用。