詳解Net Core Web Api項目與在NginX下發布

• 2020 年 2 月 26 日
• 筆記

前言

本文將介紹Net Core的一些基礎知識和如何NginX下發布Net Core的WebApi項目。

測試環境

作業系統：windows 10

開發工具：visual studio 2019

框架：Net Core 3

Net Core Web Api項目創建

首先創建一個Net Core Web Api項目——CorePublishForNginX。

首先選擇Asp.Net Core Web應用程式，如下圖：

然後修改項目名稱，如下圖：

然後選擇Api選項，如下圖：

項目創建完成，如下圖：

程式碼介紹

Controller

項目創建完成後，我們可以看到，裡面內置了一個Api Controller——WeatherForecastController，程式碼如下：

[ApiController]  [Route("[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()      {          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();      }  }

如上述程式碼所示，首先我們看到該Controller繼承的類是ControllerBase。（在NetFramework里繼承的WebApi繼承的是ApiController，Mvc繼承的是Controller）

然後，我們發現Controller有一個構造函數，並且還有一個入參；我們知道Controller的調用是框架的內部機制，也就是說，框架在調用Controller時會給他一個入參。

通過名稱我們可以發現，這個是一個日誌入參，即，Core調用Controller時，為我們內置了一個日誌記錄對象。

這裡我們不需要使用日誌，所以可以先把這個構造函數刪除。

接下來，我們看到了Api請求實現的主體，Get請求。

主體現的很簡單，就是方法名用Get，然後方法頭上加HttpGet特性。（Get方法名是可以修改的，因為一個WebApi里只支援一個Get請求，所以只要方法加了HttpGet特性，就會被視為默認的Get方法）

Get請求里實現了一個實體集合的組件，即請求該Controller會得到一個實體集合的數組。

Program

學習完Controller，我們進入Program.cs文件，我們做下簡單的修改，設置一下Kestrel的啟動埠。

修改CreateHostBuilder程式碼如下：

public static IHostBuilder CreateHostBuilder(string[] args)  {      return Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(           webBuilder =>           {               //設置項目的啟動文件               webBuilder.UseStartup<Startup>();               //Kestrel的默認監聽埠是http5000、https5001。               webBuilder.ConfigureKestrel(options =>               {                   options.ListenAnyIP(5180);//監聽本機任意ip的5180埠，相當於設置ip0.0.0.0                                             //options.Listen(new IPEndPoint(IPAddress.Parse("127.0.0.1"), 5180));//監聽指定ip的指定埠               }); ;           });  }

Startup

Startup的調用順序如下：

Startup構造函數——ConfigureServices配置服務函數——Configure請求配置

Startup構造函數：

這裡做了簡單配置資訊對象提取，實戰中，像啟動日誌這樣的操作也可以集中放在這裡。

ConfigureServices配置服務函數：

這裡只添加了一個控制器服務，實戰中，還可以添加更多服務，比如使用services.AddCors添加跨域服務。

Configure請求配置：

這裡做了一些請求配置，如：

app.UseDeveloperExceptionPage()——設置請求異常時的顯示內容為內置異常錯誤介面（在Mvc模式下，還可以指定請求異常時的顯示介面，如：app.UseExceptionHandler("/Home/Error");）

app.UseHttpsRedirection()——Https請求重定向，將Http請求轉換成Https，增加一些安全性。（還可以追加app.UseHsts()，要求瀏覽器只發送https，實現安全雙保險）

app.UseRouting()——配置endpointRouteBuilder。

app.UseEndpoints——使用endpointRouteBuilder。UseRouting與UseEndpoints組合實現路由。

app.UseAuthorization()——請求的授權處理，因為沒有沒有添加授權服務services.AddAuthorization，所以這裡它是無效的。

—————————————————————————————————-

到此，我們對Net Core Web Api項目已經有了初步的理解，現在我們調試一下，項目正常啟動並運行，如下圖：

可以看到，圖中的請求埠44317，並不是我們設置的5180，這因為，調試時使用的是快速IIS來啟動項目，等到發布後，就自然使用5180埠了。

依賴注入

這裡簡單介紹一下NetCore提供的依賴注入。

上文中提到的，框架調用Controller時，提供了一個入參—ILogger對象，這種行為就是依賴注入。

而這種為Controller提供的入參行為，在NetCore中是可以自定義增加；現在我們簡單的增加一個對象。

首先創建一個Kiba類和一個IKiba介面，如下：

public interface IKiba  {      string GetName();  }  public class Kiba: IKiba  {      public string GetName()      {          return "Kiba518";      }  }

然後在Startup的ConfigureServices里注入這個對象；程式碼如下：

public void ConfigureServices(IServiceCollection services)  {      services.AddControllers();      services.AddTransient<IKiba,Kiba>(); //依賴注入  }

然後在Controller的構造函數中，增加IKiba類型參數，程式碼如下：

public WeatherForecastController(IKiba _kiba)  {      string name = _kiba.GetName();  }

這樣，就完成了依賴注入，我們運行程式碼，在構造函數里打斷點，測試一下，是否可以獲取到值。

如上圖所示，我們得到了剛剛注入的依賴。

發布

Net Core Web Api創建完成了，現在我們進行項目發布。

右鍵項目，選擇發布，如下圖：

點擊後，彈出選取發布目標介面，如下圖：

在介面中選擇文件夾，然後在選擇文件夾文本框中輸入發布路徑。

然後點擊高級，彈出高級配置介面，如下圖：

修改配置中的部署模式為【獨立】，目標運行時為【win-x64】（因為我的測試機是X64的）。

然後點擊保存，頁面返回上一級，然後點擊創建配置文件。

然後系統進入發布介面，如下圖：

點擊發布按鈕進行發布，然後耐心等待。

如上圖，項目發布成功，現在進入發布的文件夾，會看到很多文件，我們在其中找到CorePublishForNginX.exe；然後雙擊運行，測試一下是否可以訪問。

 雙擊後運行結果如下圖所示：

WebApi項目啟動成功，現在我們訪問下http://127.0.0.1:5180/weatherforecast。

 如上圖所示，訪問成功。

PS：這裡需要注意，CMD窗口不能關閉，一旦關閉，網站會停止運行，因為CMD窗口是網站的宿主進程。

NginX下發布Net Core Web Api

現在我們使用NginX的反向代理，將客戶的請求發送到NetCoreWebApi項目中。

首先進入官網下載NginX，點擊nginx/windows-1.17.8，下載Windows版本的NginX，如下圖所示。官網地址：http://nginx.org/en/download.html

下載完成後，解壓縮到一個英文目錄下，內容如下圖所示。

conf文件夾為配置，我們雙擊進入conf文件夾，如下圖所示。

在文件夾內找到配置文件nginx.conf，用記事本將其打開，然後在這裡進行相應的配置。

上文中，我們的WebApi項目監聽的是5180埠，而NginX啟動後默認監聽的是80埠；也就是說，我們需要在NginX的配置文件中，將80埠監聽到的消息，轉發到5180埠上。

打開nginx.conf文件，修改內容如下圖所示：

修改完成後，返回上級目錄，運行NginX.exe；這裡需要注意，NginX是沒有前台介面的，所以，是否運行成功，要去任務管理中查看，看是否有NginX.exe的進程。

運行完NginX.exe，我們訪問下http://127.0.0.1/weatherforecast，看看是否將80埠的消息發送到了5180埠。

運行結果如上圖所示，消息成功的被發送到了5180埠。

PS：在nginx.conf 里，注釋符號為 #。

—————————————————————————————————-

到此詳解Net Core Web Api項目與在NginX下發布就講解完了。

程式碼已經傳到Github上了，歡迎大家下載。

Github地址：https://github.com/kiba518/CorePublishForNginX

—————————————————————————————————-