.NET Core开发日志——OData

简述

OData,即Open Data Protocol,是由微软在2007年推出的一款开放协议,旨在通过简单、标准的方式创建和使用查询式及交互式RESTful API。

类库

在.NET Core中想要使用OData功能的话需要添加Microsoft.AspNetCore.OData包。

dotnet add package Microsoft.AspNetCore.OData

准备模型类

public class Address
{
    public string City { get; set; }
    public string Street { get; set; }
}
public enum Category
{
    Book,
    Magazine,
    EBook
}
public class Press
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public Category Category { get; set; }
}
public class Book
{
    public int Id { get; set; }
    public string ISBN { get; set; }
    public string Title { get; set; }
    public string Author { get; set; }
    public decimal Price { get; set; }
    public Address Address { get; set; }
    public Press Press { get; set; }
}

创建Edm模型

OData使用EDM,即Entity Data Model来描述数据的结构。在Startup文件中添加创建方法。

private static IEdmModel GetEdmModel()
{
    var builder = new ODataConventionModelBuilder();
    builder.EntitySet<Book>("Books");
    builder.EntitySet<Press>("Presses");
    return builder.GetEdmModel();
}

注册OData服务

在Startup文件的ConfigureServices方法里注册OData服务。

services.AddOData();
services.AddMvc(options =>
    {
        options.EnableEndpointRouting = false;
    }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

这里要注意的是在.NET Core 2.2里,默认已经有终结点,所以要使用OData的终结点的话需要将默认选项禁用掉。

注册OData终结点

同样在Startup文件里,在其Configure方法内将原来的注册路由内容改为注册OData的终结点。

app.UseMvc(b =>
{
    b.MapODataServiceRoute("odata", "odata", GetEdmModel());
});

显示元数据

运行程序后访问https://localhost:5001/odata/$metadata地址,可以看到所有可用模型的元数据。

<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
    <edmx:DataServices>
        <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Default">
            <EntityType Name="Book">
                <Key>
                    <PropertyRef Name="Id"/>
                </Key>
                <Property Name="Id" Type="Edm.Int32" Nullable="false"/>
                <Property Name="ISBN" Type="Edm.String"/>
                <Property Name="Title" Type="Edm.String"/>
                <Property Name="Author" Type="Edm.String"/>
                <Property Name="Price" Type="Edm.Decimal" Nullable="false"/>
                <Property Name="Address" Type="Default.Address"/>
                <NavigationProperty Name="Press" Type="Default.Press"/>
            </EntityType>
            <EntityType Name="Press">
                <Key>
                    <PropertyRef Name="Id"/>
                </Key>
                <Property Name="Id" Type="Edm.Int32" Nullable="false"/>
                <Property Name="Name" Type="Edm.String"/>
                <Property Name="Email" Type="Edm.String"/>
                <Property Name="Category" Type="Default.Category" Nullable="false"/>
            </EntityType>
            <ComplexType Name="Address">
                <Property Name="City" Type="Edm.String"/>
                <Property Name="Street" Type="Edm.String"/>
            </ComplexType>
            <EnumType Name="Category">
                <Member Name="Book" Value="0"/>
                <Member Name="Magazine" Value="1"/>
                <Member Name="EBook" Value="2"/>
            </EnumType>
            <EntityContainer Name="Container">
                <EntitySet Name="Books" EntityType="Default.Book">
                    <NavigationPropertyBinding Path="Press" Target="Presses"/>
                </EntitySet>
                <EntitySet Name="Presses" EntityType="Default.Press"/>
            </EntityContainer>
        </Schema>
    </edmx:DataServices>
</edmx:Edmx>

创建Controller

本文实例中不考虑数据库的操作,故而使用hard code方式构建必要的模型对象。

public class BooksController : ODataController
{
    private static IList<Book> Books {get; set;}
    public BooksController()
    {
        Books = new List<Book>
        {
            new Book
            {
                Id = 1,
                ISBN = "111-0-321-56789-1",
                Title = "Calculus",
                Price = 66.6m,
                Address = new Address
                {
                    City = "Shanghai",
                    Street = "Beijin Xi Road"
                },
                Press = new Press
                {
                    Id = 1,
                    Name = "Shanghai Tongji",
                    Category = Category.Book
                }
            },
            new Book
            {
                Id = 2,
                ISBN = "222-2-654-00000-2",
                Title = "Linear Algebra",
                Price = 53.2m,
                Address = new Address
                {
                    City = "Shanghai",
                    Street = "Beijin Dong Road"
                },
                Press = new Press
                {
                    Id = 2,
                    Name = "Shanghai Fudan",
                    Category = Category.EBook
                }
            }
        };
    }

    [EnableQuery]
    public IActionResult Get()
    {
        return Ok(Books);
    }

    [EnableQuery]
    public IActionResult Get(int key)
    {
        return Ok(Books.FirstOrDefault(b => b.Id == key));
    }
}

EnableQuery特性在需要高级查询的场景时必须添加。

查询

加入Controller之后,访问https://localhost:5001/odata/Books地址,可得到所有Book数据。

{
    "@odata.context": "https://localhost:5001/odata/$metadata#Books",
    "value": [
        {
            "Id": 1,
            "ISBN": "111-0-321-56789-1",
            "Title": "Calculus",
            "Author": null,
            "Price": 66.6,
            "Address": {
                "City": "Shanghai",
                "Street": "Beijin Xi Road"
            }
        },
        {
            "Id": 2,
            "ISBN": "222-2-654-00000-2",
            "Title": "Linear Algebra",
            "Author": null,
            "Price": 53.2,
            "Address": {
                "City": "Shanghai",
                "Street": "Beijin Dong Road"
            }
        }
    ]
}

访问https://localhost:5001/odata/Books(1)地址,可得到key值为1的Book数据。

{
    "@odata.context": "https://localhost:5001/odata/$metadata#Books/$entity",
    "Id": 1,
    "ISBN": "111-0-321-56789-1",
    "Title": "Calculus",
    "Author": null,
    "Price": 66.6,
    "Address": {
        "City": "Shanghai",
        "Street": "Beijin Xi Road"
    }
}

高级查询

如果想要使用OData查询的高级功能,可以在注册终结点时额外加上相应的配置。

app.UseMvc(b =>
{
    b.Select().Expand().Filter().OrderBy().MaxTop(100).Count();
    b.MapODataServiceRoute("odata", "odata", GetEdmModel());
});

访问网址时加上所需的查询内容:

https://localhost:5001/odata/Books?$select=Id,Title

{
    "@odata.context": "https://localhost:5001/odata/$metadata#Books(Id,Title)",
    "value": [
        {
            "Id": 1,
            "Title": "Calculus"
        },
        {
            "Id": 2,
            "Title": "Linear Algebra"
        }
    ]
}

如果想要按特定条件过滤数据内容的话也很容易:

https://localhost:5001/odata/Books?$filter=Price%20le%2060

{
    "@odata.context": "https://localhost:5001/odata/$metadata#Books",
    "value": [
        {
            "Id": 2,
            "ISBN": "222-2-654-00000-2",
            "Title": "Linear Algebra",
            "Author": null,
            "Price": 53.2,
            "Address": {
                "City": "Shanghai",
                "Street": "Beijin Dong Road"
            }
        }
    ]
}

总结

不难看出,OData的真正魅力在于其对那些高级查询功能的支持,所以在创建RESTful API时,不妨考虑使用OData,这样应该能减少许多不必要的代码工作。

原文地址:https://www.cnblogs.com/kenwoo/p/10360260.html

时间: 2024-10-06 02:48:20

.NET Core开发日志——OData的相关文章

.NET Core开发日志——RequestDelegate

本文主要是对.NET Core开发日志--Middleware的补遗,但是会从看起来平平无奇的RequestDelegate开始叙述,所以以其作为标题,也是合情合理. RequestDelegate是一种委托类型,其全貌为public delegate Task RequestDelegate(HttpContext context),MSDN上对它的解释,"A function that can process an HTTP request."--处理HTTP请求的函数.唯一参数,

.NET Core开发日志——Entity Framework与PostgreSQL

Entity Framework在.NET Core中被命名为Entity Framework Core.虽然一般会用于对SQL Server数据库进行数据操作,但其实它还支持其它数据库,这里就以PostgreSQL作为例子. PostgreSQL PostgreSQL可以选用原生系统与Docker两种安装方式. Official Docker Package 在应用程序工程中添加相关的引用. dotnet add package Npgsql.EntityFrameworkCore.Postg

.Net Core开发日志——从搭建开发环境开始

.Net Core自2016年推出1.0版本开始,到目前已是2.1版本,在其roadmap计划里明年更会推出3.0版本,发展不可不谓之迅捷.不少公司在经过一个谨慎的观望期后,也逐步开始将系统升级至最新的.Net Core平台,所以现在开始进行.Net Core开发可谓正当其时. 因为.Net Core支持Windows系统以外的Linux与Mac系统,在选择开发环境时,并不需要局限在原有的Windows平台,这里我选用了Mac平台. 开发硬件设备是一台14年款的Apple Macbook Air

.Net Core开发日志——Peachpie

.Net Core的生态圈随着开源社区的力量不断注入至其中,正在变得越来越强盛,并且不时得就出现些有意思的项目,比如Peachpie,它使得PHP的代码迁移到.Net Core项目变得可能. 从创建简单的入门程序开始可以更容易地体会其特性. 首先安装Peachpie的模板: dotnet new -i Peachpie.Templates::* 接着创建项目: dotnet new web -lang PHP -o helloPHP 然后切换目录至Server文件夹运行程序: cd Server

.NET Core开发日志——简述路由

有过ASP.NET或其它现代Web框架开发经历的开发者对路由这一名字应该不陌生.如果要用一句话解释什么是路由,可以这样形容:通过对URL的解析,指定相应的处理程序. 回忆下在Web Forms应用程序中使用路由的方式: public static void RegisterRoutes(RouteCollection routes) { routes.MapPageRoute("", "Category/{action}/{categoryName}", "

.NET Core开发日志——Model Binding

ASP.NET Core MVC中所提供的Model Binding功能简单但实用,其主要目的是将请求中包含的数据映射到action的方法参数中.这样就避免了开发者像在Web Forms时代那样需要从Request类中手动获取数据的繁锁操作,直接提高了开发效率.此功能继承自ASP.NET MVC,所以熟悉上一代框架开发的工程师,可以毫无障碍地继续享有它的便利. 本文想要探索下Model Binding相关的内容,这里先从源码中找到其发生的时机与场合. 在ControllerActionInvok

.NET Core开发日志——Linux版本的SQL Server

SQL Server 2017版本已经可以在Linux系统上安装,但我在尝试.NET Core跨平台开发的时候使用的是Mac系统,所以这里记录了在Mac上安装SQL Server的过程. 最新的SQL Server没有专门为Mac系统准备安装包,但由于Mac系统上支持Docker,所以可以用一种变通的方式--在Docker内部安装Linux版本的SQL Server. 系统要求 因为我的Macbook Air型号比较老,硬件条件很一般,所以首先确定下是否满足安装SQL Server的条件.官方给

.NET Core开发日志——结构化日志

在.NET生态圈中,最早被广泛使用的日志库可能是派生自Java世界里的Apache log4net.而其后来者,莫过于NLog.Nlog与log4net相比,有一项较显著的优势,它支持结构化日志. 结构化日志,也被称为语义化日志.其作用有二,利于查询与方便分析. 当系统上线被广泛使用或者时间久远之后,日志的大量出现不可避免.且日志本身作为一种数据,也有其重要的价值.因此,如何有效地对其进行查询以及最大价值化地分析处理便成了一个重要的问题. 非结构化日志 对于日志的处理,需要权衡对开发者的友好性与

.Net Core开发日志——Global Tools

.Net Core 2.1引入了一个新的功能,Global Tools,其本质是包含控制台应用程序的nuget包,目前而言,还没有特别有用的工具,不过相信随着时间的推移,各种有创意或者实用性强的Global Tools会出现在大家的视野里. 安装一个Global Tools很简单,输入一条命令dotnet tool install -g dotnetsay,名为dotnetsay的工具便已经安装在特定目录下. OS Path Linux/macOS $HOME/.dotnet/tools Win