MySoft.Data 入門到精通（二）：實體產生器 Visual Studio 插件完整使用教學

詳細說明 Visual Studio 整合插件安裝、介面操作、介面檔產生與實體類別產生完整流程。

一、檢查插件啟用

工具 → 增益集管理器 → 確認 MySoft Entity Designer 已勾選載入。

二、建立介面專案

新增 C# 類別庫專案（如 MySoftExample.EntityDesign），專供定義實體介面。

三、產生介面檔

1. 開啟 MySoft.Tools.EntityDesign.exe
2. 設定資料庫連線，選擇資料表
3. 點選「產生實體介面」→ 產生單一 EntitiesDesign.cs 或每個介面獨立檔案

四、設定實體產生 XML 組態

複製 lib/EntityDesignConfig.xml 至專案，修改關鍵節點：

<EntityDesignConfiguration>
  <CompileMode>Debug</CompileMode>
  <InputDllName>MySoftExample.EntityDesign.dll</InputDllName>
  <OutputLanguage>C#</OutputLanguage>
  <OutputNamespace>MySoftExample.DataEntity</OutputNamespace>
  <EntityCodePath>..\MySoftExample.DataEntity\</EntityCodePath> <!-- 目錄=每介面一檔 -->
</EntityDesignConfiguration>

五、由介面產生實體類別

建置介面專案 → 點選插件工具列「產生實體」 → 自動呼叫 MySoft.Tools.EntityDesign.exe 依 XML 組態產出實體檔案 → 將產出檔案「包含在專案中」。

介面定義進階功能

1. 屬性註解與列舉

public enum UserType { General, Admin }
[Description("用戶資訊")]
public interface User : IEntity {
    [PrimaryKey, Description("用戶ID")] int UserID { get; }
    [Description("用戶名")] string UserName { get; set; }
    [Description("用戶類型")] UserType UserType { get; set; }
}

產生實體時自動帶入 XML 註解與列舉型別。

2. Mapping 屬性重新對映

[Mapping("User")]
public interface UserEntity : IEntity {
    [Mapping("UserID")] int ID { get; }
    [Mapping("UserName")] string Name { get; set; }
    [Mapping("UserType")] UserType Type { get; set; }
}

實體屬性名稱與資料庫欄位名稱不一致時使用。

3. 列舉獨立專案

列舉需置於獨立組件，介面專案與實體專案共同參考。

注意事項

• 介面修改後需重新產生實體
• 實體專案需參考 MySoft.Data.dll 才能編譯通過