使用Dapper訪問SQL Server數據庫

 

對應Demo程序名：DapperDemo

 

准備工作：為項目安裝Dapper類庫

方法一：項目中添加：項目名右鍵；Manage NuGet Packages；搜索Dappe；點擊安裝

方法二：在NuGet官網（https://www.nuget.org/）查詢類庫的安裝命令：

              搜索Dapper；找到安裝命令（Install-Package Dapper -Version 1.60.6）；在Visual Studio中打開包管理工具控制台（Tools→NuGget Package Manager→Packages Manager Console）；

              選中默認的項目（DapperDemo）並輸入安裝命令；回車

             

 

一、創建實體類，例如Person.cs

作用：Person類對應數據庫中的Person表，各字段對應數據庫表的各列。

    public class Person
    {
        public int Id { get; set; }
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string EmailAddress { get; set; }
        public DateTime CreatedOn { get; set; }
        public string IpAddress { get; set; }
        
        //定義一個屬性，用來計算所有屬性
        /// <summary>
        /// 計算屬性，返回用戶的詳細信息
        /// </summary>
        public string Display
        {
            get
            {
                return $"{FirstName} {LastName} ({EmailAddress}) {IpAddress}";
            }
        }
    }

 

二、創建數據庫連接幫助類DbHelper.cs

作用：從配置文件中讀取數據庫連接字符串。

    public class DbHelper
    {
        /// <summary>
        /// 從配置文件中讀取數據庫連接字符串
        /// </summary>
        public static string ConnectionString
        {
            get { return ConfigurationManager.ConnectionStrings["Dbconn"].ConnectionString; }
        }
    }

注：解決ConfigurationManager標紅：添加引用Reference→Add Reference→System.Configuration，再在程序中引用using System.Configuration;

 

三、數據庫連接配置（App.config）

作用：在配置文件中存放數據庫連接信息，如需修改，只修改配置文件而不用修改源代碼，符合開閉原則。

在<configuration>節點下添加<connectionStrings>節點，存放數據庫連接信息：

<configuration>
    <connectionStrings>
      <add name="Dbconn" connectionString="Server=127.0.0.1;Database=master;User Id=sa;Password=Phoenix@2019;" />
    </connectionStrings>
</configuration>

 

四、創建數據庫訪問類PersonService.cs

作用：連接並訪問數據庫，讀取或寫入到數據庫。

    public class PersonService
    {
        /// <summary>
        /// 根據用戶姓氏查詢用戶集合 
        /// </summary>
        /// <param name="lastName">姓氏</param>
        /// <returns></returns>
        public List<Person> FindListByLastName(string lastName)
        {
            //SELECT * FROM Person WHERE LastName='Pye'
            using (IDbConnection db = new SqlConnection(DbHelper.ConnectionString))
            {
                //where后直接跟變量來查詢，不能避免SQL注入，應使用后邊一種寫法
                //string sql = $"SELECT * FROM Person WHERE LastName='{lastName}'";
                //IEnumerable<Person> list = db.Query<Person>(sql);

                //Dapper應對SQL注入
                //where后邊限定屬性LastName的必須是@LastName格式，且Query中添加匿名對象new { LastName = lastName}，lastName在這里傳入
                string sql = $"SELECT * FROM Person WHERE LastName=@LastName";
                IEnumerable<Person> list = db.Query<Person>(sql, new { LastName = lastName});
                return list.ToList();
            }
            //using語句塊結束后自動釋放資源，釋放數據庫連接。
        }
        
        /// <summary>
        /// 寫入一條用戶數據
        /// </summary>
        /// <param name="person">用戶信息實體</param>
        /// <returns></returns>
        public bool Insert(Person person)
        {
            using (IDbConnection db = new SqlConnection(DbHelper.ConnectionString))
            {
                string sql = "INSERT INTO Person(FirstName, LastName, EmailAddress, CreatedOn) VALUES(@FirstName, @LastName, @EmailAddress, @CreatedOn)";
                int result = db.Execute(sql, person);
                return result > 0;  //簡化的轉換寫法
            }
        }

        /// <summary>
        /// 刪除一條用戶數據
        /// </summary>
        /// <param name="personId">用戶Id</param>
        /// <returns></returns>
        public bool Delete(int personId)
        {
            using (IDbConnection db = new SqlConnection(DbHelper.ConnectionString))
            {
                string sql = "DELETE FROM Person WHERE Id = @Id";  //where很重要！！！
                int result = db.Execute(sql, new { Id = personId });
                return result > 0;  //簡化的轉換寫法
            }
        }

        /// <summary>
        /// 更新一條用戶數據
        /// </summary>
        /// <param name="person">用戶信息實體</param>
        /// <returns></returns>
        public bool Update(Person person)
        {
            using (IDbConnection db = new SqlConnection(DbHelper.ConnectionString))
            {
                string sql =
                    "UPDATE Person SET FirstName = @FirstName, LastName = @LastName, EmailAddress = @EmailAddress WHERE Id = @Id";  //where很重要！！！
                int result = db.Execute(sql, person);
                return result > 0;  //簡化的轉換寫法
            }
        }

        /// <summary>
        /// 根據用戶Id查詢用戶
        /// </summary>
        /// <param name="personId">用戶Id</param>
        /// <returns></returns>
        public Person FindByPersonId(int personId)
        {
            using (IDbConnection db = new SqlConnection(DbHelper.ConnectionString))
            {
                string sql = $"SELECT * FROM Person WHERE Id=@Id";
                IEnumerable<Person> list = db.Query<Person>(sql, new { Id = personId });
                return list.FirstOrDefault();
            }
        }
    }

 

五、Dashboard界面

作用：分別實現增刪改查方法。

后台代碼中結合具體數據，調用PersonService中的訪問數據庫的方法，實現相關業務功能。

        private void btnSearch_Click(object sender, EventArgs e)
        {
            PersonService ps = new PersonService();
            List<Person> result = ps.FindListByLastName(txtSearchLastName.Text);
            lstSearchResult.DataSource = result;
            lstSearchResult.DisplayMember = "Display";
        }

        private void btnCreate_Click(object sender, EventArgs e)
        {
            PersonService ps = new PersonService();
            Person person = new Person()
            {
                FirstName = txtFirstName.Text,
                LastName = txtLastName.Text,
                EmailAddress = txtEmailAddress.Text,
                CreatedOn = DateTime.Now
            };

            var success = ps.Insert(person);
            MessageBox.Show(success ? "操作成功" : "操作失敗");
        }

        private void btnDelete_Click(object sender, EventArgs e)
        {
            PersonService ps = new PersonService();
            int personId = Convert.ToInt32(txtIndexPersonId.Text);
            var success = ps.Delete(personId);
            MessageBox.Show(success ? "操作成功" : "操作失敗");
        }

        private void btnUpdate_Click(object sender, EventArgs e)
        {
            PersonService ps = new PersonService();
            Person person = new Person()
            {
                Id = Convert.ToInt32(txtIndexPersonId.Text),
                FirstName = txtFirstName.Text,
                LastName = txtLastName.Text,
                EmailAddress = txtEmailAddress.Text,
                CreatedOn = DateTime.Now
            };

            var success = ps.Update(person);
            MessageBox.Show(success ? "操作成功" : "操作失敗");
        }

        private void btnIndex_Click(object sender, EventArgs e)
        {
            PersonService ps = new PersonService();
            int personId = Convert.ToInt32(txtIndexPersonId.Text);
            var person = ps.FindByPersonId(personId);

            txtFirstName.Text = person.FirstName;
            txtLastName.Text = person.LastName;
            txtEmailAddress.Text = person.EmailAddress;
        }

前台界面如圖：

 

六、拓展TODO

可以不使用SQL語句，但要使用Dapper的擴展工具。

 

使用Dapper連接MySQL數據庫

要另外使用MySql.Data庫

數據庫連接字符串格式為

 

 

 

 

使用Dapper連接SQLite數據庫

要另外使用System.Data.SQLite庫

對應的DEMO程序名：

 

 

 

 

通過IP地址連接遠程共享文件夾中的SQLite數據庫時，調試遇到的兩個問題：

1.遠程IP地址解析為C盤的地址，例如"\\192.168.1.10\MES\test.db"解析為："C:\192.168.1.10\MES\test.db"

解決方法：字符串格式問題，應寫為@"\\192.168.1.10\MES\test.db"

2.能夠訪問到遠程共享文件夾后，可以新建數據庫，但_dbConnection.Open();打開數據庫時報錯：unable to open database file

解決方法：首先嘗試將遠程文件夾的權限設為EveryOne擁有全部權限，未能解決；

然后嘗試_dbConnection = new SQLiteConnection($"Data Source={dbFilePath};Version=3;", true); 設置parseViaFramework參數為true，問題解決。

parseViaFramework：Non-zero to parse the connection string using the built-in (i.e. framework provided) parser when opening the connection.非零，以在打開連接時使用內置（即提供的框架）解析器解析連接字符串。

 

 

 

 

 

 

 

 

七、參考

https://study.163.com/course/courseLearn.htm?courseId=1004855012#/learn/video?lessonId=1050368325&courseId=1004855012