修改Hibernate源码实现建表时字段和Entity里定义的fields顺序一致

Hibernate（至截稿时最新版本为4.1.3.Final）自动建表的表字段顺序总是随机的，之前我们总是自己写语句建好表，再使用Hibernate进行增删改查。始终是有点不方便。
最近看了下源码，发现很多地方都是使用LinkedHashMap或者是List来传输Entity里面的fields，觉得Hibernate应该是考虑到使用Entity里面定义的fields的顺序来实现建表语句里的表字段顺序的。
于是一步步跟踪下去，终于在一个地方发现了一个问题：org.hibernate.cfg.PropertyContainer在取fields的时候是使用TreeMap来保存的，于是试着改了下，将这个里面的所有TreeMap改成了LinkedHashMap，编译通过，打包，测试。
终于，我们期待已久的结果出来了：建表语句里面的字段顺序和Entity里面的fields的顺序一致了。

以下附上源码和修改后的代码：
源码：

private final TreeMap<String, XProperty> fieldAccessMap;

private final TreeMap<String, XProperty> propertyAccessMap;

private TreeMap<String, XProperty> initProperties(AccessType access) {
if ( !( AccessType.PROPERTY.equals( access ) || AccessType.FIELD.equals( access ) ) ) {
throw new IllegalArgumentException( "Access type has to be AccessType.FIELD or AccessType.Property" );
}

// 其实通过以下注释也可以发现是Hibernate自己的一个失误
//order so that property are used in the same order when binding native query
TreeMap<String, XProperty> propertiesMap = new TreeMap<String, XProperty>();
List<XProperty> properties = xClass.getDeclaredProperties( access.getType() );
for ( XProperty property : properties ) {
if ( mustBeSkipped( property ) ) {
continue;
}
propertiesMap.put( property.getName(), property );
}
return propertiesMap;
}

修改后的代码

private final LinkedHashMap<String, XProperty> fieldAccessMap;

private final LinkedHashMap<String, XProperty> propertyAccessMap;

private LinkedHashMap<String, XProperty> initProperties(AccessType access) {
if ( !( AccessType.PROPERTY.equals( access ) || AccessType.FIELD.equals( access ) ) ) {
throw new IllegalArgumentException( "Access type has to be AccessType.FIELD or AccessType.Property" );
}

//order so that property are used in the same order when binding native query
LinkedHashMap<String, XProperty> propertiesMap = new LinkedHashMap<String, XProperty>();
List<XProperty> properties = xClass.getDeclaredProperties( access.getType() );
for ( XProperty property : properties ) {
if ( mustBeSkipped( property ) ) {
continue;
}
propertiesMap.put( property.getName(), property );
}
return propertiesMap;
}

PS：通过以下代码可以测试建表时的语句：
public static void main(String[] args) {
    Configuration cfg = new Configuration().configure();
    SchemaExport export = new SchemaExport(cfg);
    export.create(true, true);
}
建表语句会输出到控制台，对比之前未作修改时的语句，可以看出差别。
修改后数据库（MySQL 5.5.24）的对应表字段顺序和Entity定义的fields顺序一致。

我已将此改动向Hibernate开发组提出，希望以后会在官方版本里实现此改动。
链接如下：
https://forum.hibernate.org/viewtopic.php?f=1&t=1015920

评论

1 楼 Ryan_Wang 2017-01-12  

https://hibernate.atlassian.net/browse/HHH-11386