手擼ORM淺談ORM框架之基礎篇

好奇害死貓

一直覺得ORM框架好用、功能強大集眾多優點於一身，當然ORM並非完美無缺，任何事物優缺點並存！我曾一度認為以為使用了ORM框架根本不需要關注Sql語句如何執行的，更不用關心優化的問題！！！ 隨著髮際線後移高亮意識到優秀程式設計師寫的優秀的ORM框架會做一些Sql優化，Sql優化不是一成不變的，ORM框架不會根據專案業務場景等主動優化Sql語句。如果ORM真的強大的到開發人員不需要關注Sql，會針對當前專案情況做出相對應很好的優化，必然會增加ORM框架的體積、帶來效能等相關問題。知己知彼，百戰不殆。一直想探索ORM原理，為什麼呼叫ORM Add或Insert方法都可以把實體寫入到資料庫？？？由於好奇之心我準備寫一個ORM系列隨筆，淺談對ORM的理解，作者水平有限歡迎園友糾正錯誤及不恰當之處。

千里之行始於足下

---

ORM物件關係對映（英語：Object Relational Mapping，簡稱ORM，或O/RM，或O/R mapping），是一種程式設計技術，用於實現物件導向程式語言裡不同型別系統的資料之間的轉換。

技術棧: .NET Core 3.1 + MySql + Autofac + Swagger

官方地址傳送:

微軟NET Core 3.1: 中文https://docs.microsoft.com/zh-cn/dotnet/ 　　英文https://docs.microsoft.com/en-us/dotnet/

MySql 8.x 文件: https://dev.mysql.com/doc/

Autofac文件: 中文https://autofaccn.readthedocs.io/zh/latest/ 　　英文https://autofaccn.readthedocs.io/en/latest/

Swagger文件: https://swagger.io/docs/

目前計劃

手擼ORM淺談ORM框架之基礎篇

手擼ORM淺談ORM框架之Add篇

手擼ORM淺談ORM框架之Update篇

手擼ORM淺談ORM框架之Delete篇

手擼ORM淺談ORM框架之Query篇

後續待定。。。。。。

MySql 8.x 坎(待解決)

---

 //Grant all privileges on learndb.* to 'learn_user@'@'%'

//> 1410 - You are not allowed to create a user with GRANT
//Sql = @"CREATE DATABASE IF NOT EXISTS learndb;"

因此，許可權需要先手動授予: 伺服器許可權-》Create

注:遇到的專案中一般都是資料庫優先或者使用的EntityFramework來建立資料庫，MySql8.x命令授權給使用者不太熟練。

 新風尚WebApi

.NET Framework使用靜態資源除了保護資料夾可以直接新增需要的靜態資原始檔夾即可；.NET Core使用靜態檔案需要在Startup-》Configure 方法中啟用靜態檔案UseStaticFiles並且資料夾的名稱:wwwroot，否則禁止訪問靜態資源。WebApi新增wwwroot資料夾存放靜態資源，.Net Core中需要手動新增swagger靜態樣式資源，下載地址 : swagger-ui ，您也可以使用專案中的wwwroot裡面的樣式。

Api神器Swagger

Startup-》ConfigureServices 方法中新增Swagger 文件doc、xml、security等資訊。新版本Swashbuckle.AspNetCore.Swagger有一些改動，例如SwaggerDoc-》OpenApiInfo的屬性TermsOfService由String修改為Uri，在對TermsOfService賦值時如果非Uri或String無法轉換正確的Uri專案Debug時會丟擲下面異常。

System.UriFormatException
HResult=0x80131537
Message=Invalid URI: The format of the URI could not be determined.

private const string ProjectName = "Learn.WebApi";

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    #region Swagger

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            Title = ProjectName,
            Version = "v1",
            Description = $"{ProjectName} HTTP API ",
            TermsOfService = new Uri("https://github.com/dingshuanglei"),
            Contact = new OpenApiContact { Name = "丁雙磊", Email = "shuangleiding@163.com", Url = new Uri("https://github.com/dingshuanglei") }
        });

        var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
        var xmlPath = Path.Combine(basePath, $"{ProjectName}.xml");
        c.IncludeXmlComments(xmlPath, true);
        var modelXmlPath = Path.Combine(basePath, "Learn.Model.xml");
        c.IncludeXmlComments(modelXmlPath, true);

        // Add security definitions
        c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme()
        {
            Description = "Please enter into field the word 'Bearer' followed by a space and the JWT value",
            Name = "token",
            In = ParameterLocation.Header,
            Type = SecuritySchemeType.ApiKey,
        });
        c.AddSecurityRequirement(new OpenApiSecurityRequirement
        {
            {
                new OpenApiSecurityScheme
                {
                    Reference = new OpenApiReference()
                    {
                        Id = "Bearer",
                        Type = ReferenceType.SecurityScheme
                    }
                }, Array.Empty<string>()
            }
        });
    });

    #endregion

    #region db init

    InitDbTable.InitTable();
    
    #endregion

    services.AddControllers();
}

Startup-》Configure 方法中啟用Swagger和靜態檔案UseStaticFiles。

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseRouting();

    #region Swagger
    app.UseSwagger();
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", $"v1");
        c.RoutePrefix = string.Empty;
    });
    #endregion

    app.UseAuthorization();

    //使用靜態檔案
    app.UseStaticFiles();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

Program-》CreateHostBuilder 方法中將預設ServiceProviderFactory指定為AutofacServiceProviderFactory。

public static IHostBuilder CreateHostBuilder(string[] args) =>
   Host.CreateDefaultBuilder(args)
       //將預設ServiceProviderFactory指定為AutofacServiceProviderFactory
       .UseServiceProviderFactory(new AutofacServiceProviderFactory())
       .ConfigureWebHostDefaults(webBuilder =>
       {
           webBuilder.UseStartup<Startup>();
       });

Autofac Ioc

Startup-》新增ConfigureContainer方法注入需要Ioc管理的類及類庫，當前專案中使用的注入沒有特殊的需求，普通的注入業務層和資料訪問層類庫，也可以根據您自身專案的需要指定注入的生命週期、單介面多實現等等。

/// <summary>
/// autofac ioc
/// </summary>
/// <param name="builder"></param>
public void ConfigureContainer(ContainerBuilder builder)
{
    //使用單例模式
    //builder.RegisterType<Test>().As<ITest>().SingleInstance().PropertiesAutowired();

    //單介面多實現
    //builder.RegisterType<TestOne>().Named<ITest>(nameof(TestOne));
    //builder.RegisterType<TestTwo>().Named<ITest>(nameof(TestTwo));

    Assembly[] assembliesService = new Assembly[] { Assembly.Load("Learn.Service") };
    builder.RegisterAssemblyTypes(assembliesService).Where(type => !type.IsAbstract && typeof(IocService).IsAssignableFrom(type)).AsImplementedInterfaces().PropertiesAutowired();

    Assembly[] assembliesRepository = new Assembly[] { Assembly.Load("Learn.Repository") };
    builder.RegisterAssemblyTypes(assembliesRepository).Where(type => !type.IsAbstract).AsImplementedInterfaces().PropertiesAutowired();
}

程式碼下載地址: SourceCode  作者水平有限歡迎園友糾正錯誤及不恰當之處，予以及時修正以免誤導他人！