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

前言

本文將介紹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

----------------------------------------------------------------------------------------------------

注：此文章爲原創，任何形式的轉載都請聯繫做者得到受權並註明出處！
若您以爲這篇文章還不錯，請點擊下方的【推薦】，很是感謝！

http://www.javashuo.com/article/p-wypuknjo-gs.html