OData – How It Work

前言

OData 是很冷门的东西, 用的人少, 开发的人少, 文档自然也少的可怜.

如果真的想用它, 多少要对它机制有点了解. 这样遇到 bug, 想扩展的时候才不至于完全没有路.

主要参考:

OData NxT 001: Project Proposal

OData NxT 002: OData Queries Deep Dive

OData Nxt 003: Converting Query String to AST

OData Nxt 004: Query to Expression (IQueryable)

OData Nxt 005: Expression to Query (Part 1)

OData 解决什么问题?

对我来说, OData 最重要的就是它的 Query. 甚至可以把它当成 client side 的 SQL query.

尤其在前后端分离后, 有了 OData 后端可以省下很多不必要的接口. 前端有了获取任意数据的能力, 而不需要总是依赖后端.

OData 怎样解决这些问题？

如果撇开具体实现, OData 其实只是定义了一个规范, Client 如何向后端表达想要的数据.

比如 products?$filter=category eq 'Phone' and price gt 100&$orderby=price

意思是想获取手机类价格大于 100 元的产品, 然后依据价格小到大排序.

从前我们也能表达这些, 只是没有规范而已. 比如: products?category=Phone&price=100&orderby=price

除了定义规范以外, 最重要的当然是实现.

最终的目的就是拿数据嘛. 所以 OData query -> SQL query 是必然的.

这个和 EF Core 做的事, 非常的像. 所以 OData 的实现手法也会很类型 EF Core.

在 ASP.NET Core, SQL query 一般上都是由 EF Core 来处理的. 它通过翻译 LINQ Expression Tree 生成 SQL Query.

OData 当然不会从造轮子, 所以 OData query > LINQ Expression Tree > SQL Query 就是它的路线图了. 前半段 OData 搞, 后半段依然交给 EF Core 完成.

Entity Data Model (EDM)

与 EF Core 类似, OData 也是从 Setup Model 开始. ODataEdmModel 里头就包含了所有的 Entity 结构和 Metadata

对了, OData 的 Entity 并不一定要和 EF Core 的 Entity 一摸一样哦, 当然如果不一样的话, 就需要通过 AutoMapper 之类的工具来帮忙做一些 conversion 的动作啦.

不然就没有办法一条龙顺顺 OData query > LINQ Expression Tree > SQL Query 了.

Routing

依据 EDM 的结构, Routing 基本就已经定了.

比如 entity name products 的话, 其 URL 就是 /products, /products/1, products(1), products/1/category 等等

Controller 的职责

Controller 有 3 个职责,

1. 和上面的 routing 做匹配, 可以通过 controller name 和 action name, 或者用 route attribute 方式, (注: 上面的 URL 是定了的, 这里只是 match 它而已, 而不是修改它哦)

2. 返回 IQueryable (结合 EF Core 通常这样做)

3. 获取 ODataQueryOptions, 调用 ApplyTo(IQueryable), 通过 LINQ Expression Tree 想办法获取最终数据 (没有用 EF Core 的话, 通常是这样做)

EnableQueryAttribute 的职责

它是一个 ActionFilterAttribute. 拦截 before/after action.

Before action 会把 URL query string 变成了 ODataQueryOptions, 同时也做了 validation, 比如 MaxExpansionDepth 等等

After action 会 apply query > to list > serialize (如果在 Action 里已经 apply 了, 它就不会再 apply 了)

Serializer

OData 的 response 除了数据以为, 还会附上其它 info, 比如 @odata.context, @odata.nextLink, @odata.count 等等

所以它并不是简单的 JSON response. 它有自己的 Serializer.

TODO

先写这么多, 等以后有更多细节时在补上

OData 常用资源：

Microsoft Docs

OData Blog

Hassan Habib Youtube For OData