如何在 ASP.NET Core Web API 中处理 Patch 请求

 更新时间:2023年05月14日 15:47:11   作者:alby  
这篇文章主要介绍了在 ASP.NET Core Web API中处理Patch请求,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

一、概述

PUT 和 PATCH 方法用于更新现有资源。 它们之间的区别是,PUT 会替换整个资源,而 PATCH 仅指定更改。

在 ASP.NET Core Web API 中,由于 C# 是一种静态语言(dynamic 在此不表),当我们定义了一个类型用于接收 HTTP Patch 请求参数的时候,在 Action 中无法直接从实例中得知客户端提供了哪些参数。

比如定义一个输入模型和数据库实体:

public class PersonInput
{
    public string? Name { get; set; }
    public int? Age { get; set; }
    public string? Gender { get; set; }
}
public class PersonEntity
{
    public string Name { get; set; }
    public int Age { get; set; }
    public string Gender { get; set; }
}

再定义一个以 FromForm 形式接收参数的 Action:

[HttpPatch]
[Route("patch")]
public ActionResult Patch([FromForm] PersonInput input)
{
    // 测试代码暂时将 AutoMapper 配置放在方法内。
    var config = new MapperConfiguration(cfg =>
    {
        cfg.CreateMap<PersonInput, PersonEntity>());
    });
    var mapper = config.CreateMapper();
    // entity 从数据库读取,这里仅演示。
    var entity = new PersonEntity
    {
        Name = "姓名", // 可能会被改变
        Age = 18, // 可能会被改变
        Gender = "我可能会被改变",
    };
    // 如果客户端只输入 Name 字段,entity 的 Age 和 Gender 将不能被正确映射或被置为 null。
    mapper.Map(input, entity);
    return Ok();
}
curl --location --request PATCH 'http://localhost:5094/test/patch' \
--form 'Name="foo"'

如果客户端只提供了 Name 而没有其他参数,从 HttpContext.Request.Form.Keys 可以得知这一点。如果不使用 AutoMapper,那么接下来是丑陋的判断:

var keys = _httpContextAccessor.HttpContext.Request.Form.Keys;
if(keys.Contains("Name"))
{
    // 更新 Name(这里忽略合法性判断)
    entity.Name = input.Name!;
}
if (keys.Contains("Age"))
{
    // 更新 Age(这里忽略合法性判断)
    entity.Age = input.Age!;
}
// ...

本文提供一种方式来简化这个步骤。

二、将 Keys 保存在 Input Model 中

定义一个名为 PatchInput 的类:

public abstract class PatchInput
{
    [BindNever]
    public ICollection<string>? PatchKeys { get; set; }
}

PatchKeys 属性不由客户端提供,不参与默认绑定。

PersonInput 继承自 PatchInput:

public class PersonInput : PatchInput
{
    public string? Name { get; set; }
    public int? Age { get; set; }
    public string? Gender { get; set; }
}

三、定义 ModelBinderFactory 和 ModelBinder

public class PatchModelBinder : IModelBinder
{
    private readonly IModelBinder _internalModelBinder;
    public PatchModelBinder(IModelBinder internalModelBinder)
    {
        _internalModelBinder = internalModelBinder;
    }
    public async Task BindModelAsync(ModelBindingContext bindingContext)
    {
        await _internalModelBinder.BindModelAsync(bindingContext);
        if (bindingContext.Model is PatchInput model)
        {
            // 将 Form 中的 Keys 保存在 PatchKeys 中
            model.PatchKeys = bindingContext.HttpContext.Request.Form.Keys;
        }
    }
}
public class PatchModelBinderFactory : IModelBinderFactory
{
    private ModelBinderFactory _modelBinderFactory;
    public PatchModelBinderFactory(
        IModelMetadataProvider metadataProvider,
        IOptions<MvcOptions> options,
        IServiceProvider serviceProvider)
    {
        _modelBinderFactory = new ModelBinderFactory(metadataProvider, options, serviceProvider);
    }
    public IModelBinder CreateBinder(ModelBinderFactoryContext context)
    {
        var modelBinder = _modelBinderFactory.CreateBinder(context);
        // ComplexObjectModelBinder 是 internal 类
        if (typeof(PatchInput).IsAssignableFrom(context.Metadata.ModelType)
            && modelBinder.GetType().ToString().EndsWith("ComplexObjectModelBinder"))
        {
            modelBinder = new PatchModelBinder(modelBinder);
        }
        return modelBinder;
    }
}

四、在 ASP.NET Core 项目中替换 ModelBinderFactory

var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddPatchMapper();

AddPatchMapper 是一个简单的扩展方法:

public static class PatchMapperExtensions
{
    public static IServiceCollection AddPatchMapper(this IServiceCollection services)
    {
        services.Replace(ServiceDescriptor.Singleton<IModelBinderFactory, PatchModelBinderFactory>());
        return services;
    }
}

到目前为止,在 Action 中已经能获取到请求的 Key 了。

[HttpPatch]
[Route("patch")]
public ActionResult Patch([FromForm] PersonInput input)
{
    // 不需要手工给 input.PatchKeys 赋值。
    return Ok();
}

PatchKeys 的作用是利用 AutoMapper。

五、定义 AutoMapper 的 TypeConverter

public class PatchConverter<T> : ITypeConverter<PatchInput, T> where T : new()
{
    /// <inheritdoc />
    public T Convert(PatchInput source, T destination, ResolutionContext context)
    {
        destination ??= new T();
        var sourceType = source.GetType();
        var destinationType = typeof(T);
        foreach (var key in source.PatchKeys ?? Enumerable.Empty<string>())
        {
            var sourcePropertyInfo = sourceType.GetProperty(key, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance);
            if (sourcePropertyInfo != null)
            {
                var destinationPropertyInfo = destinationType.GetProperty(key, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance);
                if (destinationPropertyInfo != null)
                {
                    var sourceValue = sourcePropertyInfo.GetValue(source);
                    destinationPropertyInfo.SetValue(destination, sourceValue);
                }
            }
        }
        return destination;
    }
}

上述代码可用其他手段来代替反射。

六、模型映射

[HttpPatch]
[Route("patch")]
public ActionResult Patch([FromForm] PersonInput input)
{
    // 1. 目前仅支持 `FromForm`,即 `x-www-form_urlencoded` 和 `form-data`;暂不支持 `FromBody` 如 `raw` 等。
    // 2. 使用 ModelBinderFractory 创建 ModelBinder 而不是 ModelBinderProvider 以便于未来支持更多的输入格式。
    // 3. 目前还没有支持多级结构。
    // 4. 测试代码暂时将 AutoMapper 配置放在方法内。
    var config = new MapperConfiguration(cfg =>
    {
        cfg.CreateMap<PersonInput, PersonEntity>().ConvertUsing(new PatchConverter<PersonEntity>());
    });
    var mapper = config.CreateMapper();
    // PersonEntity 有 3 个属性,客户端如果提供的参数参数不足 3 个,在 Map 时未提供参数的属性值不会被改变。
    var entity = new PersonEntity
    {
        Name = "姓名",
        Age = 18,
        Gender = "如果客户端没有提供本参数,那我的值不会被改变"
    };
    mapper.Map(input, entity);
    return Ok();
}

七、测试

curl --location --request PATCH 'http://localhost:5094/test/patch' \
--form 'Name="foo"'

curl --location --request PATCH 'http://localhost:5094/test/patch' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'Name=foo'

源码

Tubumu.PatchMapper

  • 支持 FromForm,即 x-www-form_urlencoded 和 form-data
  • 支持 FromBody 如 raw 等。
  • 支持多级结构。

参考资料

GraphQL.NET

如何在 ASP.NET Core Web API 中处理 JSON Patch 请求

到此这篇关于在 ASP.NET Core Web API 中处理 Patch 请求的文章就介绍到这了,更多相关ASP.NET Core Web API 处理 Patch 请求内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 聊一聊Asp.net过滤器Filter那一些事

    聊一聊Asp.net过滤器Filter那一些事

    这篇文章主要介绍了聊一聊Asp.net过滤器Filter那一些事,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • ASP.Net中利用CSS实现多界面的两种方法

    ASP.Net中利用CSS实现多界面的两种方法

    这篇文章主要介绍了ASP.Net中利用CSS实现多界面的两种方法,包括动态加载css样式与动态设置页面同类控件的方法来实现该功能,是非常具有实用价值的技巧,需要的朋友可以参考下
    2014-12-12
  • .net indexOf(String.indexOf 方法)

    .net indexOf(String.indexOf 方法)

    字符串的IndexOf()方法搜索在该字符串上是否出现了作为参数传递的字符串,如果找到字符串,则返回字符的起始位置 (0表示第一个字符,1表示第二个字符依此类推)如果说没有找到则返回 -1
    2012-10-10
  • .Net ORM 访问 Firebird 数据库的方法

    .Net ORM 访问 Firebird 数据库的方法

    这篇文章简单介绍了在 .net6.0 环境中使用 FreeSql 对 Firebird 数据库的访问,目前 FreeSql 还支持.net framework 4.0 和 xamarin 平台上使用,对.Net ORM 访问 Firebird 数据库相关知识感兴趣的朋友一起看看吧
    2022-07-07
  • asp.net操作过程中常见错误的解决方法

    asp.net操作过程中常见错误的解决方法

    这篇文章主要介绍了asp.net操作过程中常见错误的解决方法,主要有IIS无法识别ASP.NET、 SQL Server不允许进行远程连接可能会导致此失败等问题,感兴趣的小伙伴们可以参考一下
    2015-10-10
  • C#实现上传照片到物理路径,并且将地址保存到数据库的小例子

    C#实现上传照片到物理路径,并且将地址保存到数据库的小例子

    这篇文章主要介绍了c#上传图片,并将地址保存到数据库中的简单实例,有需要的朋友可以参考一下
    2013-12-12
  • MVC4制作网站教程第四章 前台栏目浏览4.5

    MVC4制作网站教程第四章 前台栏目浏览4.5

    这篇文章主要为大家详细介绍了MVC4制作网站教程,前台栏目浏览功能实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • .NET Core3.0 日志 logging的实现

    .NET Core3.0 日志 logging的实现

    这篇文章主要介绍了.NET Core3.0 日志 logging的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • ASP.NET下使用WScript.Shell执行命令

    ASP.NET下使用WScript.Shell执行命令

    ASP.NET下有自己的执行CMD命令的方式,这里用WScript.Shell似有画蛇添足之嫌,但是我们也不能排除真的有机器禁用了.NET的相关类,未雨绸缪嘛。当然也不仅仅局限于WScript.Shell,只要是ASP中能用的组件,统统都可以用于ASP.NET中,而且还更方便!
    2008-05-05
  • Asp.Net Core中创建多DbContext并迁移到数据库的步骤

    Asp.Net Core中创建多DbContext并迁移到数据库的步骤

    这篇文章主要介绍了Asp.Net Core中创建多DbContext并迁移到数据库的步骤,帮助大家更好的理解和学习使用Asp.Net Core,感兴趣的朋友可以了解下
    2021-03-03

最新评论