一文了解.Net Core 3.1 Web API基礎知識

一、前言

　　隨著近幾年前後端分離、微服務等模式的興起，.Net Core也似有如火如荼之勢 ，自16年釋出第一個版本到19年底的3.1 LTS版本，以及將釋出的.NET 5，.NET Core一路更迭，在部署和開發工具上也都支援了跨平臺應用。一直對.Net Core有所關注，但未涉及太多實際應用，經過一番學習和了解後，於是分享出來。本文主要以.Net Core Web API為例，講述.Net Core的基本應用及注意事項，對於想通過WebAPI搭建介面應用的開發者，應該能提供一個系統的輪廓和認識，同時和更多的.Net Core開發者交流互動，探本勘誤，加強對知識的理解，並幫助更多的人。本文以貼近基本的實際操作為主，部分概念或基礎步驟不再贅述，文中如有疏漏，還望不吝斧正。

二、Swagger除錯Web API

開發環境：Visual Studio 2019

為解決前後端苦於介面文件與實際不一致、維護和更新文件的耗時費力等問題，swagger應運而生，同時也解決了介面測試問題。話不多說，直接說明應用步驟。

1. 新建一個ASP.NET Core Web API應用程式，版本選擇.ASP.NET Core 3.1；
2. 通過Nuget安裝包：Swashbuckle.AspNetCore，當前示例版本5.5.0；
3. 在Startup類的ConfigureServices方法內新增以下注入程式碼：
   

   services.AddSwaggerGen(c =>
               {
                   c.SwaggerDoc("v1", new OpenApiInfo
                   {
                       Title = "My API",
                       Version = "v1",
                       Description = "API文件描述",
                       Contact = new OpenApiContact
                       {
                           Email = "5007032@qq.com",
                           Name = "測試專案",
                           //Url = new Uri("http://t.abc.com/")
                       },
                       License = new OpenApiLicense
                       {
                           Name = "BROOKE許可證",
                           //Url = new Uri("http://t.abc.com/")
                       }
                   });              
   
               });

   Startup類的Configure方法新增如下程式碼：
   
   

   //配置Swagger
               app.UseSwagger();            
               app.UseSwaggerUI(c =>
               {
                   c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                   c.RoutePrefix = "api";// 如果設為空，訪問路徑就是根域名/index.html，設定為空，表示直接在根域名訪問；想換一個路徑，直接寫名字即可，比如直接寫c.RoutePrefix = "swagger"; 則訪問路徑為 根域名/swagger/index.html
   
               });

   Ctrl+F5進入瀏覽，按上述配置修改路徑為：http://localhost:***/api/index.html，即可看到Swagger頁面：
   
   

   然而到這裡還沒完，相關介面的註釋說明我們看不到，通過配置XML檔案的方式繼續調整程式碼如下，新增程式碼見加粗部分：
   

   services.AddSwaggerGen(c =>
               {
                   c.SwaggerDoc("v1", new OpenApiInfo
                   {
                       Title = "My API",
                       Version = "v1",
                       Description = "API文件描述",
                       Contact = new OpenApiContact
                       {
                           Email = "5007032@qq.com",
                           Name = "測試專案",
                           //Url = new Uri("http://t.abc.com/")
                       },
                       License = new OpenApiLicense
                       {
                           Name = "BROOKE許可證",
                           //Url = new Uri("http://t.abc.com/")
                       }
                   });
                
                   var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                   var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                   c.IncludeXmlComments(xmlPath);
               });

   上述程式碼通過反射生成與Web API專案相匹配的XML檔名，AppContext.BaseDirectory屬性用於構造 XML 檔案的路徑，關於OpenApiInfo內的配置引數用於文件的一些描述，在此不作過多說明。
   然後右鍵Web API專案、屬性、生成，配置XML文件的輸出路徑，以及取消不必要的XML註釋警告提醒（增加1591）：
   
   
   
   

   這樣，我們以三斜槓（///）方式給類方法屬性等相關程式碼新增註釋後，重新整理Swagger頁面，即可看到註釋說明。
   如果不想將XML檔案輸出為debug下的目錄，譬如想要放在專案根目錄（但不要修改成磁碟絕對路徑），可調整相關程式碼如下，xml檔案的名字也可以改成自己想要的：
   

   var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在目錄
   var xmlPath = Path.Combine(basePath, "CoreAPI_Demo.xml");
   c.IncludeXmlComments(xmlPath, true);

   同時，調整專案生成的XML文件檔案路徑為：..\CoreAPI_Demo\CoreAPI_Demo.xml

4. 隱藏相關介面
   對於不想暴漏給Swagger展示的介面，我們可以給相關Controller或Action頭加上：[ApiExplorerSettings(IgnoreApi = true)]
   
   
5. 調整系統預設輸出路徑
   專案啟動後，預設會訪問自帶的weatherforecast，如果想調整為其他路徑，譬如開啟後直接訪問Swagger文件，那麼調整Properties目錄下的launchSettings.json檔案，修改launchUrl值為api（前述配置的RoutePrefix值）：
   

   {
     "$schema": "http://json.schemastore.org/launchsettings.json",
     "iisSettings": {
       "windowsAuthentication": false,
       "anonymousAuthentication": true,
       "iisExpress": {
         "applicationUrl": "http://localhost:7864",
         "sslPort": 0
       }
     },
     "profiles": {
       "IIS Express": {
         "commandName": "IISExpress",
         "launchBrowser": true,
         "launchUrl": "api",
         "environmentVariables": {
           "ASPNETCORE_ENVIRONMENT": "Development"
         }
       },
       "CoreApi_Demo": {
         "commandName": "Project",
         "launchBrowser": true,
         "launchUrl": "api",
         "applicationUrl": "http://localhost:5000",
         "environmentVariables": {
           "ASPNETCORE_ENVIRONMENT": "Development"
         }
       }
     }
   }

    

三、配置檔案

以讀取appsettings.json檔案為例，當然你也定義其他名稱的.json檔案進行讀取，讀取方式一致，該檔案類似於Web.config檔案。為方便示例，定義appsettings.json檔案內容如下：

{
  "ConnString": "Data Source=(local);Initial Catalog=Demo;Persist Security Info=True;User ID=DemoUser;Password=123456;MultipleActiveResultSets=True;",
  "ConnectionStrings": {
    "MySQLConnection": "server=127.0.0.1;database=mydemo;uid=root;pwd=123456;charset=utf8;SslMode=None;"
  },
  "SystemConfig": {
    "UploadFile": "/Files",
    "Domain": "http://localhost:7864"
  },
  "JwtTokenConfig": {
    "Secret": "fcbfc8df1ee52ba127ab",
    "Issuer": "abc.com",
    "Audience": "Brooke.WebApi",
    "AccessExpiration": 30,
    "RefreshExpiration": 60
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

 

1、配置檔案的基本讀取

public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

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

            //讀取方式一
            var ConnString = Configuration["ConnString"];            
            var MySQLConnection = Configuration.GetSection("ConnectionStrings")["MySQLConnection"];
            var UploadPath = Configuration.GetSection("SystemConfig")["UploadPath"];
            var LogDefault = Configuration.GetSection("Logging").GetSection("LogLevel")["Default"];
            
            //讀取方式二
            var ConnString2 = Configuration["ConnString"];
            var MySQLConnection2 = Configuration["ConnectionStrings:MySQLConnection"];
            var UploadPath2 = Configuration["SystemConfig:UploadPath"];
            var LogDefault2 = Configuration["Logging:LogLevel:Default"];
            
        }    
        
    }

以上介紹了2種讀取配置資訊的方式，如果要在Controller內使用，類似地，進行注入並呼叫如下：

public class ValuesController : ControllerBase
    {
        private IConfiguration _configuration;

        public ValuesController(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        // GET: api/<ValuesController>
        [HttpGet]
        public IEnumerable<string> Get()
        {
            var ConnString = _configuration["ConnString"];
            var MySQLConnection = _configuration.GetSection("ConnectionStrings")["MySQLConnection"];
            var UploadPath = _configuration.GetSection("SystemConfig")["UploadPath"];
            var LogDefault = _configuration.GetSection("Logging").GetSection("LogLevel")["Default"];
            return new string[] { "value1", "value2" };
        }
    }

 

2、讀取配置檔案到自定義物件

以SystemConfig節點為例，定義類如下：

public class SystemConfig
    {
        public string UploadPath { get; set; }
        public string Domain { get; set; }       
  
    }

調整程式碼如下：

public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

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

            services.Configure<SystemConfig>(Configuration.GetSection("SystemConfig"));
        }    
        
    }

 然後Controller內進行注入呼叫：

[Route("api/[controller]/[action]")]
    [ApiController]
    public class ValuesController : ControllerBase
    {        
        private SystemConfig _sysConfig;
        public ValuesController(IOptions<SystemConfig> sysConfig)
        {           
            _sysConfig = sysConfig.Value;
        }        

        [HttpGet]
        public IEnumerable<string> GetSetting()
        {
            var UploadPath = _sysConfig.UploadPath;
            var Domain = _sysConfig.Domain;
            return new string[] { "value1", "value2" };
        }
    }

3、繫結到靜態類方式讀取

定義相關靜態類如下：

　　public static class MySettings
    {
        public static SystemConfig Setting { get; set; } = new SystemConfig();
    }    

調整Startup類建構函式如下：

public Startup(IConfiguration configuration, IWebHostEnvironment env)
        {            
            var builder = new ConfigurationBuilder()
              .SetBasePath(env.ContentRootPath)
              .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            Configuration = builder.Build();
            //Configuration = configuration;

            configuration.GetSection("SystemConfig").Bind(MySettings.Setting);//繫結靜態配置類           
        }       

接下來，諸如直接使用：MySettings.Setting.UploadPath 即可呼叫。

 

四、檔案上傳

介面一般少不了檔案上傳，相比.net framework框架下webapi通過byte陣列物件等複雜方式進行檔案上傳，.Net Core WebApi有了很大變化，其定義了新的IFormFile物件來接收上傳檔案，直接上Controller程式碼： 

後端程式碼

[Route("api/[controller]/[action]")]
    [ApiController]
    public class UploadController : ControllerBase
    {
        private readonly IWebHostEnvironment _env;

        public UploadController(IWebHostEnvironment env)
        {
            _env = env;
        }

        public ApiResult UploadFile(List<IFormFile> files)
        {
            ApiResult result = new ApiResult();

　　　　　　　//注：引數files物件去也可以通過換成： var files = Request.Form.Files;來獲取

            if (files.Count <= 0)
            {
                result.Message = "上傳檔案不能為空";
                return result;
            }

            #region 上傳          

            List<string> filenames = new List<string>();

            var webRootPath = _env.WebRootPath;
            var rootFolder = MySettings.Setting.UploadPath;           

            var physicalPath = $"{webRootPath}/{rootFolder}/";

            if (!Directory.Exists(physicalPath))
            {
                Directory.CreateDirectory(physicalPath);
            }

            foreach (var file in files)
            {
                var fileExtension = Path.GetExtension(file.FileName);//獲取檔案格式，擴充名               

                var saveName = $"{rootFolder}/{Path.GetRandomFileName()}{fileExtension}";
                filenames.Add(saveName);//相對路徑

                var fileName = webRootPath + saveName;

                using FileStream fs = System.IO.File.Create(fileName);
                file.CopyTo(fs);
                fs.Flush();

            }          
            #endregion


            result.IsSuccess = true;
            result.Data["files"] = filenames;

            return result;
        }
    }

前端呼叫

接下來通過前端呼叫上述上傳介面，在專案根目錄新建wwwroot目錄（.net core webapi內建目錄 ），新增相關js檔案包，然後新建一個index.html檔案，內容如下：

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <title></title>
    <style type="text/css">
        
    </style>
    <script src="res/scripts/jquery-1.10.2.min.js"></script>
    <script src="res/scripts/jquery.form.js"></script>
    <script type="text/javascript">
        //方法1
        function AjaxUploadfile() {
            var upload = $("#files").get(0);
            var files = upload.files;
            var data = new FormData();
            for (var i = 0; i < files.length; i++) {
                data.append("files", files[i]);
            }

            //此處data的構建也可以換成：var data = new FormData(document.getElementById("myform"));

            $.ajax({
                type: "POST",
                url: "/api/upload/uploadfile",
                contentType: false,
                processData: false,
                data: data,
                success: function (result) {
                    alert("success");
                    $.each(result.data.files, function (i, filename) {
                        $("#filePanel").append('<p>' + filename + '</p>');
                    });
                },
                error: function () {
                    alert("上傳檔案錯誤");
                }
            });
        }


        //方法2
        function AjaxUploadfile2() {
            $("#myform").ajaxSubmit({
                success: function (result) {
                    if (result.isSuccess) {
                        $.each(result.data.files, function (i, filename) {
                            $("#filePanel").append('<p>' + filename + '</p>');
                        });
                    }
                    else {
                        alert(result.message);
                    }
                }
            });
        }       
       
    </script>   
</head>
<body>
    <form id="myform" method="post" action="/api/upload/uploadfile" enctype="multipart/form-data">
        <input type="file" id="files" name="files" multiple /> <br /><br />
        <input type="button" value="FormData Upload" onclick="AjaxUploadfile();" /><br /><br />
        <input type="button" value="ajaxSubmit Upload" onclick="AjaxUploadfile2();" /><br /><br />      
        <div id="filePanel"></div>
    </form>

    <script type="text/javascript">

        $(function () {

        });

    </script>
</body>
</html>

上述通過構建FormData和ajaxSubmit兩種方式進行上傳，需要注意的是contentType和processData兩個引數的設定；另外允許一次上傳多個檔案，需設定multipart屬性。

在訪問wwwroot下的靜態檔案之前，必須先在Startup類的Configure方法下進行註冊：

public void Configure(IApplicationBuilder app)
{
    app.UseStaticFiles();//用於訪問wwwroot下的檔案    
} 

 啟動專案，通過訪問路徑：http://localhost:***/index.html，進行上傳測試，成功後，將在wwwroot下的Files目錄下看到上傳的檔案。

 

五、統一WebApi資料返回格式

定義統一返回格式

為了方便前後端使用約定好的資料格式，通常我們會定義統一的資料返回，其包括是否成功、返回狀態、具體資料等；為便於說明，定義一個資料返回類如下：

public class ApiResult
    {
        public bool IsSuccess { get; set; }
        public string Message { get; set; }
        public string Code { get; set; }
        public Dictionary<string, object> Data { get; set; } = new Dictionary<string, object>();
    }

 

這樣，我們將每一個action介面操作封裝為ApiResult格式進行返回。新建一個ProductController示例如下：

[Produces("application/json")]  
    [Route("api/[controller]")]
    [ApiController]
    public class ProductController : ControllerBase
    {
        [HttpGet]
        public ApiResult Get()
        {
            var result = new ApiResult();

            var rd = new Random();

            result.Data["dataList"] = Enumerable.Range(1, 5).Select(index => new 
            {
                Name = $"商品-{index}",
                Price = rd.Next(100, 9999)
            });           

            result.IsSuccess = true;
            return result;
        }
    }

 

• Produces：定義資料返回的方式，給每個Controller打上[Produces("application/json")]標識，即表示以json方式進行資料輸出。
• ApiController：確保每個Controller有ApiController標識，通常，我們會定義一個基類如：BaseController，其繼承自ControllerBase，並將其打上[ApiController]標識，新建的controller都繼承該類；
• Route：路由訪問方式，如不喜歡RESTful方式，可加上Action，即：[Route("api/[controller]/[action]")]；
• HTTP 請求：結合前面配置的Swagger，必須確保每個Action都有具體的請求方式，即必須是HttpGet、HttpPost、HttpPut、HttpDelete中的一種，通常情況下，我們使用HttpGet、HttpPost足以。

　　如此，即完成的資料返回的統一。

解決T時間格式

　　.Net Core Web Api預設以首字母小寫的類駝峰式命名返回，但遇到DateTime型別的資料，會返回T格式時間，如要解決T時間格式，定義一個時間格式轉換類如下：

public class DatetimeJsonConverter : JsonConverter<DateTime>
    {
        public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            if (reader.TokenType == JsonTokenType.String)
            {
                if (DateTime.TryParse(reader.GetString(), out DateTime date))
                    return date;
            }
            return reader.GetDateTime();
        }

        public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
        {
            writer.WriteStringValue(value.ToString("yyyy-MM-dd HH:mm:ss"));
        }
    }

然後在Startup類的ConfigureServices中調整services.AddControllers程式碼如下：

services.AddControllers()
                .AddJsonOptions(configure =>
                {
                    configure.JsonSerializerOptions.Converters.Add(new DatetimeJsonConverter());
                });

 

六、模型驗證

模型驗證在ASP.NET MVC已存在，使用方式基本一致。指對向介面提交過來的資料進行引數校驗，包括必填項、資料格式、字元長度、範圍等等。一般的，我們會將POST提交過來的物件定義為一個實體類進行接收，譬如定義一個註冊類如下：

    public class RegisterEntity
    {
        /// <summary>
        /// 手機號
        /// </summary>
        [Display(Name = "手機號")]
        [Required(ErrorMessage = "{0}不能為空")]
        [StringLength(11, ErrorMessage = "{0}最多{1}個字元")]
        public string Mobile { get; set; }

        /// <summary>
        /// 驗證碼
        /// </summary>
        [Display(Name = "驗證碼")]
        [Required(ErrorMessage = "{0}不能為空")]
        [StringLength(6, ErrorMessage = "{0}最多{1}個字元")]
        public string Code { get; set; }

        /// <summary>
        /// 密碼
        /// </summary>
        [Display(Name = "密碼")]
        [Required(ErrorMessage = "{0}不能為空")]
        [StringLength(16, ErrorMessage = "{0}最多{1}個字元")]
        public string Pwd { get; set; }
    }

 

　　Display標識提示欄位的名稱，Required表示必填，StringLength限制欄位的長度，當然還有其他一些內建特性，具體可參考官方文件，列舉一些常見的驗證特性如下：

• [CreditCard]：驗證屬性是否具有信用卡格式。 需要 JQuery 驗證其他方法。
• [Compare]：驗證模型中的兩個屬性是否匹配。
• [EmailAddress]：驗證屬性是否具有電子郵件格式。
• [Phone]：驗證屬性是否具有電話號碼格式。
• [Range]：驗證屬性值是否在指定的範圍內。
• [RegularExpression]：驗證屬性值是否與指定的正規表示式匹配。
• [Required]：驗證欄位是否不為 null。 有關此屬性的行為的詳細資訊，請參閱 [Required] 特性。
• [StringLength]：驗證字串屬性值是否不超過指定長度限制。
• [Url]：驗證屬性是否具有 URL 格式。
• [Remote]：通過在伺服器上呼叫操作方法來驗證客戶端上的輸入。

　　上述說明了基本的模型驗證使用方法，以這種方式，同時結合T4模板，通過表物件生成模型驗證實體，省卻了在action中編寫大量驗證程式碼的工作。當然，一些必要的較為複雜的驗證，或結合資料庫操作的驗證，則單獨寫到action或其他應用模組中。

　　那麼上述模型驗證在Web API中是怎麼工作的呢？在Startup類的ConfigureServices新增如下程式碼：

//模型引數驗證
    services.Configure<ApiBehaviorOptions>(options =>
    {
    options.InvalidModelStateResponseFactory = (context) =>
    {
        var error = context.ModelState.FirstOrDefault().Value;
        var message = error.Errors.FirstOrDefault(p => !string.IsNullOrWhiteSpace(p.ErrorMessage))?.ErrorMessage;                  

        return new JsonResult(new ApiResult { Message = message });                
    };
    });

 

　　新增註冊示例Action程式碼：

/// <summary>
        /// 註冊
        /// </summary>
        /// <param name="model"></param>
        /// <returns></returns>
        [HttpPost]
        public async Task<ApiResult> Register(RegisterEntity model)
        {
            ApiResult result = new ApiResult();

            var _code = CacheHelper.GetCache(model.Mobile);
            if (_code == null)
            {
                result.Message = "驗證碼過期或不存在";
                return result;
            }
            if (!model.Code.Equals(_code.ToString()))
            {
                result.Message = "驗證碼錯誤";
                return result;
            }

           /**
相關邏輯程式碼
**/
            return result;
        }

 

　　如此，通過配置ApiBehaviorOptions的方式，並讀取驗證錯誤資訊的第一條資訊並返回，即完成了Web API中Action對請求引數的驗證工作，關於錯誤資訊Message的返回，也可略作封裝，在此略。

 

七、日誌使用

雖然.Net Core WebApi有自帶的日誌管理功能，但不一定能較容易地滿足我們的需求，通常會採用第三方日誌框架，典型的如：NLog、Log4Net，簡單介紹NLog日誌元件的使用；

NLog的使用

① 通過NuGet安裝包：NLog.Web.AspNetCore，當前專案版本4.9.2；

② 專案根目錄新建一個NLog.config檔案，關鍵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" 
      autoReload="true" 
      throwExceptions="false" 
      internalLogLevel="Off" 
      internalLogFile="NlogRecords.log">
  <!--Nlog內部日誌記錄為Off關閉-->
  <extensions>
    <add assembly="NLog.Web.AspNetCore" />
  </extensions>
  <targets> 
    <target name="log_file" xsi:type="File" fileName="${basedir}/logs/${shortdate}.log" 
            layout="${longdate} | ${level:uppercase=false} | ${message} ${onexception:${exception:format=tostring} ${newline} ${stacktrace} ${newline}" />
  </targets>  
    
  <rules>
    <!--跳過所有級別的Microsoft元件的日誌記錄-->
    <logger name="Microsoft.*" final="true" />   
    <!--<logger name="logdb" writeTo="log_database" />-->
    <logger name="*" minlevel="Trace" writeTo="log_file" />  

  </rules>
</nlog>

<!--https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-3-->

 

③ 調整Program.cs檔案如下；

public class Program
    {
        public static void Main(string[] args)
        {
            //CreateHostBuilder(args).Build().Run();           
　　　　　　　
            var logger = NLog.Web.NLogBuilder.ConfigureNLog("nlog.config").GetCurrentClassLogger();
            try
            {
                logger.Debug("init main");
                CreateHostBuilder(args).Build().Run();
            }
            catch (Exception exception)
            {
                //NLog: catch setup errors
                logger.Error(exception, "Stopped program because of exception");
                throw;
            }
            finally
            {
                // Ensure to flush and stop internal timers/threads before application-exit (Avoid segmentation fault on Linux)
                NLog.LogManager.Shutdown();
            }
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                }).ConfigureLogging(logging => {
                    logging.ClearProviders();
                    logging.SetMinimumLevel(Microsoft.Extensions.Logging.LogLevel.Trace);
                }).UseNLog();//依賴注入Nlog;
    }

其中Main函式裡的捕獲異常程式碼配置省略也是可以的，CreateHostBuilder下的UseNLog為必設項。

Controller通過注入呼叫如下：

 

public class WeatherForecastController : ControllerBase
    {
        private static readonly string[] Summaries = new[]
        {
            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        };

        private readonly ILogger<WeatherForecastController> _logger;

        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        {
            _logger = logger;
        }

        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            _logger.LogInformation("測試一條日誌");

            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }

本地測試後，即可在debug下看到logs目錄下生成的日誌檔案。 

八、依賴注入

使用.Net Core少不了和依賴注入打交道，這也是.Net Core的設計思想之一，關於什麼是依賴注入（DI），以及為什麼要使用依賴注入，這裡不再贅述，先來看一個簡單示例的依賴注入。

public interface IProductRepository
{
    IEnumerable<Product> GetAll();
}

public class ProductRepository : IProductRepository
{
    public IEnumerable<Product> GetAll()
    {
        
    }
}

Startup類進行註冊：

public void ConfigureServices(IServiceCollection services)
{
    services.AddScoped<IProductRepository, ProductRepository>();    
}

請求 IProductRepository 服務並用於呼叫 GetAll 方法：

public class ProductController : ControllerBase
{
    private readonly IProductRepository _productRepository;

　　 public ProductController(IProductRepository productRepository)
    {
        _productRepository = productRepository;            
    }

    public IEnumerable<Product> Get()
    {
        return _productRepository.GetAll();
    }
}

通過使用DI模式，來實現IProductRepository 介面。其實前述已多次出現通過建構函式進行注入呼叫的示例。

生命週期　　

services.AddScoped<IMyDependency, MyDependency>();
services.AddTransient<IMyDependency, MyDependency>();
services.AddSingleton<IMyDependency, MyDependency>();

• Transient：每一次請求都會建立一個新例項；
• Scoped：每個作用域生成周期內建立一個例項；
• Singleton：單例模式，整個應用程式生命週期內只建立一個例項；

這裡，需要根據具體的業務邏輯場景需求選擇注入相應的生命週期服務。

實際應用中，我們會有很多個服務需要註冊到ConfigureServices內，一個個寫入顯然繁瑣，而且容易忘記漏寫，一般地，我們可能會想到利用反射進行批量注入，並通過擴充套件的方式進行注入，譬如：

public static class AppServiceExtensions
    {
        /// <summary>
        /// 註冊應用程式域中的服務
        /// </summary>
        /// <param name="services"></param>
        public static void AddAppServices(this IServiceCollection services)
        {
            var ts = System.Reflection.Assembly.Load("CoreAPI.Data").GetTypes().Where(s => s.Name.EndsWith("Repository") || s.Name.EndsWith("Service")).ToArray();
            foreach (var item in ts.Where(s => !s.IsInterface))
            {
                var interfaceType = item.GetInterfaces();
                foreach (var typeArray in interfaceType)
                {
                    services.AddTransient(typeArray, item);
                }
            }
        }
    }

public void ConfigureServices(IServiceCollection services)
{
    services.AddAppServices();//批量註冊服務    
}

 

誠然，這樣配合系統自帶DI注入是能完成我們的批量注入需求的。但其實也有更多選擇，來幫我們簡化DI註冊，譬如選擇其他第三方元件：Scrutor、Autofac…

1、Scrutor的使用

Scrutor是基於微軟注入元件的一個擴充套件庫，簡單示例如下：

services.Scan(scan => scan
    .FromAssemblyOf<Startup>()
        .AddClasses(classes => classes.Where(s => s.Name.EndsWith("Repository") || s.Name.EndsWith("Service")))
        .AsImplementedInterfaces()
        .WithTransientLifetime()
    );

以上程式碼通過Scan方式批量註冊了以Repository、Service結尾的介面服務，其生命週期為Transient，該方式等同於前述的以反射方式的批量註冊服務。

關於Scrutor的其他用法，大家可以參見官方文件，這裡只做下引子。

2、Autofac

一般情況下，使用MS自帶的DI或採用Scrutor，即可滿足實際需要，如果有更高的應用需求，如要求屬性注入、甚至接管或取代MS自帶的DI，那麼你可以選擇Autofac，關於Autofac的具體使用，在此不作詳敘。

 

九、快取

 MemoryCache使用

按官方說明，開發人員需合理說用快取，以及限制快取大小，Core執行時不會根據內容壓力限制快取大小。對於使用方式，依舊還是先行註冊，然後控制器呼叫：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMemoryCache();//快取中介軟體
}

public class ProductController : ControllerBase
    {
        private IMemoryCache _cache;

        public ProductController(IMemoryCache memoryCache)
        {
            _cache = memoryCache;
        }

        [HttpGet]
        public DateTime GetTime()
        {
            string key = "_timeKey";          

            // Look for cache key.
            if (!_cache.TryGetValue(key, out DateTime cacheEntry))
            {
                // Key not in cache, so get data.
                cacheEntry = DateTime.Now;

                // Set cache options.
                var cacheEntryOptions = new MemoryCacheEntryOptions()
                    // Keep in cache for this time, reset time if accessed.
                    .SetSlidingExpiration(TimeSpan.FromSeconds(3));

                // Save data in cache.
                _cache.Set(key, cacheEntry, cacheEntryOptions);
            }

            return cacheEntry;
        }
    }

上述程式碼快取了一個時間，並設定了滑動過期時間（指最後一次訪問後的過期時間）為3秒；如果需要設定絕對過期時間，將SetSlidingExpiration 改為SetAbsoluteExpiration即可。瀏覽重新整理，每3秒後時間將更新。

附一個封裝好的Cache類如下：

public class CacheHelper
    {
        public static IMemoryCache _memoryCache = new MemoryCache(new MemoryCacheOptions());

        /// <summary>
        /// 快取絕對過期時間
        /// </summary>
        ///<param name="key">Cache鍵</param>
        ///<param name="value">快取的值</param>
        ///<param name="minute">minute分鐘後絕對過期</param>
        public static void SetChache(string key, object value, int minute)
        {
            if (value == null) return;
            _memoryCache.Set(key, value, new MemoryCacheEntryOptions()
                    .SetAbsoluteExpiration(TimeSpan.FromMinutes(minute)));
        }

        /// <summary>
        /// 快取相對過期，最後一次訪問後minute分鐘後過期
        /// </summary>
        ///<param name="key">Cache鍵</param>
        ///<param name="value">快取的值</param>
        ///<param name="minute">滑動過期分鐘</param>
        public static void SetChacheSliding(string key, object value, int minute)
        {
            if (value == null) return;
            _memoryCache.Set(key, value, new MemoryCacheEntryOptions()
                    .SetSlidingExpiration(TimeSpan.FromMinutes(minute)));
        }

        /// <summary>
        ///設定快取，如果不主動清空，會一直儲存在記憶體中.
        /// </summary>
        ///<param name="key">Cache鍵值</param>
        ///<param name="value">給Cache[key]賦的值</param>
        public static void SetChache(string key, object value)
        {
            _memoryCache.Set(key, value);
        }

        /// <summary>
        ///清除快取
        /// </summary>
        ///<param name="key">cache鍵</param>
        public static void RemoveCache(string key)
        {
            _memoryCache.Remove(key);
        }

        /// <summary>
        ///根據key值，返回Cache[key]的值
        /// </summary>
        ///<param name="key"></param>
        public static object GetCache(string key)
        {
            //return _memoryCache.Get(key);
            if (key != null && _memoryCache.TryGetValue(key, out object val))
            {
                return val;
            }
            else
            {
                return default;
            }
        }

        /// <summary>
        /// 通過Key值返回泛型物件
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="key"></param>
        /// <returns></returns>
        public static T GetCache<T>(string key)
        {
            if (key != null && _memoryCache.TryGetValue<T>(key, out T val))
            {
                return val;
            }
            else
            {
                return default;
            }
        }

    }

 

十、異常處理

定義異常處理中介軟體

這裡主要針對全域性異常進行捕獲處理並記錄日誌，並以統一的json格式返回給介面呼叫者；說異常處理前先提下中介軟體，關於什麼是中介軟體，在此不在贅述，一箇中介軟體其基本的結構如下：

public class CustomMiddleware
{
    private readonly RequestDelegate _next;

    public CustomMiddleware(RequestDelegate next)
    {
        _next = next;
    }
    
    public async Task Invoke(HttpContext httpContext)
    {       
        await _next(httpContext);
    }
}

下面我們定義自己的全域性異常處理中介軟體，程式碼如下：

    public class CustomExceptionMiddleware
    {
        private readonly RequestDelegate _next;
        private readonly ILogger<CustomExceptionMiddleware> _logger;      

        public CustomExceptionMiddleware(RequestDelegate next, ILogger<CustomExceptionMiddleware> logger)
        {
            _next = next;
            _logger = logger;
        }

        public async Task Invoke(HttpContext httpContext)
        {
            try
            {
                await _next(httpContext);
            }
            catch (Exception ex)
            {
                _logger.LogError(ex,"Unhandled exception...");
                await HandleExceptionAsync(httpContext, ex);
            }         
        }

        private Task HandleExceptionAsync(HttpContext httpContext, Exception ex)
        {
            var result = JsonConvert.SerializeObject(new { isSuccess = false, message = ex.Message });
            httpContext.Response.ContentType = "application/json;charset=utf-8";
            return httpContext.Response.WriteAsync(result);
        }
    }

    /// <summary>
    /// 以擴充套件方式新增中介軟體
    /// </summary>
    public static class CustomExceptionMiddlewareExtensions
    {
        public static IApplicationBuilder UseCustomExceptionMiddleware(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<CustomExceptionMiddleware>();
        }
    }

然後在Startup類的Configure方法裡新增上述擴充套件的中介軟體，見加粗部分：

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

            //全域性異常處理
            app.UseCustomExceptionMiddleware();
        }

 在HandleExceptionAsync方法中，為方便開發和測試，這裡將系統的錯誤返回給了介面呼叫者，實際生產環境中可統一返回固定的錯誤Message訊息。

異常狀態碼的處理

關於http狀態碼，常見的如正常返回的200，其他401、403、404、502等等等等，因為系統有時候並不總是返回200成功，對於返回非200的異常狀態碼，WebApi也要做到相應的處理，以便介面呼叫者能正確接收，譬如緊接下來的JWT認證，當認證令牌過期或沒有許可權時，系統實際會返回401、403，但介面並不提供有效的可接收的返回，因此，這裡列舉一些常見的異常狀態碼，並以200方式提供給介面呼叫者，在Startup類的Configure方法裡新增程式碼如下：

app.UseStatusCodePages(async context =>
            {
                //context.HttpContext.Response.ContentType = "text/plain";  
                context.HttpContext.Response.ContentType = "application/json;charset=utf-8";

                int code = context.HttpContext.Response.StatusCode;
                string message =
                 code switch
                 {
                     401 => "未登入",
                     403 => "訪問拒絕",
                     404 => "未找到",
                     _ => "未知錯誤",
                 };

                context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;
                await context.HttpContext.Response.WriteAsync(Newtonsoft.Json.JsonConvert.SerializeObject(new
                {
                    isSuccess = false,
                    code,
                    message
                }));

            });

程式碼很簡單，這裡使用系統自帶的異常處理中介軟體UseStatusCodePages，當然，你還可以自定義過濾器處理異常，不過不推薦，簡單高效直接才是需要的。

關於.NET Core的異常處理中介軟體，還有其他諸如 UseExceptionHandler、UseStatusCodePagesWithRedirects等等，不同的中介軟體有其適用的環境，有的可能更適用於MVC或其他應用場景上，找到合適的即可。

題外話：大家也可以將UseStatusCodePages處理異常狀態碼的操作封裝到前述的全域性異常處理中介軟體中。

 

十一、應用安全與JWT認證

關於什麼是JWT，在此不作贅述。實際應用中，為了部分介面的安全性，譬如需要身份認證才能訪問的介面資源，對於Web API而言，一般會採用token令牌進行認證，服務端結合快取來實現。

那為什麼要選擇JWT認證呢？原因無外乎以下：服務端不進行儲存、無狀態、適合移動端、適合分散式、標準化等等。關於JWT的使用如下：

通過NuGget安裝包：Microsoft.AspNetCore.Authentication.JwtBearer，當前示例版本3.1.5；

ConfigureServices進行注入，預設以Bearer命名，這裡你也可以改成其他名字，保持前後一致即可，注意加粗部分，程式碼如下： 

appsettings.json新增JWT配置節點（見前述【配置檔案】），新增JWT相關認證類：

public static class JwtSetting
    {
        public static JwtConfig Setting { get; set; } = new JwtConfig();
    }

    public class JwtConfig
    {
        public string Secret { get; set; }
        public string Issuer { get; set; }
        public string Audience { get; set; }
        public int AccessExpiration { get; set; }
        public int RefreshExpiration { get; set; }
    }

採用前述繫結靜態類的方式讀取JWT配置，並進行注入：

public Startup(IConfiguration configuration, IWebHostEnvironment env)
        {
            //Configuration = configuration;

            var builder = new ConfigurationBuilder()
              .SetBasePath(env.ContentRootPath)
              .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);

            Configuration = builder.Build();            

            configuration.GetSection("SystemConfig").Bind(MySettings.Setting);//繫結靜態配置類
            configuration.GetSection("JwtTokenConfig").Bind(JwtSetting.Setting);//同上

        }

        public IConfiguration Configuration { get; }

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

            JwtSecurityTokenHandler.DefaultInboundClaimTypeMap.Clear();
            services.AddAuthentication("Bearer")
                .AddJwtBearer("Bearer", options =>
                {
                    options.RequireHttpsMetadata = false;

                    options.TokenValidationParameters = new TokenValidationParameters
                    {
                        ValidateIssuer = true,
                        ValidateAudience = true,
                        ValidateLifetime = true,
                        ValidateIssuerSigningKey = true,
                        ValidIssuer = JwtSetting.Setting.Issuer,
                        ValidAudience = JwtSetting.Setting.Audience,
                        IssuerSigningKey = new SymmetricSecurityKey(System.Text.Encoding.UTF8.GetBytes(JwtSetting.Setting.Secret))
                    };
                });

            #endregion
            
        }

給Swagger新增JWT認證支援，完成後，Swagger頁面會出現鎖的標識，獲取token後填入Value（Bearer token形式）項進行Authorize登入即可，Swagger配置JWT見加粗部分：

services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "My API",
                    Version = "v1",
                    Description = "API文件描述",
                    Contact = new OpenApiContact
                    {
                        Email = "5007032@qq.com",
                        Name = "測試專案",
                        //Url = new Uri("http://t.abc.com/")
                    },
                    License = new OpenApiLicense
                    {
                        Name = "BROOKE許可證",
                        //Url = new Uri("http://t.abc.com/")
                    }
                });


                // 為 Swagger JSON and UI設定xml文件註釋路徑
                //var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在目錄（不受工作目錄影響）
                //var xmlPath = Path.Combine(basePath, "CoreAPI_Demo.xml");
                //c.IncludeXmlComments(xmlPath, true);

                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);

                #region JWT認證Swagger授權

                c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
                {
                    Description = "JWT授權(資料將在請求頭header中進行傳輸) 直接在下框中輸入Bearer {token}（中間是空格）",
                    Name = "Authorization",
                    In = ParameterLocation.Header,
                    Type = SecuritySchemeType.ApiKey,
                    BearerFormat = "JWT",
                    Scheme = "Bearer"
                });

                c.AddSecurityRequirement(new OpenApiSecurityRequirement()
                {
                    {
                        new OpenApiSecurityScheme
                        {
                            Reference = new OpenApiReference {
                                Type = ReferenceType.SecurityScheme,
                                Id = "Bearer"
                            }
                        },
                        new string[] { }
                    }
                });

                #endregion

            });

Starup類新增Configure註冊，注意，需放到 app.UseAuthorization();前面：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseAuthentication();//jwt認證

            app.UseAuthorization();
        
        }

這樣，JWT就基本配置完畢，接下來實施認證登入和授權，模擬操作如下：

[HttpPost]
        public async Task<ApiResult> Login(LoginEntity model)      
        {           
            ApiResult result = new ApiResult();          

            //驗證使用者名稱和密碼
            var userInfo = await _memberService.CheckUserAndPwd(model.User, model.Pwd);
            if (userInfo == null)
            {
                result.Message = "使用者名稱或密碼不正確";
                return result;
            }
            var claims = new Claim[]
            {
                new Claim(ClaimTypes.Name,model.User),
                new Claim(ClaimTypes.Role,"User"),
                new Claim(JwtRegisteredClaimNames.Sub,userInfo.MemberID.ToString()),

            };

            var key = new SymmetricSecurityKey(System.Text.Encoding.UTF8.GetBytes(JwtSetting.Setting.Secret));
            var expires = DateTime.Now.AddDays(1);
            var token = new JwtSecurityToken(
                        issuer: JwtSetting.Setting.Issuer,
                        audience: JwtSetting.Setting.Audience,
                        claims: claims,
                        notBefore: DateTime.Now,
                        expires: expires,
                        signingCredentials: new SigningCredentials(key, SecurityAlgorithms.HmacSha256));

            //生成Token
            string jwtToken = new JwtSecurityTokenHandler().WriteToken(token);

            //更新最後登入時間
            await _memberService.UpdateLastLoginTime(userInfo.MemberID);

            result.IsSuccess= 1;            
            result.ResultData["token"] = jwtToken;
            result.Message = "授權成功！";
            return result;

        }

上述程式碼模擬登入操作（賬號密碼登入，成功後設定有效期一天），生成token並返回，前端呼叫者拿到token後以諸如localstorage方式進行儲存，調取授權介面時，新增該token到header（Bearer token）進行介面請求。接下來，給需要身份授權的Controller或Action打上Authorize標識：

[Authorize]
[Route("api/[controller]/[action]")]
public class UserController : ControllerBase
{
}

如果要新增基於角色的授權，可限制操作如下：

[Authorize(Roles = "user")]
[Route("api/[controller]/[action]")]
public class UserController : ControllerBase
{
}

//多個角色也可以逗號分隔
[Authorize(Roles = "Administrator,Finance")]
[Route("api/[controller]/[action]")]
public class UserController : ControllerBase
{
}

不同的角色資訊，可通過登入設定ClaimTypes.Role進行配置；當然，這裡只是簡單的示例說明角色服務的應用，複雜的可通過註冊策略服務，並結合資料庫進行動態配置。

這樣，一個簡單的基於JWT認證授權的工作就完成了。

 

十二、跨域

 前後端分離，會涉及到跨域問題，簡單的支援跨域操作如下：

新增擴充套件支援

public static class CrosExtensions
    {
        public static void ConfigureCors(this IServiceCollection services)
        {          

            services.AddCors(options => options.AddPolicy("CorsPolicy",
                builder =>
                {
                    builder.AllowAnyMethod()
                        .SetIsOriginAllowed(_ => true)
                        .AllowAnyHeader()
                        .AllowCredentials();
                }));

            //services.AddCors(options => options.AddPolicy("CorsPolicy",
            //builder =>
            //{
            //    builder.WithOrigins(new string[] { "http://localhost:13210" })
            //        .AllowAnyMethod()
            //        .AllowAnyHeader()
            //        .AllowCredentials();
            //}));


        }
    }

Startup類新增相關注冊如下：

public void ConfigureServices(IServiceCollection services)
{
    services.ConfigureCors();
}

 

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseCors("CorsPolicy");//跨域          
        }

這樣，一個簡單跨域操作就完成了，你也可以通過設定WithOrigins、WithMethods等方法限制請求地址來源和請求方式。

 

至此，全篇結束，本篇涉及到的原始碼地址：https://github.com/Brooke181/CoreAPI_Demo

下一篇介紹Dapper在.NET Core中的使用，謝謝支援！