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

蜡笔小兴

一、概述

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

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

1. public class PersonInput
2. {
3.     public string? Name { get; set; }
5.     public int? Age { get; set; }
7.     public string? Gender { get; set; }
8. }
10. public class PersonEntity
11. {
12.     public string Name { get; set; }
14.     public int Age { get; set; }
16.     public string Gender { get; set; }
17. }

复制代码

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

1. [HttpPatch]
2. [Route("patch")]
3. public ActionResult Patch([FromForm] PersonInput input)
4. {
5.     // 测试代码暂时将 AutoMapper 配置放在方法内。
6.     var config = new MapperConfiguration(cfg =>
7.     {
8.         cfg.CreateMap<PersonInput, PersonEntity>());
9.     });
10.     var mapper = config.CreateMapper();
12.     // entity 从数据库读取，这里仅演示。
13.     var entity = new PersonEntity
14.     {
15.         Name = "姓名", // 可能会被改变
16.         Age = 18, // 可能会被改变
17.         Gender = "我可能会被改变",
18.     };
20.     // 如果客户端只输入 Name 字段，entity 的 Age 和 Gender 将不能被正确映射或被置为 null。
21.     mapper.Map(input, entity);
23.     return Ok();
24. }

复制代码

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

复制代码

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

1. var keys = _httpContextAccessor.HttpContext.Request.Form.Keys;
2. if(keys.Contains("Name"))
3. {
4.     // 更新 Name(这里忽略合法性判断)
5.     entity.Name = input.Name!;
6. }
7. if (keys.Contains("Age"))
8. {
9.     // 更新 Age(这里忽略合法性判断)
10.     entity.Age = input.Age!;
11. }
12. // ...

复制代码

本文提供一种方式来简化这个步骤。
二、将 Keys 保存在 Input Model 中

定义一个名为 PatchInput 的类:

1. public abstract class PatchInput
2. {
3.     [BindNever]
4.     public ICollection<string>? PatchKeys { get; set; }
5. }

复制代码

PatchKeys 属性不由客户端提供，不参与默认绑定。
PersonInput 继承自 PatchInput：

1. public class PersonInput : PatchInput
2. {
3.     public string? Name { get; set; }
5.     public int? Age { get; set; }
7.     public string? Gender { get; set; }
8. }

复制代码

三、定义 ModelBinderFactory 和 ModelBinder

1. public class PatchModelBinder : IModelBinder
2. {
3.     private readonly IModelBinder _internalModelBinder;
5.     public PatchModelBinder(IModelBinder internalModelBinder)
6.     {
7.         _internalModelBinder = internalModelBinder;
8.     }
10.     public async Task BindModelAsync(ModelBindingContext bindingContext)
11.     {
12.         await _internalModelBinder.BindModelAsync(bindingContext);
13.         if (bindingContext.Model is PatchInput model)
14.         {
15.             // 将 Form 中的 Keys 保存在 PatchKeys 中
16.             model.PatchKeys = bindingContext.HttpContext.Request.Form.Keys;
17.         }
18.     }
19. }

复制代码

1. public class PatchModelBinderFactory : IModelBinderFactory
2. {
3.     private ModelBinderFactory _modelBinderFactory;
5.     public PatchModelBinderFactory(
6.         IModelMetadataProvider metadataProvider,
7.         IOptions<MvcOptions> options,
8.         IServiceProvider serviceProvider)
9.     {
10.         _modelBinderFactory = new ModelBinderFactory(metadataProvider, options, serviceProvider);
11.     }
13.     public IModelBinder CreateBinder(ModelBinderFactoryContext context)
14.     {
15.         var modelBinder = _modelBinderFactory.CreateBinder(context);
16.         // ComplexObjectModelBinder 是 internal 类
17.         if (typeof(PatchInput).IsAssignableFrom(context.Metadata.ModelType)
18.             && modelBinder.GetType().ToString().EndsWith("ComplexObjectModelBinder"))
19.         {
20.             modelBinder = new PatchModelBinder(modelBinder);
21.         }
22.         return modelBinder;
23.     }
24. }

复制代码

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

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

复制代码

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

1. public static class PatchMapperExtensions
2. {
3.     public static IServiceCollection AddPatchMapper(this IServiceCollection services)
4.     {
5.         services.Replace(ServiceDescriptor.Singleton<IModelBinderFactory, PatchModelBinderFactory>());
6.         return services;
7.     }
8. }

复制代码

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

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

复制代码

PatchKeys 的作用是利用 AutoMapper。
五、定义 AutoMapper 的 TypeConverter

1. public class PatchConverter<T> : ITypeConverter<PatchInput, T> where T : new()
2. {
3.     private static readonly IDictionary<string, Action<T, object>> _propertySetters;
5.     static PatchConverter()
6.     {
7.         _propertySetters = typeof(T).GetProperties(BindingFlags.Instance | BindingFlags.Public)
8.             .ToDictionary(p => p.Name, CreatePropertySetter);
9.     }
11.     private static Action<T, object> CreatePropertySetter(PropertyInfo propertyInfo)
12.     {
13.         var targetType = propertyInfo.DeclaringType!;
14.         var parameterExpression = Expression.Parameter(typeof(object), "value");
15.         var castExpression = Expression.Convert(parameterExpression, propertyInfo.PropertyType);
16.         var targetExpression = Expression.Parameter(targetType, "target");
17.         var propertyExpression = Expression.Property(targetExpression, propertyInfo);
18.         var assignExpression = Expression.Assign(propertyExpression, castExpression);
19.         var lambdaExpression = Expression.Lambda<Action<T, object>>(assignExpression, targetExpression, parameterExpression);
20.         return lambdaExpression.Compile();
21.     }
23.     /// <inheritdoc />
24.     public T Convert(PatchInput source, T destination, ResolutionContext context)
25.     {
26.         if (destination == null)
27.         {
28.             destination = new T();
29.         }
31.         if (source.PatchKeys == null)
32.         {
33.             return destination;
34.         }
36.         var sourceType = source.GetType();
37.         foreach (var key in source.PatchKeys)
38.         {
39.             if (_propertySetters.TryGetValue(key, out var propertySetter))
40.             {
41.                 var sourceValue = sourceType.GetProperty(key)?.GetValue(source)!;
42.                 propertySetter(destination, sourceValue);
43.             }
44.         }
46.         return destination;
47.     }
48. }

复制代码

六、模型映射

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

复制代码

七、测试

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

复制代码

或

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

复制代码

源码

Tubumu.PatchMapper

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

参考资料

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

来源:https://www.cnblogs.com/alby/archive/2023/05/13/Patch-in-ASP-NET-Core-web-API.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！