使用程式碼生成工具快速開發ABP框架專案
在一般系統開發中,我們一般要藉助於高度定製化的程式碼生成工具,用於統一程式碼風,節省開發時間,提高開發效率。不同的專案,它的專案不同分層的基類定義不同,我們需要在框架基類的基礎上擴充套件我們的業務類程式碼,儘量根據已有資料庫設計的資訊,完整、詳細的重現我們需要的編碼工作,一方面引入必要的關係和程式碼,一方面保留一定的註釋程式碼供瞭解使用,站在開發者的角度上思考程式碼如何編寫,這樣才能夠快速、高效的增量化開發我們的業務表應用模組。
1、資料庫的設計
一般情況下,我們往往喜歡基於資料庫建模我們的業務表儲存內容,資料庫表是一切業務的核心,熟練的開發人員,往往都能夠迅速根據需求的內容,以及框架所需的資訊,準確的定義好所需要的表字段,包括介面展示的欄位,以及後臺必備的一些關鍵欄位,如建立日期,建立人、所屬部門等等。
我們一般推薦使用第三方的建模工具,如PowerDesigner工具來進行資料庫表的建模,這樣可以方便分享和修改,可以根據需要隨時調整生成的資料庫指令碼。
資料庫表一般需要新增備註資訊,作為生成實體類欄位的備註,或者錄入介面的文字標籤等等,我們框架使用程式碼生成工具生成程式碼的時候,儘可能的多利用備註資訊,用來標識或者說明類或者欄位的資訊。
準確而明瞭的備註資訊,可以降低我們介入程式碼備註說明資訊的有效手段。
2、框架的多資料庫支援
對於多資料庫的支援,一般是框架底層需要考慮的,好的框架往往很容易支援多種資料庫的切換處理的。
在開發不同框架的系統應用的時候,我們往往以其中一個數據庫系統為藍本,先開發完成,然後再行擴充套件其他資料庫的支援即可。
例如對於混合框架中,底層主要使用微軟企業庫實現多種資料庫的切換的,它的底層是通過擴充套件適配來實現的。
而對於ABP框架來說,它提供EFCore的資料庫抽象,因此也是支援多種資料庫的處理。
ABP預設的資料庫是SQLServer,不過ABP框架底層是EF框架,因此也是很容易支援其他型別的資料庫的,如切換到Mysql操作,引入不同的包處理,然後調整下程式碼即可。
ABP官方文件中推薦使用的Mysql處理包,如下所示。
pomelo.entityframeworkcore.mysql
pomelo.entityframeworkcore.mysql.design
修改其中對應的常數定義,切換為我們所需要的Mysql資料庫即可,如下所示。
不同的資料庫支援,EFCore的切換程式碼,主要是在EntityFrameworkCore專案的類MyProjectDbContextConfigurer下面。
/// <summary> /// 配置使用特定資料庫的處理 /// </summary> public static class MyProjectDbContextConfigurer { public static void Configure(DbContextOptionsBuilder<MyProjectDbContext> builder, string connectionString) { builder.UseSqlServer(connectionString);//預設SQlServer //builder.UseMySql(connectionString, new MySqlServerVersion(new Version(5, 7)));//MySQL //builder.UseNpgsql(connectionString);//PostgreSQL //builder.UseOracle(connectionString);//Oracle } public static void Configure(DbContextOptionsBuilder<MyProjectDbContext> builder, DbConnection connection) { builder.UseSqlServer(connection);//預設SQlServer //builder.UseMySql(connection, new MySqlServerVersion(new Version(5, 7)));//MySQL //builder.UseNpgsql(connection);//PostgreSQL //builder.UseOracle(connection);//Oracle } }
對於預設從SQLServer切換到Mysql的處理,詳細可以參考隨筆《ABP框架使用Mysql資料庫,以及基於SQLServer建立Mysql資料庫的架構和資料》
如果需要支援Oracle資料庫,那麼也需要引入Oracle的如下驅動即可,如下所示。
然後調整下MyProjectDbContextConfigurer類的程式碼即可。
3、框架後端程式碼生成
一般來說,我們基於框架的構建,基本上把通用的介面或者邏輯儘可能都封裝在基類或接口裡面,以便減少我們需要維護的程式碼,基類程式碼越抽象、統一,那麼所需要的開發工作量就會非常少,只需要擴充套件我們自己的業務介面或函式即可,這方面也可以通過呼叫公用的處理方法,來進一步降低程式碼量。
ABP初始框架的各個分層的資訊,它主要是分為下面幾個專案分層。
Application應用層:應用層提供一些應用服務(Application Services)方法供展現層呼叫。一個應用服務方法接收一個DTO(資料傳輸物件)作為輸入引數,使用這個輸入引數執行特定的領域層操作,並根據需要可返回另一個DTO。
Core領域核心層,領域層就是業務層,是一個專案的核心,所有業務規則都應該在領域層實現。這個專案裡面,除了定義所需的領域實體類外,其實可以定義我們自己的自定義的倉儲物件(類似DAL/IDAL),以及定義自己的業務邏輯層(類似BLL/IBLL),以及基於AutoMapper對映規則等內容。
EntityFrameworkCore 實體框架核心層,這個專案不需要修改太多內容,只需要在DbContext裡面加入對應領域物件的倉儲物件即可。
Migrator資料遷移層,這個是一個輔助建立的控制檯程式專案,如果基於DB First,我們可以利用它來建立我們專案的初始化資料庫。
Web.Core Web核心層,基於Web或者Web API的核心層,提供了對身份登陸驗證的基礎處理,沒有其他內容。
Web.Core.Host Web API的宿主層,也是動態釋出Web API的核心內容,另外在Web API裡面整合了Swagger,使得我們可以方便對Web API的介面進行除錯。
Tests 單元測試層,這個提供了一些應用層物件的模擬測試,其中測試的資料庫使用的是Entity Framework 的記憶體資料庫,不影響實際資料庫內容。
經過我進行簡化和優化處理的框架專案結構如下所示。
以字典模組為介紹的話。
例如對於01-Core模組層,需要增加檔案
對於03-Application.Common模組來說,需要增加DTO和應用服務層介面檔案
而對於04-Application應用層來說,需要增加對應的介面實現檔案
而05、06、07模組,我們不需要加入任何檔案,08-Caller層加入對WebAPI的遠端呼叫封裝類,給Winform、WPF/UWP、控制檯程式等呼叫。
通過整合相關的生成規則,我們可以增加對應的ABP框架程式碼的生成,如下程式碼生成工具介面所示。
程式碼生成工具Database2Sharp地址:http://www.iqidi.com/database2sharp.htm
最終根據根據選擇資料庫表資訊,一鍵生成相關ABP架構分層程式碼,檔案結構如下所示。
我們只需要把這些生成的檔案,增量式的合併到我們的專案中即可完成後臺程式碼的整合了。
由於我們釋出了ApplicationService層的類,那麼在Swagger的接口裡面,可以檢視我們新增的業務介面了,已經具備了常規標準的增刪改查等介面了
ABP+Swagger負責API介面的釋出展示管理,如下是API介面的管理介面。
待我們熟練各個業務介面的處理邏輯後,我們就可以進行手工的增加,或者調整邏輯了。
4、ABP框架Winform介面程式碼的生成
ABP框架的介面包含兩個部分,一個是Winform介面部分,這個和我們常規的Winform開發框架或者混合框架介面開發差不多,根據資料庫表結構生成對應的列表展示和編輯介面,其中整合了條件查詢、分頁、匯入、匯出、檢視、新增、編輯、刪除等操作功能。
Database2Sharp關於ABP框架的Winform介面配置。
設定好後直接生成,程式碼工具就可以依照模板來生成所需要的WInform列表介面和編輯介面的內容了,如下是生成的介面程式碼。
放到VS專案裡面,就看到對應的窗體介面效果了。
生成介面後,進行一定的佈局調整就可以實際用於生產環境了,省卻了很多時間。
在應用業務的模組介面生成好並整合到解決方案後,就需要在後臺許可權管理系統的選單管理模組中維護對應的入口,新增對應的選單/工具欄入口了。
選單資源管理的列表介面介面如下所示
雙擊樹列表或者右側的列表,都可以對已有的選單進行編輯,選單編輯介面如下所示。
主體框架介面採用的是基於選單的動態生成,以及多文件的介面佈局,具有非常好的美觀性和易用性。
5、ABP框架Element前端介面生成
Vue+Element的前端介面,是一套BS的純前端管理介面,它利用後端ABP提供的API介面作為資料來源,展示介面。
引入了前後端分離的Vue + Element 作為前端技術路線,那麼前後端的邊界則非常清晰,前端可以在通過網路獲取對應的JSON就可以構建前端的應用了。
主體框架介面採用的是基於後臺配置的選單動態生成,左側是選單,右邊頂部是特定導航條和內容區。
選單可以進一步展開更多內容,包括系統的許可權模組(機構、使用者、角色、選單、功能),日誌,字典等等模組內容,以及其他展示案例模組。
我們一般做增量開發,只需要完成ABP後臺程式碼開發並整合後,使用程式碼開發工具進一步開發Element前端介面即可,增量開發好對應業務模組內容後整合在Vue&Element的前端框架中,並配置好選單入口即可展示使用。
在程式碼生成工具Database2Sharp介面裡面,選擇【程式碼生成】【ABP的Vue+Element介面程式碼】,如下所示。
按照程式碼工具一步步選定表進行生成,在最後根據需要選擇不同的配置生成即可。
或者選擇帶有樹列表的介面,並自定義指定目錄位置。
確認生成程式碼後,我們可以看到對應的API呼叫JS類和Vue檢視檔案,如下所示。
我們把這些整合到我們的Vue&Element前端系統專案中。
然後在路由系統中加入對應的路由資訊,路由資訊是決定選單是否能夠訪問的關鍵,只有在路由列表集合裡面,選單才放行的,如下所示。
在ABP + Vue + Element 快速開發框架裡面,我們BS前端的選單和其CS的選單是各自分開的,我們在後臺的許可權模組系統中維護選單內容並分配給對應角色使用者,在使用者登入系統後,動態載入選單展示,並通過選單的配置資訊,跳轉到對應的路由上去進行頁面展示處理。
選單資源管理的列表介面介面如下所示
這樣就完成了整個ABP框架,後端和前端的整合處理了。