(一)學習瞭解OrchardCore筆記——開篇：基於asp.net core的OrchardCore

shuisen發表於2020-07-09
筆記ASP.NET

　　想深入瞭解OrchadCore原始碼許久了，但是讀原始碼的時候遇到很多問題而網上的參考資料太少了(幾乎都是OrchadCms不帶OrchardCore的)，現在解決得差不多了，做下筆記方便自己檢視，有錯誤之處也請大家幫忙指出，謝謝。

　　OrchardCore是一個基於asp.net core的cms(廢話)，其結構類似於asp.net core(為啥說類似我也不知道，asp.net core的原始碼我只看了一部分，似是而非吧)。因此，我將直接從asp.net core的角度來解析OrchardCore，從asp.net core的角度就是說關於asp.net core的靠自己理解，可以省略1萬字。

　　廢話結束，開始正題，原始碼直接github搜尋OrchardCore就可以下載了，我直接用visual studio(我不用rider，首先我沒錢買，其次我之前是弄.net framework不是java，我用的vs都是社群版)自帶的git去clone半天(這小水管受不了後面直接碼雲找映象倉庫clone了)。

　　clone完了，第一個坑出現了，選擇記得選擇版本和分支，說多都是淚，OrchardCore支援的版本(從.net core 1.0到.net core 3.1都有)和自身的分支太多了，第一次接觸沒注意跳坑了導致各種出錯(原因是我沒有裝對應的.net core版本，預設好像2.x)，後面發現了就直接用.net core 3.1的dev分支。新手常見錯誤，大家儘管嘲笑，讓我漲漲記性，特麼有次我自己的程式碼都改錯分支！

　　正文開始，vs載入完OrchardCore解決方案出現很多專案，非常清晰，加粗的OrcharCore.Cms.Web專案就是啟動專案。

　　啟動專案的內容非常熟悉非常簡潔，就是一個asp.net core的專案。

　　當然你會發現多了個Localization資料夾和NLog.config配置檔案，除了這兩個之外跟我們正常新建asp.net core專案一模一樣，所有我們直接從asp.net core解讀開始剖析。

　　程式入口Program.cs檔案的main函式(為啥是這樣我也不知道，反正學c、學java還是c#的時候老師和書都是這樣教的，應該是定義或者約定俗成吧)開啟如下：

namespace OrchardCore.Cms.Web
{
    public class Program
    {
        public static Task Main(string[] args)
            => BuildHost(args).RunAsync();

        public static IHost BuildHost(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureLogging(logging => logging.ClearProviders())
                .ConfigureWebHostDefaults(webBuilder => webBuilder
                    .UseStartup<Startup>()
                    .UseNLogWeb())
                .Build()
            ;
    }
}

　　非常明顯的asp.net core程式碼，建立Host(主機)，然後Build(生成)，然後Run(執行)，跟新建asp.net core專案唯一區別就多了ConfigureLogging和ConfigureWebHostDefaults兩個配置了，意思也很清楚(不清楚得去看asp.net core的原始碼了，此處省略1萬個字)，就是清除預設日誌提供者然後用NLog代替(感覺就是個人愛好，你用log4net又咋樣)，這也是專案裡有NLog.config這個配置檔案的原因。要了解logging.ClearProviders()直接看asp.net core的api去。UseNLogWeb()是OrchardCord自定義的擴充套件方法，程式碼非常清楚就是載入NLog.config這個配置檔案，NLog我也是隻會簡單用，就不分析了，以後有空再去看原始碼

        public static IWebHostBuilder UseNLogWeb(this IWebHostBuilder builder)
        {
            LayoutRenderer.Register<TenantLayoutRenderer>(TenantLayoutRenderer.LayoutRendererName);
            builder.UseNLog();
            builder.ConfigureAppConfiguration((context, configuration) =>
            {
                var environment = context.HostingEnvironment;
                environment.ConfigureNLog($"{environment.ContentRootPath}{Path.DirectorySeparatorChar}NLog.config");
                LogManager.Configuration.Variables["configDir"] = environment.ContentRootPath;
            });

            return builder;
        }

　　我重點關注還是入口檔案的UseStartup<Startup>()，總所周知這個是asp.net core的核心中的核心，沒錯，就是服務和中介軟體，終於來到重點了，這個會呼叫專案裡Startup.cs的程式碼通過中介軟體生成管道，至於原理又是關於asp.net core的執行原理又可以省略1萬字。

　　接觸過asp.net core都知道通過Startup的ConfigureServices方法註冊服務，Configure方法配置管道中介軟體。

    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddOrchardCms();
        }

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

            app.UseStaticFiles();

            app.UseOrchardCore();
        }
    }

　　asp.net core表示服務配置可以沒有。服務部分我是直接跳過了，這裡是直接呼叫擴充套件方法services.AddOrchardCms()配置服務，其實服務按我理解就是依賴注入的註冊，依賴注入是asp.net core的基礎沒啥好說的，反正就是後面可以自動例項化建構函式的類，所以這個地方導致我後面又掉了一個坑(找錯例項的類)。

　　asp.net core的中介軟體配置一定要有，所以這部分是重中之重，前面的app.UseDeveloperExceptionPage()和app.UseStaticFiles()就不用說了，一般的asp.net core專案都有，就是異常和靜態檔案中介軟體。這個OrchardCore最重要的內容在於app.UseOrchardCore()這個擴充套件方法，這個擴充套件方法主要是後面兩個中介軟體，當然前面那個PoweredByMiddleware也很重要(作者說我辛辛苦苦弄一個cms你居然說我的版權不重要那我就慘了)，我這裡只是說程式的執行很重要並不是不尊重版權(我本身很尊重各個版權的，所以vs我只能用社群版、sqlserver只能用epress版)

    public static class ApplicationBuilderExtensions
    {
        /// <summary>
        /// Enables multi-tenant requests support for the current path.
        /// </summary>
        public static IApplicationBuilder UseOrchardCore(this IApplicationBuilder app, Action<IApplicationBuilder> configure = null)
        {
            var env = app.ApplicationServices.GetRequiredService<IHostEnvironment>();
            var appContext = app.ApplicationServices.GetRequiredService<IApplicationContext>();

            env.ContentRootFileProvider = new CompositeFileProvider(
                new ModuleEmbeddedFileProvider(appContext),
                env.ContentRootFileProvider);

            // Init also the web host 'ContentRootFileProvider'.
            app.ApplicationServices.GetRequiredService<IWebHostEnvironment>()
                .ContentRootFileProvider = env.ContentRootFileProvider;

            app.UseMiddleware<PoweredByMiddleware>();

            // Ensure the shell tenants are loaded when a request comes in
            // and replaces the current service provider for the tenant's one.
            app.UseMiddleware<ModularTenantContainerMiddleware>();

            configure?.Invoke(app);

            app.UseMiddleware<ModularTenantRouterMiddleware>(app.ServerFeatures);

            return app;
        }
    }

　　ModularTenantContainerMiddleware和ModularTenantRouterMiddleware這兩個中介軟體撐起OrchardCore一片天，下次就從UseOrchardCore繼續！從asp.net core角度去看真心簡化好多，但是後面估計要惡補下asp.net core了(原始碼的專案太多，這個感覺要看很久，而且目前github上面的asp.net core原始碼都是基於.net 5的，build都要好久)

相關文章