一個實(shí)用技巧，告別手動畫圖，自動生成數(shù)據(jù)庫 ER 圖|原創(chuàng)

忙，真忙

這兩個星期真是巨忙，年前有個項(xiàng)目因?yàn)楦鞣N莫名原因，一直拖到這個月才開始真正測試。然后上周又接到新需求，馬不停蹄進(jìn)入開發(fā)。

一邊開發(fā)著新需求，一邊改著舊項(xiàng)目的 Bug。再加上這個項(xiàng)目算是從別人那交給過來的，這部分新功能代碼并不是很熟，改 Bug 的時候又需要理清楚上下文邏輯，非常耗時間。

這不有一天狀態(tài)還不好，迷迷糊糊中改了一天 Bug，又寫了一天 Bug。

自產(chǎn)自銷，問題有點(diǎn)大，后面幾天一直填自己的挖的坑，那叫一個酸爽。

好了，不水了，不水了！

本周沒啥時間寫技術(shù)文，那就寫點(diǎn)輕松的，分享一個日常比較實(shí)用的功能『自動生成數(shù)據(jù)庫 ER 圖』

自動生成 ER 圖

平常做技術(shù)方案設(shè)計(jì)的時候，如果有涉及到表結(jié)構(gòu)的變更，就需要在文檔中說明，還得將表結(jié)構(gòu)信息寫到文檔中，類似如下：

如果是一個新項(xiàng)目，新增了多張表，手動將字段填到表格中，再畫個 ER 圖，很是費(fèi)勁。

這不最近剛好發(fā)現(xiàn)了 IDEA Database 插件，可以自動生成 ER 圖。

假設(shè)現(xiàn)有兩張表 activity 與 visitor，表結(jié)構(gòu)如下：

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 彈框中選中相應(yīng)的表，右鍵菜單選擇 Diagrams-Show Visualisation，就可以生成 ER 圖。

ps: maven 包之間的層級關(guān)系也可以用這個功能展示

由于存在真實(shí)外鍵，IDEA Database 生成 ER 圖的時候?qū)詣由赏怄I的關(guān)系。

但是真實(shí)生產(chǎn)環(huán)境，我們很少會建立這種真實(shí)物理外鍵關(guān)系，僅僅只會在邏輯上生成一個虛擬的外鍵的關(guān)系。

具體原因可以參考阿里巴巴『Java 開發(fā)手冊』

這種情況下，如果 IDEA 的版本低于 2019.3.2，那就別想了，直接用下節(jié)提到的工具。

IDEA 2019.3.2 新增了虛擬外鍵的功能，在 ER 圖增加生成虛擬外鍵的功能。

假設(shè)現(xiàn)有表結(jié)構(gòu)如下：

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)
);

系統(tǒng)生成 ER 圖中將會生成虛擬外鍵關(guān)系。

不過不要高興太早，IDEA 是根據(jù)一定規(guī)則生成虛擬外鍵關(guān)系的。

如果你的表中外鍵命名不符合規(guī)則，IDEA 是不會生成外鍵的。我們需要在 Setting | Editor | Code Completion 設(shè)置規(guī)則。

說白了就是設(shè)置正則表達(dá)式，設(shè)置完成之后，可以點(diǎn)擊 這個按鈕進(jìn)行調(diào)試。

上面功能比較適合表結(jié)構(gòu)比較規(guī)范的情況，但是真實(shí)場景可能比較復(fù)雜，外鍵命名也不是規(guī)范。為了生成這個外鍵關(guān)系，還要配置正則規(guī)則，學(xué)習(xí)成本過很大，也很難啊。

不過好在 IDEA 有另外一個功能，可以手動指定表之間的外鍵關(guān)系。

首先我們需要打開一個 IDEA Database console 窗口，在里面輸入連表 sql，然后使用 Alt+Enter 快捷鍵選擇 Store table relation。

這是 IDEA 會提醒你保存這個外鍵關(guān)系到 xml 文件中。

生成 XML 文件如下：

如果還需要生成外鍵關(guān)系，直接在這個配置文件中增加即可。

dbschema

IDEA Database 生成虛擬外鍵，這樣看起來還是比較繁瑣的，下面介紹一款軟件『dbschema』,可以圖形化生成虛擬外鍵。

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

ps:收費(fèi)軟件，免費(fèi) 15 天

這款軟件專門簡化數(shù)據(jù)庫設(shè)計(jì)和管理，功能很強(qiáng)大，這里僅僅介紹其虛擬外鍵這個小功能，其他功能感興趣同學(xué)可以自行研究一下。

首先我們新建一個 Layout，導(dǎo)入指定表。

生成 ER 圖如下：

選擇相應(yīng)的表，右鍵菜單選擇 Add Foreign Key

在新建窗口選擇相應(yīng)的表以及字段。

這里需要注意，我們是要生成虛擬的外鍵關(guān)系，所以一定要勾選下 Virtual,不然會生成真實(shí)物理外鍵。

最后 ER 圖如下：

我們可以將這個 ER 圖以及表結(jié)構(gòu)導(dǎo)出到 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/