EFCore 和 FreeSql 都是 ORM,在各自領域都有着獨特的優勢。
問題起源
假設某項目是使用 EFCore 開發的,且實體 特性或FluentApi 都配置好了,如:
protected override void MapTable( EntityTypeBuilder builder ) {
builder.ToTable( "cg_kssqbs" ); //實體表名有單獨定義
}
此時用 FreeSql 操作實體會報錯:數據庫表不存在。除非又配置一套FreeSql的 特性或FluentApi,這顯然會比較麻煩。
問:為什么不統一,非要各自定義標准?
答:每個 ORM 的理念不同,提供的功能也不盡相同,FreeSql 的理念是“打造 .NETCore 最方便的 ORM”。與 EFCore 相比只提供了極少的特性配置(如:主鍵、自增、類型、別名、可空),並且這些設定針對已現實的數據庫都是一致的。因此 FreeSql 有單獨一套簡單的實體配置語法,特別聲明:方便、簡單指的是上手簡單,並非說 FreeSql 功能簡單。
來自 Issues 4 《建議能結合EF Core的一些特性來弄 #4》
解決方法
1、關閉 FreeSql 遷移功能
IFreeSql fsql = new FreeSql.FreeSqlBuilder()
.UseConnectionString(FreeSql.DataType.Sqlite, @"Data Source=|DataDirectory|\document.db;Attachs=xxxtb.db;Pooling=true;Max Pool Size=10")
//.UseAutoSyncStructure(true) //自動同步實體結構到數據庫,這行一定要關閉
.Build();
原因是 EFCore 與 FreeSql 遷移會發生沖突,那邊遷移好了,這邊又遷移的邏輯顯然不對。
2、讀取 EFCore 的實體配置數據
-
Microsoft.EntityFrameworkCore.Metadata.IModel 可以獲取 EFCore 的實體配置數據;
-
FreeSql 已實現了 特性 + FluentApi 配置實體,參考:https://github.com/2881099/FreeSql/wiki/CodeFirst;
ICodeFirst.ConfigEntity 方法可以在程序運行中配置,從而改變實體的映射
以擴展類庫的方式現實需求代碼如下:
public static void ConfigEntity(this ICodeFirst codeFirst, IModel efmodel) {
foreach (var type in efmodel.GetEntityTypes()) {
codeFirst.ConfigEntity(type.ClrType, a => {
//表名
var relationalTableName = type.FindAnnotation("Relational:TableName");
if (relationalTableName != null)
a.Name(relationalTableName.Value?.ToString() ?? type.ClrType.Name);
foreach (var prop in type.GetProperties()) {
var freeProp = a.Property(prop.Name);
//列名
var relationalColumnName = prop.FindAnnotation("Relational:ColumnName");
if (relationalColumnName != null)
freeProp.Name(relationalColumnName.Value?.ToString() ?? prop.Name);
//主鍵
freeProp.IsPrimary(prop.IsPrimaryKey());
//自增
freeProp.IsIdentity(
prop.ValueGenerated == ValueGenerated.Never ||
prop.ValueGenerated == ValueGenerated.OnAdd ||
prop.GetAnnotations().Where(z =>
z.Name == "SqlServer:ValueGenerationStrategy" && z.Value.ToString().Contains("IdentityColumn") //sqlserver 自增
|| z.Value.ToString().Contains("IdentityColumn") //其他數據庫實現未經測試
).Any()
);
//可空
freeProp.IsNullable(prop.AfterSaveBehavior != PropertySaveBehavior.Throw);
//類型
var relationalColumnType = prop.FindAnnotation("Relational:ColumnType");
if (relationalColumnType != null) {
var dbType = relationalColumnType.ToString();
if (!string.IsNullOrEmpty(dbType)) {
var maxLength = prop.FindAnnotation("MaxLength");
if (maxLength != null)
dbType += $"({maxLength})";
freeProp.DbType(dbType);
}
}
}
});
}
}
測試
public class Song {
[Key, DatabaseGenerated(DatabaseGeneratedOption.Identity)]
public int Id { get; set; }
public string Title { get; set; }
}
public class SongContext : DbContext {
public DbSet<Song> Songs { get; set; }
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) {
optionsBuilder.UseSqlite(@"Data Source=|DataDirectory|\document.db;Attachs=xxxtb.db;Pooling=true;Max Pool Size=10");
}
}
Console.WriteLine(fsql.Insert<Song>().AppendData(new Song()).ToSql());
//INSERT INTO "Song"("Id", "Title") VALUES(@Id0, @Title0)
using (var sdb = new SongContext()) {
Fsql.CodeFirst.ConfigEntity(sdb.Model);
//ps: 只需要配置一次
}
Console.WriteLine(fsql.Insert<Song>().AppendData(new Song()).ToSql());
"INSERT INTO "Songs"("Title") VALUES(@Title0)"
//此處配置已生效,Id 為自增時不插入,表名也改名了 Songs
示范項目已整理上傳到 Github/Examples/efcore_to_freesql
有幾個問題
本人對 EF 不太熟,有幾個問題請教:
1、EFCore 是不是非要定義 DBContext 來使用?
2、Microsoft.EntityFrameworkCore.Metadata.IModel 有沒有變化通知或攔截的方法?簡化配置;
3、EFCore 自增各種數據庫的現實貌似有差異?
結束語
感謝觀看,以上是我的解決思路,如果有更好的建議或方法歡迎討論。
FreeSql 雖然目前的版本發布為 0.xx,但功能和可能性已經較高了。