一个实用技巧，告别手动画图，自动生成数据库 ER 图

忙，真忙

这两个星期真是巨忙，年前有个项目因为各种莫名原因，一直拖到这个月才开始真正测试。然后上周又接到新需求，马不停蹄进入开发。

一边开发着新需求，一边改着旧项目的 Bug。再加上这个项目算是从别人那交给过来的，这部分新功能代码并不是很熟，改 Bug 的时候又需要理清楚上下文逻辑，非常耗时间。

这不有一天状态还不好，迷迷糊糊中改了一天 Bug，又写了一天 Bug。

自产自销，问题有点大，后面几天一直填自己的挖的坑，那叫一个酸爽。

好了，不水了，不水了！

本周没啥时间写技术文，那就写点轻松的，分享一个日常比较实用的功能『自动生成数据库 ER 图』

自动生成 ER 图

平常做技术方案设计的时候，如果有涉及到表结构的变更，就需要在文档中说明，还得将表结构信息写到文档中，类似如下：

如果是一个新项目，新增了多张表，手动将字段填到表格中，再画个 ER 图，很是费劲。

这不最近刚好发现了 IDEA Database 插件，可以自动生成 ER 图。

假设现有两张表 activity 与 visitor，表结构如下：

CREATE TABLE activity
(
    activity_id int          NOT NULL,
    title       varchar(256) NOT NULL,
    PRIMARY KEY (activity_id)

);

CREATE TABLE visitor
(
    id          int NOT NULL,
    activity_id int NOT NULL,
    PRIMARY KEY (id),
    FOREIGN KEY (activity_id) REFERENCES activity(activity_id)
);

在 IDEA Database 弹框中选中相应的表，右键菜单选择 Diagrams-Show Visualisation，就可以生成 ER 图。

ps: maven 包之间的层级关系也可以用这个功能展示

由于存在真实外键，IDEA Database 生成 ER 图的时候将会自动生成外键的关系。

但是真实生产环境，我们很少会建立这种真实物理外键关系，仅仅只会在逻辑上生成一个虚拟的外键的关系。

具体原因可以参考阿里巴巴『Java 开发手册』

这种情况下，如果 IDEA 的版本低于 2019.3.2，那就别想了，直接用下节提到的工具。

IDEA 2019.3.2 新增了虚拟外键的功能，在 ER 图增加生成虚拟外键的功能。

假设现有表结构如下：

CREATE TABLE activity
(
    activity_id int          NOT NULL,
    visitor_id      int NOT NULL,
    PRIMARY KEY (activity_id)

);

CREATE TABLE visitor
(
    id          int NOT NULL,
    first_name int NOT NULL,
    PRIMARY KEY (id)
);

系统生成 ER 图中将会生成虚拟外键关系。

不过不要高兴太早，IDEA 是根据一定规则生成虚拟外键关系的。

如果你的表中外键命名不符合规则，IDEA 是不会生成外键的。我们需要在 Setting | Editor | Code Completion 设置规则。

说白了就是设置正则表达式，设置完成之后，可以点击这个按钮进行调试。

上面功能比较适合表结构比较规范的情况，但是真实场景可能比较复杂，外键命名也不是规范。为了生成这个外键关系，还要配置正则规则，学习成本过很大，也很难啊。

不过好在 IDEA 有另外一个功能，可以手动指定表之间的外键关系。

首先我们需要打开一个 IDEA Database console 窗口，在里面输入连表 sql，然后使用 Alt+Enter 快捷键选择 Store table relation。

这是 IDEA 会提醒你保存这个外键关系到 xml 文件中。

生成 XML 文件如下：

如果还需要生成外键关系，直接在这个配置文件中增加即可。

dbschema

IDEA Database 生成虚拟外键，这样看起来还是比较繁琐的，下面介绍一款软件『dbschema』,可以图形化生成虚拟外键。

下载地址：https://dbschema.com/

ps:收费软件，免费 15 天

这款软件专门简化数据库设计和管理，功能很强大，这里仅仅介绍其虚拟外键这个小功能，其他功能感兴趣同学可以自行研究一下。

首先我们新建一个 Layout，导入指定表。

生成 ER 图如下：

选择相应的表，右键菜单选择 Add Foreign Key

在新建窗口选择相应的表以及字段。

这里需要注意，我们是要生成虚拟的外键关系，所以一定要勾选下 Virtual,不然会生成真实物理外键。

最后 ER 图如下：

我们可以将这个 ER 图以及表结构导出到 PDF 中。在 Layout 选择 Export。

最后生成 PDF 如下图所示：

Reference

1. https://www.jetbrains.com/help/idea/foreign-keys.html
2. https://blog.jetbrains.com/datagrip/2020/01/22/datagrip-2019-3-2-virtual-foreign-keys-and-more/