Spring Boot代碼生成

一、背景

在Java web開發中，雖然Spring boot已經幫助我們簡化了很多工作，但項目中龐雜的業務仍然需要自己去編寫較多的 entity，vo，Mapper，Service， Controller 代碼等，那么我們有沒有什么辦法來簡化這整個開發流程呢？

二、工具選型

在嘗試了部分市場較為主流的自動化工具后，還是選擇了diboot-devtools這個開發者工具 ，因為她：

• 專門為springboot開發，引入依賴，配置好相對路徑即可使用；
• 並且支持較為常用的五種數據庫（MySQL，ORACLE，SQLServer，PostgreSQL，MariaDB）；
• 代碼自動生成到項目相應的目錄下；
• 數據庫表結構更改后，可以同步更改對應文件的代碼，而不影響到你自己寫的代碼；
• 基礎框架中依靠注解實現的數據關聯（一對一、一對多、多對多、數據字典關聯等），將關聯問題簡單化了；
• 對數據關聯設置簡單，代碼生成與更新也可以自動支持一對一、一對多、多對多、數據字典關聯；
• 支持開發以及維護過程中對數據庫相關表的數據結構更改進行記錄，並寫入到對應的數據庫更改日志文件中；
• 支持啟用lombok的代碼形式；
• 支持啟用swagger的項目；
• 依賴少、簡便輕量、靈活性高；
• Github地址為https://github.com/dibo-software/diboot-v2/，官網為https://www.diboot.com/。

三、開始使用

1. 在https://start.spring.io/下載一個初始項目demo.zip並解壓導入到IDEA。
2. 訪問https://mvnrepository.com/artifact/com.diboot/diboot-devtools-spring-boot-starter鏈接可以看到devtools的所有版本，點擊一個最新版本進去，復制maven或者gradle的依賴配置，因為官方不建議打包到生產環境，所以maven中添加provide參數，gradle中也做相應處理即可。
3. 因為其中關聯綁定是使用了diboot-core-starter中的相關綁定類，所以還需要引入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</version>
 <scope>provide</scope>
</dependency>
<dependency>
 <groupid>com.diboot</groupid>
 <artifactid>diboot-core-spring-boot-starter</artifactid>
 <version>2.0.3</version>
</dependency>

4. 根據自己項目情況設置配置文件

📋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.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. 啟動項目，項目啟動后，會出現以下日志，點擊打開這個鏈接即可訪問到devtools對於項目的配置界面：
   

四、代碼生成

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

五、代碼更新

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

六、關聯自動化

> 在他們之前發布的diboot-core中就已經支持了關聯無SQL的注解綁定方式，可見https://github.com/dibo-software/diboot-v2/tree/master/diboot-core，省去了編寫關聯代碼，以及性能調優的相關麻煩，這次的devtools又將這些關聯做到了自動化，已經不再寫關聯代碼就能輕松實現業務數據的多種關聯關系了。

數據字典關聯

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

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

 // status字段的關聯數據字典
 public static final String DICT_DEMO_STATUS = "DEMO_STATUS";

 // 關聯數據字典：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. 訪問接口，驗證關聯關系綁定，可以看到下圖中已經顯示出了目標字段statusLabel的值：
   

一對多關聯

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

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

 // 字段關聯：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. 對該表的接口進行簡單驗證，可以看到已經關聯了demo表，並顯示了目標name字段的關聯值：
   

多對多關聯

多對多關聯需要借助中間表來進行多對多的數據關聯，但這一切devtools都幫我們想好了，自動生成中間表。

1. 先創建兩張表user和role表，以及相關字段如下所示：
   
   
2. 在user表中設置user和role表多對多關聯，並生成代碼：
   
3. 可以看到在vo中已經通過注解自動綁定了多對多的關聯關系：

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

 // 通過中間表的多-多Entity實體關聯
 @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表的樣例數據（此處初始id為10000002，也需要手動改下role_id的字段標簽），並更新數據庫（此處不需要生成代碼）：
   
5. 重啟應用后，訪問user的列表接口，即可看到關聯數據的結果了：
   

七、結語

以上是對diboot devtools的一些基礎的使用方法及效果的介紹，還有很多方面沒有介紹到，其他功能比如對swagger、對lombok等的支持，各位小伙伴可以先自我嘗試下，希望本文對各位小伙伴有所幫助，祝猿媛們多多提高效率，專注與工作中那些更加核心的部分，也少些加班，多些時間陪陪家人哦~~~ 如果您喜歡不妨 點贊、收藏、分享 三連哦，純手打，萬分感謝!