ASP.NET Web API 中简单属性的自定义类型转换器

Question

在一个 ASP.NET Web API 项目中，我想加密所有响应中的所有实体 ID，并解密所有请求中的加密值。

（注意：我知道如何加密/解密数据，这不是我的问题。）

我认为如果我只在响应/请求中使用自定义属性装饰我需要加密/解密的属性会很好。

这就是我喜欢它的工作方式：

public class Person
{
  [EncryptDecrypt]
  public int PersonID {get; set;}

  public string Name {get; set;}

  public IEnumerable<Order> Orders {get; set;}
}

public class Order 
{
    [EncryptDecrypt]
    public long OrderID {get; set;}

    public string Title {get; set;}

    public float Price {get; set;}
}

然后在 Web API 方法中：

// GET: api/persons/xhj$j78dPs (xhj$j78dPs is an encrypted PersonID)    

public Person Get([EncryptDecrypt]int personId)
{
    // Now, I expect personId to be a normal ID, like: 187356

    Person person = _repository.GetPerson(personId);

    return person;
}

上述 Web API 的期望响应是：

{
   "personId": "xhj$j78dPs",
   "name": "Joe Williams",
   "orders": [
      {
         "orderId": "a#jd75mlzed0ihd",
         "title": "Buying a new item",
         "price": 19.99
      }
    ]
 }

这是另一个例子，这次是用于 PUT 动词的 Web API：

/* PUT Request body: */
{
   "orderId": "a#jd75mlzed0ihd",
   "title": "Buying a new item - edited",
   "price": 13.00
}

相关的Web API方法：

// PUT: api/persons/xhj$j78dPs/orders/ (xhj$j78dPs is an encrypted PersonID)

public void Put([EncryptDecrypt]int personId, Order editedOrder)
{
    // I expect personId to be a normal ID, like: 187356

    // I expect editedOrder.OrderID to be a normal ID, like: 10000089765

    _repository.UpdateOrder(personId, editedOrder);
}

如何开发[EncryptDecrypt] 属性？

[EncryptDecrypt] 实际上应该是JsonConverter attribute 吗？或者我应该开发自定义Media Formatter 或模型绑定器或值提供者或参数绑定器？我很困惑。

Answer 1

如何开发 [EncryptDecrypt] 属性？

[EncryptDecrypt] 实际上应该是 JsonConverter 属性吗？还是我应该开发自定义媒体格式化程序或模型绑定器或值提供程序或参数绑定器？我很困惑。

你需要同时开发一点；自定义JsonConverter 用于（反）序列化JSON 数据，自定义ModelBinder 用于将（加密int/long）值绑定到端点参数。

试试这样的：

public class EncryptDecrypt : JsonConverter, IModelBinder 
{    
  public override bool CanConvert(Type objectType)
  {
    return typeof(int).IsAssignableFrom(objectType) || 
           typeof(long).IsAssignableFrom(objectType);
  }

  public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
  {
    // Deserialize the provided value as string
    // and decrypt it to its exprected int/long type 
    var value = serializer.Deserialize<string>(reader);
    return Decrypt(value, objectType);
  }

  public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
  {
    // obviously Encrypt() should convert the int/ long value 
    // to its encrypted string representation.
    var encrypted = Encrypt(value);
    writer.WriteValue(encrypted);
  }

  public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
  {
    if (!CanConvert(bindingContext.ModelType)) return false;

    var val = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
    if (val == null) return false;

    // bindingContext.ModelType should tell us whether the decrypted value 
    // is expected as an int/ long.
    var decrypted = Decrypt(val.RawValue as string, bindingContext.ModelType);
    if (decrypted != null)
    {
      bindingContext.Model = decrypted;
      return true;
    }

    bindingContext.ModelState.AddModelError(bindingContext.ModelName, "Cannot convert value");
    return false;
  }
}

然后你可以像这样装饰模型：

public class Person
{
  [JsonConverter(typeof(EncryptDecrypt))]
  public int PersonID { get; set; }

  public string Name { get; set; }

  public IEnumerable<Order> Orders { get; set; }
}

public class Order
{
  [JsonConverter(typeof(EncryptDecrypt))]    
  public long OrderID { get; set; }

  public string Title { get; set; }

  public float Price { get; set; }
}

对于 Web API 方法，您需要像这样装饰它：

public IHttpActionResult Get([ModelBinder(typeof(EncryptDecrypt))] int personId)
{
  // Now, I expect personId to be a normal ID, like: 187356
  Person person = _repository.GetPerson(personId);

  return Json(person);
}

public void Put([ModelBinder(typeof(EncryptDecrypt))] int personId, Order editedOrder)
{
  // I expect personId to be a normal ID, like: 187356
  // I expect editedOrder.OrderID to be a normal ID, like: 10000089765

  _repository.UpdateOrder(personId, editedOrder);
}