一、新建數據源配置
因考慮到多數據源問題,代碼生成器作為一個通用的模塊,后續可能會為其他工程生成代碼,所以,這里不直接讀取系統工程配置的數據源,而是讓用戶自己維護。
參數說明
- 數據源名稱:用於查找區分數據源的名稱
- 連接地址 : 連接方式:數據庫類型:數據庫地址等參數,例:jdbc:mysql://127.0.0.1/gitegg_cloud?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=utf8&all owMultiQueries=true&serverTimezone=Asia/Shanghai
- 用戶名:登錄數據庫的用戶名
- 密碼:登錄數據庫的密碼
- 數據庫驅動:數據庫驅動類型,例:com.mysql.jdbc.Driver(MySQL5 )或 com.mysql.cj.jdbc.Driver(MySQL8 )
- 數據庫類型:選擇對應的數據庫類型,如果有新增可以新增數據字典
- 備注:備注信息
二、新建業務數據字典
界面的增刪改查界面會有一些數據字典的下拉框或者單選、多選等基礎數據,這些根據具體需要生成代碼的表設計提前做好規划,在業務字典中提前建好數據字典。在自定類型表,點擊一條記錄所在的行即是選中,右側字典值列表會出現對應的字典值列表。
三、代碼生成的基礎配置
代碼生成的基礎配置實際也是一類數據字典,但這是只針對代碼生成功能模塊使用的數據字典,比如在界面上選擇的數據庫類型、表單展現類型、樹類型等、都是獲取這里的配置數據。在實際應用開發過程中,可以根據自己的需求進行新增、修改。
四、校驗規則配置
在我們業務開發過程中,無論是界面還是接口,都會對數據字段的長度、大小、類型等進行校驗,這里的配置主要是配置數據字段校驗的正則表達式,在代碼生成時,會在前端代碼和后台代碼添加校驗方法進行數據校驗。
五、代碼配置(重點)
代碼配置是實際代碼生成的重點,以上幾項配置都是為代碼生成做前期准備工作,代碼配置模塊是實際的針對業務表進行配置,最終生成代碼。
1、 新建代碼配置
配置參數說明
- 數據源 :選擇我們上面配置的需要生成代碼的數據庫。
- 模塊名稱:需要生成代碼的模塊名稱,這個名稱將用作菜單名稱、系統提示等。
- 模塊代碼:系統在生成代碼時會根據模塊代碼新建對應名稱的目錄,進行存放該模塊的代碼。
- 服務名稱:微服務注冊到Nacos上的名稱,框架中這個取得的是微服務pom.xml里的artifactId配置,在生成代碼時,微服務名稱將加在請求url的前面,請一定確認這個字段的正確性,否則訪問不到后台服務。
- 表名 : 需要生成代碼的表。
- 表別名 :在生成多表聯合代碼時,這個作為表的別名在查詢語句的mapper文件中使用。
- 表前綴 :在我們定義表時,t_代碼是表(table的首字母),下划線后面代碼子系統的名稱,再后面是模塊名稱,那么在我們生成代碼時,前面的前綴需要去掉,只保留模塊名稱,即生成代碼時的實體類名稱。
- 父級包名:定義生成模塊代碼的包路徑,代碼將存放在這個包名下。
- 表單類型:在進行增刪查改時的展現方式,有彈出框、新打開一個頁面、右側伸縮抽屜等形式
- 表單列數:定義表單字段在表里每行展示幾列
- 數據展示:配置數據查詢列表的展示形式,有表格、樹等形式
- 左樹類型: 當數據展示形式包含左側樹時,這里可以選擇左側樹的數據類型
- Controller請求路徑:配置在Controller代碼中的 @RequestMapping 參數,即模塊的請求路徑
- 后端代碼保存路徑:后端代碼的存放路徑,到具體微服務的根目錄即可,即src目錄的上一級目錄,不需要具體到src目錄和src下面的目錄。
- 前端代碼保存路徑:前端代碼的存放路徑,到具體前端代碼的根目錄即可。
- 頁面文件目錄自定義: 前端代碼默認放到views目錄下,不設置的話會使用服務請求和模塊代碼兩級字段開始生成目錄,如果需要大的區分,這里可以再設置一級目錄。
- 生成類型:有些代碼生成可能只有接口,或者只想重新生成頁面代碼,那么這里可以選擇是全部生成,還是只生成后端代碼或前端代碼。
- 狀態處理:具體業務模塊中,狀態是一個常用的字段,如果要生成的代碼有狀態字段,那么這里可以選擇是否生成對狀態相關操作代碼。
- 支持導出:配置該模塊是否有導出功能。
- 支持導入:配置該模塊是否有導入功能。
- 聯表類型:配置該模塊在操作時,是進行多表操作還是單表操作。
- 查詢復用:代碼中列表查詢(分頁或不分頁)和單條記錄查詢可以使用同一條sql,基於性能方面考慮,這里可以選擇是生成單獨的查詢方法,還是復用同一個查詢方法。
2、配置代碼生成規則
在已建好的代碼配置列表中點擊"配置規則"按鈕,進入到代碼生成規則配置頁面。如果在上一步中選擇的是多表查詢,那么這里會進入多表配置界面,如果選擇的是單表,那么這里直接進入字段配置界面。
- 配置聯表
- 多表配置列表
- 多表配置表單
配置參數說明
- 表名 : 選擇相同數據源下的表。
- 別名 : 聯表查詢時,mapper.xml里面SQL語句的表別名。
- 表前綴 : 去除系統和模塊標識,只保留實體名稱。
- 排序 : 顯示排序及在SQL查詢時的排序。
- 聯表方式 : 表連接方式,LEFT JOIN、RIGHT JOIN、INNER JOIN、UNION、UNION ALL等
- 查詢字段 : 此表需要查詢的字段
- 自定義on條件: 需要和主表關聯的字段及自定義的條件
- 配置字段
配置參數說明
- 字段描述 : 獲取數據表的描述信息,用於字段名稱和展示在頁面字段的label。
- 字段類型 : 自動轉換數據庫定義的字段類型為JAVA對應的字段類型。
- 字段名稱 : 實體類里面字段的定義。
- 配置表單
配置參數說明
- 表單新增 : 字段是否展示在界面的新增表單。
- 表單編輯 : 字段是否展示在界面的編輯表單。
- 組件類型 : 字段展示在界面的類型,INPUT、SELECT、CHECKBOX等。
- 字典編碼 : 當字段的組件類型為選擇類型時,提供選擇的填充數據。此數據來自業務字典。
- 配置表單校驗
配置參數說明
- 最小長度 : 字段的最小長度,初始值來自數據庫字段定義。
- 最大長度 : 字段的最大長度,初始值來自數據庫字段定義。
- 是否必填 : 字段是否必填。
- 是否唯一 : 字段是否唯一,如果配置為唯一,那么在表單新增或編輯時會自動生成校驗方法。
- 校驗類型 : 選擇已配置的通用正則表達式。
- 正則表達式 : 對於非通用的特殊字段,可以自定義正則表達式。
- 最大值 : 當字段為數值類型時,字段的最大值,初始值來自數據庫字段定義。
- 最小值 : 當字段為數值類型時, 字段的最小值,初始值來自數據庫字段定義。
- 配置數據展示列表
配置參數說明
- 查詢條件 : 是否是查詢條件,展示在界面的查詢條件區域。
- 查詢類型 : 字段的查詢類型,等於、不等於、大於、小於等。
- 列表展示 : 是否展示在查詢結果的數據表格中。
- 支持導入 : 字段是否支持導入,在代碼配置中支持導入時,此字段生效。
- 支持導出 : 字段是否支持導出,在代碼配置中支持導出時,此字段生效。
- 完成保存配置,在列表中點擊生成代碼按鈕,生成代碼。
六、配置資源權限
執行完代碼生成操作之后,會在后台代碼的mapper.xml同級目錄生成一個同名的.sql文件,這里面是訪問新生成代碼模塊的資源菜單權限腳本。