前言

本文將介紹Net Core的一些基礎(chǔ)知識(shí)和如何NginX下發(fā)布Net Core的WebApi項(xiàng)目。

測(cè)試環(huán)境

• 操作系統(tǒng)：windows 10
• 開發(fā)工具：visualstudio 2019
• 框架：Net Core 3

Net Core WebApi項(xiàng)目創(chuàng)建

首先創(chuàng)建一個(gè)Net Core WebApi項(xiàng)目——CorePublishForNginX。

首先選擇Asp.Net Core Web應(yīng)用程序，如下圖：

然后修改項(xiàng)目名稱，如下圖：

然后選擇Api選項(xiàng)，如下圖：

項(xiàng)目創(chuàng)建完成，如下圖：

代碼介紹

Controller

項(xiàng)目創(chuàng)建完成后，我們可以看到，里面內(nèi)置了一個(gè)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）

然后，我們發(fā)現(xiàn)Controller有一個(gè)構(gòu)造函數(shù)，并且還有一個(gè)入?yún)?；我們知道Controller的調(diào)用是框架的內(nèi)部機(jī)制，也就是說，框架在調(diào)用Controller時(shí)會(huì)給他一個(gè)入?yún)ⅰ?/p>

通過名稱我們可以發(fā)現(xiàn)，這個(gè)是一個(gè)日志入?yún)?，即，Core調(diào)用Controller時(shí)，為我們內(nèi)置了一個(gè)日志記錄對(duì)象。

這里我們不需要使用日志，所以可以先把這個(gè)構(gòu)造函數(shù)刪除。

接下來，我們看到了Api請(qǐng)求實(shí)現(xiàn)的主體，Get請(qǐng)求。

主體現(xiàn)的很簡(jiǎn)單，就是方法名用Get，然后方法頭上加HttpGet特性。（Get方法名是可以修改的，因?yàn)橐粋€(gè)WebApi里只支持一個(gè)Get請(qǐng)求，所以只要方法加了HttpGet特性，就會(huì)被視為默認(rèn)的Get方法）

Get請(qǐng)求里實(shí)現(xiàn)了一個(gè)實(shí)體集合的組件，即請(qǐng)求該Controller會(huì)得到一個(gè)實(shí)體集合的數(shù)組。

Program

學(xué)習(xí)完Controller，我們進(jìn)入Program.cs文件，我們做下簡(jiǎn)單的修改，設(shè)置一下Kestrel的啟動(dòng)端口。

修改CreateHostBuilder代碼如下：

public static IHostBuilder CreateHostBuilder(string[] args)
{
  return Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(
     webBuilder =>
     {
       //設(shè)置項(xiàng)目的啟動(dòng)文件
       webBuilder.UseStartup<Startup>();
       //Kestrel的默認(rèn)監(jiān)聽端口是http5000、https5001。
       webBuilder.ConfigureKestrel(options =>
       {
         options.ListenAnyIP(5180);//監(jiān)聽本機(jī)任意ip的5180端口，相當(dāng)于設(shè)置ip0.0.0.0
                      //options.Listen(new IPEndPoint(IPAddress.Parse("127.0.0.1"), 5180));//監(jiān)聽指定ip的指定端口
       }); ;
     });
}

Startup

Startup的調(diào)用順序如下：

Startup構(gòu)造函數(shù)——ConfigureServices配置服務(wù)函數(shù)——Configure請(qǐng)求配置

Startup構(gòu)造函數(shù)：

這里做了簡(jiǎn)單配置信息對(duì)象提取，實(shí)戰(zhàn)中，像啟動(dòng)日志這樣的操作也可以集中放在這里。

ConfigureServices配置服務(wù)函數(shù)：

這里只添加了一個(gè)控制器服務(wù)，實(shí)戰(zhàn)中，還可以添加更多服務(wù)，比如使用services.AddCors添加跨域服務(wù)。

Configure請(qǐng)求配置：

這里做了一些請(qǐng)求配置，如：

app.UseDeveloperExceptionPage()——設(shè)置請(qǐng)求異常時(shí)的顯示內(nèi)容為內(nèi)置異常錯(cuò)誤界面（在Mvc模式下，還可以指定請(qǐng)求異常時(shí)的顯示界面，如：app.UseExceptionHandler("/Home/Error");）

app.UseHttpsRedirection()——Https請(qǐng)求重定向，將Http請(qǐng)求轉(zhuǎn)換成Https，增加一些安全性。（還可以追加app.UseHsts()，要求瀏覽器只發(fā)送https，實(shí)現(xiàn)安全雙保險(xiǎn)）

app.UseRouting()——配置endpointRouteBuilder。

app.UseEndpoints——使用endpointRouteBuilder。UseRouting與UseEndpoints組合實(shí)現(xiàn)路由。

app.UseAuthorization()——請(qǐng)求的授權(quán)處理，因?yàn)闆]有沒有添加授權(quán)服務(wù)services.AddAuthorization，所以這里它是無效的。

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

到此，我們對(duì)Net Core Web Api項(xiàng)目已經(jīng)有了初步的理解，現(xiàn)在我們調(diào)試一下，項(xiàng)目正常啟動(dòng)并運(yùn)行，如下圖：

可以看到，圖中的請(qǐng)求端口44317，并不是我們?cè)O(shè)置的5180，這因?yàn)?，調(diào)試時(shí)使用的是快速IIS來啟動(dòng)項(xiàng)目，等到發(fā)布后，就自然使用5180端口了。

依賴注入

這里簡(jiǎn)單介紹一下NetCore提供的依賴注入。

上文中提到的，框架調(diào)用Controller時(shí)，提供了一個(gè)入?yún)ⅰ狪Logger對(duì)象，這種行為就是依賴注入。

而這種為Controller提供的入?yún)⑿袨?，在NetCore中是可以自定義增加；現(xiàn)在我們簡(jiǎn)單的增加一個(gè)對(duì)象。

首先創(chuàng)建一個(gè)Kiba類和一個(gè)IKiba接口，如下：

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

然后在Startup的ConfigureServices里注入這個(gè)對(duì)象；代碼如下：

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

然后在Controller的構(gòu)造函數(shù)中，增加IKiba類型參數(shù)，代碼如下：

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

這樣，就完成了依賴注入，我們運(yùn)行代碼，在構(gòu)造函數(shù)里打斷點(diǎn)，測(cè)試一下，是否可以獲取到值。

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

發(fā)布

Net Core Web Api創(chuàng)建完成了，現(xiàn)在我們進(jìn)行項(xiàng)目發(fā)布。

右鍵項(xiàng)目，選擇發(fā)布，如下圖：

點(diǎn)擊后，彈出選取發(fā)布目標(biāo)界面，如下圖：

在界面中選擇文件夾，然后在選擇文件夾文本框中輸入發(fā)布路徑。

然后點(diǎn)擊高級(jí)，彈出高級(jí)配置界面，如下圖：

修改配置中的部署模式為【獨(dú)立】，目標(biāo)運(yùn)行時(shí)為【win-x64】（因?yàn)槲业臏y(cè)試機(jī)是X64的）。

然后點(diǎn)擊保存，頁面返回上一級(jí)，然后點(diǎn)擊創(chuàng)建配置文件。

然后系統(tǒng)進(jìn)入發(fā)布界面，如下圖：

點(diǎn)擊發(fā)布按鈕進(jìn)行發(fā)布，然后耐心等待。

如上圖，項(xiàng)目發(fā)布成功，現(xiàn)在進(jìn)入發(fā)布的文件夾，會(huì)看到很多文件，我們?cè)谄渲姓业紺orePublishForNginX.exe；然后雙擊運(yùn)行，測(cè)試一下是否可以訪問。

雙擊后運(yùn)行結(jié)果如下圖所示：

WebApi項(xiàng)目啟動(dòng)成功，現(xiàn)在我們?cè)L問下http://127.0.0.1:5180/weatherforecast。

如上圖所示，訪問成功。

PS：這里需要注意，CMD窗口不能關(guān)閉，一旦關(guān)閉，網(wǎng)站會(huì)停止運(yùn)行，因?yàn)镃MD窗口是網(wǎng)站的宿主進(jìn)程。

NginX下發(fā)布Net Core Web Api

現(xiàn)在我們使用NginX的反向代理，將客戶的請(qǐng)求發(fā)送到NetCoreWebApi項(xiàng)目中。

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

下載完成后，解壓縮到一個(gè)英文目錄下，內(nèi)容如下圖所示。

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

在文件夾內(nèi)找到配置文件nginx.conf，用記事本將其打開，然后在這里進(jìn)行相應(yīng)的配置。

上文中，我們的WebApi項(xiàng)目監(jiān)聽的是5180端口，而NginX啟動(dòng)后默認(rèn)監(jiān)聽的是80端口；也就是說，我們需要在NginX的配置文件中，將80端口監(jiān)聽到的消息，轉(zhuǎn)發(fā)到5180端口上。

打開nginx.conf文件，修改內(nèi)容如下圖所示：

修改完成后，返回上級(jí)目錄，運(yùn)行NginX.exe；這里需要注意，NginX是沒有前臺(tái)界面的，所以，是否運(yùn)行成功，要去任務(wù)管理中查看，看是否有NginX.exe的進(jìn)程。

運(yùn)行完NginX.exe，我們?cè)L問下http://127.0.0.1/weatherforecast，看看是否將80端口的消息發(fā)送到了5180端口。

運(yùn)行結(jié)果如上圖所示，消息成功的被發(fā)送到了5180端口。

PS：在nginx.conf里，注釋符號(hào)為#。location后面有個(gè)斜杠“/”，斜杠代表根目錄，想指向子目錄，只需在斜杠后加目錄名，如/admin。

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

到此詳解Net Core Web Api項(xiàng)目與在NginX下發(fā)布就講解完了。

代碼已經(jīng)傳到Github上了，歡迎大家下載。

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

到此這篇關(guān)于Net Core Web Api項(xiàng)目與在NginX下發(fā)布的方法的文章就介紹到這了,更多相關(guān)Net Core Web Api NginX下發(fā)布內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

作者：kiba518

https://www.cnblogs.com/kiba/p/12286225.html

最新評(píng)論