<<ABP框架>> OData 集成

来源:http://www.cnblogs.com/kid1412/archive/2016/10/30/6012938.html
-Advertisement-
Play Games

文檔目錄 本節內容： 簡介 安裝 安裝Nuget包 設置模塊依賴 配置你的實體 創建控制器 示例 獲取實體列表 請求 響應 獲取單個實體 請求 響應 獲取單個實體及導航屬性 請求 響應 查詢 請求 響應 創建一個新實體 請求 響應 獲取元數據 請求 響應 示例項目 安裝Nuget包 設置模塊依賴 配 ...


文檔目錄

 

本節內容：

 

簡介

OData在odata.org上的定義是：“一個開放的協議,允許創建和使用可查詢、可互操作的RESTful api的簡單的標準方式”。你可以在ABP里使用OData，Abp.Web.Api.OData的nuget包簡化了它的使用方式。

 

安裝

安裝Nuget包

在我們的WebApi項目里，先安裝Abp.Web.api.Odata的nuget包：

Install-Package Abp.Web.Api.OData

 

設置模塊依賴

在我們的模塊上設置對AbpWebApiOdataModule的依賴，例如：

[DependsOn(typeof(AbpWebApiODataModule))]
public class MyProjectWebApiModule : AbpModule
{
    ...
}

 查看模塊系統更好地理解模塊依賴。

 

配置你的實體

OData需要聲明哪個實體作為它的資源，我們應當在我們模塊的PreInitialize方法里指定，如下所示：

[DependsOn(typeof(AbpWebApiODataModule))]
public class MyProjectWebApiModule : AbpModule
{
    public override void PreInitialize()
    {
        var builder = Configuration.Modules.AbpWebApiOData().ODataModelBuilder;

        //Configure your entities here...
        builder.EntitySet<Person>("Persons");
    }

    ...
}

此處，我們ODataModelBuilder的引用，並給它設置了Person實體，類似地，你可以使用EntitySet來添加其它實體，查看OData文檔獲取更多信息。

 

創建控制器

Abp.Web.Api.OData的nuget包包括了AbpODataEntityController基類（它擴展了標準的ODataController），用它可更容易地創建你自己的控制器，如下是一個為Person實體創建一個OData端點的例子：

public class PersonsController : AbpODataEntityController<Person>
{
    public PersonsController(IRepository<Person> repository)
        : base(repository)
    {
    }
}

這很簡單，AbpODataEntityController的所有方法都是virtual，也就是說你可以重寫Get、Post、Put、Patch、Delete和其它Action來添加自己的邏輯。

 

示例

這裡我們列幾個請求上面定義的控制器的基本的例子，假設應用工作在http://localhost:61842上，因為OData是一個標準的協議，你可以很容易地在網頁上找到更深入的例子。

 

獲取實體列表

獲取所有person。

 

請求

GET http://localhost:61842/odata/Persons

 

響應

{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons","value":[
    {
      "Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1
    },{
      "Name":"John Nash","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":2
    }
  ]
}

 

獲取單個實體

獲取Id=2的person。

 

請求

GET http://localhost:61842/odata/Persons(2)

 

響應

{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons/$entity","Name":"John Nash","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":2
}

 

獲取單個實體及導航屬性

獲取Id=1的person包含它的電話號碼。

 

請求

GET http://localhost:61842/odata/Persons(1)?$expand=Phones

  

響應

{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons/$entity","Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1,"Phones":[
    {
      "PersonId":1,"Type":"Mobile","Number":"4242424242","CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1
    },{
      "PersonId":1,"Type":"Mobile","Number":"2424242424","CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":2
    }
  ]
}

 

查詢

這裡列舉一個稍微複雜點的查詢，包含過濾，排序和獲取最前面2條結果。

 

請求

GET http://localhost:61842/odata/Persons?$filter=Name eq 'Douglas Adams'&$orderby=CreationTime&$top=2

 

響應 

{
  "@odata.context":"http://localhost:61842/odata/$metadata#Persons","value":[
    {
      "Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2015-11-07T20:12:39.363+03:00","CreatorUserId":null,"Id":1
    },{
      "Name":"Douglas Adams","IsDeleted":false,"DeleterUserId":null,"DeletionTime":null,"LastModificationTime":null,"LastModifierUserId":null,"CreationTime":"2016-01-12T20:29:03+02:00","CreatorUserId":null,"Id":3
    }
  ]
}

OData支持分頁，排序，過濾，投射等更多，請查閱它自己的文檔。

 

創建一個新實體

接下來的例子，我們創建一個新person。

 

請求

POST http://localhost:61842/odata/Persons

{
    Name: "Galileo Galilei"
}

此處，“Content-Type"頭是”application/json“。

 

響應

{
  "@odata.context": "http://localhost:61842/odata/$metadata#Persons/$entity",
  "Name": "Galileo Galilei",
  "IsDeleted": false,
  "DeleterUserId": null,
  "DeletionTime": null,
  "LastModificationTime": null,
  "LastModifierUserId": null,
  "CreationTime": "2016-01-12T20:36:04.1628263+02:00",
  "CreatorUserId": null,
  "Id": 4
}

如果我們再次獲取列表，我們可以看到這個新person，也OData支持更新或刪除一個已經存在的實體。

 

獲取元數據

我們可以獲取實體的元數據，如接下來的例子所示。

 

請求

GET http://localhost:61842/odata/$metadata

 

響應

<?xml version="1.0" encoding="utf-8"?>

<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx">

    <edmx:DataServices>

        <Schema Namespace="AbpODataDemo.People" xmlns="http://docs.oasis-open.org/odata/ns/edm">

            <EntityType Name="Person">

                <Key>

                    <PropertyRef Name="Id" />

                </Key>

                <Property Name="Name" Type="Edm.String" Nullable="false" />

                <Property Name="IsDeleted" Type="Edm.Boolean" Nullable="false" />

                <Property Name="DeleterUserId" Type="Edm.Int64" />

                <Property Name="DeletionTime" Type="Edm.DateTimeOffset" />

                <Property Name="LastModificationTime" Type="Edm.DateTimeOffset" />

                <Property Name="LastModifierUserId" Type="Edm.Int64" />

                <Property Name="CreationTime" Type="Edm.DateTimeOffset" Nullable="false" />

                <Property Name="CreatorUserId" Type="Edm.Int64" />

                <Property Name="Id" Type="Edm.Int32" Nullable="false" />

                <NavigationProperty Name="Phones" Type="Collection(AbpODataDemo.People.Phone)" />

            </EntityType>

            <EntityType Name="Phone">

                <Key>

                    <PropertyRef Name="Id" />

                </Key>

                <Property Name="PersonId" Type="Edm.Int32" />

                <Property Name="Type" Type="AbpODataDemo.People.PhoneType" Nullable="false" />

                <Property Name="Number" Type="Edm.String" Nullable="false" />

                <Property Name="CreationTime" Type="Edm.DateTimeOffset" Nullable="false" />

                <Property Name="CreatorUserId" Type="Edm.Int64" />

                <Property Name="Id" Type="Edm.Int32" Nullable="false" />

                <NavigationProperty Name="Person" Type="AbpODataDemo.People.Person">

                    <ReferentialConstraint Property="PersonId" ReferencedProperty="Id" />

                </NavigationProperty>

            </EntityType>

            <EnumType Name="PhoneType">

                <Member Name="Unknown" Value="0" />

                <Member Name="Mobile" Value="1" />

                <Member Name="Home" Value="2" />

                <Member Name="Office" Value="3" />

            </EnumType>

        </Schema>

        <Schema Namespace="Default" xmlns="http://docs.oasis-open.org/odata/ns/edm">

            <EntityContainer Name="Container">

                <EntitySet Name="Persons" EntityType="AbpODataDemo.People.Person" />

            </EntityContainer>

        </Schema>

    </edmx:DataServices>

</edmx:Edmx>

元數據用來查看服務信息。

 

示例項目

你可以從https://github.com/aspnetboilerplate/sample-odata上獲取這個示例項目的源代碼。


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

-Advertisement-
Play Games
更多相關文章
  • OutPut子句的使用限制
    Output子句很方便，多數情況下可以省略了更新後插入或者刪除後插入操作表，將2個語句變成1個語句操作。不管從語句美觀還是效率上都是有不錯的提升， 但是對於Output自身，也是有一些限制的。 從文檔上看。主要有以下三點需要註意 1 Output into 的對象不能含有觸發器 2 Output i ...
  • centos 配置本地 yum源
    修改CentOS-Media.repo時 每行代碼開始不要有空格[c6-media] #庫名稱 name=CentOS-$releasever - Media #名稱描述 baseurl=file:///media/centos/ #yum源目錄，源地址 gpgcheck=1 #檢查GPG-KEY，... ...
  • Ubuntu 16.10 安裝byzanz截取動態效果圖工具
    1.瞭解byzanz截取動態效果圖工具 byzanz能製作文件小，清晰的GIF動態效果圖，不足就是，目前只能通過輸入命令方式來錄製。 byzanz主要的參數選項有： -d, --duration=SECS 動畫的時間 (預設：10 秒) -e, --exec=COMMAND Command to e ...
  • <<ABP文檔>> Mvc 控制器
    文檔目錄 本節內容： 簡介 AbpController基類 本地化 其它 過濾 異常處理和結果包裝 審計日誌 驗證 授權 工作單元 反偽造 模型綁定器 本地化 其它 異常處理和結果包裝 審計日誌 驗證 授權 工作單元 反偽造 簡介 ABP通過nuget包Abp.Web.Mvc集成到Asp.net M ...
  • 開源物聯網通訊框架ServerSuperIO，成功移植到Windows10 IOT，在物聯網和集成系統建設中降低成本。附：“物聯網”交流大綱
    經過一個多月晚上的時間，終於把開源物聯網通訊框架ServerSuperIO成功移植到Windows10 IOT上，暫時全名：ServerSuperIO.WinIOT（以後可能還會移植到Ubuntu上）。以後可以把ServerSuperIO框架應用到嵌入式設備上，移植的成功具有標誌性意義，意味著軟體和... ...
  • <<ABP框架>> Swagger UI 集成
    文檔目錄 本節內容： 簡介 Asp.net Core 安裝 安裝Nuget包 配置 測試 Asp.net 5.x 安裝 安裝Nuget包 配置 測試 安裝 安裝Nuget包 配置 測試 安裝 安裝Nuget包 配置 測試 簡介 來自它的網頁：“...使用一個Swagger-enabled Api，你 ...
  • winform實例(3)-利用攝像頭進行拍照
    前言： 由於先前用python+opencv做了一會兒人臉識別。（其實是別人做的，我是打醬油的）。 用winform做了當時用的一個功能界面。打開攝像頭併進行拍照保存。 界面預覽： 此次，利用的是winform+AForge框架。AForge是全過程都在用的，必須要有。 介紹一下製作過程： 1.創建 ...
  • .NET4.5新特性之非同步編程（Async和Await）的使用
    一、簡介 首先來看看.net的發展中的各個階段的特性：NET 與C# 的每個版本發佈都是有一個“主題”。即：C#1.0托管代碼→C#2.0泛型→C#3.0LINQ→C#4.0動態語言→C#4.5非同步編程 所謂的非同步編程是利用CPU空閑時間和多核的特性，它所返回的Task或Task是對await的一個 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類