【ASP.NET Core學習】基礎

<style>.cnblogs_code { width: auto; border-radius: 4px; box-shadow: 3px 2px 7px rgba(189, 183, 183, 1) } .ws-title { background-color: rgba(40, 120, 156, 1); font-size: 25px; font-family: "微軟雅黑"; padding: 8px 24px; border-radius: 4px; text-align: left; box-shadow: 1px 4px 5px 1px rgba(136, 136, 136, 1); color: rgba(255, 255, 255, 1); clear: both } .ws-content { margin-left: 20px; margin-top: 12px }</style> 新建專案時，程式入口呼叫CreateDefaultBuilder(args)，下面是源代碼

public static IHostBuilder CreateDefaultBuilder(string[] args)
{
    var builder = new HostBuilder();

    builder.UseContentRoot(Directory.GetCurrentDirectory());
    builder.ConfigureHostConfiguration(config =>
    {
        config.AddEnvironmentVariables(prefix: "DOTNET_");
        if (args != null)
        {
            config.AddCommandLine(args);
        }
    });

    builder.ConfigureAppConfiguration((hostingContext, config) =>
    {
        var env = hostingContext.HostingEnvironment;

        config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
                .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);

        if (env.IsDevelopment() && !string.IsNullOrEmpty(env.ApplicationName))
        {
            var appAssembly = Assembly.Load(new AssemblyName(env.ApplicationName));
            if (appAssembly != null)
            {
                config.AddUserSecrets(appAssembly, optional: true);
            }
        }

        config.AddEnvironmentVariables();

        if (args != null)
        {
            config.AddCommandLine(args);
        }
    })
    .ConfigureLogging((hostingContext, logging) =>
    {
        var isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);

        // IMPORTANT: This needs to be added *before* configuration is loaded, this lets
        // the defaults be overridden by the configuration.
        if (isWindows)
        {
            // Default the EventLogLoggerProvider to warning or above
            logging.AddFilter<EventLogLoggerProvider>(level => level >= LogLevel.Warning);
        }

        logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
        logging.AddConsole();
        logging.AddDebug();
        logging.AddEventSourceLogger();

        if (isWindows)
        {
            // Add the EventLogLoggerProvider on windows machines
            logging.AddEventLog();
        }
    })
    .UseDefaultServiceProvider((context, options) =>
    {
        var isDevelopment = context.HostingEnvironment.IsDevelopment();
        options.ValidateScopes = isDevelopment;
        options.ValidateOnBuild = isDevelopment;
    });

    return builder;
}

View Code

從上面代碼看見這個方法幫我們處理的東西

1. 設定根目錄為當前目錄
2. 配置應用程式配置
3. 配置日志配置
4. 配置依賴注入

組態檔

組態檔內容如下

{"Setting": {
    "Name": "Wilson",
    "Date": "2019-10-28"    
  }
}

 一、注入IConfiguration

public IndexModel(IConfiguration config)
{
　　var name = config.GetSection("Setting").GetValue<string>("Name");
　　var date = config.GetSection("Setting").GetValue<DateTime>("Date");
}

二、通過IOptions注入

1. 在ConfigureServices添加Options支持和組態檔節點

public void ConfigureServices(IServiceCollection services)
{
    services.AddOptions();
    services.Configure<Setting>(Configuration.GetSection("Setting"));
}

2. 建構式里面注入IOptions

public IndexModel(IOptions<Setting> option)
{
    var setting = option.Value;

    var name = setting.Name;
    var date = setting.Date;
}

三、系結到類

public IndexModel(IConfiguration config)
{
    var setting = new Setting();
    config.GetSection("Setting").Bind(setting);
}

或者

public IndexModel(IConfiguration config)
{
    var setting = config.GetSection("Setting").Get<Setting>();
}

四、頁面讀取組態檔

@using Microsoft.Extensions.Configuration
@inject IConfiguration Configuration

<div class="text-center">
    <h3 class="color-red">@Configuration["Setting:Name"]</h3>
</div>

 

我個人推薦使用第二種方式去讀取組態檔，因為它隱藏了如何讀取組態檔，只需要獲取我們關心的資訊即可，第一，第三種都在不同地方使用硬編碼的方式去讀取（當然可以設定為常量），而且還有知道節點資訊

開發程序通常不同環境是讀取不同配置，ASPNET Core提供了一個很方便的方法去實作

截取源代碼部分代碼

var env = hostingContext.HostingEnvironment;

config.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
      .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true);

 它會除了加載appsettings.json外，還好加載當前環境的json組態檔

 我們只要設定當前環境環境變數（專案設定或者當前電腦環境變數添加ASPNETCORE_ENVIRONMENT）就能加載不同組態檔

 

日志

截取源代碼部分代碼

var isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);

// IMPORTANT: This needs to be added *before* configuration is loaded, this lets
// the defaults be overridden by the configuration.
if (isWindows)
{
    // Default the EventLogLoggerProvider to warning or above
    logging.AddFilter<EventLogLoggerProvider>(level => level >= LogLevel.Warning);
}

logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
logging.AddConsole();
logging.AddDebug();
logging.AddEventSourceLogger();

if (isWindows)
{
    // Add the EventLogLoggerProvider on windows machines
    logging.AddEventLog();
}

除了配置基本資訊，Windows作業系統Waring以上的日志還會寫入到EventLog

現在我們寫幾個日志試試，因為配置了，所以我們直接注入logger寫日志

public IndexModel(Logger<IndexModel> logger)
{
    logger.LogDebug("This is Debug Message");
    logger.LogInformation("This is Information Message");
    logger.LogWarning("This is Warning Message");
    logger.LogError("This is Error Message");
}

看到控制臺輸出

 接著我們看看Evenlog有沒有寫入數

 

 我們看到警告基本以上的日志都寫入了

 

實際應用我們通常需要將日志寫入文本檔案，但ASPNET Core內置日志記錄提供程式并沒有提供文本檔案的程式，但是我們可以使用第三方日志組件（例如log4net)

1. Nuget添加log4net（Microsoft.Extensions.Logging.Log4Net.AspNetCore）

2. 呼叫日志記錄框架提供的 ILoggerFactory 擴展方法，

public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerFactory loggerFactory)
{
    loggerFactory.AddLog4Net();
    .....
}

 

 訪問一下，看看寫入日志

 

可以看到，除了中間那段是我們寫入的，其他都是系統的日志

在源代碼里面可以看到，系統是添加Logging節點的配置資訊，里面可以指定日志類別

"Logging": {
  "LogLevel": {
    "Default": "Debug",
    "System": "Warning",
    "Microsoft": "Warning"
  }
}

 指定System和Microsoft類別為Warning，只有高于這個級別才會輸出到日志

 可以設定莫一類別的日志級別

"Logging": {
  "LogLevel": {
    "Default": "Debug",
    "System": "Warning",
    "Microsoft": "Information",
    "Microsoft.AspNetCore.Mvc":"Warning"
  }
}

 只能設定大的級別再設定小級別才有效，即若只設定Microsoft.AspNetCore.Mvc，不設定Microsoft就不起效果

 

依賴注入

ASP.NET Core 支持依賴關系注入 (DI) 軟體設計模式，這是一種在類及其依賴關系之間實作控制反轉 (IoC) 的技術，

在CreateDefaultBuilder最后是一個擴展方法，使用默認的DefaultServiceProviderFactory

ASP.NET Core 提供三種注冊方法

方法	描述	適合場景
AddTransient	每次從服務容器進行請求時都是新建	輕量級、 無狀態的服務
AddScoped	每次請求/連接是同一個物件	Http請求需要保持同一個物件
AddSingleton	單例	單例物件

 

 

 

 

一、添加服務

public void ConfigureServices(IServiceCollection services)
{
　  ...
　
    services.AddSingleton<IServiceSingleton, ServiceSingleton>();
    services.AddScoped<IServiceScoped, ServiceScoped>();
    services.AddTransient<IServicesTransient, ServicesTransient>();
    services.AddTransient<IMyService, MyService>();
}

 

二、 獲取服務方式 1. 建構式獲取

public IndexModel(IServicesTransient servicesTransient)
{
}

 2. 通過IHttpContextAccessor獲取

　　2.1 注入IHttpContextAccessor

public void ConfigureServices(IServiceCollection services)
{
    services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
}

 　　2.2 通過RequestServices獲取

var service = accessor.HttpContext.RequestServices.GetService<IMyService>();
service.Run();

 

 

三、使用第三方容器

內置的容器實作最基本的注入方式，已經能滿足大部分專案需求，但是有時候可能需要特殊的需求，例如屬性注入、基于名稱的注入、自定義生存期管理等功能時，內置的容器不支持這些功能，下面介紹如何替換內置容器，以Autofac為例

1. nuget 添加Autofac.Extensions.DependencyInjection

2. Program替換容器

public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .UseServiceProviderFactory(new AutofacServiceProviderFactory())

 

3. Startup類添加方法ConfigureContainer 

public void ConfigureContainer(ContainerBuilder builder)
{
    builder.RegisterType<HttpContextAccessor>().As<IHttpContextAccessor>();

    builder.RegisterAssemblyTypes(System.Reflection.Assembly.GetExecutingAssembly())
            .Where(m => m.Name.Contains("Service"))
            .AsImplementedInterfaces()
            .InstancePerLifetimeScope();
}

這是ASPNET Core 3.0+版本替換Autofac方法，3.0不支持回傳IServiceProvider 

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/100095.html

標籤：.NET Core

上一篇：ASP.NET Core中使用MialKit實作郵件發送

下一篇：向net core 3.0進擊——多平臺專案發布與部署