解决达梦集成 JPA 时表和字段注释注解不生效的问题

news2024/10/6 6:52:05

前言

最近在做达梦数据库集成 JPA 时，发现使用的表注解和字段注解均未生效（MySQL、Oracle、PostgreSQL中均可以在建表时正常生成相应的注释），经过调试发现解决办法也很简单：

自定义方言类继承自org.hibernate.dialect.DmDialect，重写supportsCommentOn方法返回 true：

/**
 * 自定义 dm 方言类
 *
 * @author butterfly
 * @date 2024-03-11
 */
public class MyDmDialect extends DmDialect {
    
    @Override
    public boolean supportsCommentOn() {
        return true;
    }

}

yaml 配置中使用自定义的方言类：

spring:
  jpa:
    # 根据自己的类路径进行修改
    database-platform: cn.butterfly.config.MyDmDialect

如果大家也在使用达梦集成 JPA 时遇到了以上问题，按照上述说明配置即可。下面再说明一下我的解决思路以及后续如果集成其它数据库出现类似问题改如何解决。

产生背景

首先我们要知道的是 JPA 之所以能够帮助我们屏蔽不同 SQL 语言的差异，帮助我们自动建表，生成增删改查语句等等，其实都是内部帮助我们做了数据库类型的判断，然后生成或拼接相应的 SQL 语句。所以对于已经广泛使用的数据库，例如 MySQL、Oracle、PostgreSQL 等均能比较好地适配 JPA 的语法和提供的注解功能，而像达梦是近几年由于信创才开始在国内兴起，因此难免会有一些不兼容的情况，这也是本文出现的根本原因。

解决思路

正如标题所说，达梦是在自动建表时不支持 JPA 的表和字段注释注解，因此我们就需要找到负责拼接建表语句的org.hibernate.tool.schema.internal.StandardTableExporter类（类似地，如果建索引有问题就可以看org.hibernate.tool.schema.internal.StandardIndexExporter类），然后经过查找就可以发现如下负责拼接注释的代码：

这里可以看到第一张图是用于拼接列注释，第二张图的第一处红框用于拼接表注释，而第二张图的第二处调用的方法又进行了一次表和字段注释的拼接，这是什么原因呢？其实就是不同数据库的注释拼接方式不同而已，像 Mysql 的列注释直接拼接在字段说明后即可，表注释也是跟随建表语句一起，类似下图：

而像 Oracle、达梦之类的数据库则是使用了comment on的语法形式，如下图所示：

因此上述代码中有两种处理注释拼接的方式，同时也可以发现第一种拼接方式获取列注释和表注释时分别调用了dialect.getColumnComment( columnComment ) 和dialect.getTableComment( table.getComment() ) 方法，而第二种拼接方式则是调用了dialect.supportsCommentOn() 先进行判断，然后再处理注释的拼接。

这里的dialect即是方言对象：

该类中包含以上三个方法，返回值不是 false 就是空字符串也就是不添加注释：

不过在运行时会 JPA 会自动注入我们在 yaml 文件中的配置：

但是到这里我们只是知道了注释的拼接方式，还不清楚为什么达梦数据库会出现失效的情况，那我们就先看一下 MySQL 和 Oracle 等数据库为什么能生效，首先是 MySQL（org.hibernate.dialect.MySQLDialect）：

可以发现 MySQL 内部重写了获取表和字段注释的方法，没有重写supportsCommentOn方法，而该方法默认返回 false，因此 MySQL 会使用第一种创建注释的方式，下面再看看 Oracle 的处理：

可以看到 Oracle 只重写了supportsCommentOn方法并返回 true，也就是上面讲到的第二种拼接方式，而我们知道达梦和 Oracle 一样使用这种创建注释的方法，到这里相信大家也可以知道达梦无法创建表和字段注释的原因了，不过我们还是先看一下达梦的源码：

可以发现达梦比较直接，直接把Dialect类中的代码原样不动搬过来了，还没有重载注解（懂得都懂，CV 大法🙂），因此我们只需要重写一个方言类继承自该类，然后使用即可，前言中已经说明，不再重述。

运行测试

在改完后，我们先再运行测试一下再结束本篇文章。首先我们创建一个实体类（这里的 IdEntity 就是包含 id 字段的类）：

/**
 * Demo
 *
 * @author butterfly
 * @date 2024-03-11
 */
@Data
@Entity
@Table(name = "demo")
@EqualsAndHashCode(callSuper = true)
@org.hibernate.annotations.Table(appliesTo = "demo", comment = "演示表")
public class Demo extends IdEntity {
    
    /**
     * 字段
     */
    @Column(length = 50, nullable = false)
	@Comment("字段")
    private String field;
    
}