萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

Entity Framework 4 中使用複雜類型實現 Enum 枚舉映射完整教學

背景:EF4 不原生支援 Enum

Entity Framework 4 (.NET 4.0) 僅支援純量基本型別 (int, string, DateTime...),不支援直接映射 Enum 型別屬性。EF 5 (.NET 4.5+) 才引入原生 Enum 支援。若專案鎖定 .NET 4.0/EF4,需透過 Complex Type (複雜類型) 包裝 Enum 實現資料庫整數欄位與 Enum 的雙向轉換。

資料庫結構

CREATE TABLE Account (
    ID UNIQUEIDENTIFIER NOT NULL DEFAULT NEWSEQUENTIALID() PRIMARY KEY,
    UserName NVARCHAR(20) NOT NULL,
    Password VARCHAR(40) NOT NULL,
    Email NVARCHAR(100) NOT NULL,
    Role INT NOT NULL  -- 對應 Enum 值
);

INSERT INTO Account (UserName, Password, Email, Role) VALUES
('Test1','Test1','test1',1), ('Test2','Test2','test2',1), ('Test3','Test3','test3',2);

Enum 定義

public enum AccountRoleEnum {
    Admin = 1,
    User = 2
}

複雜類型包裝器:RoleWrapper

public partial class RoleWrapper
{
    private AccountRoleEnum _role = AccountRoleEnum.User;

    // 資料庫映射用:整數值
    public int Value {
        get => (int)_role;
        set => _role = (AccountRoleEnum)value;
    }

    // 業務邏輯用:強型別 Enum
    public AccountRoleEnum EnumValue {
        get => _role;
        set => _role = value;
    }

    // 隱式轉換運算子:Enum ↔ Wrapper 雙向無縫轉換
    public static implicit operator RoleWrapper(AccountRoleEnum role) =>
        new RoleWrapper { EnumValue = role };

    public static implicit operator AccountRoleEnum(RoleWrapper wrapper) =>
        wrapper?.EnumValue ?? AccountRoleEnum.User; // null 安全預設
}
  • Value 屬性對應資料庫 INT 欄位,EF 直接讀寫此屬性。
  • EnumValue 供業務程式碼使用,型別安全。
  • implicit operator 讓指派 entity.Role = AccountRoleEnum.Admin 或 var role = entity.Role 自動轉換,語法糖極致。

實體類別:POCO 手寫 (非設計器產生)

public class Account
{
    public Guid ID { get; set; }
    public string UserName { get; set; }
    public string Password { get; set; }
    public string Email { get; set; }
    public RoleWrapper Role { get; set; }  // 複雜類型屬性
}

關鍵:必須使用手寫 POCO 類別,不能使用 EDMX 設計器產生的 EntityObject 衍生類,因為複雜類型映射需手動配置,設計器會覆蓋自訂邏輯。

ObjectContext 衍生類別

public class EntitiesContext : ObjectContext
{
    public EntitiesContext() : base("name=Entities", "Entities") {
        _accounts = CreateObjectSet();
    }

    public ObjectSet Accounts => _accounts;
    private readonly ObjectSet _accounts;
}

連接字串在 app.config/web.config 中定義 <add name="Entities" ... />。

EDMX 複雜類型映射配置 (手動編輯 .edmx XML)

<!-- CSDL (概念模型) -->
<ComplexType Name="RoleWrapper">
  <Property Name="Value" Type="Int32" Nullable="false" />
  <Property Name="EnumValue" Type="Self.AccountRoleEnum" Nullable="false" /> <!-- 概念層 Enum -->
</ComplexType>

<EntityType Name="Account">
  <Key><PropertyRef Name="ID" /></Key>
  <Property Name="Role" Type="Self.RoleWrapper" Nullable="false" />
</EntityType>

<!-- SSDL (儲存模型) -->
<EntityType Name="Account">
  <Key><PropertyRef Name="ID" /></Key>
  <Property Name="Role" Type="int" Nullable="false" /> <!-- 對應資料表 Role INT 欄位 -->
</EntityType>

<!-- C-S Mapping -->
<EntityTypeMapping TypeName="Self.Account">
  <MappingFragment StoreEntitySet="Account">
    <ScalarProperty Name="ID" ColumnName="ID" />
    ...
    <ComplexProperty Name="Role">
      <ScalarProperty Name="Value" ColumnName="Role" /> <!-- 關鍵:只映射 Value 欄位 -->
    </ComplexProperty>
  </MappingFragment>
</EntityTypeMapping>

僅將 RoleWrapper.Value 映射至資料表 Role 欄位;EnumValue 僅存在記憶體中,不持久化。

使用範例

記憶體中比較 (完美支援)

var admin = ctx.Accounts.FirstOrDefault(a => a.Role == AccountRoleEnum.Admin); // 編譯錯誤!無法轉譯為 SQL
// 需改為:
var admin = ctx.Accounts.FirstOrDefault(a => a.Role.Value == (int)AccountRoleEnum.Admin); // 正確

LINQ to Entities 查詢限制

  • 無法在 LINQ 查詢中直接使用 Enum 比較,因 EF 無法將 RoleWrapper.EnumValue 或隱式轉換轉譯為 SQL。
  • 必須比較 Role.Value 與 (int)Enum。
  • 或使用 SqlFunctions / EntityFunctions 建構原始 SQL 片段 (不推薦)。

完整 CRUD 範例

using (var ctx = new EntitiesContext()) {
    // Create
    var newUser = new Account {
        ID = Guid.NewGuid(),
        UserName = "NewAdmin",
        Password = "pwd",
        Email = "admin@test.com",
        Role = AccountRoleEnum.Admin  // 隱式轉換 → RoleWrapper
    };
    ctx.Accounts.AddObject(newUser);
    ctx.SaveChanges();

    // Read (查詢)
    var admins = ctx.Accounts.Where(a => a.Role.Value == (int)AccountRoleEnum.Admin).ToList();

    // Update
    var user = ctx.Accounts.First(a => a.UserName == "NewAdmin");
    user.Role = AccountRoleEnum.User; // 隱式轉換
    ctx.SaveChanges();

    // Delete
    ctx.DeleteObject(user);
    ctx.SaveChanges();
}

進階:集中管理 Enum 複雜類型 (泛型包裝器)

public class EnumWrapper where TEnum : struct, Enum {
    private TEnum _value;
    public int Value { get => (int)(object)_value; set => _value = (TEnum)(object)value; }
    public TEnum EnumValue { get => _value; set => _value = value; }
    public static implicit operator EnumWrapper(TEnum v) => new EnumWrapper { EnumValue = v };
    public static implicit operator TEnum(EnumWrapper w) => w?.EnumValue ?? default;
}

// 使用
public class Account {
    public EnumWrapper Role { get; set; }
}

.NET 4.0 不支援 where TEnum : Enum (4.5+ 才有),需用 struct, IConvertible 並執行期檢查 typeof(TEnum).IsEnum。

遷移至 EF 5+/EF Core 的優勢

  • 原生 public AccountRoleEnum Role { get; set; },無需包裝器。
  • LINQ 查詢直接支援 .Where(a => a.Role == AccountRoleEnum.Admin)。
  • 資料庫遷移自動處理 Enum 欄位型別 (可選 HasConversion 控制儲存字串/數值)。

總結

  1. EF4 使用 Complex Type + 隱式轉換運算子 實現 Enum 映射。
  2. 資料庫存 INT,映射 Wrapper.Value;業務層用 Wrapper.EnumValue。
  3. 查詢必須比較 .Value == (int)Enum,無法直接用 Enum。
  4. POCO 手寫類別 + 手動 EDMX XML 映射是關鍵。
  5. 條件允許請升級 EF Core,獲得完整原生 Enum 體驗。
copyright © 萬盛學電腦網 all rights reserved