ASP.NET Core 2.0 WebApi全局配置及日誌

最新在將原來寫的一些webSerivce轉換為WebApi，直接就用了ASP.Net Core 2.0的框架，在使用中，發現的與原有的asp.net不同的地方，通過搜索已經慢慢解決，記錄下來備用。

一、全局配置

在asp.net中，全局變更配置寫在web.config中，如下所示

 1 <?xml version="1.0"?>
 2 <configuration>
 3 <connectionStrings>
 4     <add name="conn" connectionString="Data Source=localhost;Initial Catalog=helloworld;Integrated Security=True"/>
 5   </connectionStrings>
 6   <appSettings>
 7     <add key="app_key" value="helloworld" />
 8     <add key="app_secret" value="1234567890abcdef" />
 9   </appSettings>
10 </configuration>

在ASP.Net Core 2.0 WebApi中，已經沒有了web.config文件，查了一些資料，可以把全局變數配置寫在appsetting.json文件中，如下所示：

{
  "connectionStrings": {
    "conn": "Data Source=localhost;Initial Catalog=helloworld;Integrated Security=True"
  }
  "appSettings": {
    "app_key": "helloworld",
    "app_secret": "1234567890abcdef"
  }
}

這樣一來，在程式中就可以對全局變數配置進行引用了。

使用appSetting.json，全局變數可以設置的更為複雜，具體的方法可以參考文後的參考文獻。

二、記錄日誌

以前ASP.NET的時候，日誌都是用Nlog進行記錄，現在轉換到了Core 2.0，也準備繼續使用Nlog，在使用中，發現和以前的有也所不同。

首先，在Nuget中獲取NLog.Web.AspNetCore包，

然後將startup.cs文件的代碼進行修改

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
//修改為
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)

併在Configure函數中，加上以下語句：

loggerFactory.AddNLog();
app.AddNLogWeb();
loggerFactory.ConfigureNLog(“nlog.config”);

記得要在文件頭先引用using NLog.Web和using NLog.Extensions.Logging;

增加一個"Web配置文件"，文件名為nlog.config，內容如下：

<?xml version="1.0" encoding="utf-8"?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <targets>
        <target xsi:type="File" name="logfile" fileName="${basedir}/logs/${shortdate}.log" keepFileOpen="false" layout="${longdate}|${callsite:fileName=True}|${uppercase:${level}}|${message} ${exception}" />
        <target xsi:type="File" name="debugfile" fileName="${basedir}/logs/${shortdate}_debug.log" keepFileOpen="false" layout="${longdate}|${callsite:fileName=True}|${uppercase:${level}}|${message} ${exception}" />
    <target xsi:type="File" name="errfile" fileName="${basedir}/logs/${shortdate}_error.log" keepFileOpen="false" layout="${longdate}|${callsite:fileName=True}|${uppercase:${level}}|${message} ${exception}" />
  </targets>
    <rules>
    <logger name="*" level="Debug" writeTo="debugfile" />
      <logger name="*" level="Error" writeTo="errfile" />
    <logger name="*" minlevel="Trace" writeTo="logfile" />
    </rules>
</nlog>

然後在程式中就可以開始調用日誌功能了。

二個功能的DEMO代碼如下：

using System;
using System.IO;
using Microsoft.Extensions.Configuration;
using NLog.Extensions.Logging;
using NLog.Web;

public class Program
{
    public static IConfigurationRoot Configuration { get; set; }
    public static NLog.Logger log = NLog.LogManager.GetCurrentClassLogger();
    public static void ConfigAndLog()
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(Directory.GetCurrentDirectory())
            .AddJsonFile("appsettings.json");

        Configuration = builder.Build();
        string app_key = Configuration["appSettings:app_key"];
        string coon = Configuration["connectionStrings:conn"];
        log.Debug("資料庫連接為：" + conn);
        return;
    }
}

參考文檔：

[1].Configure an ASP.NET Core App

[2].在 Asp.net core 2.0 的Web Api 添加logging