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

来源:https://www.cnblogs.com/podolski/archive/2020/07/07/13264216.html

本文屬於OData系列 目錄 武裝你的WEBAPI-OData入門 武裝你的WEBAPI-OData便捷查詢 武裝你的WEBAPI-OData分頁查詢 武裝你的WEBAPI-OData資源更新Delta 武裝你的WEBAPI-OData之EDM 武裝你的WEBAPI-OData常見問題 武裝你的WE ...


本文屬於OData系列

目錄


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泛型,能夠包裝我們的數據對象,可以極大地簡化資源更新的開發工作。


您的分享是我們最大的動力!

更多相關文章
  • 其實spring boot攔截器的配置方式和springMVC差不多,只有一些小的改變需要註意下就ok了。下麵主要介紹兩種常用的攔截器: 一、基於URL實現的攔截器: public class LoginInterceptor extends HandlerInterceptor{ /** * 在請 ...
  • 點擊藍色“程式員書單”關註我喲 加個“星標”,每天帶你看好文,讀好書! 本文轉自知乎:https://zhuanlan.zhihu.com/p/34994820 最近在看程式員的自我修養 (豆瓣),作者陳逸鶴,一本寫給程式員的思考書,其實市面上類似題材的書也不少,比如我看過的另外兩本內外兼修:程式員 ...
  • 關註公眾號【程式員書單】後回覆“book”即可領取30+精品免費電子書 ​ Go 是一種簡單、小巧、令人愉悅的語言。它也有一些犄角旮旯,但絕大部分是經過精心設計的。它的學習速度令人難以置信,並且規避了其他語言中一些不那麼廣為人知的特性。 現如今越來越多的互聯網公司開始使用go語言,有的初創公司開始使 ...
  • 前言 本文的文字及圖片來源於網路,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯繫我們以作處理。 作者:打磨蝦 “遲到”了一個月的高考終於要來了。 正好我得到了一份山東新高考模擬考的成績和山東考試院公佈的一分一段表,以及過去三年的普通高考本科普通批首次志願錄取情況統計。2 ...
  • 一. 安裝依賴包 yum install -y wget yum install -y gcc-c++ yum install -y zlib-devel perl-ExtUtils-MakeMaker yum -y install curl-devel expat-devel gettext-de ...
  • 解決辦法: https://tunatore.wordpress.com/2015/06/15/org-jboss-tools-vpe-xulrunner-xulrunnerbundlenotfoundexception-bundle-org-mozilla-xulrunner-win32-win3 ...
  • **前言** Topological sort 又稱 Topological order,這個名字有點迷惑性,因為拓撲排序並不是一個純粹的排序演算法,它只是針對某一類圖,找到一個可以執行的線性順序。 這個演算法聽起來高大上,如今的面試也很愛考,比如當時我在面我司時有整整一輪是基於拓撲排序的設計。 但它其 ...
  • 前言 面試總是會被問到有沒有用過分散式鎖、redis 鎖,大部分讀者平時很少接觸到,所以只能很無奈的回答 “沒有”。本文通過 Spring Boot 整合 redisson 來實現分散式鎖,並結合 demo 測試結果。 首先看下大佬總結的圖 正文 添加依賴 <!--redis--> <depende ...
一周排行
  • 比如要拆分“呵呵呵90909086676喝喝999”,下麵當type=0返回的是中文字元串“呵呵呵,喝喝”,type=1返回的是數字字元串“90909086676,999”, private string GetStrings(string str,int type=0) { IList<strin ...
  • Swagger一個優秀的Api介面文檔生成工具。Swagger可以可以動態生成Api介面文檔,有效的降低前後端人員關於Api介面的溝通成本,促進項目高效開發。 1、使用NuGet安裝最新的包:Swashbuckle.AspNetCore。 2、編輯項目文件(NetCoreTemplate.Web.c ...
  • 2020 年 7 月 30 日, 由.NET基金會和微軟 將舉辦一個線上和為期一天的活動,包括 微軟 .NET 團隊的演講者以及社區的演講者。本次線上大會 專註.NET框架構建微服務,演講者分享構建和部署雲原生應用程式的最佳實踐、模式、提示和技巧。有關更多信息和隨時瞭解情況:https://focu... ...
  • #abp框架Excel導出——基於vue #1.技術棧 ##1.1 前端採用vue,官方提供 UI套件用的是iview ##1.2 後臺是abp——aspnetboilerplate 即abp v1,https://github.com/aspnetboilerplate/aspnetboilerp ...
  • 前言 本文的文字及圖片來源於網路,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯繫我們以作處理。 作者:碧茂大數據 PS:如有需要Python學習資料的小伙伴可以加下方的群去找免費管理員領取 input()輸入 Python提供了 input() 內置函數從標準輸入讀入一 ...
  • 從12年到20年,python以肉眼可見的趨勢超過了java,成為了當今It界人人皆知的編程語言。 python為什麼這麼火? 網路編程語言搜索指數 適合初學者 Python具有語法簡單、語句清晰的特點,這就讓初學者在學習階段可以把精力集中在編程對象和思維方法上。 大佬都在用 Google,YouT ...
  • 在社會上存在一種普遍的對培訓機構的學生一種歧視的現象,具體表現在,比如:當你去公司面試的時候,一旦你說了你是培訓機構出來的,那麼基本上你就涼了,那麼你瞞著不說,然後又通過了面試成功入職,但是以後一旦在公司被髮現有培訓經歷,可能會面臨被降薪,甚至被辭退,培訓機構出來的學生,在用人單位眼裡就是能力低下的 ...
  • from typing import List# 這道題看了大佬寫的代碼,經過自己的理解寫出來了。# 從最外圍的四周找有沒有為O的,如果有的話就進入深搜函數,然後深搜遍歷# 判斷上下左右的位置是否為Oclass Solution: def solve(self, board: List[List[s ...
  • import requests; import re; import os; # 1.請求網頁 header = { "user-agent":'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, li ...
  • import requests; import re; import os; import parsel; 1.請求網頁 header = { "user-agent":'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537. ...