01.前後端分離中台框架後端 Admin.Core 學習-介紹與配置說明

来源:https://www.cnblogs.com/morang/archive/2023/08/20/zhontai_admin_core_book_01.html
-Advertisement-
Play Games

## 中台框架後端項目 Admin.Core 的介紹與配置說明 > 中台admin是前後端分離許可權管理系統，Admin.Core為後端項目，基於.NET 7.0開發。 > 支持多租戶、數據許可權、動態 Api、任務調度、OSS 文件上傳、滑塊拼圖驗證、多資料庫，分散式緩存、分散式事務等 - 介面文檔一 ...


中台框架後端項目 Admin.Core 的介紹與配置說明

中台admin是前後端分離許可權管理系統，Admin.Core為後端項目，基於.NET 7.0開發。
支持多租戶、數據許可權、動態 Api、任務調度、OSS 文件上傳、滑塊拼圖驗證、多資料庫，分散式緩存、分散式事務等

  • 介面文檔一覽

  • 項目地址

  • 技術棧

    • dotnet7
    • FreeSql
    • Autofac
    • CAP
    • Mapster

  • 特點

    • 快速啟動，上手簡單
    • 系統模塊化
    • Swagger的模塊化封裝
    • 讀寫分離
    • 分庫分表
    • 分散式事務 TCC/ SAGA
    • 動態API
    • 系統許可權封裝基本滿足大部分項目
    • 多租戶實現

  • 開發環境

    • Vs2022
    • dotnet7

  • 項目結構

    • hosts
      • ZhonTai.Host:預設啟動項目,添加對 ZhonTai.Admin.Dev，模塊的引用，並將程式集配置到 assemblyNames
    • platform
      • ZhonTai.Admin 核心服務
      • ZhonTai.ApiUI 介面文檔封裝，分模塊載入
      • zhonTai.Common 通用庫封裝
      • ZhonTai.DynamicApi 動態WebApi庫
      • ZhonTai.Admin.Dev 代碼生成器添加
    • tests
      • ZhonTai.Tests 測試庫
    • modules
      • XX.XX 我準備放自己的模塊

預設實現功能

  1. 用戶管理：配置用戶，查看部門用戶列表，支持禁用/啟用、重置密碼、設置主管、用戶可配置多角色、多部門和上級主管。
  2. 角色管理：配置角色，支持角色分組、設置角色菜單和數據許可權、批量添加和移除角色員工。
  3. 部門管理：配置部門，支持樹形列表展示。
  4. 許可權管理：配置分組、菜單、操作、許可權點、許可權標識，支持樹形列表展示。
  5. 租戶套餐：配置租戶套餐，支持新增/移除套餐企業。
  6. 租戶管理：配置租戶，新增租戶時初始化部門、角色和管理員數據，支持租戶配置套餐、禁用/啟用功能。
  7. 字典管理：配置字典，查看字典類型和字典數據列表，支持字典類型和字典數據維護。
  8. 任務調度：查看任務和任務日誌列表，支持任務啟動、執行、暫停等功能。
  9. 緩存管理：緩存列表查詢，支持根據緩存鍵清除緩存
  10. 介面管理：配置介面，支持介面同步功能，用於新增許可權點選擇介面，支持樹形列表展示。
  11. 視圖管理：配置視圖，支持視圖維護功能，用於新增菜單選擇視圖，支持樹形列表展示。
  12. 文件管理：支持文件列表查詢、文件上傳/下載、查看大圖、複製文件地址、刪除文件功能。
  13. 登錄日誌：登錄日誌列表查詢，記錄用戶登錄成功和失敗日誌。
  14. 操作日誌：操作日誌列表查詢，記錄用戶操作正常和異常日誌。

框架的使用

1. 從GitHub 克隆/下載項目

  • 後端：git clone https://github.com/zhontai/Admin.Core.git
  • 前端：git clone https://github.com/zhontai/admin.ui.plus.git

2. 後端項目的啟動

使用新下的VS2022打開後，預設啟動項目 ZhonTai.Host ，直接Ctrl+F5運行即可
系統將會根據實體生成資料庫及表，並根據 Configs/dbconfig.json 配置將 initData/*.json 的數據生成到本地Sqlite中
(ps:第一次搞dotnet7的項目，vs2019+自己下SDK折騰半天搞不了一點，需要vs2022 17.4+)

3. 配置文件說明

  • launchSettings.json

    • 預設本地啟動配置
      • 配置項
        • 運行環境
          • ASPNETCORE_ENVIRONMENT:Development
        • 啟動埠
          • 預設：8000
          • 優先順序低於appconfig.urls的配置

  • appsettings.{Env}.json

    • 預設的應用配置文件
    • 配置項
      • 日誌等級
        • 預設：Information
      • 跨域
        • 預設：*
      • CAP配置
        • 預設：未啟用
      • 滑動驗證碼
        • 預設：300s有效期
        • 是否開啟在appconfig.json配置varifyCode.enable

  • Configs*.{Env}.json

    • 自定義的應用配置文件
    • dbconfig.json
      • 資料庫配置
      • 綁定模型
        • 單例：DbConfig
      • 配置項
        • 支持類型：type
          • 預設：Sqlite
            MySql = 0, SqlServer = 1, PostgreSQL = 2,Oracle = 3, Sqlite = 4, OdbcOracle = 5,OdbcSqlServer = 6, OdbcMySql = 7,OdbcPostgreSQL = 8, Odbc = 9, OdbcDameng =10, MsAccess = 11, Dameng = 12,OdbcKingbaseES = 13, ShenTong = 14,KingbaseES = 15, Firebird = 16
        • 連接字元串：connectionString
          • 預設：admindb.db
        • 同步結構
          • syncStructure：true
            • 預設啟用
            • 分散式部署需要註意關閉
          • 監聽同步結構腳本 syncStructureSql：false

          將會輸出codeFirst執行的腳本
          將 assemblyNames 配置的所有實體執行結構移 db.CodeFirst.SyncStructure 
          1.創建臨時表
          2.插入歷史數據，修改欄位名稱情況註意
          3.刪除舊表，重命名臨時表為新表
          生產上該自己執行腳本的還是自己執行

        • 同步數據
          • syncData：true
          • sysUpdateData:false
            • 同步更新數據
            • 確定要修改表數據是最新數據再開啟，除localdb測試就不要使用
          • syncDataIncludeTables：[]
            • 同步數據包含表，指定表同步，不填同步所有表
          • syncDataExcludeTables：[]
            • 同步數據排除表，指定表不同步
          • syncDataUser
            • 同步數據操作用戶
          • syncDataPath
            • 不配置預設為  項目目錄/InitData/Admin
            • 預設會將文件夾下的所有 表名.json 添加到數庫中，預設新增所有數據
            • 如果是租戶數據，格式為 表.tenant.json
          • syncDataCurd：false
            • 監聽同步數據Curd操作

          設置是否將syncDataPath文件夾下的 表名.json 加/修改到資料庫中

        • 生成數據
          • generateData：true
            預設開啟但無效，需要將禁用創建資料庫及禁用步：createDb:false && syncData:false
          • 加了視圖菜單就可以使用這個功能來創建生成預設數據

  • cacheconfig.json

    • 緩存配置，未綁定模型，redis緩存，限流參數配置
    • 配置項
      • 支持類型
        • 預設：Memory
        • Memory = 0,Redis = 1
      • 限流緩存類型
        • 預設：Memory
        • Memory = 0,Redis = 1
      • Redis配置
        • 127.0.0.1:6379

  • appconfig.json

    • 應用配置
    • 綁定模型
      • 單例: AppConfig
    • 配置項
      • appType 應用程式類型
        • 預設：Controllers
        • Controllers ControllersWithViews MVC
      • urls 啟動地址
        • http://*:8000
      • corUrls 跨域
        • []
      • assemblyNames 程式集名稱
        • ZhonTai.Admin
        • Mapster自動註冊程式集
      • tenantc租戶
        • true
      • distributeKey 分散式事務唯一標識
        • 為空則不生成分散式事務表
      • validate 驗證開關
        • 登錄,介面許可權,數據許可權驗證
      • swagger Swagger文檔s
      • apiUI 介面文檔地址
      • MiniProfiler 性能分析器
        • false
      • identityServer 統一認證授權伺服器
        • false
      • aop 面向切麵編程s
        • 開啟事務
      • log 資料庫日誌
        • 操作日誌
      • rateLimit 限流開關
        • false
      • varifyCode 登錄驗證碼
        • true
      • defaultPassword 預設密碼
        • 111111
      • dynamicApi 動態api
        • 結果格式化
      • passwordHasher 標準標識密碼哈希
        • 啟用後相同密碼加密後各不相同
      • maxRequestBodySize 最大請求大小
        • 104857600
      • healthChecks 健康檢查
        • enable:true 啟用
        • path:/admin/health

  • jwtconfig.json

    • JWT配置
    • 綁定模型
      • 單例：JwtConfig
    • 配置項
      • issuer 發行者
      • audience 訂閱者
      • securityKey 密鑰
      • expires 有效期(分鐘) 120
      • refreshExpires 刷新有效期(分鐘) 1440

  • ossconfig.json

    • 本地上傳配置
    • 綁定模型
      • IOptions<OSSConfig>
    • OSS配置
      • Minio
      • 阿裡雲
      • 騰訊雲
      • 七牛
      • 華為雲

  • uploadconfig.json

    • 上傳配置
    • 綁定模型
      • IOptions<UploadConfig>

  • ratelimitconfig.json

    • 限流配置
    • 綁定模型
      • IOptions
    • 支持類型
      • IP限流
        • 預設未啟用
        • 需要在appconfig.json中配置rateLimit:true生效
        • 使用Redis實現限流
        • 需要在cacheconfig.json中配置typeRateLimit

  • InitData\模塊*.{tenant}.json

    • 預設初始化數據

4. 代碼生成

前端及代碼生成見下篇

寫在最後

文章的起因是想找個不錯的框架用來搞個自己用的系統，找了幾個dotnet+vue的框架，zhontai的這個是看到上手最容易，前後臺的代碼也沒有封裝得太深，二開也很方便，看著用著都挺舒服的。
唯一的不足就是文檔了，一點資料都找不到，就只能一點點看代碼，然後邊看邊記錄，以備後用，又想著既然都寫了，那就再整理一下了，順便分享出來咯，希望能夠對後面使用框架的有所幫助。

作者：易墨
Github：yimogit
純靜態工具站點：metools
說明：歡迎拍磚,不足之處還望園友們指出;
迷茫大概是因為想的太多做的太少。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 每日一庫：gosec
    `gosec` 是一個用於在 Go 代碼中查找安全問題的開源工具，它可以幫助發現可能的漏洞和潛在的安全風險。以下是關於 `gosec` 的詳細介紹： ## 1. 工具概述： `gosec` 是一個靜態分析工具，用於掃描 Go 代碼以查找潛在的安全問題。它可以識別常見的代碼漏洞、敏感信息泄露和其他安全 ...
  • Java Polymorphism Concept
    # What is Polymorphism 這個多態看中文確實有點費解，多態的英文是Polymorphism，它的翻譯含義是： n. 多態性 （可以看出是比較寬泛的） n. 多型現象 從翻譯也看不出啥, 我舉一個生活中的例子來引入多態： 生活中有很多常見的物體具有多態性。例如，一張紙可以用來寫字、 ...
  • .NET 個人博客-給文章添加上標簽
    # 個人博客-給文章添加上標簽 # 優化計劃 - [x] 置頂3個且可滾動或切換 - [x] 推薦改為4個,然後新增歷史文章，將推薦的載入更多放入歷史文章，按文章發佈時間降序排列。 - [x] 標簽功能，可以為文章貼上標簽 - [ ] 推薦點贊功能 本篇文章實現文章標簽功能 # 思路 > 首先需要新 ...
  • WPF實現Element UI風格的日期時間選擇器
    # .NET Evolve資料庫版本管理工具 ## 1.簡介 提到資料庫版本管理，`Java`領域開發首先會想到大名鼎鼎的`flyway`。但是它不適用`.NET`領域，那麼`.NET`領域也需要做資料庫版本管理，該用什麼工具？自行造輪子？`.NET`領域的解決方案就是`Evolve`，這是一個開源 ...
  • Ocelot與路由共存
    # Ocelot與路由共存 ### 引言 在Asp.Net Core中使用了Ocelot做網關之後，其自身的Api路由就不起作用了，尋了許久的解決方法，終於找到一個，主要是使用MapWhen判斷Ocelot的配置是否符合，是則走轉發路由，否則走自身路由，步驟如下： ### 1.先創建以下類 ``` ...
  • 每個.NET開發都應掌握的C#委托事件知識點
    上篇文章講述了[C#介面的知識點](https://mp.weixin.qq.com/s?__biz=MzI2NDE1MDE1MQ==&mid=2650851371&idx=1&sn=c630043f8d85816c660c53cbf6b3f218&chksm=f14565c3c632ecd5816 ...
  • Unity UGUI的Button組件的介紹及使用
    # UGUI的Button（按鈕）組件的介紹及使用 ## 1. 什麼是UGUI的Button組件？ UGUI（Unity GUI）是Unity引擎中的一套用戶界面系統，Button（按鈕）是其中的一個常用組件。Button組件可以用於創建可交互的按鈕，用戶點擊按鈕時可以觸發相應的事件。 ## 2. ...
  • 【演算法】用c#實現自定義字元串編碼及圍欄解碼方法
    先決條件 Visual Studio 2019 v16.9 預覽版1或更高版本(通過WSL可選組件進行.NET調試)。若要檢查 WSL 組件，請選擇 “工具” > “獲取工具和功能” 。 在 Visual Studio 安裝程式中，選擇 “單個組件”，然後鍵入 “WSL” 搜索安裝組件 。 安裝WS ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類