SnailAspNetCoreFramework

項目介紹

• 本專案定位為基於asp.net core的中小企業快速開發框架，包含完整的後端和前端的程式碼。
• 目前正在開發v2.0版本，v1.0版本可在分支裡切換後直接運行，教程可參考我的系列博客，或是項目內的docs
• 後端技術堆疊：asp.net core 3.1,cap,swag,ef core code first,autofac,automapper,nlog,aop
• 前端技術堆疊：vue-element-admin,crud快速開發模組組件,mock
• 實現的功能：基於角色的權限控制，專案分層約定，程式碼自動生成，日誌記錄，效能監控，aop等

如何運行項目

 git clone [email protected]:shengyu-kmust/SnailAspNetCoreFramework.git
git clone [email protected]:shengyu-kmust/Snail.git
cd SnailAspNetCoreFramework
dotnet build

專案示範

如下是基於v1.0版本的示範圖

• 1、下載和運行項目
• 2、根據設定檔自動產生項目
• 3、運行項目

專案目錄介紹

--ApplicationCore // 核心抽象層，採用clear architecture模式，不依賴其它層，其它三個項目都依賴此類庫，負責接口、常數、枚舉、dto、實體等公共定義
----Const // 常數定義，如配置常數，事件名常數
----Dtos // 所有的dto
----Entities // 所有實體
----Enums // 枚舉
----IServices // Service層的抽象定義
----Utilities // 幫助類

--Infrastructure // 基礎架構層，為上層（如服務層及應用層）提供資料服務。
----Data/config // 資料庫entityframework fluent api配置
----EFValueConverter // entityframework的資料庫型別和clr型別的轉換，如枚舉轉換
----Migrations //為entityframework code first的migrate產生目錄

--Service // 服務層，用於實作ApplicationCore裡的服務接口，為應用的邏輯實現的主層
----Cache // 快取實現，後面會移除並抽離到Snail項目
----Interceptor // 預設實作的攔截器
----BaseService.cs // 各service的基底類，包含了各service的常用方法，如CRUD
----InitDatabaseService.cs // 負責資料庫的資料初始化
----InterceptorService.cs // 攔截器基底類

--Web // 負責介面參數的輸入及輸出的所有相關處理（如參數校驗，輸出格式預定等）
----AutoFacModule // autofac的注入配置
----AutoMapperProfiles // automapper的配置
----ClientApp // 前端項目
------build // 前端編譯產生的輸出目錄
------mock // 前端mock
------src // 前端核心程式碼
----CodeGenerater // 程式碼產生的t4模組和相關邏輯
----ConfigureServicesExtenssions // serviceProvider的注入擴展，以避免寫在startup檔案裡
----Controllers // 控制器
----docs // 文件集
----Dto // 只會在web層裡用到的dto類
----Filter // 過濾器
----Hubs // signalr
----Permission // 權限的預設實現
----staticFile // 用於儲存上傳的文件

專案整體結構設計

採用DDD，但要依照專案的大小應用DDD的不同技術，整體是分以下幾個項目

• Service：服務層，用於實作ApplicationCore裡的服務接口，為應用的邏輯實現的主層
• Infrastructure層：基礎層，此層在不同的專案中進行重複使用，依賴ApplicationCore層的介面約定，為上層（如服務層及應用層）提供資料服務。同時實作IDAL的通用資料存取介面。
• ApplicationCore層：應用邏輯層，DDD模式，包含所有業務邏輯，不依賴其它層
• Web層：負責介面參數的輸入及輸出的所有相關處理（如參數校驗，輸出格式預定等）、Application/DAL層的呼叫。

通用資料權限及驗證

WEB層

• 負責輸入輸出參數處理、異常攔截、web緩存
• 對於查詢統計類型的資料操作，可直接呼叫DAL層
• 開發和測試環境的配置可分開

參數校驗--已實現

• 用微軟的介面--已實現

輸出約定--已實現

• HTTP Status Code遵照狀態碼的約定，20x為成功（介面已呼叫成功），40x為請求錯誤（業務異常、未授權等），50x為伺服器錯誤（伺服器的異常） --已實現
• 傳回結果內容以實際前端要的資料格式為主，為json物件；如果是錯誤提示，則回傳的是錯誤內容。 --已實現

異常處理--已實現

• 異常處理用微軟的技術，參考https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/error-handling?view=aspnetcore-2.2
• 所有的異常都不會捕獲
• Business異常向外提示，伺服器異常做攔截並向外提示，提示輸出格式遵照輸出約定

swagger --已實現

• 用NSwagger

ApplicationCore圖層

• 此項目不要依賴任何的其它項目，用乾淨體系結構，參考：https://docs.microsoft.com/zh-cn/dotnet/standard/modern-web-apps-azure-architecture/common-web-application- architectures

快取

• ICache接口，實作redis,memcached，memoryCache等，可考慮用easycaching。
• 快取用AOP，避免每個方法寫快取邏輯。 easycaching+autofac
• 快取的更新用事件驅動，引入第三方元件。 easycaching+cap

領域驅動

領域驅動，如果依賴其它層，依賴對應層的接口，而不是實現

AOP --已實現

• 日誌、快取的AOP切入，考慮用autofac

IOC --已實現

• 用autofac

記憶體表--已實現

• 將不常變動的、資料量比較小的表儲存在記憶體裡（不是緩存，是物件），並用事件驅動的想法同步最新的數據

事件

• 發布和訂閱
• 用cap，可在分散式和單應用間切換

日誌處理--已實現

• 用nlog

command bus --已實現

• 使用Mediatr

DAL層

• 負責所有和數據相關的操作
• 封裝通用的資料存取介面及實現，如用EF實現以下幾個功能
• 用面向介面程式設計的思想，為以後DAL層採用EF外的技術做擴展
• 採用Repository模式，其實EF本身就是一個Repository模式，但為了統一在資料庫存取操作這一層進行攔截並應用自己的邏輯，再用自己的Repository對EF進行一個封裝
• 單表的查詢，分頁
• 多表的簡單關聯查詢，分頁
• 簡單的CRUD

automapper

• 引用automapper做物件的賦值轉換
• 實作基於expression的objectmapper類，用於簡單的物件賦值，彌補automapper的配置複雜、用反射的效能低下的缺點

EF的使用

• EF執行sql語言的日誌**--已實作**
• 對於枚舉類型，用EF的ValueConverter技術自動轉換，約定儲存在資料庫裡的為string類型而不是Int類型，方便理解**--已實現**

即時通訊

• 用signalr

技術選型

事務的處理

用repository和unit of work模式，但repository模式用EF自帶的

資料庫處理方式

• 用EF做資料處理，不考慮其它的方式。

前端介面

• 放入到web專案裡，用spa的方式

需要做的

• 單元測試的注入
• service層應該不在web層裡，而是applicationcore

多語言

各技術細節

CAP

• CAP的原始實作是對autofac的支援不是太好，本專案裡寫SnailCapConsumerServiceSelector來做處理
• CAP原生對Controller和非Controller的處理不一樣，Controller只要在方法上加上CapSubscribe特性就行，而埋Controller要在類別上實現ICapSubscribe接口，並在方法上加上CapSubscribe特性

使用方法

1、git clone此項目2、設定codeGenerate.json 3、執行此項目，並在swagger登入後，執行codeGenerate介面4、執行add-migration 5、啟動專案即可

教學博文

SnailAspNetCoreFramework框架系列博客
1.框架內各項目及目錄的介紹與總設計思路－SnailAspNetCoreFramework快速開發框架
2.介面輸入校驗、輸出格式、及異常處理－SnailAspNetCoreFramework快速開發框架後端設計
3.通用權限設計－SnailAspNetCoreFramework快速開發框架後端設計
4.如何提供給前端良好的介面文件（Swagger）－SnailAspNetCoreFramework快速開發框架在後端設計
5.各場景下的快取使用－SnailAspNetCoreFramework快速開發框架後端設計
6.基於castle的AOP設計與常用快取、效能、日誌攔截器實作－SnailAspNetCoreFramework快速開發框架後端設計
7.依賴注入介紹之autofac－SnailAspNetCoreFramework快速開發框架後端設計
8.為什麼用Eventbus，怎麼用－SnailAspNetCoreFramework快速開發框架後端設計
9.日誌元件之Nlog介紹－SnailAspNetCoreFramework快速開發框架後端設計
10.Mediatr介紹－SnailAspNetCoreFramework快速開發框架後端設計
11.controller、service、dal層的通用CRUD設計－SnailAspNetCoreFramework快速開發框架後端設計
12.物件映射之利器automapper－SnailAspNetCoreFramework快速開發框架後端設計
13.如何監控ef產生的sql語句－SnailAspNetCoreFramework快速開發框架後端設計
14..net core的幾種部署方式介紹－SnailAspNetCoreFramework快速開發框架後端設計
15.即時通訊之signalr－SnailAspNetCoreFramework快速開發框架後端設計
16.如何用ef code first進行專案的資料庫版本持續迭代－SnailAspNetCoreFramework快速開發框架在後端設計
17.程式碼自動產生功能介紹－SnailAspNetCoreFramework快速開發框架後端設計
18.如何監控專案的各個功能是否正常(HealthCheck)－SnailAspNetCoreFramework快速開發框架在後端設計
19.定時任務之hangfire介紹－SnailAspNetCoreFramework快速開發框架後端設計
20.前端總體介紹－SnailAspNetCoreFramework快速開發框架之前端設計
21.再也不用跪求後端介面了（MOCK的使用）－SnailAspNetCoreFramework快速開發框架之前端設計
22.前端的權限控制－SnailAspNetCoreFramework快速開發框架之前端設計
23.如何避免重複寫入前端的CRUD程式碼（前端各種SnailXXX元件介紹與使用）－SnailAspNetCoreFramework快速開發框架前端設計
24.請求代理介紹－SnailAspNetCoreFramework快速開發框架之前端設計