問題描述
今天下午(看現在這時間,應該是昨天下午了哈),園友 choon 寫了這樣一篇博文《關於有默認值的字段在用EF做插入操作時的思考》。
博文內容主要記錄的是 choon 使用 EF 做數據插入與更新時,字段默認值的問題,這個問題我們平常應該都會遇到,但是,最后博文內容包括評論,並沒人能給出一個准確的答案,真是很可惜(知識點的博文都是一侃一大堆,而這些實際項目遇到的問題卻回答不上來,又有什么用呢,哎。。。)。詳細內容請查看上面的博文,這邊我再簡單敘述下:
數據庫有一個 Users 表,表中有一個 CreateDate 字段,我們希望使用 EF 的時候,插入 User 數據,不需要插入 CreateDate 的值,而是通過默認值生成。
- CreateDate 字段為 null:使用 EF 的 ADD 操作(沒有給 User 對象賦予 CreateDate 的值),插入的結果是 CreateDate 值為 null。
- CreateDate 字段不為 null:還是按照上面的操作,插入 User 報錯。
choon 最后給出的解決方式是:
<Property Name="CreateDate" Type="datetime" Nullable="false" StoreGeneratedPattern="Computed" />
后來,choon 又補充這樣實現的兩個問題(看過下面的內容,你就知道為什么會出現這兩個問題了):
- 如果將 StoreGeneratedPattern 值設置為 Identity,只要一修改 CreateDate 字段就會拋異常;
- 如果把 StoreGeneratedPattern 值設置為 Computed 不會拋異常,但值仍然沒有被修改,即使你寫了 user.CreateDate = "xxx"。
問題分析
為了方面理解,我按照當時實現的步驟敘述下,因為我喜歡 EF 的 CodeFirst 模式,所以這邊我就用它來做演示,看一下示例代碼:
using System;
using System.ComponentModel.DataAnnotations;
using System.Data.Entity;
namespace CodeFirstDemo
{
class Program
{
static void Main(string[] args)
{
using (var db = new ProductContext())
{
var product = new Product { Name = "xishuai" };
db.Products.Add(product);
db.SaveChanges();
Console.WriteLine("success");
Console.ReadKey();
}
}
}
public class Product
{
[Key]
public int ID { get; set; }
public string Name { get; set; }
public DateTime? CreateTime { get; set; }
}
public class ProductContext : DbContext
{
public DbSet<Product> Products { get; set; }
}
}
這是我們一般的實現方式,注意這段代碼:var product = new Product { Name = "xishuai" }; 我並沒有給 CreateTime 進行賦值,為了可以使數據庫生成成功,我還把 CreateTime 設置為 null(DateTime?),但是運行的結果是:數據庫生成了,卻只有 ID 和 Name 字段,而且添加數據失敗:
異常信息:“由於表 'Products' 中不存在列 'CreateTime',ALTER TABLE ALTER COLUMN 失敗。”,什么原因呢?主要是沒有指定 CreateTime 屬性(Attribute),比如[Required],但是我們發現 Name 也沒有指定啊,為什么它卻可以生成數據庫列?因為我們在 Add 的時候指定 Name 的值了,這樣 EF 會自動識別這些字段進行生成列。
我們可以先把數據庫生成一下,然后再進行實驗,可以暫時把添加數據代碼改為:var product = new Product { Name = "xishuai", CreateTime = DateTime.Now };,這樣數據庫就可以成功生成了,之后再還原一下,我們按照 choon 的配置,做下面類似的操作:
[DatabaseGenerated(DatabaseGeneratedOption.Computed)]
public DateTime? CreateTime { get; set; }
上面添加的屬性配置和 choon 在 config 中的配置是一樣的,只不過這個場景是 CodeFirst 下。毫無疑問,這樣添加數據像 choon 一樣,還是會無效果或抱異常(沒有賦值 CreateTime),那究竟是什么問題呢?我們再看一下 StoreGeneratedPattern 的枚舉值(MSDN詳情):
- None:一個值,指示它不是服務器生成的屬性。這是默認值。如果沒有StoreGeneratedPattern屬性,其值就默認為None.
- Identity:執行插入時生成一個值,但在執行更新時保持不變。
- Computed:執行插入和更新時都將生成一個值。
Identity 是什么意思?其實是標識鍵的意思,也就是我們常說的自增鍵,如果我們把上面示例中 CreateTime 的數據類型改為 int,配置還是原來的配置,但是數據識可以添加的,園中也有人做了一個示例,詳情請訪問:Entity Framework 數據生成選項 DatabaseGenerated 。
在 MSDN 中也又相應的示例說明,我貼一下關於這一點的總結(MSDN詳情):
You read above that by default, a key property that is an integer will become an identity key in the database. That would be the same as setting DatabaseGenerated to DatabaseGenerationOption.Identity. If you do not want it to be an identity key, you can set the value to DatabaseGenerationOption.None.
英語不太好,請自行理解,說了這么多,難道沒有解決方式嗎?當然會有,只是你比較懶而已,google 搜索:“code first datetime default” 、“databasegenerated datetime” 或 “An error occurred while updating the entries. See the inner exception for details” 關鍵字,你就會發現答案。
解決方案
首先,Product 中的 CreateTime 屬性,還是之前的配置:
[DatabaseGenerated(DatabaseGeneratedOption.Computed)]
public DateTime? CreateTime { get; set; }
我們要做的是使用 CodeFirst 遷移(怎么遷移?請查看:初試Code First(附Demo)),先輸入命令“Enable-Migrations”啟動遷移,然后再“Add-Migration Update1”添加遷移,這時候會生成 Update1 遷移文件,打開后進行如下更改:
namespace CodeFirstDemo.Migrations
{
using System;
using System.Data.Entity.Migrations;
public partial class Update1 : DbMigration
{
public override void Up()
{
//AlterColumn("dbo.Products", "CreateTime", c => c.DateTime());
AlterColumn("dbo.Products", "CreateTime", c => c.DateTime(defaultValueSql: "GETDATE()"));
}
public override void Down()
{
AlterColumn("dbo.Products", "CreateTime", c => c.DateTime());
}
}
}
代碼什么意思,我就不多說了,改完之后,輸入命令“Update-Database”更新到數據庫,然后我們再進行測試:
可以看到數據是添加成功的,不放心的話可以去數據庫瞧瞧,有人可能會有疑問,我們增加了 DateTime 值的默認 SQL,是不是就不需要對 DateTime 進行 DatabaseGenerated 配置了呢?這個我試過,去掉 DatabaseGenerated 是會報錯的,至於為什么?其實你看到這,應該會明白上面 choon 所提出的兩個問題,這邊我說一下我的理解,但是不一定正確哦:
- 如果將 StoreGeneratedPattern 值設置為 Identity,只要一修改 CreateDate 字段就會拋異常:StoreGeneratedPattern 設置為 Identity,也就是標識鍵,但數據類型不是 int,而是 dateTime,最重要的是在增加或修改數據的時候,EF 找不到"the formula for the computed column"(計算列的公式-來自MSDN),所以不報錯才怪。
- 如果把 StoreGeneratedPattern 值設置為 Computed 不會拋異常,但值仍然沒有被修改,即使你寫了 user.CreateDate = "xxx":將 StoreGeneratedPattern 設置為 Computed(執行插入和更新時都將生成一個值),既然是生成,你再進行 Set 也是沒用的,而且像上面一樣,找不到此列的計算公式(可以理解為 GETDATE),所以沒用任何值添加或修改。
這是 EF CodeFirst 中的解決方式,至於“Model First”生成 edmx 中的方式解決,這個我還沒試(肯定是修改 Config 配置文件),但我覺得都大同小異。還有就是,大家項目中使用 EF,如果可以的話,建議使用 CodeFirst 模式,不是一般的爽哦。。。
示例代碼下載:http://pan.baidu.com/s/1pJG3jab
問題解決,要留下“痕跡”:
- Adding CreatedDate to an entity using Entity Framework 5 Code First
- Code First Data Annotations
- Entity Framework “Code First + Computed GETDATE()”
- Entity Framework 6 Code First default datetime value on insert
- Entity Framework - “An error occurred while updating the entries. See the inner exception for details”
- 記不得了...
