在一般系統開發中,我們一般要借助於高度定制化的代碼生成工具,用於統一代碼風,節省開發時間,提高開發效率。不同的項目,它的項目不同分層的基類定義不同,我們需要在框架基類的基礎上擴展我們的業務類代碼,盡量根據已有數據庫設計的信息,完整、詳細的重現我們需要的編碼工作,一方面引入必要的關系和代碼,一方面保留一定的注釋代碼供了解使用,站在開發者的角度上思考代碼如何編寫,這樣才能夠快速、高效的增量化開發我們的業務表應用模塊。
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框架,后端和前端的整合處理了。
為了方便讀者理解,我列出一下前面幾篇隨筆的連接,供參考:
循序漸進VUE+Element 前端應用開發(1)--- 開發環境的准備工作
循序漸進VUE+Element 前端應用開發(2)--- Vuex中的API、Store和View的使用
循序漸進VUE+Element 前端應用開發(3)--- 動態菜單和路由的關聯處理
循序漸進VUE+Element 前端應用開發(4)--- 獲取后端數據及產品信息頁面的處理
循序漸進VUE+Element 前端應用開發(5)--- 表格列表頁面的查詢,列表展示和字段轉義處理
循序漸進VUE+Element 前端應用開發(6)--- 常規Element 界面組件的使用
循序漸進VUE+Element 前端應用開發(7)--- 介紹一些常規的JS處理函數
循序漸進VUE+Element 前端應用開發(8)--- 樹列表組件的使用
循序漸進VUE+Element 前端應用開發(9)--- 界面語言國際化的處理
循序漸進VUE+Element 前端應用開發(10)--- 基於vue-echarts處理各種圖表展示
循序漸進VUE+Element 前端應用開發(11)--- 圖標的維護和使用
循序漸進VUE+Element 前端應用開發(12)--- 整合ABP框架的前端登錄處理
循序漸進VUE+Element 前端應用開發(13)--- 前端API接口的封裝處理
循序漸進VUE+Element 前端應用開發(14)--- 根據ABP后端接口實現前端界面展示
循序漸進VUE+Element 前端應用開發(15)--- 用戶管理模塊的處理
循序漸進VUE+Element 前端應用開發(16)--- 組織機構和角色管理模塊的處理
循序漸進VUE+Element 前端應用開發(17)--- 菜單管理
循序漸進VUE+Element 前端應用開發(18)--- 功能點管理及權限控制
循序漸進VUE+Element 前端應用開發(19)--- 后端查詢接口和Vue前端的整合
使用代碼生成工具快速生成基於ABP框架的Vue+Element的前端界面
循序漸進VUE+Element 前端應用開發(20)--- 使用組件封裝簡化界面代碼
循序漸進VUE+Element 前端應用開發(21)--- 省市區縣聯動處理的組件使用
循序漸進VUE+Element 前端應用開發(22)--- 簡化main.js處理代碼,抽取過濾器、全局界面函數、組件注冊等處理邏輯到不同的文件中
循序漸進VUE+Element 前端應用開發(23)--- 基於ABP實現前后端的附件上傳,圖片或者附件展示管理
循序漸進VUE+Element 前端應用開發(24)--- 修改密碼的前端界面和ABP后端設置處理
循序漸進VUE+Element 前端應用開發(25)--- 各種界面組件的使用(1)
循序漸進VUE+Element 前端應用開發(26)--- 各種界面組件的使用(2)
循序漸進VUE+Element 前端應用開發(27)--- 數據表的動態表單設計和數據存儲
循序漸進VUE+Element 前端應用開發(28)--- 附件內容的管理
循序漸進VUE+Element 前端應用開發(29)--- 高級查詢條件的界面設計
部署基於.netcore5.0的ABP框架后台Api服務端,以及使用Nginx部署Vue+Element前端應用
循序漸進VUE+Element 前端應用開發(30)--- ABP后端和Vue+Element前端結合的分頁排序處理
循序漸進VUE+Element 前端應用開發(31)--- 系統的日志管理,包括登錄日志、接口訪問日志、實體變化歷史日志
循序漸進VUE+Element 前端應用開發(32)--- 手機短信動態碼登陸處理
循序漸進VUE+Element 前端應用開發(33)--- 郵件參數配置和模板郵件發送處理
使用Vue-TreeSelect組件實現公司-部門-人員級聯下拉列表的處理
使用Vue-TreeSelect組件的時候,用watch變量方式解決彈出編輯對話框界面無法觸發更新的問題