FreeSql在ASP.NTE Core WebApi中如何使用的教程

時間 2019-11-17

標籤 freesql asp.nte asp nte core webapi 如何使用教程欄目 ASP 简体版

原文原文鏈接

文章概述

主要在介紹FreeSql在ASP.NTE Core WebApi中如何使用的過程，完成一個最簡單的博客系統的後端接口。mysql

FreeSql 簡介

國人寫的一個功能強大的ORM,FreeSql 支持 MySql/SqlServer/PostgreSQL/Oracle/Sqlite，特色：輕量級、可擴展、基於 .NET Standard 跨平臺。git

參考

FreeSql github github.com/2881099/Fre…github
關於.net core cli中如何使用dotnet newweb
使用 ASP.NET Core 建立 Web APIsql
Swagger/OpenAPI 生成接口文檔數據庫
Swagger GitHub (Swashbuckle.AspNetCore)c#
項目源碼 github.com/luoyunchong…後端
項目源碼稍微有所重構，命名空間會有變化，但總體類與結構無大的變化。api

項目準備

Mysql 5.6
Visual Studio 2019或201七、Visual Studio code
.NET Core 2.2+
PowerShell
懂點mvc，該教程不會教你如何使用 ASP .NET Core MVC、RESTful

建立一個webapi 的項目，起名爲RESTful.FreeSql瀏覽器

PS dotnetcore-examples\asp.net-core-freesql> dotnet new webapi -n RESTful.FreeSql
The template "ASP.NET Core Web API" was created successfully.
PS dotnetcore-examples\asp.net-core-freesql> cd .\RESTful.FreeSql\
PS dotnetcore-examples\asp.net-core-freesql\RESTful.FreeSql> dotnet run

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:5001
info: Microsoft.Hosting.Lifetime[0]
      Now listening on: http://localhost:5000
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: D:\code\github\dotnetcore-examples\asp.net-core-freesql\RESTful.FreeSql
複製代碼

打開瀏覽器 https://localhost:5001 會出現404

請打開這個地址 https://localhost:5001/api/values ，可看到以下內容。

["value1","value2"]
複製代碼

接下來咱們來集成FreeSql，咱們以最簡單的命令和說明，詳細內容去官網看具體內容

官網文檔 freesql.net/doc

Install

要先cd到RESTful.FreeSql目錄中。

PS \asp.net-core-freesql\RESTful.FreeSql> dotnet add package FreeSql
PS \asp.net-core-freesql\RESTful.FreeSql> dotnet add package FreeSql.Provider.MySql
複製代碼

code first

關於CodeFirst，官方文檔的介紹

代碼優先，使用過EntityFramework的應該很清楚這一律念，個人理解就是：在分析數據庫表關係時，不經過在數據庫中設計表，而是直接在代碼中聲明對應的類，使用導航屬性代替外鍵關聯，經過數據表字段與C#中的類庫對應，從而自動生成數據表。

db first

數據庫優先：需求分析後，直接設計數據庫，經過數據庫中的表，直接生成代碼，類。

開始

分析需求

咱們以code first 爲示例，學習如何使用freesql，實現一個簡單的博客。將表內容分爲博客表（Blog)和評論表（Post)

Blog 表

字段名	字段類型	說明
BlogId	int	博客id
Title	varchar(50)	博客標題
Content	varchar(500)	博客內容
CreateTime	DateTime	發佈時間

Post 表

字段名	字段類型	說明
PostId	int	評論id
ReplyContent	varchar(50)	標題
BlogId	int	博客id
ReplyTime	DateTime	回覆時間

建一個Domain文件夾,用於存放數據庫表中對應的實體類。

關於

1. Column屬性介紹，你們能夠看源碼，解析

1). 好比：Blog表中指定了Title爲varchar(50),咱們如何經過代碼指定了主鍵，惟一值，字形。

public class Blog
    {
        [Column(IsIdentity = true, IsPrimary = true)]
        public int BlogId { get; set; }
        [Column(DbType = "varchar(50)")]
        public string Title { get; set; }
    }
複製代碼

2). Column的命名空間在

using FreeSql.DataAnnotations;
複製代碼

更多屬性介紹

字段	備註
Name	數據庫列名
OldName	指定數據庫舊的列名，修改實體屬性命名時，同時設置此參數爲修改以前的值，CodeFirst才能夠正確修改數據庫字段；不然將視爲【新增字段】
DbType	數據庫類型，如： varchar(255)
IsPrimary	主鍵
IsIdentity	自增標識
IsNullable	是否可DBNull
IsIgnore	忽略此列，不遷移、不插入
IsVersion	設置行鎖（樂觀鎖）版本號，每次更新累加版本號，若更新整個實體時會附帶當前的版本號判斷（修改失敗時拋出異常）
DbDefautValue	數據庫默認值
MapType	類型映射，好比：可將 enum 屬性映射成 typeof(string)
Uniques	惟一鍵，在多個屬性指定相同的標識，表明聯合鍵；可以使用逗號分割多個 UniqueKey 名。

2. Table 的使用：用於在類的上面指定這個表的屬性

[Table(Name = "t_blog")]
public class Blog {
  //...
}
複製代碼

更多屬性介紹

字段	備註
Name	數據庫表名
OldName	指定數據庫舊的表名，修改實體命名時，同時設置此參數爲修改以前的值，CodeFirst才能夠正確修改數據庫表；不然將視爲【建立新表】
SelectFilter	查詢過濾SQL，實現相似 a.IsDeleted = 1 功能
DisableSyncStructure	禁用 CodeFirst 同步結構遷移

3. 其餘的仍是看 github.com/2881099/Fre…

Blog.cs

using FreeSql.DataAnnotations;
using System;

namespace RESTful.FreeSql.Domain
{
    public class Blog
    {
        [Column(IsIdentity = true, IsPrimary = true)]
        public int BlogId { get; set; }
        [Column(DbType = "varchar(50)")]
        public string Title { get; set; }
        [Column(DbType = "varchar(500)")]
        public string Content { get; set; }
        public DateTime CreateTime { get; set; }
    }
}
複製代碼

Post.cs

using FreeSql.DataAnnotations;
using System;

namespace RESTful.FreeSql.Domain
{
    public class Post
    {
        [Column(IsIdentity = true, IsPrimary = true)]
        public int PostId { get; set; }
        [Column(DbType = "varchar(50)")]
        public string ReplyContent { get; set; }
        public int BlogId { get; set; }
        public DateTime ReplyTime { get; set; }
        public Blog Blog { get; set; }
    }
}
複製代碼

Startup.cs

非所有代碼，這裏注意點：要先在mysql中建立數據庫FreeSql_Blog，不然一直提示主庫xxxxx,官網未找到相關描述。

這裏初始化FreeSql，並使用單例模式，注入到默認的依賴中，這樣在Controller中便可直接注入。

namespace RESTful.FreeSql
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Fsql = new FreeSqlBuilder()
                        .UseConnectionString(DataType.MySql, @"Data Source=127.0.0.1;Port=3306;User ID=root;Password=123456;Initial Catalog=FreeSql_Blog;Charset=utf8;SslMode=none;Max pool size=10")
                        .UseAutoSyncStructure(true)
                        .Build();
        }

        public IFreeSql Fsql { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSingleton<IFreeSql>(Fsql);

        }
    }
}
複製代碼

BlogController

在controllers文件夾新建一個控制器BlogController

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using FreeSql;
using Microsoft.AspNetCore.Mvc;
using RESTful.FreeSql.Domain;

namespace RESTful.FreeSql.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class BlogController : ControllerBase
    {
        // GET api/Blog

        IFreeSql _fsql;
        public BlogController(IFreeSql fsql)
        {
            _fsql = fsql;
        }

        [HttpGet]
        public ActionResult<IEnumerable<Blog>> Get()
        {
            List<Blog> blogs = _fsql.Select<Blog>().OrderByDescending(r => r.CreateTime).ToList();

            return blogs;
        }

        // GET api/blog/5
        [HttpGet("{id}")]
        public ActionResult<Blog> Get(int id)
        {
            return _fsql.Select<Blog>(id).ToOne();
        }


        // DELETE api/blog/5
        [HttpDelete("{id}")]
        public void Delete(int id)
        {
            _fsql.Delete<Blog>(new { BlogId = id }).ExecuteAffrows();
        }
    }
}
複製代碼

從新運行，打開地址 http://localhost:5001/api/blog 會發現數據庫中生成了表blog，這時候表post並無生成。因此咱們判斷，只有在訪問到實體類才檢查是否存在表結構，而後執行相應的處理。

手動向blog表中加一些數據，而後再次請求

http://localhost:5001/api/blog，可看到相應的數據。
http://localhost:5001/api/blog/1 可獲得單個數據。

自動同步實體結構【開發環境必備】

此功能默認爲開啓狀態，發佈正式環境後，請修改此設置

Fsql = new FreeSqlBuilder()
          .UseConnectionString(DataType.MySql, @"鏈接字符串")
          .UseAutoSyncStructure(true)
          .Build();
                      
//UseAutoSyncStructure(true/false)【開發環境必備】自動同步實體結構到數據庫，程序運行中檢查實體表是否存在，而後建立或修改

// 也可以使用此方法指定是否自動同步結構。                  
Fsql.CodeFirst.IsAutoSyncStructure = true;
複製代碼