摘要:快速開發:此功能爲框架的核心,通過選擇數據庫中的表,就能自動生成對應的實體層、業務邏輯層、控制器、前端頁面Vue文件,無需編寫代碼即可生成基本的CRUD操作。使用RBAC權限體系,基於角色的權限管理,支持菜單權限、操作權限(按鈕權限)、接口權限、數據權限。

引言

時間真快,轉眼今年又要過去了。回想今年,依次開源發佈了 Colder.Fx.Net.AdminLTE(254Star)Colder.Fx.Core.AdminLTE(335Star)DotNettySocket(82Star)IdHelper(47Star) ,這些框架及組件都是本着以實際出發,實事求是的態度,力求提高開發效率(我自己都是第一個使用者),目前來看反響不錯。但是隨着前端和後端技術的不斷變革,尤其是前端,目前大環境已經是前後端完全分離爲主的開發模式,在這樣的大環境和必然趨勢之下,傳統的MVC就顯得有些落伍了。在這樣的背景下,一款前後端分離的.NET開發框架就顯得尤爲必要,由此便定了框架的升級目標: 前後端分離

首先後端技術的選擇,從目前的數據來看,.NET Core的發展遠遠快於.NET Framework,最簡單的分析就是Colder.Fx.Core.AdminLTE發佈比Colder.Fx.Net.AdminLTE晚,但是星星卻後來居上而且比前者多30%,並且這個差距在不斷擴大,由點及面的分析可以看出我們廣大.NET開發人員學習的熱情和積極向上的態度,並不是某些人所認爲的那麼不堪( 走自己的路,讓別人說去吧 )。大環境上微軟積極擁抱開源,大力發展.NET Core, 可以說前途一片光明。因此後端決定採用  .NET Core3.1 ,不再浪費精力去支持.NET Framework。

然後是前端技術選擇,首選是三大js框架選擇,也是從實際出發,Vue相對其它而言更加容易上手,並且功能也毫不遜色,深得各種大小公司喜歡,如果偏要說缺點的話,那就是對TS支持不行,但是即將發佈Vue3.0肯定會改變這一缺陷。選擇了Vue之後,然後就是UI框架的選擇了,這裏的選擇更多了,我選擇了Ant Design Vue,理由便是簡潔方便,十分符合我的設計理念。

技術選型完畢之後便進入研發,由於鄙人前端比較菜,因此需要從頭學Vue2.x全家桶,從開始到現在差不多經歷3個月,在預期之內。其實學習並使用前端的Vue2.x全家桶並不難,還是比較容易上手的,所以在此給沒有前後端分離開發經驗的老哥打一記預防針,不要退縮,要知難而上,學習永無止境。

某些老哥可能比較直接粗暴,嫌我BBB嘮叨,下面直接上地址

代碼(GitHub):https://github.com/Coldairarrow/Colder.Admin.AntdVue

文檔(GitHub):https://github.com/Coldairarrow/Colder.Admin.AntdVue/wiki

代碼(碼雲鏡像):https://gitee.com/Coldairarrow/Colder.Admin.AntdVue

文檔(碼雲鏡像):https://gitee.com/Coldairarrow/Colder.Admin.AntdVue/wikis

在線預覽地址:http://coldairarrow.gitee.io/coler.antdvue.preview

由於服務器是阿里雲的86服務器,帶寬1M小水管,因此將前端部署到碼雲上了,在此多謝 碼雲 ,後端部署在阿里雲86服務器CentOS7上。整個技術棧使用 .NET Core + PostggreSQL+ Ant Design Vue + CentOS7+Nginx+Dokcer+jenkins ,囊括了從快速開發到自動化部署一條龍,開源免費並具有高性能、高移植性、高拓展性( 小公司創業選型+個人接單利器

簡介

本框架爲.NET Core3.1+Ant Design Vue版

本框架旨在極大的提高開發效率

使用技術棧:

後端:採用.NET Core平臺,ASP.NET Core3.1,C#語言(使用反射等高級技術),Entity FrameworkCore(數據庫ORM框架)。

使用數據倉儲模式,抽象化數據庫操作(CRUD等)、支持事務處理以及分佈式事務處理(跨庫)

支持數據庫讀寫分離、分庫分表及事務(僅支持單表操作,不支持多表) 全面採用Autofac作爲IOC容器,面向接口編程,全面解耦

集成多種工具類庫以及操作拓展

數據庫:支持SqlServer,PostgreSQL,MySQL,Oracle(框架使用簡單工廠,工廠方法,抽象工廠,可輕鬆更換數據庫),Redis作爲分佈式緩存

前端:Vue2.x全家桶+Ant Design Vue,其中集成常用組件,力求方便項目開發。

具體技術實施:

項目採用前後端完全分離模式,並採用嚴格分層模式,極大的增加聚合度,降低耦合度,

提高代碼的健壯性,可維護性。

前後端通過JWT進行身份驗證,通過數據接口操作數據,統一使用JSON作爲數據格式,並使用默認接口簽名算法保證接口的安全性。

功能架構部分詳解:

快速開發:此功能爲框架的核心,通過選擇數據庫中的表,就能自動生成對應的實體層、業務邏輯層、控制器、前端頁面Vue文件,無需編寫代碼即可生成基本的CRUD操作。

接口密鑰管理:管理接口的密鑰,若開啓接口簽名的規則,則前端需要通過給接口簽名才能夠正常訪問後臺接口。

權限管理:使用基本的RBAC權限控制,支持操作權限、接口權限以及數據權限

框架主要功能及特色如下

功能 詳細描述
用戶登錄 用戶登錄、密碼修改
系統用戶管理 系統用戶管理
角1色管理 角色管理
部門管理 部門管理、天然多級
權限管理 使用RBAC權限體系,基於角色的權限管理,支持菜單權限、操作權限(按鈕權限)、接口權限、數據權限
系統日誌 支持多彩控制檯、文件、數據庫和ElasticSearch記錄日誌,框架全局異常自動捕捉,多級別記錄
快速開發 通過數據庫直接生成實體層、業務邏輯層、控制器層以及前端頁面Vue代碼,無需編碼即可實現CURD
數據庫操作封裝 使用基於EF的倉儲模式、封裝常用的CURD,支持單庫事物和分佈式事物
多數據庫支持 使用基於EF的倉儲模式,支持各大主流關係型數據庫(SQLServer、MySQL、PostgreSQL和Oracle)
超強移植性 使用抽象工廠封裝數據庫操作層,切換數據庫 0 代碼修改
支持 軟刪除 一鍵切換刪除模式,支持物理刪除和軟刪除,對業務操作透明
緩存支持 支持系統自帶緩存和Redis緩存、封裝操作接口、簡單易用
前後端完全分離 前端使用Vue2.x全家桶+Ant Design Vue,界面簡潔美觀,組件化開發
集成JWT驗證 框架使用JWT作爲身份驗證,擺脫Cookie苦海,分佈式拓展毫無壓力
集成對外接口簽名算法 框架對外接口可以開啓超強嚴格簽名校驗(防抵賴、防僞造、防重複調用),保障系統安全性
頁面響應式 前端爲單頁應用,無iframe,各大主流瀏覽器支持友好
拓展 其它各種幫助類庫及插件

其相關版本請看下錶:

.NET版本 前端UI 地址
Core3.1 Ant Design Vue https://github.com/Coldairarrow/Colder.Admin.AntdVue
Core2.2 AdminLTE https://github.com/Coldairarrow/Colder.Fx.Core.AdminLTE
.NET4.72 AdminLTE https://github.com/Coldairarrow/Colder.Fx.Net.AdminLTE
.NET4.52 Easyui https://github.com/Coldairarrow/Coldairarrow.Fx.Net.Easyui.GitHub
Core2.1 Easyui https://github.com/Coldairarrow/Coldairarrow.Fx.Core.Easyui.GitHub
.NET4.0 Easyui https://github.com/Coldairarrow/Coldairarrow.Fx.Net40.Easyui.GitHub

後臺效果展示如下:

環境搭建

開發環境要求:

操作系統:Windows 10

後端開發工具:Visual Studio 2019+

前端開發工具:Visual Studio Code,安裝 nodejs , yarn

SDK:安裝.NET Core SKD 3.0 及以上

數據庫:SQLServer2008 R2及以上

基礎數據庫構建:

  • 數據庫創建

    目錄"/docs/初始化文件"中有所需的數據庫資料

    先手動創建數據庫,然後執行對應的SQL腳本即可

  • 連接字符串配置

    打開src目錄下Colder.Admin.AntdVue的解決方案,如下圖

如下圖所示依次展開05.Coldairarrow.Api/appsettings.json,配置數據庫連接字符串,name不用修改,connectionString改爲上述創建的數據庫(若不清楚數據庫連接字符串請自行百度搜索教程)

數據庫設計規範

由於本框架支持自動生成代碼的核心功能,此功能是根據數據庫的表結構來生成代碼的

因此規定每張表都有一個主鍵,列名爲Id,類型爲字符串,實際添加數據時默認使用SnowflakeId(雪花Id,Twitter設計的分佈式趨勢自增Id,若不清楚請自行百度相關資料),表中的每個列都需要有描述信息(建議這樣操作,若不按照這個標準則需要一些額外的改動才能夠成功運行)。每張表都需要 Id、CreateTime、CreatorId 這幾個必帶字段

運行

後端:打開解決方案=>還原nuget包=>配置數據庫=>運行(05.Coldairarrow.Api設爲啓動項目)

後臺成功運行後會自動打開swagger

前端:確保已安裝 nodejsyarn

用VS Code 打開文件夾src\Coldairarrow.Web

輸入命令: yarn

輸入命令: yarn run serve

成功運行後即可打開登錄頁面

輸入賬號:Admin,密碼:123456進入後臺主頁

使用教程

系統配置

05.Coldairarrow.Api/appsettings.json 中配置了系統的必要參數,其中包括數據庫類型、連接字符串、日誌配置等,具體配置參考註釋

快速開發

此功能爲本框架的核心功能,能夠自動生產完整的可運行代碼,具體使用如下:

  • 配置數據源

首選需要有數據庫源,因爲代碼生成是根據數據庫表來生成的。

菜單:開發=>數據庫連接

若列表中沒有目標數據源,則添加數據庫連接

數據連接名、連接字符串、數據庫類型即可。添加完成後即可看到連接字符串信息。

  • 生成代碼

有了數據庫連接之後,即可進行代碼生成。

菜單:開發=>代碼生成

選擇數據庫,然後勾選需要生成代碼的數據庫表,點擊生成代碼會彈出生成選項(這裏演示勾選 Base_BuildTest,其餘表全是系統基礎表,不要勾選,否則會被覆蓋,導致異常,請勾選自己的業務表進行生成):

生成選項中可以選擇需要生成的類型,默認生成全部:實體層、業務層、接口層(即控制器)和頁面(Vue前端頁面代碼)。

生成區域請輸入業務模塊名(例如系統叫Base_Manage),請按具體業務填入(必填)

這裏示例填寫TestManage,點擊生成按鈕,即可完成代碼生成。生成後的代碼在項目解決方案中,將代碼文件包括進入項目

默認生成後的文件會被自動包括到解決方案中,若沒有則需要點擊顯示所有文件按鈕,即可看到生成後的新文件

生成的實體層、業務邏輯層、控制器層代碼:

前端生成的代碼:

後端代碼添加後需要重新編譯下(F7),編譯後好可以看到有新的接口

前端生成代碼後會自動保存並編譯(別的文件修改保存也會自動編譯,畢竟編譯一次挺慢的),不放心可以Ctrl+C停止,然後再yarn run serve重新運行

代碼生成完畢,但是要展示到菜單上需要進行配置,並且所有業務菜單都是動態的(權限控制)

打開菜單:系統管理=>權限管理=>新建

菜單名:即需要顯示的菜單名

上級菜單:菜單是多級樹狀的,可以放在某個菜單下面

類型:可以選擇菜單或頁面,這裏是具體的頁面,所以選頁面

路徑:頁面的路徑,菜單可以不配置,這裏配置爲/TestManage/Base_BuildTest/List,這裏設置規則爲:views文件夾爲根路徑(即"/"),向下展開依次爲/TestManage/Base_BuildTest/List,最後真正的列表頁爲List.vue文件,表單頁爲EditForm.vue文件

是否需要權限:若爲“否”,則此頁面不限制權限,即所有人都能看

圖標:菜單顯示圖標,具體到開發=>圖標選擇頁進行選擇

排序:若需要需要對菜單進行排序則設置,默認0,類型爲int

頁面權限:頁面擁有的權限(權限值唯一,作爲操作權限即接口權限的依據),詳見 權限管理

確認保存,然後刷新整個頁面(F5),即可看到全新生成的菜單“生成測試”

整個代碼生成過程,無需編寫代碼即可完成一張表的CRUD,當然需要根據具體業務中進行相應的修改,本次示例中字段比較少,但是當一張表的字段很多時,那麼此功能能夠將開發效率提高几個檔次。

管理員登錄

默認超級管理員賬號爲:Admin

密碼爲:123456

系統用戶管理

管理系統登錄的用戶

菜單:系統=>用戶管理

點擊右側設置權限

系統角色管理

管理系統角色,角色是權限的載體,合理分配角色有利於權限管理

菜單:系統=>角色管理

操作中可以設置角色的權限,詳情見<權限管理>模塊

權限管理

一般情況下,後臺管理系統多少會涉及權限管理,因此本框架提供了一個靈活、高效、簡潔的權限管理系統。

首先,權限分爲兩種,即 操作權限數據權限 ,其中操作權限主要包括菜單權限和按鈕權限,在角色編輯表單中,給角色勾選需要的權限即可,用戶可以分配多個角色,繼承所有角色的權限。

如上圖,按需勾選,有人會疑問爲什麼只有增、改和刪的權限而沒有查的權限,其實這裏考慮到了當勾選“用戶管理”時,就已經默認擁有“查”的權限了,這裏再設置“查”權限豈不是多此一舉,可以根據實際業務需求添加諸如申請、審覈等權限,靈活應用。

這裏的樹狀是和菜單一一對應的,勾選哪些菜單就擁有哪些菜單

下面介紹下最常用的 按鈕權限

如上圖,在需要控制權限的按鈕使用 v-if="hasPerm('Base_User.Add')" ,表示只有當用戶擁有權限值 Base_User.Add 才顯示此按鈕,權限值就是權限表單中配置的權限值

這裏的按鈕級權限控制只能夠在前端控制操作入口,若系統對安全性要求較高,則需要控制接口權限

如上圖,在需要權限控制的接口加上 ApiPermission 特性即可,參數也爲權限值,只有擁有此權限才能訪問此接口

數據權限比較複雜,若採用純SQL方式,那麼會更加複雜,本框架全程採用EF作爲ORM框架,通過對IQueryable< T >進行過濾,即可完成數據權限控制,詳細使用方式見 用戶管理

更詳細的使用方式,請參考 源代碼 中的 用戶管理模塊(菜單權限、操作權限、數據權限、聯表查詢、業務層AOP等使用方式均可參考此模塊)

接口祕鑰管理

作爲對外接口簽名的AppId和AppSecret管理

菜單:系統=>接口祕鑰管理

系統日誌

菜單:系統=>系統日誌

操作日誌

菜單:系統=>操作日誌

事務使用

系統採用AOP管理事務,使用十分簡單,只需要在需要事務包裹的方法中添加 Transactional 特性,無需任何其他處理,系統會自動捕捉異常並回滾,而且支持多庫事務(即使用多個不同的IRepository也會在同一個事務中處理)

讀寫分離分庫分表

系統採用 EFCore.Sharding 組件,具體使用方式請移步EFCore.Sharding

常見疑問

如何進行聯表查詢

框架使用EF+LINQ進行聯表操作,核心在於對IQueryable< T >的使用,另可網上搜EF+LINQ的相關教程。

示例如下:

Base_User表左連接Base_Department表獲取DepartmentName屬性

//定義數據模型類
public class Base_UserTestDTO : Base_User
{
    public string DepartmentName { get; set; }
}

//即BaseBusiness中的Service
var db = DbFactory.GetRepository();
Expression<Func<Base_User, Base_Department, Base_UserTestDTO>> select = (a, b) => new Base_UserTestDTO
{
    DepartmentName = b.Name
};
select = select.BuildExtendSelectExpre();
var q = from a in db.GetIQueryable<Base_User>().AsExpandable()
        join b in db.GetIQueryable<Base_Department>() on a.DepartmentId equals b.Id into ab
        from b in ab.DefaultIfEmpty()
        select @select.Invoke(a, b);
//篩選
var where = LinqHelper.True<Base_UserTestDTO>();
where = where.And(x => x.UserName == "Admin");

//獲取篩選數據
var list = q.Where(where).ToList();

源碼可參考 Base_UserBusiness.GetDataList

如何切換數據庫類型

修改05.Coldairarrow.Api/appsettings.json中的 DatabaseType

修改相應的數據庫連接字符串

安裝相應的數據庫Nuget包

注意:若使用Oracle,只能使用2.x版本的包(EFCore.Sharding也要降級爲2.x),因爲EF Core3.x版本暫不支持Oracle,其餘版本數據庫使用最新版即可

如何使用多個數據庫

默認框架會自動注入IRepository作爲數據庫訪問接口,在需要的時候注入即可,若系統需要操作多個數據庫,那麼需要定義額外的接口繼承IRepository然後配置注入進去即可訪問

  • 先定義新的接口IMyRepository

  • 然後配置數據庫類型和連接字符串

  • 使用IMyRepository

這樣就可以在任何地方注入並使用IMyRepository,更多數據庫同理配置即可

結語

歡迎使用本框架,若覺得不錯,請比心

相關文章