背景
在一些開發(fā)過程中，會在局域網(wǎng)內(nèi)搭建webapi服務(wù)作為移動端的服務(wù)接口使用，但是每次實施人員要到客戶現(xiàn)場安裝iis等工具，還有一些web的配置，非常繁瑣，所以想著把webapi封裝到WindowService中，可以通過自定義的安裝程序進(jìn)行一鍵部署，豈不美哉！
這篇文章主要是記錄如何將Kestrel的服務(wù)封裝在WindowService中
關(guān)于WindowsServer
請參考如下這篇文章
.netcore worker service (輔助角色服務(wù)） 的上手入門，包含linux和windows服務(wù)部署
開發(fā)服務(wù)
之前做過.net5版本的處理，覺得挺簡單的，但是到.net6的時候遇到了一些問題，所以下面都會記錄
.NET5版本
建項目
新建一個webapi項目，如下圖
添加Controller
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace WebApiNet_v5.Controllers
{
[Route("api/[controller]")]
[ApiController]
public class TestController : ControllerBase
{
[HttpGet]
public string Get(string name)
{
return $"Hello {name}";
}
}
}
添加引用
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net5.0-windows</TargetFramework>
</PropertyGroup>
<ItemGroup>
<!-- 千萬不要引用7.0版本，不兼容 -->
<PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="6.0.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" />
</ItemGroup>
</Project>
修改Startup.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.OpenApi.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace WebApiNet_v5
{
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApiNet_v5", Version = "v1" });
});
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
//這里注釋一下是為了在發(fā)布以后還可以查看Swagger
//if (env.IsDevelopment())
//{
app.UseDeveloperExceptionPage();
app.UseSwagger();
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApiNet_v5 v1"));
//}
app.UseHttpsRedirection();
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}
}
}
修改Program.cs
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
namespace WebApiNet_v5
{
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup<Startup>();
})
//添加服務(wù)
.UseWindowsService(cfg =>
{
cfg.ServiceName = "WebApiNet_v5";
})
;
}
}
配置Kestrel監(jiān)聽
參考文章
.Net Core 通過配置文件(appsetting.json)修改Kestrel啟動端口
實際配置效果
{
"Logging": {
"LogLevel": {
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.Hosting.Lifetime": "Information"
}
},
"Kestrel": {
"EndPoints": {
"Http": {
"Url": "http://0.0.0.0:5003" // 端口自己改吧
}
}
},
"AllowedHosts": "*"
}
發(fā)布程序
發(fā)布到本地目錄，如下圖
通過命令行創(chuàng)建服務(wù)
注意：一定要以管理員身份運行，否則無權(quán)限
例如出現(xiàn)如下錯誤：
[SC] OpenSCManager 失敗 5:
關(guān)于SC命令
啟動服務(wù)查看效果
sc.exe start 1_v5
測試效果
.NET6
因為.net6的改版，已經(jīng)沒有Startup文件了，而且程序的啟動已經(jīng)不再使用IHostBuilder接口了。
所以如下記錄的內(nèi)容都是在.net5版本上的差異與變動
代碼如下：
using Microsoft.Extensions.Hosting.WindowsServices;
using Microsoft.Extensions.Options;
using Microsoft.OpenApi.Models;
using System.Net;
namespace WebApiNet_v6
{
public class Program
{
public static void Main(string[] args)
{
//配置啟動參數(shù)
var options = new WebApplicationOptions
{
Args = args,
ContentRootPath = WindowsServiceHelpers.IsWindowsService()
? AppContext.BaseDirectory : default
};
var builder = WebApplication.CreateBuilder(options);
// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
//啟動服務(wù)
builder.Host.UseWindowsService();
var app = builder.Build();
// Configure the HTTP request pipeline.
//if (app.Environment.IsDevelopment())
//{
app.UseSwagger();
app.UseSwaggerUI();
//}
//app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();
}
}
}
代碼上的調(diào)整就這么多，但是在修改的過程中遇到了一些錯誤
錯誤1
出現(xiàn) URL scheme must be http or https for CORS request
解決辦法：
禁用https重定向，或者完全使用https都可以
禁用辦法就是注釋這行代碼
//app.UseHttpsRedirection();
錯誤2
安裝了服務(wù)怎么都無法開啟
解決辦法：因為沒有證書，所以不配置https的終結(jié)點就可以了。
運行效果如下圖
.NET7版本（和6版本一樣就可以）
源碼下載
https://download.csdn.net/download/iml6yu/87377783文章來源：http://www.zghlxwxcb.cn/news/detail-482595.html
在 Windows 服務(wù)中托管 ASP.NET Core文章來源地址http://www.zghlxwxcb.cn/news/detail-482595.html
到了這里，關(guān)于Kestrel封裝在WindowService中（.net5,.net6,.net7三個版本的介紹）的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
