ASP.NET Core使用EF Core操作MySql資料庫

ASP.NET Core操作MySql資料庫，這樣整套環境都可以佈署在Linux上使用微軟的 Microsoft.EntityFrameworkCore(2.1.4) 和MySql出的 MySql.Data.EntityFrameworkCore(8.0.13) 軟體版本 Asp.net Cor ...

ASP.NET Core操作MySql資料庫，這樣整套環境都可以佈署在Linux上

使用微軟的 Microsoft.EntityFrameworkCore(2.1.4) 和MySql出的 MySql.Data.EntityFrameworkCore(8.0.13)

軟體版本

Asp.net Core:2.1

MySql:5.6

項目結構

Snai.Mysql 是 Asp.net core 2.0 Api網站，Database 下的是MySql建庫建表腳本

項目實現

一、MySql 建庫建表

使用 Database下的 mysql 建庫表主鍵索引.sql 腳本建庫建表，腳本如下：

CREATE DATABASE alan CHARACTER SET utf8 COLLATE utf8_general_ci
;

USE alan
;

CREATE TABLE student(
    id INT AUTO_INCREMENT PRIMARY KEY,            -- 自增列需為主鍵
    `name` NVARCHAR(32) NOT NULL DEFAULT '',
    sex TINYINT NOT NULL DEFAULT 1,                -- 0 男生，1 女生，2 保密
    age INT NOT NULL DEFAULT 0
)
;
   
ALTER TABLE student ADD INDEX ix_student_name(`name`)          -- UNIQUE INDEX 唯一索引

建庫時加上 CHARACTER SET utf8 COLLATE utf8_general_ci 代碼，設置資料庫字元集為 utf8，配合程式的資料庫連接串加上 CharSet=utf8，防止中文保存時亂碼

如果建庫時不是utf8，就把字元集改為utf8

二、EF Core 連接操作 MySql 資料庫

1、新建項目，添加EF Core 和 MySql驅動依賴項

新建 asp.net core api 網站程式，NuGet 添加依賴項 Microsoft.EntityFrameworkCore.Tools(2.1.4) 和 MySql.Data.EntityFrameworkCore(8.0.13) 包

2、添加實體類Student和資料庫上下文

新建 Entities 目錄，在，根據表及欄位，在目錄下新建 Student 實體類，在類上加 [Table("student")] 表名、屬性上加[Column("id")] 欄位名等與表對應，代碼如下：

using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using System.Threading.Tasks;

namespace Snai.Mysql.Entities
{
    [Table("student")]
    public class Student
    {
        [Column("id")]
        public int ID { get; set; }

        [Column("name")]
        public string Name { get; set; }

        [Column("sex")]
        public byte Sex { get; set; }
        
        [Column("age")]
        public int Age { get; set; }
    }
}

在根目錄下加上 DataAccess 目錄做為資料庫操作目錄，在該目錄下加上 Base 目錄做資料庫上下文目錄

在 Base 目錄下新建 AlanContext 上下文類，繼承 DbContext 類，通過構造函數註入資料庫連接，添加 DbSet<Student> 實體屬性，代碼如下：

using Microsoft.EntityFrameworkCore;
using Snai.Mysql.Entities;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace Snai.Mysql.DataAccess.Base
{
    public class AlanContext:DbContext
    {
        public AlanContext(DbContextOptions<AlanContext> options)
            : base(options)
        { }

        public DbSet<Student> Student { get; set; }
    }
}

3、添、刪、改、查資料庫記錄

在 DataAccess 目錄下新建 Interface 目錄，用於保存資料庫操作的介面，在該目錄下新建 IAlanDao 介面，在介面里增加 CreateStudent()，GetStudents()，GetStudentByID()，UpdateStudent()，UpdateNameByID()，DeleteStudentByID() 資料庫添、刪、改、查介面，代碼如下：

using Snai.Mysql.Entities;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace Snai.Mysql.DataAccess.Interface
{
    public interface IAlanDao
    {
        //插入數據
        bool CreateStudent(Student student);

        //取全部記錄
        IEnumerable<Student> GetStudents();

        //取某id記錄
        Student GetStudentByID(int id);

        //根據id更新整條記錄
        bool UpdateStudent(Student student);

        //根據id更新名稱
        bool UpdateNameByID(int id, string name);

        //根據id刪掉記錄
        bool DeleteStudentByID(int id);
    }
}

在 DataAccess 目錄下新建 Implement 目錄，用於保存資料庫操作介面的實現，在該目錄下新建 AlanDao 類，繼承 IAlanDao 介面，實現介面里的資料庫操作方法，在構造函數註入 AlanContext 資料庫上下文，代碼如下：

using Snai.Mysql.DataAccess.Base;
using Snai.Mysql.DataAccess.Interface;
using Snai.Mysql.Entities;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace Snai.Mysql.DataAccess.Implement
{
    public class AlanDao: IAlanDao
    {
        public AlanContext Context;

        public AlanDao(AlanContext context)
        {
            Context = context;
        }

        //插入數據
        public bool CreateStudent(Student student)
        {
            Context.Student.Add(student);
            return Context.SaveChanges() > 0;
        }

        //取全部記錄
        public IEnumerable<Student> GetStudents()
        {
            return Context.Student.ToList();
        }

        //取某id記錄
        public Student GetStudentByID(int id)
        {
            return Context.Student.SingleOrDefault(s => s.ID == id);
        }

        //根據id更新整條記錄
        public bool UpdateStudent(Student student)
        {
            Context.Student.Update(student);
            return Context.SaveChanges() > 0;
        }

        //根據id更新名稱
        public bool UpdateNameByID(int id, string name)
        {
            var state = false;
            var student = Context.Student.SingleOrDefault(s => s.ID == id);

            if (student != null)
            {
                student.Name = name;
                state = Context.SaveChanges() > 0;
            }

            return state;
        }

        //根據id刪掉記錄
        public bool DeleteStudentByID(int id)
        {
            var student = Context.Student.SingleOrDefault(s => s.ID == id);
            Context.Student.Remove(student);
            return Context.SaveChanges() > 0;
        }
    }
}

4、添加 StudentController 控制器，調用資料庫操作方法

在 Controllers 目錄下，添加 StudentController 控制器，在構造函數註入 AlanDao 資料庫操作，在控制器里創建 Create()，Gets()，Get()，Update()，UpdateName()，Delete()等方法，調用 AlanDao 資料庫操作方法，代碼如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Snai.Mysql.DataAccess.Interface;
using Snai.Mysql.Entities;

namespace Snai.Mysql.Controllers
{
    public class StudentController : ControllerBase
    {
        private IAlanDao AlanDao;

        public StudentController(IAlanDao alanDao)
        {
            AlanDao = alanDao;
        }

        //插入數據
        public ActionResult<string> Create(string name, byte sex, int age)
        {
            if (string.IsNullOrEmpty(name.Trim()))
            {
                return "姓名不能為空";
            }

            if (sex < 0 || sex > 2)
            {
                return "性別數據有誤";
            }

            if (age <= 0)
            {
                return "年齡數據有誤";
            }

            var student = new Student() {
                Name = name,
                Sex = sex,
                Age = age
            };

            var result = AlanDao.CreateStudent(student);

            if (result)
            {
                return "學生插入成功";
            }
            else
            {
                return "學生插入失敗";
            }
            
        }

        //取全部記錄
        public ActionResult<string> Gets()
        {
            var names = "沒有數據";
            var students = AlanDao.GetStudents();

            if (students != null)
            {
                names = "";
                foreach (var s in students)
                {
                    names += $"{s.Name} \r\n";
                }
                    
            }

            return names;
        }

        //取某id記錄
        public ActionResult<string> Get(int id)
        {
            var name = "沒有數據";
            var student = AlanDao.GetStudentByID(id);

            if (student != null)
            {
                name = student.Name;
            }

            return name;
        }

        //根據id更新整條記錄
        public ActionResult<string> Update(int id, string name, byte sex, int age)
        {
            if (id <= 0)
            {
                return "id 不能小於0";
            }

            if (string.IsNullOrEmpty(name.Trim()))
            {
                return "姓名不能為空";
            }

            if (sex < 0 || sex > 2)
            {
                return "性別數據有誤";
            }

            if (age <= 0)
            {
                return "年齡數據有誤";
            }

            var student = new Student()
            {
                ID = id,
                Name = name,
                Sex = sex,
                Age = age
            };

            var result = AlanDao.UpdateStudent(student);

            if (result)
            {
                return "學生更新成功";
            }
            else
            {
                return "學生更新失敗";
            }
        }

        //根據id更新名稱
        public ActionResult<string> UpdateName(int id, string name)
        {
            if (id <= 0)
            {
                return "id 不能小於0";
            }

            if (string.IsNullOrEmpty(name.Trim()))
            {
                return "姓名不能為空";
            }

            var result = AlanDao.UpdateNameByID(id, name);

            if (result)
            {
                return "學生更新成功";
            }
            else
            {
                return "學生更新失敗";
            }
        }

        //根據id刪掉記錄
        public ActionResult<string> Delete(int id)
        {
            if (id <= 0)
            {
                return "id 不能小於0！";
            }

            var result = AlanDao.DeleteStudentByID(id);

            if (result)
            {
                return "學生刪除成功";
            }
            else
            {
                return "學生刪除失敗";
            }
        }
    }
}

5、配置資料庫連接串，註冊資料庫連接到容器，註冊資料庫操作類到容器，修改路由

在 appsettings.json 中配置資料庫連接串 "AlanConnection": "server=localhost;port=3306;database=alan;uid=root;pwd=123456;CharSet=utf8" ，CharSet=utf8 是為了配合資料庫 utf8 字元集，防止中文亂碼：

{
  "ConnectionStrings": {
    "AlanConnection": "server=localhost;port=3306;database=alan;uid=root;pwd=123456;CharSet=utf8"
  }
}

修改 Startup.cs 類的 ConfigureServices() 方法，註冊資料庫連接，註冊資料庫操作類

註冊資料庫連接 services.AddDbContext<AlanContext>(options => options.UseMySQL(Configuration.GetConnectionString("AlanConnection")));

UseMySql() 為使用 MySql 資料庫，如果是 Sql Server 則使用 UseSqlServer()

註冊資料庫操作類 services.AddScoped<IAlanDao, AlanDao>();

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<AlanContext>(options => options.UseMySQL(Configuration.GetConnectionString("AlanConnection")));
    services.AddScoped<IAlanDao, AlanDao>();

    services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1);
}

修改路由，添加預設路由，以 controller、action，MVC的路徑方式訪問而不是 restful api 路徑方式訪問

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}");
    });
}

到此代碼編寫已完成

三、運行測試資料庫添、刪、改、查

運行項目

1、添加記錄，打開 http://localhost:5000/Student/Create?name=小木&sex=0&age=18 地址，數據插入成功