.Net Core3.0 WebApi 項目框架搭建 六: Sqlsugar+異步泛型倉儲

.Net Core3.0 WebApi 項目框架搭建：目錄

 

SqlSugar介紹

 

SqlSugar是國人開發者開發的一款基於.NET的ORM框架，是可以運行在.NET 4.+ & .NET CORE的高性能、輕量級 ORM框架，眾多.NET框架中最容易使用的數據庫訪問技術。官網http://www.codeisbug.com/Doc/8

 

SqlSugar的優點:

 

1、高性能 ,不誇張的說，去掉Sql在數據庫執行的時間，SqlSugar是EF數倍性能，另外在批量操作和一對多查詢上也有不錯的SQL優化

 

2、高擴展性 ，支持自定義拉姆達函數解析、擴展數據類型、支持自定義實體特性，外部緩存等

 

3、穩定性和技術支持，  雖然不是官方ORM, 但在穩定性上也是有着數年用戶積累，如果遇到問題可以在GITHUB提出來，會根據緊急度定期解決

 

4、功能全面，雖然SqlSugar小巧可功能並不遜色於EF框架

 

5、創新、持續更新 ，向下兼容

創建數據庫

這里采用DB First的模式，先新建一個數據庫，然后新建一張User表,這里比較簡單，記得表字段添加注釋說明。

 

使用代碼生成器生成數據庫連接文件和實體類

下載地址 ：https://github.com/sunkaixuan/SoEasyPlatform

用法非常簡單

1、下載項目

2、解壓項目

3、點擊解決方案打開項目

4、配置連接字符串名稱、數據庫類型和解決方案名稱

 5、F5運行該項目

 

6.生成成功 

 Repository 和Model層中引入SqlSugar

直接在類庫中通過Nuget引入 sqlSugarCore或者通過Install-Package sqlSugarCore安裝

刪除原來Model層的的User.cs將代碼生成器生成的實體放到model層的enity文件夾

using System;
using System.Linq;
using System.Text;
using SqlSugar;

namespace Webapi.Core.Model.Enity
{
    ///<summary>
    ///用戶表
    ///</summary>
    [SugarTable("User")]
    public partial class User
    {
        public User()
        {


        }
        /// <summary>
        /// Desc:用戶ID
        /// Default:
        /// Nullable:False
        /// </summary>           
        [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
        public int UserId { get; set; }

        /// <summary>
        /// Desc:用戶名
        /// Default:
        /// Nullable:True
        /// </summary>           
        public string UserName { get; set; }

        /// <summary>
        /// Desc:年齡
        /// Default:
        /// Nullable:True
        /// </summary>           
        public int? Age { get; set; }

    }
}

Repository層新建suger文件夾，將生成的DBConext.cs放置進去，里面已經內置了增刪改查等方法,可以刪除掉這些方法，后面我們自己使用異步實現，還是很方便的，不過，如果要使用異步，就要異步到底，不然就會阻塞，變成了同步。

using Webapi.Core.Model.Entity;
using SqlSugar;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
public class DbContext<T> where T : class, new()
{
    public DbContext()
    {
        Db = new SqlSugarClient(new ConnectionConfig()
        {
            ConnectionString = "server=.;uid=sa;pwd=sa123;database=CoreDB",
            DbType = DbType.SqlServer,
            InitKeyType = InitKeyType.Attribute,//從特性讀取主鍵和自增列信息
            IsAutoCloseConnection = true,//開啟自動釋放模式和EF原理一樣我就不多解釋了

        });
        //調式代碼 用來打印SQL 
        Db.Aop.OnLogExecuting = (sql, pars) =>
        {
            Console.WriteLine(sql + "\r\n" +
                Db.Utilities.SerializeObject(pars.ToDictionary(it => it.ParameterName, it => it.Value)));
            Console.WriteLine();
        };

    }
    //注意：不能寫成靜態的
    public SqlSugarClient Db;//用來處理事務多表查詢和復雜的操作
    public SimpleClient<T> CurrentDb { get { return new SimpleClient<T>(Db); } }//用來操作當前表的數據

   public SimpleClient<User> UserDb { get { return new SimpleClient<User>(Db); } }//用來處理User表的常用操作


   
}

這里的ConnectionString是數據庫連接字符串，我們可以寫在配置文件里面，sugar新建BaseDBConfig.cs

    public class BaseDBConfig
    {
        /// <summary>
        /// 數據庫連接字符串
        /// </summary>
        public static string ConnectionString { get; set; }

    }

修改DbContext的構造函數

        Db = new SqlSugarClient(new ConnectionConfig()
        {
            ConnectionString = BaseDBConfig.ConnectionString,
            DbType = DbType.SqlServer,
            InitKeyType = InitKeyType.Attribute,//從特性讀取主鍵和自增列信息
            IsAutoCloseConnection = true,//開啟自動釋放模式和EF原理一樣我就不多解釋了

        });

在 startup.cs 中的 ConfigureServices() 方法中添加

            //數據庫配置
            BaseDBConfig.ConnectionString = Configuration.GetSection("AppSettings:ConnectionString").Value;

設計倉儲基類接口——IBaseRepository.cs

IRepository 層中添加Base文件夾，並添加接口 IBaseRepository.cs。

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

namespace Webapi.Core.IRepository.Base
{
    /// <summary>
    /// 基類接口,其他接口繼承該接口
    /// </summary>
    /// <typeparam name="TEntity"></typeparam>
   public interface IBaseRepository<TEntity> where TEntity : class
    {
        /// <summary>
        /// 根據ID查詢
        /// </summary>
        /// <param name="objId"></param>
        /// <returns></returns>
        Task<TEntity> QueryByID(object objId);

        /// <summary>
        /// 添加
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        Task<bool> Add(TEntity model);

        /// <summary>
        /// 修改
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        Task<bool> Update(TEntity model);

        /// <summary>
        /// 刪除
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        Task<bool> DeleteByIds(object[] ids);

    }
}

繼承基接口

IRepository 層中，將其他的接口，繼承Base，新建IUserRepository.cs，然后將其他所有的方法都繼承該基類方法

   public interface IUserRepository : IBaseRepositoryy<User>
    {

    }

對倉儲基接口進行實現

Repository 層中，添加Base文件夾，並添加 BaseRepository.cs 基類

    public class BaseRepository<TEntity> : DbContext<TEntity>, IBaseRepository<TEntity> where TEntity : class, new()
    {
        /// <summary>
        /// 寫入實體數據
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        public async Task<bool> Add(TEntity model)
        {
            var i = await Task.Run(() => Db.Insertable(model).ExecuteReturnBigIdentity());
            //返回的i是long類型,這里你可以根據你的業務需要進行處理
            return i;
        }

        /// <summary>
        /// 根據ID刪除
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        public async Task<bool> DeleteByIds(object[] ids)
        {
            var i = await Task.Run(() => Db.Deleteable<TEntity>().In(ids).ExecuteCommand());
            return i > 0;
        }

        /// <summary>
        /// 根據ID查詢一條數據
        /// </summary>
        /// <param name="objId"></param>
        /// <returns></returns>
        public async Task<TEntity> QueryByID(object objId)
        {
            return await Task.Run(() => Db.Queryable<TEntity>().InSingle(objId));
        }

        /// <summary>
        /// 更新實體數據
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        public async Task<bool> Update(TEntity model)
        {
            //這種方式會以主鍵為條件
            var i = await Task.Run(() => Db.Updateable(model).ExecuteCommand());
            return i > 0;
        }

Repository層新建UserRepository，繼承BaseRepository和IUserRepository

    public class UserRepository : BaseRepository<User>, IUserRepository
    {

    }

業務邏輯層基類與基接口

IService 層中添加Base文件夾，並添加接口 IBaseService.cs。

public interface IBaseServices<TEntity> where TEntity : class
    {
        /// <summary>
        /// 根據ID列表刪除
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>
        Task<bool> DeleteByIds(object[] ids);

        /// <summary>
        /// 根據ID查詢
        /// </summary>
        /// <param name="objId"></param>
        /// <returns></returns>
        Task<TEntity> QueryByID(object objId);

        /// <summary>
        /// 添加實體
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        Task<bool> Add(TEntity model);

        /// <summary>
        /// 更新實體
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>

        Task<bool> Update(TEntity model);
    }

Service 層中添加Base文件夾，並添加接口 BaseService.cs。並添加 BaseService.cs 基類

    public class BaseServices<TEntity> : IBaseServices<TEntity> where TEntity : class, new()
    {
        public IBaseRepository<TEntity> baseDal = new BaseRepository<TEntity>();

        /// <summary>
        /// 寫入實體
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        public async Task<bool> Add(TEntity model)
        {
            return await baseDal.Add(model);
        }

        /// <summary>
        /// 根據ID刪除
        /// </summary>
        /// <param name="ids"></param>
        /// <returns></returns>

        public async Task<bool> DeleteByIds(object[] ids)
        {
            return await baseDal.DeleteByIds(ids);
        }

        /// <summary>
        /// 根據ID查詢
        /// </summary>
        /// <param name="objId"></param>
        /// <returns></returns>
        public async Task<TEntity> QueryByID(object objId)
        {
            return await baseDal.QueryByID(objId);
        }

        /// <summary>
        /// 更新實體
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        public async Task<bool> Update(TEntity model)
        {
            return await baseDal.Update(model);
        }
    }

IService 層新建IUserService，繼承BaseService

    public interface IUserService : IBaseService<User>
    {

    }

Service 層新建IUserService，繼承BaseService和IUserService

    public class UserService : BaseService<User>, IUserService
    {

    }

新增接口

User控制器新增接口:

 /// <summary>
        /// 根據id獲取數據
        /// </summary>
        /// <param name="id">參數id</param>
        /// <returns></returns>
        [HttpGet("{id}", Name = "Get")]
        public async Task<IActionResult> GetUser(int id)
        {
            IUserService userService = new UserService();
            User user = await userService.QueryByID(id);
            return Ok(user);
        }


        /// <summary>
        /// 添加數據
        /// </summary>
        /// <param name="id">參數id</param>
        /// <returns></returns>
        [HttpGet("{id}", Name = "Get")]
        public async Task<IActionResult> Add(User user)
        {
            IUserService userService = new UserService();
            var count = await userService.Add(user);
            return Ok(count);
        }

        /// <summary>
        /// 更新數據
        /// </summary>
        /// <param name="id">參數id</param>
        /// <returns></returns>
        [HttpGet("{id}", Name = "Get")]
        public async Task<IActionResult> Update(User user)
        {
            IUserService userService = new UserService();
            var sucess = await userService.Update(user);
            return Ok(sucess);
        }

        /// <summary>
        /// 刪除數據
        /// </summary>
        /// <param name="id">參數id</param>
        /// <returns></returns>
        [HttpGet("{id}", Name = "Get")]
        public async Task<IActionResult> Delete(object[] ids)
        {
            IUserService userService = new UserService();
            var sucess = await userService.DeleteByIds(ids);
            return Ok(sucess);
        }

調試接口

F5運行項目，測試添加接口：

 數據庫成功添加了數據，因為Id用的是自增，所以是1

 測試查詢接口：

 測試修改接口

如果修改不存在的ID，則刪除失敗

 測試刪除接口：

 數據已刪除

 本章Github

 https://github.com/huguodong/Webapi.Core/tree/sqlsugar/