武裝你的WEBAPI-OData資源更新Delta

本文屬於OData系列

目錄

• 武裝你的WEBAPI-OData入門
• 武裝你的WEBAPI-OData便捷查詢
• 武裝你的WEBAPI-OData分頁查詢
• 武裝你的WEBAPI-OData資源更新Delta
• 武裝你的WEBAPI-OData之EDM
• 武裝你的WEBAPI-OData常見問題
• 武裝你的WEBAPI-OData使用Endpoint

Introduction

OData不光提供了數據查詢的便捷手段，它也提供了數據更新的方便辦法。

傳統WebAPI方式

一般用於數據更新的方式，最多的就是PUT和PATCH方法了。關於這兩個方法的區別以及介紹，可以翻看我之前寫的RESTful設計中的常見疑問。

舉例說明：

[AllowAnonymous]
[HttpPut]
[ProducesResponseType(typeof(ReturnData<CarInfo>), Status200OK)]
[ProducesResponseType(typeof(ReturnData<string>), Status409Conflict)]
public async Task<ActionResult> Put([FromBody] Models.CarInfo value)
{
    var info = new Info<CarInfo>();
    var res = await info.Put(value);
    if (res != null) return Ok(new ReturnData<CarInfo>(res));
    else return Conflict(new ReturnData<string>("數據已經存在"));
}

[HttpPatch()]
[Authorize(Roles = "Administrator, Supervisor")]
[ProducesResponseType(typeof(ReturnData<CarInfo>), Status200OK)]
[ProducesResponseType(typeof(ReturnData<string>), Status404NotFound)]
public async Task<ActionResult> Patch([FromBody] Models.CarInfo value)
{
    var info = new Info<CarInfo>();
    var res = await info.Patch(value);
    if (res != null) return Ok(new ReturnData<CarInfo>(res));
    else return NotFound(new ReturnData<string>("無法找到原數據"));
}

public async ValueTask<T?> Put(T value)
{
    //只列出關鍵代碼
    var res = await dbset!.FindAsync(key.GetValue(value) as string);

    if (res != null)
    {
        //return null;
        context.Entry(res).CurrentValues.SetValues(value);
    }
    else
    {
        value.CreateDate = DateTime.Now;
        dbset.Add(value);
        await context.SaveChangesAsync();
        return value;
    }
}

Put和Patch方法主要是實現資料庫對應實體的替換邏輯，這裡我就不貼詳細的代碼了。

可以發現，我需要傳入的是一個CarInfo的對象，替換這個對象，我們就可以實現資源的更新了。

OData資源更新Delta

當然用上面這個方式可以實現資源的更新，不過也存在幾個問題：

• 需要傳遞較為完整的對象（其實這一點不太充分，現在的webapi不完整也能成功解析數據對象；
• 無法追蹤對象的變化；
• 更新需要自己寫邏輯實現；

OData提供了一個叫做Delta<>的泛型類，Delta就是Δ，物理裡面一般用來表示變化量。OData的這個類，也是用來表示一個對象的變化的。

[Table("deviceinfo")]
public class DeviceInfo
{
    [Key]
    [MaxLength(200)]
    public string DeviceId { get; set; }
    public string CameraId { get; set; }
    public string AppKey { get; set; }
    public string AppSecret { get; set; }
    public string Name { get; set; }
    public string DeviceType { get; set; }
    public string Location { get; set; }
    public string Description { get; set; }
}

[Produces("application/json")]
[ProducesResponseType(typeof(Order), Status200OK)]
[ProducesResponseType(Status400BadRequest)]
[Authorize(Roles ="Administrator")]
[ODataRoute("({id})")]
public async Task<IActionResult> Patch(string id, Delta<DeviceInfo> delta)
{
    if (!ModelState.IsValid) return BadRequest(new ODataError() { ErrorCode = "400", Message = "Data is not valid" });

    var infos = await _context.DeviceInfoes.FindAsync(id);

    delta.GetInstance().CameraId = infos.CameraId;
    delta.Patch(infos);
    //獲得更改過的屬性名稱
    var ps = delta.GetChangedPropertyNames();
    await _context.SaveChangesAsync();
    return Ok();
}

使用Delta<>的時候，不需要發送對象的全部屬性，只需要發送變化的部分即可。對於上面的請求，我們只需要發送Key屬性（用於確定數據）和變化的屬性即可。另外，delta提供了追蹤變化的一系列方法：GetChangedPropertyNames()之類的，可以很方便地繼續手動處理，也提供了GetInstance()方法獲得數據對象，可以很方便的進行拓展。

一般使用的話，Delta還提供Post和Put方法，和WebAPI定義的行為一致，這樣用起來也非常直觀。

總結

OData提供了Delta泛型，能夠包裝我們的數據對象，可以極大地簡化資源更新的開發工作。