.Net Core 2.2升级3.1的避坑指南(小结)

更新时间：2020年07月13日 11:00:12 作者：山治先生

这篇文章主要介绍了.Net Core 2.2升级3.1的避坑指南，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

写在前面

　　微软在更新.Net Core版本的时候，动作往往很大，使得每次更新版本的时候都得小心翼翼，坑实在是太多。往往是悄咪咪的移除了某项功能或者组件，或者不在支持XX方法，这就很花时间去找回需要的东西了，下面是个人在迁移.Net Core WebApi项目过程中遇到的问题汇总：

开始迁移

1. 修改*.csproj项目文件

<TargetFramework>netcoreapp2.2</TargetFramework>
修改为
<TargetFramework>netcoreapp3.1</TargetFramework>

2 修改Program

public static void Main(string[] args)
    {
      CreateWebHostBuilder(args).Build().Run();
    }

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
          .UseStartup<Startup>().ConfigureAppConfiguration((hostingContext, config) =>
          {
            config.AddJsonFile($"你的json文件.json", optional: true, reloadOnChange: true);
          }
          );

修改为

public static void Main(string[] args)
    {
      CreateHostBuilder(args).Build().Run();
    }
 
    public static IHostBuilder CreateHostBuilder(string[] args) =>
      Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
          webBuilder.UseStartup<Startup>()
                .ConfigureAppConfiguration((hostingContext, config)=>
                {
                  config.AddJsonFile($"你的json文件.json", optional: true, reloadOnChange: true);
                });
        });

3.1 修改Startup.ConfigureServices

services.AddMvc();
修改为
services.AddControllers();

3.2 修改Startup.Configure

public void Configure(IApplicationBuilder app, IHostingEnvironment env)

修改为
using Microsoft.Extensions.Hosting;
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

IHostingEnvironment在3.0之后已被标记弃用。

路由配置：

app.UseMvc(routes =>
        {
          routes.MapRoute(
            name: "areas",
            template: "{area:exists}/{controller=Home}/{action=Index}/{id?}"
          );

          routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}"
          );
        });

修改为

      app.UseRouting();
      app.UseEndpoints(endpoints =>
      {
        endpoints.MapControllers();
        endpoints.MapControllerRoute(
            name: "areas",
            pattern: "{area:exists}/{controller=Home}/{action=Index}/{id?}");
        endpoints.MapControllerRoute(
            name: "default",
            pattern: "{controller=Home}/{action=Index}/{id?}");
      });

你以为结束了？还没。

坑

　　这时候你以为结束了，兴高采烈的去服务器装好runningTime和hosting相应的版本，运行……

HTTP Error 500.30 – ANCM In-Process Start Failure

直接cmd，进入到发布目录，执行：

E:\你的路径>dotnet xxx.dll

显示详细错误

而我的相应250代码行是：

services.AddAutoMapper(AppDomain.CurrentDomain.GetAssemblies());

搜索最新的AutoMapper根本没更新或改变，所以不是这个组件的问题。

尝试下载补丁Windows6.1-KB974405-x64.msu，无果……

卸载sdk重置，无果……

修改web.config，无果……

修改应用池32位，无果……

最后，查看发布：勾选上【删除现有文件】，解决……

Endpoint contains CORS metadata, but a middleware was not found that supports CORS.

　　顺利可以启动项目之后，发现有些接口：

2020-06-29 10:02:23,357 [14] ERROR System.String - 全局异常捕捉：异常：Endpoint contains CORS metadata, but a middleware was not found that supports CORS.
Configure your application startup by adding app.UseCors() inside the call to Configure(..) in the application startup code. The call to app.UseAuthorization() must appear between app.UseRouting() and app.UseEndpoints(...).

提示很明显，在.net core 2.2 的时候

app.UseCors();

不是需要强制在指定位置的，在3.0之后需要设置在app.UseRouting和app.UseEndpoints 之间

app.UseRouting();//跨域
app.UseCors(one);
app.UseCors(two);
……
app.UseEndpoints(endpoints => ……

The JSON value could not be converted to System.Int32. Path……

　　运行之后，有些接口没有数据返回，而有些直接报错了。原因又是爸爸把Newtonsoft.Json移除，使用内置的System.Text.Json，所以依赖于Newtonsoft.Json的组件将不可用，那么，只能手动添加。

Install-Package Microsoft.AspNetCore.Mvc.NewtonsoftJson -Version 3.1.5

然后添加引用

public void ConfigureServices(IServiceCollection services)
{
  services.AddControllers().AddNewtonsoftJson();
}

目前还不太建议你使用内置的序列化，因为实在太多功能或方法不支持，详细对比请参考https://docs.microsoft.com/zh-cn/dotnet/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to

授权相关

　　基于策略授权，我想在座的加班狗都是大同小异，在2.2以前：

public class PolicyHandler : AuthorizationHandler<PolicyRequirement>
  {
    /// <summary>
    /// 授权方式（cookie, bearer, oauth, openid）
    /// </summary>
    public IAuthenticationSchemeProvider Schemes { get; set; }

    private IConfiguration _configuration;

    /// <summary>
    /// ctor
    /// </summary>
    /// <param name="configuration"></param>
    /// <param name="schemes"></param>
    /// <param name="jwtApp"></param>
    public PolicyHandler(IConfiguration configuration, IAuthenticationSchemeProvider schemes)
    {
      Schemes = schemes;
      _jwtApp = jwtApp;
      _configuration = configuration;
    }

    /// <summary>
    /// 授权处理
    /// </summary>
    /// <param name="context"></param>
    /// <param name="requirement"></param>
    protected override async Task HandleRequirementAsync(AuthorizationHandlerContext context, PolicyRequirement requirement)
    {
      var httpContext = (context.Resource as AuthorizationFilterContext).HttpContext;

      //获取授权方式
      var defaultAuthenticate = await Schemes.GetDefaultAuthenticateSchemeAsync();
      if (defaultAuthenticate != null)
      {
        //验证签发的用户信息
        var result = await httpContext.AuthenticateAsync(defaultAuthenticate.Name);
        if (result.Succeeded)
        {
          httpContext.User = result.Principal;
         
          //判断是否过期
          var expirationTime = DateTime.Parse(httpContext.User.Claims.SingleOrDefault(s => s.Type == ClaimTypes.Expiration).Value);
          if (expirationTime >= DateTime.UtcNow)
          {
             //你的校验方式
             //todo
            context.Succeed(requirement);
          }
          else
          {
            HandleBlocked(context, requirement);
          }
          return;
        }
      }
      HandleBlocked(context, requirement);
    }
     
    /// <summary>
    /// 验证失败返回
    /// </summary>
    private void HandleBlocked(AuthorizationHandlerContext context, PolicyRequirement requirement)
    {
      var authorizationFilterContext = context.Resource as AuthorizationFilterContext;
      authorizationFilterContext.Result = new Microsoft.AspNetCore.Mvc.JsonResult(new UnAuthorizativeResponse()) { StatusCode = 202 };
      //不要调用 context.Fail(),设置为403会显示不了自定义信息,改为Accepted202,由客户端处理,;
      context.Succeed(requirement);
    }
  }

然后发现升级到3.0之后，

var httpContext = (context.Resource as AuthorizationFilterContext).HttpContext;

3.0不再支持返回AuthorizationFilterContext，而是返回的是RouteEndpoint，这句代码就会报错，所以修改的方式就是注入IHttpContextAccessor，从里面获取HttpContext，这里就不用演示了吧。

并修改PolicyHandler校验失败时候调用的方法：

/// <summary>
    /// 验证失败返回
    /// </summary>
    private void HandleBlocked(AuthorizationHandlerContext context, PolicyRequirement requirement)
    {
      context.Fail();
    }

并在Startup.ConfigureServices修改

 services.AddHttpContextAccessor();

在AddJwtBearer中

.AddJwtBearer(s =>
      {
        //3、添加 Jwt bearer 
        s.TokenValidationParameters = new TokenValidationParameters
        {
          ValidIssuer = issuer,
          ValidAudience = audience,
          IssuerSigningKey = key,
          //允许的服务器时间偏差的偏移量
          ClockSkew = TimeSpan.FromSeconds(5),
          ValidateLifetime = true
        };
        s.Events = new JwtBearerEvents
        {
          OnAuthenticationFailed = context =>
          {
            //Token 过期 
            if (context.Exception.GetType() == typeof(SecurityTokenExpiredException))
            {
              context.Response.Headers.Add("Token-Expired", "true");
            } 
            return Task.CompletedTask;
          },
          OnChallenge = context =>
          {
            context.HandleResponse(); 
            context.Response.StatusCode = StatusCodes.Status200OK;
            context.Response.ContentType = "application/json";
            //无授权返回自定义信息
            context.Response.WriteAsync(JsonConvert.SerializeObject(new UnAuthorizativeResponse()));
            return Task.CompletedTask;
          }
        };
      });

UnAuthorizativeResponse 是自定义返回的内容。

Startup.Configure中启用Authentication，注意顺序

app.UseRouting();
//跨域
app.UseCors(one);
app.UseCors(two);
……
//启用 Authentication 
app.UseAuthorization();
app.UseAuthentication();
app.UseEndpoints(endpoints => ……

也必须在app.UseRouting和app.UseEndpoints之间。

文件下载

　　单独封装的HttpContext下载方法：

public static void DownLoadFile(this HttpContext context,string fileName, byte[] fileByte, string contentType = "application/octet-stream")
    {
      int bufferSize = 1024;
      
      context.Response.ContentType = contentType;
      context.Response.Headers.Append("Content-Disposition", "attachment;filename=" + HttpUtility.UrlEncode(fileName));
      context.Response.Headers.Append("Charset", "utf-8");
      context.Response.Headers.Append("Access-Control-Expose-Headers", "Content-Disposition");
     
      //context.Response.Headers.Append("Access-Control-Allow-Origin", "*");
      //使用FileStream开始循环读取要下载文件的内容
      using (Stream fs = new MemoryStream(fileByte))
      {
        using (context.Response.Body)
        {
          long contentLength = fs.Length;
          context.Response.ContentLength = contentLength;

          byte[] buffer;
          long hasRead = 0;
          while (hasRead < contentLength)
          {
            if (context.RequestAborted.IsCancellationRequested)
            {
              break;
            }
            
            buffer = new byte[bufferSize];
            //从下载文件中读取bufferSize(1024字节)大小的内容到服务器内存中
            int currentRead = fs.Read(buffer, 0, bufferSize);
            context.Response.Body.Write(buffer, 0, currentRead);
            context.Response.Body.Flush();
            hasRead += currentRead;
          }
        }
      }
    }

下载的时候发现以下错误：Synchronous operations are disallowed. Call WriteAsync or set AllowSynchronousIO to true instead.

2020-06-29 14:18:38,898 [109] ERROR System.String - System.InvalidOperationException: Synchronous operations are disallowed. Call WriteAsync or set AllowSynchronousIO to true instead.
  at Microsoft.AspNetCore.Server.IIS.Core.HttpResponseStream.Write(Byte[] buffer, Int32 offset, Int32 count)
  at Microsoft.AspNetCore.Server.IIS.Core.WrappingStream.Write(Byte[] buffer, Int32 offset, Int32 count)
  at DigitalCertificateSystem.Common.Extensions.HttpContextExtension.DownLoadFile(HttpContext context, String fileName, Byte[] fileByte, String contentType) in ……

意思不运行同步操作，修改为

context.Response.Body.WriteAsync(buffer, 0, currentRead);

这才顺利完成了更新。真的太坑了，不过也感觉微软的抽象化做得很好，按需引入，减少项目的冗余。

更多升级指南请参考“孙子兵法”：https://docs.microsoft.com/zh-cn/aspnet/core/migration/22-to-30?view=aspnetcore-2.1&tabs=visual-studio

作者：EminemJK（山治先生）
出处：https://www.cnblogs.com/EminemJK/

到此这篇关于.Net Core 2.2升级3.1的避坑指南(小结)的文章就介绍到这了,更多相关.Net Core 2.2升级3.1内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

.NET Core系列之MemoryCache 缓存选项
这篇文章主要介绍了.NET Core系列之MemoryCache 缓存选项，详细的介绍一下 MSCache 中的 Options，由此来介绍一些 MSCache 中的内部机制，感兴趣的小伙伴们可以参考一下
2018-08-08
asp.net中Fine Uploader文件上传组件使用介绍
最近在处理后台数据时需要实现文件上传.考虑到对浏览器适配上采用Fine Uploader. Fine Uploader 采用ajax方式实现对文件上传.同时在浏览器中直接支持文件拖拽[对浏览器版本有要求类似IE版本必须是9或是更高的IE10].
2013-01-01
.NET/C#利用反射调用含ref或out参数的方法示例代码
这篇文章主要给大家介绍了关于.NET/C#利用反射调用含ref或out参数的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2018-09-09
.NET core 3.0如何使用Jwt保护api详解
这篇文章主要给大家介绍了关于.NET core 3.0如何使用Jwt保护api的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用.NET core 3.0具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-11-11
一个简单的asp.net 单点登录实现
上次做了学校的火车订票系统，那边要求要从学生信息平台直接点过来就是登录状态，不用在重新登录。学生信息平台原来是用asp做的，而火车订票系统是asp.net做的。两个网站的学生信息调用的是同一个数据库。
2009-11-11
asp.net(C#)生成Code39条形码实例条码枪可以扫描出
这篇文章主要介绍了asp.net(C#)生成Code39条形码实例条码枪可以扫描出。需要的朋友可以过来参考下，希望对大家有所帮助
2014-02-02
.NET框架中间语言IL指令大全
IL是微软.NET平台上衍生出的一门中间语言，.NET平台上的各种高级语言（如C#，VB，F#）的编译器会将各自的代码转化为IL。，其中包含了.NET平台上的各种元素，如“范型”，“类”、、“接口”、“模块”、“属性”等等。
2016-06-06
ASP.NET MVC使用Ajax的辅助的解决方法
我们将大致了解一下ASP.NET MVC如何使用Ajax的辅助方法
2013-03-03
Linq to SQL Delete时遇到问题的解决方法
在Linq to SQL中要删除一行记录，官方的例子教我这样做
2008-03-03
Asp.Net FckEditor在web.config中配置的具体实例
Asp.Net FckEditor在web.config中配置的具体实例，需要的朋友可以参考一下
2013-06-06

.Net Core 2.2升级3.1的避坑指南(小结)

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具