.NET Core开发日志之OData（Open Data Protocol）

2023-08-29 03:31:06 81

简述

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

类库

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

dotnetaddpackageMicrosoft.AspNetCore.OData

准备模型类

publicclassAddress
{
publicstringCity{get;set;}
publicstringStreet{get;set;}
}
publicenumCategory
{
Book,
Magazine,
EBook
}
publicclassPress
{
publicintId{get;set;}
publicstringName{get;set;}
publicstringEmail{get;set;}
publicCategoryCategory{get;set;}
}
publicclassBook
{
publicintId{get;set;}
publicstringISBN{get;set;}
publicstringTitle{get;set;}
publicstringAuthor{get;set;}
publicdecimalPrice{get;set;}
publicAddressAddress{get;set;}
publicPressPress{get;set;}
}

创建Edm模型

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

privatestaticIEdmModelGetEdmModel()
{
varbuilder=newODataConventionModelBuilder();
builder.EntitySet("Books");
builder.EntitySet("Presses");
returnbuilder.GetEdmModel();
}

注册OData服务

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

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

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

注册OData终结点

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

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

显示元数据

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

创建Controller

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

publicclassBooksController:ODataController
{
privatestaticIListBooks{get;set;}
publicBooksController()
{
Books=newList
{
newBook
{
Id=1,
ISBN="111-0-321-56789-1",
Title="Calculus",
Price=66.6m,
Address=newAddress
{
City="Shanghai",
Street="BeijinXiRoad"
},
Press=newPress
{
Id=1,
Name="ShanghaiTongji",
Category=Category.Book
}
},
newBook
{
Id=2,
ISBN="222-2-654-00000-2",
Title="LinearAlgebra",
Price=53.2m,
Address=newAddress
{
City="Shanghai",
Street="BeijinDongRoad"
},
Press=newPress
{
Id=2,
Name="ShanghaiFudan",
Category=Category.EBook
}
}
};
}

[EnableQuery]
publicIActionResultGet()
{
returnOk(Books);
}

[EnableQuery]
publicIActionResultGet(intkey)
{
returnOk(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":"BeijinXiRoad"
}
},
{
"Id":2,
"ISBN":"222-2-654-00000-2",
"Title":"LinearAlgebra",
"Author":null,
"Price":53.2,
"Address":{
"City":"Shanghai",
"Street":"BeijinDongRoad"
}
}
]
}

访问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":"BeijinXiRoad"
}
}

高级查询

如果想要使用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":"LinearAlgebra"
}
]
}

如果想要按特定条件过滤数据内容的话也很容易：
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":"LinearAlgebra",
"Author":null,
"Price":53.2,
"Address":{
"City":"Shanghai",
"Street":"BeijinDongRoad"
}
}
]
}

总结

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

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对毛票票的支持。

.NET Core开发日志之OData（Open Data Protocol）

热门推荐

随机推荐