Kerry 的筆記本
  • Table of contents
  • Kerry的Mac裝機必要
  • ASP.NET Core 教育訓練文件
    • .NET 9 OpenAPI 介紹與教學
    • 目錄
    • ASP.NET Core Authentication系列(一)理解Claim, ClaimsIdentity, ClaimsPrincipal
    • ASP.NET Core Authentication系列(三)Cookie選項
    • ASP.NET Core Authentication系列(二)實現認證、登錄和註銷
    • ASP.NET Core Authentication系列(四)基於Cookie實現多應用間單點登錄(SSO)
    • ASP.NET Core Consul 教學
    • ASP.NET Core Hangfire 排程管理
    • ASP.NET Core KeyCloak 實作
    • ASP.NET Core NLog-依照Environment使用Nlog.Config檔案
    • ASP.NET Core NLog-如何使用 NLog 將 log 寫到檔案
    • ASP.NET Core Nlog-發送訊息到ElasticSearch
    • 目錄
    • ASP.NET Core Quartz.NET 管理介面
    • ASP.NET Core RDLC 報表設計
    • ASP.NET Core SFTP (使用第三方套建 SSH.Net) - 類別庫為案例
    • ASP.NET Core 中使用 HttpReports 進行接口統計,分析, 可視化, 監控,追踪等
    • ASP.NET 使用 MassTransit 與 RabbitMQ,實現事件發佈、訂閱
    • Asp.Net Core 分散式Session – 使用 Redis
    • ASP.NET Core 前台會員修改個人資料
    • ASP.NET Core 前台會員忘記密碼與重設密碼
    • ASP.NET Core 前台會員登入
    • ASP.NET Core 前台會員註冊
    • ASP.NET Core 呼叫 API 發生 CORS 錯誤
    • ASP.NET Core 如何套網頁設計樣版
    • ASP.NET Core 客製化Model Validation 預設錯誤訊息
    • ASP.NET Core 後台查詢頁面教學
    • ASP.NET Core 網站生命週期
    • ASP.NET Feature Management 使用說明與教學
    • ASP.NET RulesEngine 介紹
    • ASP.NET WinForms APP 程式安裝檔
    • LinePay 支付完成後返回 LINE 應用而不跳出外部瀏覽器
    • EntityFramework
      • EF Core Migrations 完整教學手冊
      • EntityFramework Core DB Migrations
      • 使用 Entity Framework Core (EF Core) 的 Migrations 功能進行版本控制
    • NET 6
      • .NET 6 Autofac範例
      • .NET 6 Automapper範例
      • .NET 6 BenchmarkDotNet範例
      • .NET 6 Bogus範例
      • .NET 6 Dapper範例
      • .NET 6 Dapper語法說明
      • .NET 6 EFCore範例
      • .NET 6 EFCore語法說明
      • .NET 6 EPPlus圖表範例
      • .NET 6 EPPlus範例
      • .NET 6 Hangfire範例
      • .NET 6 HttpClient單元測試範例
      • .NET 6 MailKit前置作業
      • .NET 6 MailKit範例
      • .NET 6 Moq範例
      • .NET 6 NLog範例
      • .NET 6 NLog進階範例
      • .NET 6 Serilog範例
      • .NET 6 Serilog進階範例
      • .NET 6 Telegram.Bot前置作業
      • .NET 6 Telegram.Bot範例
      • .NET 6 Text.Json範例
      • .NET 6 swagger授權
      • .NET 6 swagger範例
      • .NET 6 xUnit範例
      • .NET 6 取得appsettings檔案內容
      • .NET 6 更改回傳Json時為大駝峰命名
      • .NET 6 解決System.Text.Json序列化後會將所有非ASCII轉為Unicode
    • WDMIS
      • CORS
      • FeatureManagement
      • Serilog
      • Spectre.Console
      • 資料模型實戰:從 MSSQL 設計到 .NET 8 WebAPI 實作(以刀具管理為例)
  • Azure
    • 如何在 ASP.NET CORE 5.0 WEB 應用程序中實現 AZURE AD 身份驗證
    • Azure App Configuration 使用教學
    • Azure Blob Storage
    • Azure DevOps 持續整合(CI) + Artifacts
  • CSharp
    • ASP.NET await 與 wait 的差異
    • AutoMapper —— 類別轉換超省力
    • C# 中的 HTTPClient — 入門指南
    • C# 正則表達式:從零到英雄指南
    • C# 集合, List<> 取交集、差集、聯集的方法
    • C#單元測試教學
    • CORS 介紹與設定方式
    • CSharp Coding Conventions
    • Using jQuery Unobtrusive AJAX in ASP.NET Core Razor Pages
    • 深入Dapper.NET源碼
    • 菜雞與物件導向
      • 菜雞與物件導向 (0): 前言
      • 菜雞與物件導向 (1): 類別、物件
      • 菜雞與物件導向 (10): 單一職責原則
      • 菜雞與物件導向 (11): 開放封閉原則
      • 菜雞與物件導向 (12): 里氏替換原則
      • 菜雞與物件導向 (13): 介面隔離原則
      • 菜雞與物件導向 (14): 依賴反轉原則
      • 菜雞與物件導向 (15): 最少知識原則
      • 菜雞與物件導向 (2): 建構式、多載
      • 菜雞與物件導向 (3): 封裝
      • 菜雞與物件導向 (4): 繼承
      • 菜雞與物件導向 (5): 多型
      • 菜雞與物件導向 (6): 抽象、覆寫
      • 菜雞與物件導向 (7): 介面
      • 菜雞與物件導向 (8): 內聚、耦合
      • 菜雞與物件導向 (9): SOLID
      • 菜雞與物件導向 (Ex1): 小結
  • DBeaver
    • 如何強制讓 DBeaver 在 Mac 上使用英文介面
  • DesignPattern
    • OAuth
    • Repository 模式 (Repository Pattern)
    • Single Sign On 實作方式介紹 (CAS)
    • 【SOP製作教學】新手適用,SOP範例、流程圖、製作流程全公開!
    • 【SOP製作教學】流程圖教學、重點範例、BPMN符號介紹!
    • 【SOP製作教學】流程圖符號整理、BPMN2.0進階符號教學!
    • 多奇數位 C# 程式碼撰寫規範 (C# Coding Guideline)
    • 軟體分層設計模式 (Software Layered Architecture Pattern)
    • 開源程式碼檢測平台 SonarQube
    • 菜雞新訓記
      • 菜雞新訓記 (0): 前言
      • 菜雞新訓記 (1): 使用 Git 來進行版本控制吧
      • 菜雞新訓記 (2): 認識 Api & 使用 .net Core 來建立簡單的 Web Api 服務吧
      • 菜雞新訓記 (3): 使用 Dapper 來連線到資料庫 CRUD 吧
      • 菜雞新訓記 (4): 使用 Swagger 來自動產生可互動的 API 文件吧
      • 菜雞新訓記 (5): 使用 三層式架構 來切分服務的關注點和職責吧
      • 菜雞新訓記 (6): 使用 依賴注入 (Dependency Injection) 來解除強耦合吧
      • 菜雞新訓記 (7): 使用 Fluent Validation 來驗證參數吧
  • DevOps
    • Repository 模式 (Repository Pattern)
    • pipeline工具研究
    • 單例模式 (Singleton Pattern)
    • 單元測試
    • 軟體分層設計模式 (Software Layered Architecture Pattern)
    • 雙重檢查鎖定模式 (Double-Checked Locking Pattern)
  • Docker
    • Docker 中部署 .NET 8 Web App 並支援 HTTPS
    • Docker指令大全
    • 第七章 安裝Nomad
    • Docker - 第三章 | 安裝 MSSQL
    • Docker - 第九章 | 安裝 datalust seq
    • 第二章 docker-compose 教學
    • Docker - 第五章 | 安裝 Redis
    • 第八章 安裝SonarQube
    • Docker - 第六章 | 安裝RabbitMQ
    • 第十一章 安裝 VtigerCRM
    • 第十二章 安裝KeyCloak
    • Docker - 第十章 | 安裝 Redmine
    • 第四章 安裝MySQL
    • Docker Desktop (含更改 Docker Image 路徑)
  • Git
    • Git Flow 指令大全(完整指令整理) 🚀
    • Git 安裝及配置SSH Key
    • Git 建立到上傳
    • 將現有專案的遠端儲存庫直接更改為新的儲存庫
    • Git 流程規劃
    • Git 語法大全
    • 30 天精通 Git 版本控管
      • 30 天精通 Git 版本控制
        • 第 01 天:认识 Git 版本控制
        • 第 02 天:在 Windows 平台必装的三套 Git 工具
        • 第 03 天:建立仓库
        • 第 04 天:常用的 Git 版本控制指令
        • 第 05 天:了解仓库、工作目录、物件与索引之间的关系
        • 第 06 天:解析 Git 资料结构 - 物件结构
        • 第 07 天:解析 Git 资料结构 - 索引结构
        • 第 08 天:关于分支的基本观念与使用方式
        • 第 09 天:比对文件与版本差异
        • 第 10 天:认识 Git 物件的绝对名称
        • 第 11 天:认识 Git 物件的一般参照与符号参照
        • 第 12 天:认识 Git 物件的相对名称
        • 第 13 天:暂存工作目录与索引的变更状态
        • 第 14 天: Git for Windows 选项设定
        • 第 15 天:标签 - 标记版本控制过程中的重要事件
        • 第 16 天:善用版本日志 git reflog 追踪变更轨迹
        • 第 17 天:关于合并的基本观念与使用方式
        • 第 18 天:修正 commit 过的版本历史记录 Part 1
        • 第 19 天:设定 .gitignore 忽略清单
        • 第 20 天:修正 commit 过的版本历史记录 Part 2
        • 第 21 天:修正 commit 过的版本历史记录 Part 3
        • 第 22 天:修正 commit 过的版本历史记录 Part 4 (Rebase)
        • 第 23 天:修正 commit 过的版本历史记录 Part 5
        • 第 24 天:使用 GitHub 远端仓库 - 入门篇
        • 第 25 天:使用 GitHub 远端仓库 - 观念篇
        • 第 26 天:多人在同一个远端仓库中进行版控
        • 第 27 天:通过分支在同一个远端仓库中进行版控
        • 第 28 天:了解 GitHub 的 fork 与 pull request 版控流程
        • 第 29 天:如何将 Subversion 项目汇入到 Git 仓库
        • 第 30 天:分享工作中几个好用的 Git 操作技巧
      • zh-tw
        • 第 01 天:認識 Git 版本控管
        • 第 02 天:在 Windows 平台必裝的三套 Git 工具
        • 第 03 天:建立儲存庫
        • 第 04 天:常用的 Git 版本控管指令
        • 第 05 天:了解儲存庫、工作目錄、物件與索引之間的關係
        • 第 06 天:解析 Git 資料結構 - 物件結構
        • 第 07 天:解析 Git 資料結構 - 索引結構
        • 第 08 天:關於分支的基本觀念與使用方式
        • 第 09 天:比對檔案與版本差異
        • 第 10 天:認識 Git 物件的絕對名稱
        • 第 11 天:認識 Git 物件的一般參照與符號參照
        • 第 12 天:認識 Git 物件的相對名稱
        • 第 13 天:暫存工作目錄與索引的變更狀態
        • 第 14 天: Git for Windows 選項設定
        • 第 15 天:標籤 - 標記版本控制過程中的重要事件
        • 第 16 天:善用版本日誌 git reflog 追蹤變更軌跡
        • 第 17 天:關於合併的基本觀念與使用方式
        • 第 18 天:修正 commit 過的版本歷史紀錄 Part 1
        • 第 19 天:設定 .gitignore 忽略清單
        • 第 20 天:修正 commit 過的版本歷史紀錄 Part 2
        • 第 21 天:修正 commit 過的版本歷史紀錄 Part 3
        • 第 22 天:修正 commit 過的版本歷史紀錄 Part 4 (Rebase)
        • 第 23 天:修正 commit 過的版本歷史紀錄 Part 5
        • 第 24 天:使用 GitHub 遠端儲存庫 - 入門篇
        • 第 25 天:使用 GitHub 遠端儲存庫 - 觀念篇
        • 第 26 天:多人在同一個遠端儲存庫中進行版控
        • 第 27 天:透過分支在同一個遠端儲存庫中進行版控
        • 第 28 天:了解 GitHub 的 fork 與 pull request 版控流程
        • 第 29 天:如何將 Subversion 專案匯入到 Git 儲存庫
        • 第 30 天:分享工作中幾個好用的 Git 操作技巧
  • Hands-On Labs - LineBotSDK 實作手札 (C#, .net core)
    • 00. 如何申請LINE Bot
    • CLI
      • 使用CLI來發送新的Channel Access Token(LINE Bot)
      • 使用CLI免費發送LINE Notify通知
    • basic
      • 如何發送LINE訊息(Push Message)
      • 如何發送LINE Template Messages
      • 如何發送ImageMap訊息
      • 如何發送Flex Message
      • 如何在訊息後面加上QuickReply快捷選項
    • liff
      • Lab 21: 建立第一個LIFF應用
    • webhook
      • 如何建立可Echo的基本LINE Bot
      • 如何在WebHook中取得用戶個人資訊(名稱、頭像、狀態)
      • 如何在WebHook中取得用戶上傳的圖片(Bytes)
  • Markdown
    • Markdown Cheatsheet 中文版
    • Markdown語法大全
    • 使用HackMD建立書本目錄
    • 使用HackMD建立簡報
  • SAP ABAP
    • ABAP開發環境和總體介紹
    • SAP MM模塊常用表總結
    • SAP QM數據庫表清單
    • SAP欄位與表的對應關係
  • SQL Server
    • [SQL SERVER] Like in
    • SQL Server 中,移除資料庫中所有的關聯限制
    • SQL Server 刪除資料庫中所有資料表
    • SQL Server View、Function 及 Stored Procedure 定義之快速備份
    • SSMS v18 清除登入畫面中,下拉選單歷史紀錄
    • [MS SQL]如何透過Database Mail進行郵件發送
    • [SQL SERVER]撰寫Stored Procedure小細節
    • 使用 Data Migration Assistant 移轉 SQL Server 資料庫與帳戶
    • 使用SSIS創建同步資料庫數據任務
  • Tools
    • 免費 FTP 伺服器 FileZilla Server 安裝教學 (新版設定)
  • VisualStudio
    • .NET CLI 指令碼介紹
    • Visual Studio 使用 Git 版本控制
    • 使用 Visual Studio 2022 可透過 .editorconfig 鎖定文字檔案的儲存編碼格式分享
  • Web API
    • ASP.NET Core 6 Web API 進行 JWT 令牌身份驗證
    • [ASP.NET Core]如何使用SwaggerAPI說明文件
    • ASP.NET Core Web Api實作JWT驗證筆記
    • ECFIT API 範例
    • JWT Token Authentication And Authorizations In .Net Core 6.0 Web API
    • 微服務架構 - 從狀態圖來驅動 API 的設計
  • Windows
    • [C#] 伺服器監控常用語法 (事件檢視器、CPU 硬碟使用率、程式執行狀況)
    • Configure IIS Web Server on Windows Server 2019
    • Log Paser Studio 分析 IIS W3C Log
    • Windows Server 2019 如何安裝 IIS 運行 ASP.NET 專案
    • 如何檢查安裝在 IIS 上的 .NET Core Hosting Bundle 版本
    • [IIS] 如何解決網站第一個請求 Request 特別慢 ?
    • IIS 不停機更版設置
    • SQL Server 2019 Standard 繁體中文標準版安裝
    • WINDOWS共用資料夾的網路認證密碼放在哪?如何清除?
    • 如何設定 ASP.NET CORE 網站應用程式持續執行在 IIS 上
  • 專案管理
    • SSDLC (Secure Software Development Life Cycle)
    • 系統開發原則
    • MIS及專案管理-使用Redmine
      • 第10章 - [日常管理]MIS部門週會工作進度追蹤
      • 第11章 - [日常管理]MIS部門主管月會報告管理
      • 第12章 - [日常管理]機房工作日誌
      • 第13章 - [日常管理]MIS部門耗用工時及工作進度檢討
      • 第14章 - [日常管理]MIS文件知識庫
      • 第15章 - [日常管理]整理及管理分享
      • 第16章 - [異常管理]使用者問題回報系統
      • 第17章 - [異常管理]資安事件及異常紀錄
      • 第18章 - [異常管理]整理及管理分享
      • 第19章 - [變革管理]MIS的專案及專案管理五大階段
      • 第1章 - [MIS及專案管理]中小企業MIS的鳥事
      • 第20章 - [變革管理]MIS的新專案管理:起始階段
      • 第21章 - [變革管理]MIS的新專案管理:規劃階段
      • 第22章 - [變革管理]MIS的新專案管理:執行階段
      • 第23章 - [變革管理]MIS的新專案管理:監控階段
      • 第24章 - [變革管理]MIS的新專案管理:結束階段
      • 第25章 - [變革管理]整理及管理分享
      • 第26章 - [ISMS管理]ISMS平台整體規劃
      • 第27章 - [ISMS管理]ISMS文管中心
      • 第28章 - [ISMS管理]ISMS表單紀錄的管理
      • 第29章 - [ISMS管理]整理及管理分享
      • 第2章 - [MIS及專案管理]專案管理的概念及MIS應用
      • 第30章 - 初心、來時路及感謝:系列文章總結回顧
      • 第3章 - [MIS及專案管理]管理工具的選擇
      • 第4章 - [Redmine]Redmine的安裝及設定
      • 第5章 - [Redmine]Redime系統邏輯說明
      • 第6章 - [Redmine]自行建立及維護表單
      • 第7章 - [Redmine]專案版面的規劃
      • 第8章 - [日常管理]AR管理
      • 第9章 - [日常管理]資訊服務申請
  • 微服務架構
    • DDD + CQRS + MediatR 專案架構
    • 微服務架構 #2, 按照架構,重構系統
    • 淺談微服務與網站架構的發展史
    • API First Workshop 設計概念與實做案例
      • API First #1 架構師觀點 - API First 的開發策略 - 觀念篇
      • API First #2 架構師觀點 - API First 的開發策略 - 設計實做篇
    • 基礎建設 - 建立微服務的執行環境
      • Part #1 微服務基礎建設 - Service Discovery
      • Part #2 微服務基礎建設 - 服務負載的控制
      • Part #3 微服務基礎建設 - 排隊機制設計
      • Part #4 可靠的微服務通訊 - Message Queue Based RPC
      • Part #5 非同步任務的處理機制 - Process Pool
    • 實做基礎技術 API & SDK Design
      • API & SDK Design #1, 資料分頁的處理方式
      • API & SDK Design #2, 設計專屬的 SDK
      • API & SDK Design #3, API 的向前相容機制
      • API & SDK Design #4, API 上線前的準備 - Swagger + Azure API Apps
      • API & SDK Design #5 如何強化微服務的安全性 API Token JWT 的應用
    • 建構微服務開發團隊
      • 架構面試題 #1, 線上交易的正確性
      • 架構面試題 #2, 連續資料的統計方式
      • 架構面試題 #3, RDBMS 處理樹狀結構的技巧
      • 架構面試題 #4 - 抽象化設計;折扣規則的設計機制
    • 架構師觀點 - 轉移到微服務架構的經驗分享
      • Part #1 改變架構的動機
      • Part #2 實際改變的架構案例
    • 案例實作 - IP 查詢服務的開發與設計
      • 容器化的微服務開發 #1 架構與開發範例
      • 容器化的微服務開發 #2 IIS or Self Host
  • 系統評估
    • RPA 與 WebAPI 評估
    • 數位轉型:從現有系統到數位化的未來
    • 數位轉型:從現有系統到數位化的未來
  • 面試
    • CV_黃子豪_2024
    • HR 問題集
    • .NET 工程師 面試問題集
    • 資深工程師 問題集
    • 資深開發人員 / 技術主管
    • 題目
Powered by GitBook
On this page
  • 前言
  • 第 1 章:資料模型設計概論
  • 1.1 資料模型的角色
  • 1.2 資料模型分類
  • 1.3 資料模型設計原則
  • 1.4 資料模型設計流程(步驟)
  • 1.5 刀具管理系統概念性模型
  • 1.6 工具與設計建議
  • 第 2 章:MSSQL 資料表設計與關聯
  • 2.1 資料表設計
  • 2.2 關聯解釋
  • 2.3 資料表命名原則(Table Naming)
  • 2.4 資料欄位命名原則(Column Naming)
  • 2.6 命名一致性對 EF Core 的重要性
  • 第 3 章:使用 EF Core Power Tools 映射資料模型
  • 3.1 安裝 EF Core Power Tools
  • 3.2 使用 Reverse Engineer 功能
  • 3.3 產出結果說明
  • 3.4 測試查詢
  • 第 4 章:建立 WebAPI 並整合資料模型
  • 4.1 建立 ASP.NET Core Web API 專案
  • 4.2 設定 DI 與資料庫連線
  • 4.3 實作 Controller
  • 4.4 測試 API
  • 第 5 章:進階開發實務補充
  • 5.1 使用 DTO 與 AutoMapper 抽離資料模型
  • 5.2 驗證機制:FluentValidation 整合
  • 5.3 單元測試與整合測試(xUnit)
  • 5.4 加入觀察性:OpenTelemetry + Serilog
  • 結語
  1. ASP.NET Core 教育訓練文件
  2. WDMIS

資料模型實戰:從 MSSQL 設計到 .NET 8 WebAPI 實作(以刀具管理為例)

前言

在現代製造業或工廠數位化轉型中,「刀具管理」是一個具代表性的應用場景。透過資料庫模型設計、Entity Framework Core 整合與 API 建置,我們能快速打造一套具備 CRUD、保養紀錄與歷史查詢的完整系統。

本書將以 30 分鐘教學課程為藍本,帶領讀者從 MSSQL 資料庫設計開始,一步一步進入 .NET 8 的 WebAPI 開發世界,使用 EF Core Power Tools 自動產生模型,並實作實用的 API。


第 1 章:資料模型設計概論

1.1 資料模型的角色

資料模型是連結業務需求與資料結構的橋樑。它幫助我們:

  • 定義資料如何儲存(資料表設計)

  • 理解資料之間的關係(ERD 設計)

  • 支援系統的資料存取與驗證需求

1.2 資料模型分類

  • 概念性模型(Conceptual Model):業務角度的抽象定義實體與關聯,例如「一把刀具可有多筆保養紀錄」。

  • 邏輯模型(Logical Model):資料表結構、欄位類型、關聯關係(ERD)。

  • 實體模型(Physical Model):實際在資料庫中的實作,例如實際的資料表定義、索引、資料型別。

[使用者需求訪談]
        ↓
[概念性模型](Entities: 刀具、入庫、保養、使用紀錄)
        ↓
[邏輯模型 ERD]
(關聯關係:一對多、多對多)
        ↓
[實體模型]
(欄位設計、資料型別、主外鍵)
        ↓
[MSSQL 資料表實作]
(CREATE TABLE)
        ↓
[.NET 實體類別]
(EF Core Entity / DbContext)
        ↓
[DTO + 驗證 + API + 測試 + 觀察性]

1.3 資料模型設計原則

設計資料模型時應遵守以下原則:

  • 正規化(Normalization):消除資料冗餘,確保一致性(如第三正規化)

  • 關聯一致性(Referential Integrity):透過外鍵約束維持資料關聯的正確性

  • 可擴展性(Scalability):模型設計應容許未來擴充欄位或新關聯

  • 命名一致性(Naming Consistency):欄位名稱具描述性,資料型別合理

1.4 資料模型設計流程(步驟)

  1. 需求蒐集:訪談使用者或主管,瞭解業務流程與資料項目

  2. 定義實體與屬性:找出資料實體(如 Tool)、每個實體的屬性(如 Name, PurchaseDate)

  3. 設計關聯:定義實體之間的關聯類型(如一對多)

  4. 畫出 ERD:使用圖形工具(如 dbdiagram.io)呈現模型

  5. 驗證與調整:與業務方對焦確認,是否符合實際應用

  6. 轉換為資料表設計:將 ERD 對應至 MSSQL 資料表與欄位型別

1.5 刀具管理系統概念性模型

實體:

  • Tool(刀具):刀具的基本資料。

  • ToolInbound(刀具入庫):刀具何時入庫、來源、數量。

  • ToolUsage(刀具使用紀錄):紀錄使用時間、機台、人員。

  • ToolMaintenance(刀具保養紀錄):紀錄保養項目、保養人員與時間。

關聯:

  • 一個 Tool 對應多個 Inbound、Usage、Maintenance

ERD 示意:

Tool
├── ToolInbound
├── ToolUsage
└── ToolMaintenance

關聯設計:

  • 一把 Tool 可有多筆 ToolUsage → 一對多

  • 一把 Tool 可有多筆 ToolMaintenance → 一對多

  • 使用 ToolId 作為外鍵連結

ERD 示意圖(文字版):

Tool (1) -------- (∞) ToolUsage
Tool (1) -------- (∞) ToolMaintenance

透過這樣的設計,我們可以:

  • 快速查詢某把刀具的使用與保養紀錄

  • 保證每筆紀錄都有對應的刀具資料(外鍵保護)

  • 容許未來擴充屬性,例如刀具狀態、壽命指標等

1.6 工具與設計建議

  • ERD 設計:使用 dbdiagram.io、draw.io、SSMS Diagram Tool

  • 命名建議:實體用單數命名(Tool)、主鍵為實體名 + Id

  • 優先定義核心資料表,次要資料表視需求擴充


第 2 章:MSSQL 資料表設計與關聯

2.1 資料表設計

CREATE TABLE Tool (
    ToolId INT PRIMARY KEY IDENTITY,
    ToolCode NVARCHAR(50) NOT NULL,
    ToolName NVARCHAR(100) NOT NULL,
    Spec NVARCHAR(200),
    CreatedAt DATETIME NOT NULL DEFAULT GETDATE()
);

CREATE TABLE ToolInbound (
    InboundId INT PRIMARY KEY IDENTITY,
    ToolId INT FOREIGN KEY REFERENCES Tool(ToolId),
    Quantity INT NOT NULL,
    InboundDate DATETIME NOT NULL,
    Source NVARCHAR(100)
);

CREATE TABLE ToolUsage (
    UsageId INT PRIMARY KEY IDENTITY,
    ToolId INT FOREIGN KEY REFERENCES Tool(ToolId),
    Machine NVARCHAR(50),
    Operator NVARCHAR(50),
    UsedHours DECIMAL(5,2),
    UsageDate DATETIME NOT NULL
);

CREATE TABLE ToolMaintenance (
    MaintenanceId INT PRIMARY KEY IDENTITY,
    ToolId INT FOREIGN KEY REFERENCES Tool(ToolId),
    MaintenanceDate DATETIME NOT NULL,
    Description NVARCHAR(200),
    Maintainer NVARCHAR(50)
);

2.2 關聯解釋

  • 一把刀具 Tool 會有多筆使用紀錄與保養紀錄 → 一對多關係

  • 使用外鍵約束確保資料完整性

  • 可為 ToolUsage.Date、Tool.Name 建立索引加速查詢

2.3 資料表命名原則(Table Naming)

✅ 原則說明

原則
說明

使用單數名詞

如:Tool 而非 Tools,對應物件導向設計(Entity)概念

使用 PascalCase 或 Snake_Case

根據團隊慣例選擇一致風格,例如 ToolMaintenance 或 tool_maintenance

命名具備業務語意

使用業務語言描述(如 PurchaseOrder、ToolUsage)

不使用縮寫或語焉不詳詞

避免 TMP, VAL1, DATA2 等無意義命名

🔍 範例命名

業務對象
表名建議

刀具主檔

Tool

使用紀錄

ToolUsage

保養紀錄

ToolMaintenance

採購訂單

PurchaseOrder

工作單

WorkOrder


2.4 資料欄位命名原則(Column Naming)

✅ 原則說明

原則
說明

使用 PascalCase(C#)或 snake_case(SQL)

保持一致性,例如:ToolId / tool_id

主鍵命名為 TableName + Id

如 ToolId、OrderId,避免單一 Id 帶來混淆

外鍵應具備來源實體語意

如:ToolId(來自 Tool)

避免使用保留字

如 Date, User, Name 等,應改為具體如 PurchaseDate

布林欄位建議用 Is/Has 開頭

例如:IsActive, HasWarranty

時間類欄位建議用 Time/Date 結尾

例如:CreatedDate, LastModifiedTime

🔍 範例命名

欄位目的
命名建議

主鍵

ToolId

外鍵

ToolId, OrderId

名稱

Name

狀態

IsActive, Status

建立時間

CreatedDate

負責人員

MaintainedBy, Operator

數值欄位

UsageHours, Price, Quantity


2.6 命名一致性對 EF Core 的重要性

類型
建議命名格式
EF Core 行為

主鍵

EntityNameId

自動辨識為主鍵

導覽屬性

複數命名如 ToolUsages

對應一對多集合

外鍵欄位

EntityNameId

自動建立關聯與 FK


第 3 章:使用 EF Core Power Tools 映射資料模型

3.1 安裝 EF Core Power Tools

  • Visual Studio → Extensions → Manage Extensions

  • 搜尋 "EF Core Power Tools" 並安裝

  • 重啟 Visual Studio

3.2 使用 Reverse Engineer 功能

  1. 右鍵專案 → EF Core Power Tools → Reverse Engineer

  2. 選擇資料庫連線 → 選擇 Tool, ToolUsage, ToolMaintenance

  3. 設定輸出目錄(如 /Models/Entities)

  4. 命名 DbContext 為 ToolDbContext

  5. 選擇適合的選項(如使用 Fluent API、自動包含導覽屬性)

3.3 產出結果說明

  • 自動產生三個 Entity 類別與一個 DbContext:

public partial class Tool
{
    public int ToolId { get; set; }
    public string Name { get; set; }
    public string ToolType { get; set; }
    public DateTime? PurchaseDate { get; set; }
    public bool IsActive { get; set; }

    public virtual ICollection<ToolUsage> ToolUsages { get; set; }
    public virtual ICollection<ToolMaintenance> ToolMaintenances { get; set; }
}

3.4 測試查詢

using var db = new ToolDbContext();
var tool = db.Tools.Include(t => t.ToolUsages).FirstOrDefault(t => t.ToolId == 1);

第 4 章:建立 WebAPI 並整合資料模型

4.1 建立 ASP.NET Core Web API 專案

dotnet new webapi -n ToolManagement.Api

4.2 設定 DI 與資料庫連線

在 Program.cs 註冊 DbContext:

builder.Services.AddDbContext<ToolDbContext>(options =>
    options.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));

4.3 實作 Controller

以 ToolController 為例:

[ApiController]
[Route("api/[controller]")]
public class ToolController : ControllerBase
{
    private readonly ToolDbContext _context;
    public ToolController(ToolDbContext context) => _context = context;

    [HttpGet]
    public async Task<IEnumerable<Tool>> GetAll() => await _context.Tools.ToListAsync();

    [HttpPost]
    public async Task<IActionResult> Create(Tool tool)
    {
        _context.Tools.Add(tool);
        await _context.SaveChangesAsync();
        return Ok(tool);
    }
}

4.4 測試 API

  • 使用 Swagger 自動產生測試介面

  • 或用 Postman 測試 GET/POST 呼叫


第 5 章:進階開發實務補充

5.1 使用 DTO 與 AutoMapper 抽離資料模型

在實際開發中,我們不建議直接將 EF Core 的實體類別(Entities)公開給前端使用,原因包括資料洩漏風險、耦合性過高、不易維護等。

Data Transfer Object (DTO) 是一種介於資料層與展示層之間的中介結構,用於:

  • 隱藏不必要欄位

  • 控制資料流向(防止 over-posting)

  • 提供多樣化輸出格式(如列表頁與詳情頁不同格式)

AutoMapper 可自動將 Entity 與 DTO 相互對應,簡化轉換程式碼:

public class ToolDto
{
    public string Name { get; set; }
    public string ToolType { get; set; }
    public bool IsActive { get; set; }
}

public class MappingProfile : Profile
{
    public MappingProfile()
    {
        CreateMap<Tool, ToolDto>();
        CreateMap<ToolDto, Tool>();
    }
}

在 Program.cs 中註冊 AutoMapper:

builder.Services.AddAutoMapper(typeof(Program));

5.2 驗證機制:FluentValidation 整合

FluentValidation 是一套用於建構強型別驗證規則的 .NET 套件,相較於 Data Annotations 更具彈性與可讀性。

安裝方式:

dotnet add package FluentValidation.AspNetCore

定義驗證規則:

public class ToolDtoValidator : AbstractValidator<ToolDto>
{
    public ToolDtoValidator()
    {
        RuleFor(x => x.Name).NotEmpty().WithMessage("名稱不可空白");
        RuleFor(x => x.ToolType).MaximumLength(50);
    }
}

在 Program.cs 註冊:

builder.Services.AddValidatorsFromAssemblyContaining<ToolDtoValidator>();

5.3 單元測試與整合測試(xUnit)

良好的系統需具備測試能力,包括:

  • 單元測試(Unit Test):測試個別邏輯,例如驗證規則、資料轉換

  • 整合測試(Integration Test):模擬 API 呼叫流程,測試資料庫互動

安裝必要套件:

dotnet add package xunit

範例測試類別:

public class ToolTests
{
    [Fact]
    public void Should_Create_Valid_Tool()
    {
        var tool = new Tool { Name = "Cutter", ToolType = "Drill", IsActive = true };
        Assert.Equal("Cutter", tool.Name);
    }
}

整合測試可使用 WebApplicationFactory 或 TestServer 建立 API 測試情境。

5.4 加入觀察性:OpenTelemetry + Serilog

現代應用應具備觀察性能力,包括追蹤、日誌與指標收集。

Serilog 紀錄日誌

dotnet add package Serilog.AspNetCore

設定 Serilog:

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console()
    .CreateLogger();

builder.Host.UseSerilog();

OpenTelemetry 分散式追蹤

dotnet add package OpenTelemetry.Exporter.Zipkin

設定追蹤:

builder.Services.AddOpenTelemetryTracing(builder => builder
    .AddAspNetCoreInstrumentation()
    .AddEntityFrameworkCoreInstrumentation()
    .AddZipkinExporter(opt => opt.Endpoint = new Uri("http://localhost:9411/api/v2/spans")));

搭配 Zipkin/Grafana/Jaeger 可視覺化整個請求鏈路,有助除錯與效能監控。


結語

透過本書範例,我們實作了 MSSQL → EF Core → ASP.NET Core API 的資料模型整合流程。這不僅可套用於刀具管理,也適用於大多數的商業資料管理系統。

PreviousSpectre.ConsoleNextAzure

Last updated 13 days ago