Entity Framework使用Code First模式管理存儲過程

Posted on 2022-03-05 by WalkonNet

在EF中使用存儲過程和使用視圖是很相似的，一般會使用Database對象上的兩個方法：SqlQuery和ExecuteSqlCommand。為瞭從存儲過程中讀取很多數據行，我們隻需要定義一個類，我們會將檢索到的所有數據行物質化到該類實例的集合中。比如，從下面的存儲過程讀取數據：

CREATE PROCEDURE [dbo].[SelectBooks]
@BookTypeName AS NVARCHAR(10)
AS
BEGIN
select B.Name,B.Author,B.PublicationDate,T.BookTypeName from Books as B
join BookTypes as T on B.BookTypeId=T.BookTypeId where T.BookTypeName=@BookTypeName
END

1、定義實體類

Book實體類定義如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace CodeFirstProcedureApp.Model
{
    public class Book
    {
        public int Id { get; set; }

        public string Name { get; set; }

        public string Author { get; set; }

        public DateTime PublicationDate { get; set; }

        public virtual BookType BookType { get; set; }
    }
}

BookType實體類定義如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace CodeFirstProcedureApp.Model
{
    public class BookType
    {
        public BookType()
        {
            Books = new HashSet<Book>();
        }

        public int BookTypeId { get; set; }

        public string BookTypeName { get; set; }

        public virtual ICollection<Book> Books { get; set; }
    }
}

2、定義與存儲過程結果匹配的實體類

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace CodeFirstProcedureApp.Model
{
    public class BookFromProcedure
    {
        public string Name { get; set; }

        public string Author { get; set; }

        public DateTime PublicationDate { get; set; }

        public string BookTypeName { get; set; }
    }
}

註意：類的屬性名必須和存儲過程中定義的列名一致。

3、創建種子初始化器類

using CodeFirstProcedureApp.Model;
using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace CodeFirstProcedureApp.EF
{
    public class Initializer : DropCreateDatabaseIfModelChanges<EFDbContext>
    {
        protected override void Seed(EFDbContext context)
        {
            // 創建初始化數據
            BookType bookType = new BookType()
            {
                BookTypeName = "文學小說",
                Books = new List<Book>
                {
                  new Book(){Name="人間失格",Author="太宰治",PublicationDate=DateTime.Parse("2015-08-01")},
                  new Book(){Name="解憂雜貨店",Author="東野圭吾",PublicationDate=DateTime.Parse("2014-05-01")},
                  new Book(){Name="追風箏的人",Author="卡勒德胡賽尼",PublicationDate=DateTime.Parse("2006-08-01")},
                  new Book(){Name="百年孤獨",Author="加西亞馬爾克斯",PublicationDate=DateTime.Parse("2011-06-01")},
                  new Book(){Name="霍亂時期的愛情",Author="加西亞馬爾克斯",PublicationDate=DateTime.Parse("2015-06-01")}
                }
            };

            BookType bookType2 = new BookType()
            {
                BookTypeName = "科學",
                Books = new List<Book>
                {
                   new Book(){Name="人類簡史",Author="尤瓦爾赫拉利",PublicationDate=DateTime.Parse("2017-01-01")}
                }
            };

            context.BookTypes.Add(bookType);
            context.BookTypes.Add(bookType2);
            base.Seed(context);
        }
    }
}

4、定義數據上下文類

using CodeFirstProcedureApp.Model;
using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace CodeFirstProcedureApp.EF
{
    public class EFDbContext :DbContext
    {
        public EFDbContext()
            : base("name=AppConnection")
        {
            Database.SetInitializer(new Initializer());
        }

        // 添加到數據上下文中
        public DbSet<Book> Books { get; set; }

        public DbSet<BookType> BookTypes { get; set; }

        protected override void OnModelCreating(DbModelBuilder modelBuilder)
        {
            // 配置表名和主鍵
            modelBuilder.Entity<Book>().ToTable("Books").HasKey(p => p.Id);
            modelBuilder.Entity<BookType>().ToTable("BookTypes").HasKey(p => p.BookTypeId);
            // 設置實體關系
            //  BookType和 Books 一對多關系 外鍵：BookTypeId
            modelBuilder.Entity<BookType>().HasMany(p => p.Books).WithRequired(t => t.BookType)
                .Map(m =>
                {
                    m.MapKey("BookTypeId");
                });
            base.OnModelCreating(modelBuilder);
        }
    }
}

5、運行程序

使用SQL語句創建存儲過程：

var createSql = @"CREATE PROCEDURE [dbo].[SelectBooks]
                                    @BookTypeName AS NVARCHAR(10)
                                    AS
                                    BEGIN
                                    select B.Name,B.Author,B.PublicationDate,T.BookTypeName from Books as B
                                    join BookTypes as T on B.BookTypeId=T.BookTypeId where T.BookTypeName=@BookTypeName
                                    END";
context.Database.ExecuteSqlCommand(createSql);

查看數據庫：

調用存儲過程查詢數據

註意：在使用存儲過程前，先要在存儲過程中執行該存儲過程或者使用上面的程序生成存儲過程。

var sql = "SelectBooks {0}";
var books = context.Database.SqlQuery<BookFromProcedure>(sql, "文學小說");
books.ToList().ForEach(p =>
{
      Console.WriteLine("BookName:" + p.Name + "     Author:" + p.Author + "    BookTypeName:" + p.BookTypeName + "     PublicationDate:" + p.PublicationDate);
});

在上面的代碼中，我們制定瞭使用哪個類讀取查詢的結果，創建SQL語句時，也為存儲過程的參數提供瞭一個格式化占位符，調用SqlQuery時為那個參數提供瞭一個值。假如要提供多個參數的話，多個格式化占位符必須要用逗號分隔，還要給SqlQuery提供值的數組。我們也可以使用表值函數代替存儲過程。存儲過程執行結果如下：

6、執行無返回值的存儲過程

另一個用例就是假如存儲過程沒有任何的返回值，隻是對數據庫中的一張表或者多張表執行瞭一條命令的情況。一個存儲過程做瞭多少事情不重要，重要的是它不返回任何數據。例如：下面的存儲過程隻是更新瞭一些數據：

CREATE PROCEDURE UpdateBooks
@name AS NVARCHAR(60),
@id as int
AS 
BEGIN
UPDATE Books SET Name=@name
WHERE Id=@id
END

先在數據庫中執行該存儲過程，然後要調用該存儲過程，我們使用ExecuteSqlCommand()方法。該方法會返回存儲過程或者其它任何SQL語句受影響的行數。如果對這個返回值不感興趣，可以忽略返回值。

var sql = "UpdateBooks @name,@id";
SqlParameter[] para = new SqlParameter[]
{
       new SqlParameter("@id",1d),
       new SqlParameter("@name","人間失敗"),
};
var book = context.Books.Where(p => p.Id == 1);
Console.WriteLine("執行存儲過程前的數據為：");
foreach (var item in book)
{
       Console.WriteLine(item.Name + "\t" + item.Author + "\t" + item.PublicationDate);
}
var rowsAffected = context.Database.ExecuteSqlCommand(sql, para);
Console.WriteLine("影響的行數為{0}條", rowsAffected);
Console.WriteLine("執行存儲過程之後的數據為：");
var books = context.Books.Where(p => p.Id == 1);
foreach (var item in books)
{
        Console.WriteLine(item.Name + "\t" + item.Author + "\t" + item.PublicationDate);
}

上面的代碼中為存儲過程提供瞭兩個參數：一個是Name，一個是Id。這裡需要註意的是：我們必須嚴格按照它們在存儲過程中定義的順序依次傳入相應的值，它們會以參數數組傳入ExecuteSqlCommand。執行結果如下：

很大程度上，EF降低瞭存儲過程的需要。然而，仍舊有很多原因要使用它們。這些原因包括安全標準、遺留數據庫或者效率問題。比如，如果需要在單個操作中更新幾千條數據，然後在通過EF檢索出來；如果每次都更新一行，然後在保存那些實例，效率是很低的。最後，即使使用瞭SqlQuery()方法調用瞭存儲過程，也可以更新數據。

註意：開發者可以執行任意的SQL語句，隻需要將上面SqlQuery或ExecuteSqlCommand方法中的存儲過程名稱改為要執行的SQL語句就可以瞭。

示例代碼下載地址：點此下載

到此這篇關於Entity Framework使用Code First模式管理存儲過程的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

Entity Framework使用Code First模式管理存儲過程

1、定義實體類

2、定義與存儲過程結果匹配的實體類

3、創建種子初始化器類

4、定義數據上下文類

5、運行程序

6、執行無返回值的存儲過程

推薦閱讀：

發佈留言取消回覆

近期文章

1、定義實體類

2、定義與存儲過程結果匹配的實體類

3、創建種子初始化器類

4、定義數據上下文類

5、運行程序

6、執行無返回值的存儲過程

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆