NetCoreWebApi项⽬与在NginX下发布的⽅法
前⾔
本⽂将介绍Net Core的⼀些基础知识和如何NginX下发布Net Core的WebApi项⽬。
测试环境
操作系统:windows 10
开发⼯具:visualstudio 2019
框架:Net Core 3
Net Core WebApi项⽬创建
⾸先创建⼀个Net Core WebApi项⽬——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的)。
然后点击保存,页⾯返回上⼀级,然后点击创建配置⽂件。
然后系统进⼊发布界⾯,如下图:
点击发布按钮进⾏发布,然后耐⼼等待。
如上图,项⽬发布成功,现在进⼊发布的⽂件夹,会看到很多⽂件,我们在其中到;然后双击运⾏,测试⼀下是否可以访问。
双击后运⾏结果如下图所⽰:
如上图所⽰,访问成功。
PS:这⾥需要注意,CMD窗⼝不能关闭,⼀旦关闭,⽹站会停⽌运⾏,因为CMD窗⼝是⽹站的宿主进程。
NginX下发布Net Core Web Api
现在我们使⽤NginX的反向代理,将客户的请求发送到NetCoreWebApi项⽬中。
下载完成后,解压缩到⼀个英⽂⽬录下,内容如下图所⽰。
conf⽂件夹为配置,我们双击进⼊conf⽂件夹,如下图所⽰。
在⽂件夹内到配置⽂件f,⽤记事本将其打开,然后在这⾥进⾏相应的配置。
上⽂中,我们的WebApi项⽬监听的是5180端⼝,⽽NginX启动后默认监听的是80端⼝;也就是说,我
们需要在NginX的配置⽂件中,将80端⼝监听到的消息,转发到5180端⼝上。打开f⽂件,修改内容如下图所⽰:
修改完成后,返回上级⽬录,运⾏;这⾥需要注意,NginX是没有前台界⾯的,所以,是否运⾏成功,要去任务管理中查看,看是否有的进程。
运⾏结果如上图所⽰,消息成功的被发送到了5180端⼝。
PS:在f⾥,注释符号为#。location后⾯有个斜杠“/”,斜杠代表根⽬录,想指向⼦⽬录,只需在斜杠后加⽬录名,如/admin。
----------------------------------------------------------------------------------------------------
到此详解Net Core Web Api项⽬与在NginX下发布就讲解完了。
代码已经传到Github上了,欢迎⼤家下载。
到此这篇关于Net Core Web Api项⽬与在NginX下发布的⽅法的⽂章就介绍到这了,更多相关Net Cor
error parse new
e Web Api NginX下发布内容请搜索以前的⽂章或继续浏览下⾯的相关⽂章希望⼤家以后多多⽀持!作者:kiba518

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。