Web後臺快速開發框架(支持.NET Core2.1,.NET452,.NET40)

Web後臺快速開發框架使用說明書

Coldairarrow

目錄

簡介

本框架旨在爲.NET開發人員提供一個Web後臺快速開發框架，採用本框架，可以極大的提升項目開發效率。

整個框架包括三個版本：

.NET新版，採用.NET452,GitHub地址爲：https://github.com/Coldairarrow/Coldairarrow.Fx.Net.Easyui.GitHub

.NET40版，採用.NET40,GitHub地址爲：https://github.com/Coldairarrow/Coldairarrow.Fx.Net40.Easyui.GitHub

.NET Core版，採用.NET Core2.1, GitHub地址爲：https://github.com/Coldairarrow/Coldairarrow.Fx.Core.Easyui.GitHub

以上三個版本中，.NET新版，主要支持最新的技術方案，做爲主要生產版本；.NET40版是爲了兼容Windows 2003服務器而降級的版本，功能正常。.NET Core 版本是將來的發展方向，可以跨平臺，而且涉及Linux、Docker、Nginx、微服務等概念，已完成移植。

基礎準備

開發環境要求

操做系統：Windows 10

開發工具：Visual Studio 2017

SDK：安裝.NET4.52及以上

數據庫：SQLServer2008 R2及以上

基礎數據庫構建

使用本框架須要構建基礎數據庫，具體步驟以下：

建立基礎數據庫的Sql腳本文件在：/docs/初始化文件/db.sql，在數據庫中運行db.sql腳本便可建立數據庫:Coldairarrow.Fx.Net.Easyui.Git

若Sql運行出錯，請直接使用同目錄下的Coldairarrow.Fx.Net.Easyui.GitHub.bak還原數據庫

打開src目錄下Coldairarrow.Fx.Net.Easyui.Git.sln的解決方案，以下圖

以下圖所示依次展開05.Coldairarrow.Web=>Config=>database.config，配置數據庫鏈接字符串，name不用修改，connectionString改成上述建立的數據庫（若不清楚數據庫鏈接字符串請自行百度搜索教程）

自此基礎數據庫配置完成。

運行

請先還原Nuget包

而後將05.Coldairarrow.Web設爲啓動項目，成功運行便可進入如下頁面

詳細教程

代碼架構

整體架構

框架組成結構一共分爲5層，如上圖所示，分別以下：

基礎設施層：此層爲最底層，能夠爲其他全部層服務。主要提供了項目開發所需的各類幫助類：數據庫訪問幫助類、文件操做幫助類、二維碼生成幫助類、分揀壓縮幫助類等等其他幫助類；拓展類：字符串拓展類、集合操做拓展類、表達式樹拓展類等等其他拓展類；還集成了我的編寫的Socket通信框架，WCF拓展使用框架，Windows服務容器。這些豐富的類庫都是爲開發人員提供了開發中經常使用的功能，爲快速開發提供強有力的保障。

數據倉儲層：這層主要爲對數據庫操做CRUD的簡單封裝，以EntityFramework爲核心，採用簡單工廠、抽象工廠、工廠方法、三個工廠設計模式，使開發人員進行CRUD只須要極爲簡單的代碼便可完成。本層還提供了數據庫事務的支持，更是提供了分佈式事務支持，爲數據庫操做提供必備的保障。使用本層提供的接口，無需關心具體的數據庫類型，好比是採用SQLServer數據庫或者MySQL數據庫，開發人員只須要關心具體的業務邏輯實現，哪怕更換數據庫，也無需更改業務邏輯代碼，只須要更改簡單的數據庫配置便可。總之，本層爲開發人員對數據庫的操做提供了簡單高效的操做接口，能夠極大的提升開發效率。

實體層：這層主要爲ORM框架數據庫表對應的實體類，爲業務邏輯層和應用層服務。

業務邏輯層：本層是開發人員主要編寫層，經過調用數據倉儲層操做數據庫，併爲應用層提供所需的接口，處理具體操做的業務邏輯，能夠說是最爲複雜的一層。

應用層：本層在本框架中表現形式爲ASP.NET MVC網站，其實也能夠泛指其他的表現形式：控制檯程序、Windows服務程序、WinForm程序、WPF程序等等。本層爲具體的應用，負責系統功能的實現。

基礎設施層

此層爲最底層，能夠爲其他全部層服務。主要提供了項目開發所需的各類類庫，主要爲如下幾種類庫：

1. 拓展幫助類

利用C#的語法糖（是由英國計算機科學家彼得·約翰·蘭達（Peter J. Landin）發明的一個術語，指計算機語言中添加的某種語法，這種語法對語言的功能並無影響，可是更方便程序員使用），能夠在類上拓展自定義方法，這樣開發人員在使用的時候就能夠十分的方便，既能減小重複的代碼又能加快開發效率。具體包含但不限於如下類：

Object拓展：Object是全部類的基類。如今先後端數據交互中，採用JSON是選擇，所以對象JSON序列化與反序列化的使用就十分的頻繁，經過給Object拓展ToJson方法，就能夠將數據對象直接轉爲對應的JSON字符串，可以極大的簡化JSON序列化所須要的代碼。

Byte拓展：Byte，即字節，一個字節是8個比特位，十進制數值範圍在0-255。因爲Byte與二進制是直接對應的，而計算機中一切數據都是二進制，因此關於Byte與其餘數據類型之間的轉換就顯得尤其重要，編寫Byte相關的拓展方法可以方便Byte的使用。例如，拓展將Byte數組轉爲16進制字符串的方法，可以將字節數組直接轉爲對應的16進制字符串，如今物聯網的發展也十分的迅速，在物聯網開發中，關鍵是創建與硬件之間的通訊，可是因爲硬件的配置通常都不高，所以與硬件之間的通訊大多以字節爲單位，這種狀況下，使用該拓展方法就能夠提升開發效率。

Expression拓展：Expression，即表達式樹，在LINQ查詢中常用。在平常使用中,Where篩選估計是用得最多的，可是大多數開發人員都是使用最原始的Where篩選，當篩選條件增多，篩選條件變複雜的時候，原始的Where雖然也能夠勝任，可是就會致使代碼重複，不夠簡潔雅觀，此時能夠爲Expression<Func<T, bool>>類拓展And與Or方法，其中And是「與」操做，Or是「或」操做，這樣就能夠將多個篩選條件拼接在一塊兒，十分的實用。

IQueryable<T>拓展：IQueryable<T>是提供針對特定數據源（其中數據類型未未知）評估查詢的功能接口，其在EntityFramework中發揮着重要的做用。例如，在後臺管理系統中，數據表格的使用最爲廣泛，前端向後臺請求表格數據時，不外乎須要如下幾個參數：當前請求頁碼、每頁記錄數、排序列與排序類型，這些參數在每一個請求表格數據請求中都須要處理，這時，經過給IQueryable<T>拓展GetPagination<T>方法，只須要傳入分頁參數，就能夠獲取所需的數據表格數據，十分的方便高效。

1. 工具幫助類

主要提供了經常使用的一些幫助類，包含但不限於：

Office辦公文檔導入導出幫助類：當今，隨着人們環保意識的加強，以及各行業對辦公模式需求的不斷升級，現代化、信息化建設步伐的加快，無紙化辦公已經由概念逐漸應用到多個行業領域中，辦公中，各類辦公文件，尤爲是Excel文件與Word文件常常須要導入與導出，可是C#操做Excel與Word文件並不簡單，常常困擾着開發者，由此，本框架提供了Office文檔操做幫助類，封裝簡化了對辦公文檔的經常使用操做，可以下降開發難度，提升開發效率。

HTTP請求模擬幫助類：在傳統網站開發中，通常都是前端瀏覽器向後臺發起請求，可是，如今的系統與系統之間的合做愈來愈緊密，常常須要後端向後端發起請求，即須要後端模擬HTTP請求，但編寫一個完整的HTTP請求並非那麼容易，所以本框架提供HTTP請求幫助類，開發人員只須要傳入須要請求的URL地址與參數便可完成HTTP請求操做，使用起來簡單高效，可以極大的提升開發效率。

1. 緩存操做幫助類

在現代化系統開發中，隨着業務量的增大，系統性能就難以知足要求，要達到性能要求，一方面能夠採用更好的硬件，可是成本較高，而另外一方面就是使用緩存，有效使用緩存可以提升吞吐量與併發量，所需成本較低，是絕大多數用戶的首選。

.NET Framework框架提供了系統緩存，雖然使用簡單方便，可是不支持分佈式，所以大多選擇諸如Redis和Memcached緩存，可是不一樣的緩存爲開發者提供的接口不同，當使用不一樣的緩存時開發人員又須要去學習別的緩存操做接口，十分的麻煩，爲解決這個問題，本框架提供了緩存操做幫助類。緩存操做幫助類將緩存核心操做抽象定義成操做接口：添加緩存、刪除緩存、設置緩存過時時間，而後再用Redis與系統緩存實現抽象接口，當使用緩存時可使用一樣的操做接口操做不一樣的緩存，可以下降開發人員學習成本，提升開發效率。

1. 數據庫操做幫助類

不管什麼網站，只要須要對數據進行操做，那麼大多離不開數據庫。數據庫目前使用最多的就是三大關係型數據庫：SQLServer、MySQL與Oracle，訪問數據庫須要一系列的程序：首先須要建立數據庫鏈接對象，緊接着打開數據庫，其次傳入數據庫操做命令，而後執行命令，最後獲得數據結果，若每次訪問數據庫都要寫一遍這些流程，那麼將會極大的阻礙開發效率，所以，本框架提供了數據庫操做幫助類，將數據庫操做所須要的流程封裝，開發人員只須要關心具體的SQL語句的編寫便可，而且支持三大關係型數據庫，適合不一樣的開發人員使用。

數據倉儲層

在後端開發中，數據庫操做是最頻繁的，每個後端開發人員或多或少都會接觸，甚至很多開發人員天天的工做就是與數據庫打交道，因此可見數據庫操做是多麼的重要。在如今開發的過程當中，絕大多數開發人員只是以編寫SQL語句的方式操做數據庫，這種方式是操做數據庫最基本最原始的方式，簡單高效，可是在編寫SQL語句的過程當中，極容易因馬虎大意而編寫錯誤，就會出現一個現象：開發人員面對着一堆SQL語句在DEBUG，並且每次都須要開發人員本身去手寫SQL語句，其開發效率極低。哪怕開發人員足夠出色，可以保證編寫的SQL語句較低的出錯率，可是，不一樣的數據庫所須要的SQL語句仍是有差別的，這就須要開發人員學習不一樣的數據庫SQL語法，添加學習成本。並且在項目開發中不免會遇到更換數據庫的狀況，這時還須要花費大量的精力去進行修改SQL語句。

在本框架的數據倉儲層中，上述問題便可迎刃而解。數據倉儲層，不一樣於傳統三層架構中的數據層，其核心繼承關係圖以下圖所示（圖6-1）：

圖6-1 數據倉儲類圖

如上圖所示，首先定義了數據操做接口IRepository,該接口包含了增、刪、改、查、事物控制等數據庫經常使用核心操做，可以知足對數據庫的經常使用操做，DbRepository類實現了IRepository接口，主要以ORM框架Entity Framework爲基礎，封裝實現了大部分IRepository所需的操做，SqlServerRepository、MySqlRepository和PostgreSqlRepository分別實現具體數據庫對應的數據倉儲，並且繼承自同一個數據操做接口IRepository，所以在具體的使用上，能夠實現以同一個操做方法訪問不一樣的數據庫，當遇到須要更換數據庫的狀況時，採用本框架開發的系統可以不改代碼而正常運行，這一點可以極大的下降軟件開發成本。而且以Entity Framework爲核心，不須要編寫SQL語句就可以完成絕大部分的數據庫操做，再加上簡潔的LINQ配合，完全將開發人員從SQL語句中解放出來，讓開發人員可以更加專一於業務邏輯的實現，可以極大的提升軟件開發效率。

IRepository代碼以下：

using System;

using System.Collections.Generic;

using System.Data;

using System.Data.Common;

using System.Data.Entity;

using System.Linq;

using System.Linq.Expressions;

namespace Coldairarrow.DataRepository

{

public interface IRepository

{

#region 數據庫鏈接相關方法

DbContext GetDbContext();

#endregion

#region 事物提交

/// <summary>

/// 開始單庫事物

/// 注意:若要使用跨庫事務,請使用DistributedTransaction

/// </summary>

void BeginTransaction();

bool EndTransaction();

#endregion

#region 增長數據

void Insert<T>(T entity) where T : class, new();

void Insert<T>(List<T> entities) where T : class, new();

void BulkInsert<T>(List<T> entities) where T : class, new();

#endregion

#region 刪除數據

void DeleteAll<T>() where T : class, new();

void Delete<T>(string key) where T : class, new();

void Delete<T>(List<string> keys) where T : class, new();

void Delete<T>(T entity) where T : class, new();

void Delete<T>(List<T> entities) where T : class, new();

void Delete<T>(Expression<Func<T, bool>> condition) where T : class, new();

#endregion

#region 更新數據

void Update<T>(T entity) where T : class, new();

void Update<T>(List<T> entities) where T : class, new();

void UpdateAny<T>(T entity, List<string> properties) where T : class, new();

void UpdateAny<T>(List<T> entities, List<string> properties) where T : class, new();

#endregion

#region 查詢數據

T GetEntity<T>(object keyValue) where T : class, new();

List<T> GetList<T>() where T : class, new();

IQueryable<T> GetIQueryable<T>() where T : class, new();

DataTable GetDataTableWithSql(string sql);

DataTable GetDataTableWithSql(string sql, List<DbParameter> parameters);

List<T> GetListBySql<T>(string sqlStr) where T : class, new();

List<T> GetListBySql<T>(string sqlStr, List<DbParameter> parameters) where T : class, new();

#endregion

#region 執行Sql語句

void ExecuteSql(string sql);

void ExecuteSql(string sql, List<DbParameter> parameters);

#endregion

}

}

數據實體層

因爲框架主要採用了Entity Framework做爲ORM框架，這其中數據庫實體映射必不可少，須要將數據庫中每張表映射到類中，而且一張表一個類。這些實體類即可以做爲數據庫操做中的實體，還可以做爲DTO(Data Transfer Object)，將這些實體類劃分爲獨立的一層，可以方便對實體的管理，易於開發與維護。

業務邏輯層

在整個後端開發中，業務邏輯的處理是最複雜的，由於從技術角度來說，不少技術都可以實現代碼複用，即無需重複造輪子（重造輪子是重複創造一個已經存在的基本方法或者被其餘人優化），並且只要會使用了就可以快速投入生產中，雖然技術能夠從設計上實現代碼重用，下降學習成本，可是不一樣的系統其業務邏輯一般是不可複製的，所以開發人員能夠不關心具體數據倉儲的實現技術，可是不得不關心具體業務邏輯的實現，既然業務邏輯沒法避免又那麼複雜，那麼設計出合理的業務邏輯架構來加快開發效率就顯得尤其重要。

本框架將業務邏輯獨立一層，其核心繼承關係以下圖（圖6-2）所示：

圖6-2 業務邏層次圖

如上圖所示：首先定義了一個業務邏輯基類BaseBusiness<T>，該基類實現了全部調用數據倉儲的方法，其他全部業務處理類都須要繼承自基類BaseBusiness<T>，其中泛型T爲數據庫實體，通常默認操做但張表，但在實際運用中連表操做十分的廣泛，所以在BaseBusiness中提供了Service屬性，該屬性爲IRepository類型，所以能夠操做泛型接口，傳入不一樣的實體類型便可對應到所需表的操做，故而支持聯表操做，方便開發人員操做數據庫。基類還提供了通用業務邏輯返回數據，Success和Error分別對應成功請求返回和失敗請求返回，統一數據格式，方便先後端開發對接。

應用展現層

這層也能夠稱之爲應用層，其他的層表現形式都是類庫，而這一層負責具體項目應用的實施，好比可使用控制檯程序、Windows服務程序、WinForm程序、WCF程序等等,在本項目中使用了ASP.NET MVC網站項目負責具體功能的實現。

AOP（Aspect Oriented Programming）使用：AOP，即面向切片編程，利用AOP可以將系統各個部分進行隔離，從而下降模塊之間的耦合度，提升程序可用性，同時提升開發效率。本框架中主要使用瞭如下AOP：

管理員登陸校驗CheckLoginAttribute：在後臺管理系統中，管理員只有登陸後纔可以進行相關操做，通常經過Session來記錄管理員登陸信息，最簡單直接就是在每個請求中都須要判斷一遍管理員是否登陸，這無疑將會致使不少的重複代碼，此時，經過將登錄校驗做爲一個特性，只須要在須要登陸的控制器或方法上添加該特性便可完成管理員登陸校驗，這樣就可以減小大量的重複代碼，加快開發效率。

簽名校驗CheckSignAttribute：當後端接口須要給外部系統調用時，若不對接口訪問進行限制，那麼就會面臨惡意請求攻擊的風險，輕則影響系統性能，重則致使系統癱瘓，數據被惡意串改，此時，保證接口的安全性就十分關鍵。保證接口的安全性，主要就是按照必定的簽名算法，對請求者傳入的參數進行簽名校驗，只有經過纔可以正常訪問，原始作法就是在每一個請求中去進行簽名校驗，這一樣會致使大量的重複代碼，這時經過引入簽名校驗特性，只須要在須要簽名校驗的控制器或方法中加入特性便可，使用簡單方便，開發效率也高。

應用層還在視圖中使用了通用佈局模板，並統一了代碼規範，再集成了JQuery以及一些其它經常使用的JS類庫，以Layui爲主要前端UI框架，界面風格統一，開發效率高。

功能架構

全局配置

在01.Coldairarrow.Util中的GlobalSwitch類中，設置了各個參數，其中RunModel須要重點關注一下，若RunModel==RunModel.LocalTest，則系統會直接跳過登陸，默認使用Admin超級管理員登陸，其它參數請看註釋。

快速開發

使用此功能請確保GlobalSwitch.RunModel= RunModel.LocalTest

此功能爲本框架的核心功能，可以自動生產完整的可運行代碼，具體使用以下：

首選須要有數據庫源，由於代碼生成是根據數據庫表來生成的。

菜單：開發=>快速開發=>數據庫鏈接管理

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

數據鏈接名、鏈接字符串、數據庫類型（目前不支持Oracle，有空餘時間再研究）便可。添加完成後便可看到鏈接字符串信息。

有了數據庫鏈接以後，便可進行代碼生成。

菜單：開發=>快速開發=>代碼生成

選擇數據庫，而後勾選須要生成代碼的數據庫表，點擊生成代碼會彈出生成選項（這裏暫時只能勾選Dev_Project，其他表全是系統基礎表，不要勾選，不然會被覆蓋，致使異常，請勾選本身的業務表進行生成）：

生成選項中能夠選擇須要生成的類型，能夠默認生成實體層、業務邏輯層、控制器和視圖。

生成區域對應MVC中的Areas，請按需填入（必填）

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

默認生成後的文件是隱藏的，須要點擊顯示全部文件按鈕，便可看到生成後的新文件

右鍵新的文件夾，包括在項目中

因爲是新生成的代碼，因此才配置新的菜單

如上圖，在Web項目中的Config/SystemMenu.config中配置菜單，模仿原有菜單便可，其中Url是指頁面的路徑，Permission是指若須要訪問此菜單須要的權限（對應權限配置），若沒有此權限，則菜單也中不會顯示此菜單，修改完成後從新編譯生成（權限相關模塊進行了緩存，從新生成會清緩存），從新運行便可看到新的項目菜單以下：

整個代碼生成過程，無需編寫代碼便可完成一張表的CRUD，固然須要根據具體業務中進行相應的修改，本次示例中字段比較少，可是當一張表的字段不少時，那麼此功能可以將開發效率提升幾個檔次。

管理員登陸

若要使用登陸功能，請將GlobalSwitch中的RunModel改成RunModel.Publish

默認超級管理員帳號爲：Admin

密碼爲：123456

系統用戶管理

管理系統登陸的用戶

菜單：系統=>系統管理=>用戶管理，以下頁面

點擊右側設置權限，能夠設置用戶權限，詳情見<權限管理>模塊

具體權限相關配置見權限管理模塊

系統角色管理

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

菜單：系統=>系統管理=>角色管理

操做中能夠設置角色的權限，詳情見<權限管理>模塊

權限管理

通常狀況下，後臺管理系統多少會涉及權限管理，所以本框架提供了一個靈活、高效、簡潔的權限管理系統。

首先，權限分爲兩種，即操做權限和數據權限，其中操做權限報貨系統用戶權限和AppId權限，系統用戶權限就是指操做用戶具有哪些權限，而當對外提供Api接口時，爲了保證接口的安全性（若不在乎可忽略），一般會提供接口簽名算法，其中AppId和AppSecret是必備的，經過對AppId設置權限，便可控制接口的權限。數據權限比較複雜，若採用純SQL方式，那麼會更加複雜，本框架全程採用EF做爲ORM框架，經過對IQueryable<T>進行過濾，便可完成數據權限控制。

用戶權限：若對每一個用戶都設置對應的權限，那麼工做量無疑是十分巨大的，所以引入了角色的概念，角色是權限的集合載體，那麼屬於此角色的用戶就繼承了角色的權限，固然某些特殊用戶須要擁有本身的不屬於角色的特殊權限，所以最終用戶擁有的權限就是本身的權限和所屬角色權限的並集。

權限使用：

權限定義：

如上圖，在Permission.config中定義了各個權限

權限配置：

在系統用戶管理和系統角色管理中能夠設置用戶和角色的權限，把須要的權限勾選便可。

權限使用：

如上圖所示，在須要控制權限的頁面中，調用方法：PermissionManage.OperatorHasPermissionValue("sysuser.manage")

這個方法是判斷操做者用戶是否含有sysuser.manage權限值，其中sysuser是指Permission.config中定義的module的value屬性，manage是指permission中的value屬性，用.鏈接便是最終權限值。

更詳細的使用方式，請參考源代碼。

接口祕鑰管理

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

系統日誌

菜單：系統=>系統管理=>系統日誌

結語

歡迎使用本框架，若以爲不錯，請比心

Github:https://github.com/Coldairarrow，請Statrt

博客園：https://www.cnblogs.com/coldairarrow/

QQ羣：373144077

本人將會對這個快速開發框架不斷完善與維護，但願可以幫助到各位

若遇到任何問題或須要技術支持，請聯繫我。

---------------------學習永無止境，技術永無上限，代碼就是藝術-----------------------