前言
本文將介紹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 里,注釋符號為 #,location后面有個斜杠“/”,斜杠代表根目錄,想指向子目錄,只需在斜杠后加目錄名,如/admin,
----------------------------------------------------------------------------------------------------
到此詳解Net Core Web Api專案與在NginX下發布就講解完了,
代碼已經傳到Github上了,歡迎大家下載,
Github地址:https://github.com/kiba518/CorePublishForNginX
----------------------------------------------------------------------------------------------------
注:此文章為原創,任何形式的轉載都請聯系作者獲得授權并注明出處!
若您覺得這篇文章還不錯,請點擊下方的【推薦】,非常感謝!
https://www.cnblogs.com/kiba/p/12286225.html

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/61662.html
標籤:.NET Core
