一、背景

在Java web開發(fā)中，雖然Spring boot已經(jīng)幫助我們簡化了很多工作，但項(xiàng)目中龐雜的業(yè)務(wù)仍然需要自己去編寫較多的 entity，vo，Mapper，Service， Controller 代碼，同時也需要處理相對復(fù)雜的一些關(guān)聯(lián)關(guān)系等，那么我們有沒有什么辦法來簡化或者說自動化這些開發(fā)流程呢？

二、我們的Diboot

diboot主要有diboot-core和diboot-devtools組成，diboot-core又為springboot專門封裝了diboot-core-spring-boot-starter組件，diboot-devtools也以starter提供，主要具有以下優(yōu)良特性：

• 專門為springboot開發(fā)，引入依賴，配置好相對路徑即可使用；
• 并且支持較為常用的五種數(shù)據(jù)庫（MySQL，ORACLE，SQLServer，PostgreSQL，MariaDB）；
• 代碼自動生成到項(xiàng)目相應(yīng)的目錄下；
• 數(shù)據(jù)庫表結(jié)構(gòu)更改后，可以同步更改對應(yīng)文件的代碼，而不影響到你自己寫的代碼；
• 基礎(chǔ)框架中依靠注解實(shí)現(xiàn)的數(shù)據(jù)關(guān)聯(lián)（一對一、一對多、多對多、數(shù)據(jù)字典關(guān)聯(lián)等），將關(guān)聯(lián)問題簡單化了；
• 對數(shù)據(jù)關(guān)聯(lián)設(shè)置簡單，代碼生成與更新也可以自動支持一對一、一對多、多對多、數(shù)據(jù)字典關(guān)聯(lián)；
• 支持開發(fā)以及維護(hù)過程中對數(shù)據(jù)庫相關(guān)表的數(shù)據(jù)結(jié)構(gòu)更改進(jìn)行記錄，并寫入到對應(yīng)的數(shù)據(jù)庫更改日志文件中；
• 支持啟用lombok的代碼形式；
• 支持啟用swagger的項(xiàng)目；
• 依賴少、簡便輕量、靈活性高。

三、開始使用

1. 在https://start.spring.io/下載一個初始項(xiàng)目demo.zip并解壓導(dǎo)入到IDEA。
2. 訪問https://mvnrepository.com/artifact/com.diboot/diboot-devtools-spring-boot-starter鏈接可以看到devtools的所有版本，點(diǎn)擊一個最新版本進(jìn)去，復(fù)制maven或者gradle的依賴配置，因?yàn)楣俜讲唤ㄗh打包到生產(chǎn)環(huán)境，所以maven中添加provide參數(shù)，gradle中也做相應(yīng)處理即可。
3. 因?yàn)槠渲嘘P(guān)聯(lián)綁定是使用了diboot-core-starter中的相關(guān)綁定類，所以還需要引入diboot-core-starter，訪問https://mvnrepository.com/artifact/com.diboot/diboot-core-spring-boot-starter可以看到diboot-core-spring-boot-starter的所有版本，選擇和devtools一致的版本即可。

??<dependency>
    <groupId>com.diboot</groupId>
    <artifactId>diboot-devtools-spring-boot-starter</artifactId>
    <version>2.0.3-RC2</version>
    <scope>provide</scope>
</dependency>
<dependency>
    <groupId>com.diboot</groupId>
    <artifactId>diboot-core-spring-boot-starter</artifactId>
    <version>2.0.3-RC2</version>
</dependency>

4.  根據(jù)自己項(xiàng)目情況設(shè)置配置文件

??server.port=8080
server.servlet.context-path=/example

#datasource config
spring.datasource.url=jdbc:mysql://localhost:3306/demo?characterEncoding=utf8&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=xxxx
spring.datasource.hikari.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.hikari.maximum-pool-size=5
spring.datasource.hikari.data-source-properties.useInformationSchema=true
spring.datasource.hikari.data-source-properties.nullCatalogMeansCurrent=true

spring.main.allow-bean-definition-overriding=true

# devtools config
diboot.devtools.codes-author=xxx
diboot.devtools.codes-copyright=xxxx.com
diboot.devtools.codes-version=1.0.0
diboot.devtools.output-path-entity=demo/src/main/java/com/example/demo/entity/
diboot.devtools.output-path-vo=demo/src/main/java/com/example/demo/vo/
diboot.devtools.output-path-service=demo/src/main/java/com/example/demo/service/
diboot.devtools.output-path-mapper=demo/src/main/java/com/example/demo/mapper/
diboot.devtools.output-path-controller=demo/src/main/java/com/example/demo/controller/
diboot.devtools.output-path-sql=demo/src/main/resources/
diboot.devtools.enable-lombok=false
diboot.devtools.enable-swagger=false

    5. 啟動項(xiàng)目，項(xiàng)目啟動后，會出現(xiàn)以下日志，點(diǎn)擊打開這個鏈接即可訪問到devtools對于項(xiàng)目的配置界面：

四、代碼生成

1. 點(diǎn)擊如下?按鈕，添加一張數(shù)據(jù)表：
   
2. 添加一張案例表， 其他先使用默認(rèn)即可：
   
3. 在數(shù)據(jù)表管理中添加一個字段name，設(shè)置樣例數(shù)據(jù)，然后點(diǎn)擊右上角的更新數(shù)據(jù)庫并生成代碼：
   
4. 可以看到相關(guān)的代碼文件已經(jīng)生成了：
   
5. 重啟應(yīng)用，訪問接口地址http://localhost:8080/example/demo/list便可以獲取到該表的列表數(shù)據(jù)：
   

五、代碼更新

1. 在demo.java的entity中增加一個count字段，測試更新代碼功能：
   
2. 在數(shù)據(jù)庫配置頁面，在demo表中增加一個title字段，并點(diǎn)擊右上角更新數(shù)據(jù)庫和代碼。
   
3. 可以看到代碼已經(jīng)更新完成，并沒有影響到自己添加的字段：
   

六、關(guān)聯(lián)自動化

在他們之前發(fā)布的diboot-core中就已經(jīng)支持了關(guān)聯(lián)無SQL的注解綁定方式，可見https://github.com/dibo-software/diboot-v2/tree/master/diboot-core，省去了編寫關(guān)聯(lián)代碼，以及性能調(diào)優(yōu)的相關(guān)麻煩，這次的devtools又將這些關(guān)聯(lián)做到了自動化，已經(jīng)不再寫關(guān)聯(lián)代碼就能輕松實(shí)現(xiàn)業(yè)務(wù)數(shù)據(jù)的多種關(guān)聯(lián)關(guān)系了。

數(shù)據(jù)字典關(guān)聯(lián)

1. 新建一個status字段，并設(shè)置關(guān)聯(lián)為數(shù)據(jù)字典關(guān)聯(lián)，先添加一個數(shù)據(jù)字典數(shù)據(jù)以供測試：
   
   
2. 添加好數(shù)據(jù)字典數(shù)據(jù)后，選擇該數(shù)據(jù)字典類型，以及該字段對應(yīng)的數(shù)據(jù)字典樣例數(shù)據(jù)，然后提交更新數(shù)據(jù)庫生成代碼（這里更新代碼也是支持的）。
   
3. 關(guān)聯(lián)相關(guān)代碼將會生成或更新到vo代碼中，會自動完成status字段對數(shù)據(jù)字典的關(guān)聯(lián)關(guān)系的綁定操作，如下：

??public class DemoVO extends Demo  {
    private static final long serialVersionUID = -4435060215996407737L;

    // status字段的關(guān)聯(lián)數(shù)據(jù)字典
    public static final String DICT_DEMO_STATUS = "DEMO_STATUS";

    // 關(guān)聯(lián)數(shù)據(jù)字典：DEMO_STATUS
    @BindDict(type=DICT_DEMO_STATUS, field="status")
    private String statusLabel;

    public String getStatusLabel() {
        return statusLabel;
    }

    public void setStatusLabel(String statusLabel) {
        this.statusLabel = statusLabel;
    }

}

    4. 訪問接口，驗(yàn)證關(guān)聯(lián)關(guān)系綁定，可以看到下圖中已經(jīng)顯示出了目標(biāo)字段statusLabel的值：

一對多關(guān)聯(lián)

1. 新建關(guān)聯(lián)測試表demo_rel，并新建字段demo_id，設(shè)置與demo表的一對多關(guān)聯(lián)關(guān)系：
   
2. 點(diǎn)擊右上角“更新數(shù)據(jù)庫&生成代碼”提交，開始生成該表的相關(guān)的代碼，可以看到vo中也對這個一對多的關(guān)聯(lián)關(guān)系進(jìn)行了注解的自動綁定：

??public class DemoRelVO extends DemoRel  {
    private static final long serialVersionUID = 943963213889204702L;

    // 字段關(guān)聯(lián)：this.demo_id=id
    @BindField(entity = Demo.class, field = "name", condition = "this.demo_id=id")
    private String demoName;

    public String getDemoName() {
        return demoName;
    }

    public void setDemoName(String demoName) {
        this.demoName = demoName;
    }

}

    3. 對該表的接口進(jìn)行簡單驗(yàn)證，可以看到已經(jīng)關(guān)聯(lián)了demo表，并顯示了目標(biāo)name字段的關(guān)聯(lián)值：

多對多關(guān)聯(lián)

多對多關(guān)聯(lián)需要借助中間表來進(jìn)行多對多的數(shù)據(jù)關(guān)聯(lián)，但這一切devtools都幫我們想好了，自動生成中間表。

1. 先創(chuàng)建兩張表user和role表，以及相關(guān)字段如下所示：
   
   
2. 在user表中設(shè)置user和role表多對多關(guān)聯(lián)，并生成代碼：
   
3. 可以看到在vo中已經(jīng)通過注解自動綁定了多對多的關(guān)聯(lián)關(guān)系：

??public class UserVO extends User  {
    private static final long serialVersionUID = -8863290616176144787L;

    // 通過中間表的多-多Entity實(shí)體關(guān)聯(lián)
    @BindEntityList(entity = Role.class, condition="this.id=user_role.user_id AND user_role.role_id=id AND user_role.is_deleted=0")
    private List<Role> roleList;

    public List<Role> getRoleList() {
        return roleList;
    }

    public void setRoleList(List<Role> roleList) {
        this.roleList = roleList;
    }

}

    4. 更新user_role表的樣例數(shù)據(jù)（此處初始id為10000002，也需要手動改下role_id的字段標(biāo)簽），并更新數(shù)據(jù)庫（此處不需要生成代碼）：

    5. 重啟應(yīng)用后，訪問user的列表接口，即可看到關(guān)聯(lián)數(shù)據(jù)的結(jié)果了：

七、結(jié)語

以上是對diboot devtools的一些基礎(chǔ)的使用方法及效果的介紹，其他對swagger、對lombok等的支持，更改配置文件中關(guān)于devtools相關(guān)配置即可啟用。