翼度科技»论坛 编程开发 .net 查看内容

OData WebAPI实践-Non-EDM模式

5

主题

5

帖子

15

积分

新手上路

Rank: 1

积分
15
本文属于OData系列文章
前文说到了 EDM  与 OData 之间的关系,具有 EDM 的 OData 提供了强大的查询能力,但是 OData 并不必须要配置 EDM,我们也可以使用 Non-EDM 方案。
Non-EDM

所谓 Non-EDM ,并不是说在 OData 运行时不需要 EDM 配置了,而是由 OData 动态生成的 EDM,进而实现 OData 功能。
配置

配置 OData 就可以不需要在内配置 GetEdmModel()。当然,如果你需要配置路由,因为函数参数需要,我们可以返回一个默认的空 EDM。
  1.             services.AddControllers()
  2.                 .AddOData(opt => opt.Count().Filter().Expand().Select().OrderBy().SetMaxTop(5)
  3.                 );
复制代码
控制器

为了实现 OData 的功能,我们依然需要给控制器与函数上增加一些配置:
  1.         [ApiController]
  2.     [Route("api/[controller]")]
  3.     public class AccountsController : ControllerBase
  4.     {
  5.         [HttpGet]
  6.         public IActionResult Get(ODataQueryOptions<Account> queryOptions)
  7.         {
  8.             var querable = accounts.AsQueryable<Account>();
  9.             var finalQuery = queryOptions.ApplyTo(querable);
  10.             return Ok(finalQuery);
  11.         }
  12.         [HttpGet("{id}")]
  13.         public IActionResult Get(Guid id, ODataQueryOptions<Account> queryOptions)
  14.         {
  15.             var accountQuery = accounts.Where(c => c.AccountId == id);
  16.             if (!accountQuery.Any())
  17.             {
  18.                 return NotFound();
  19.             }
  20.             var finalQuery = queryOptions.ApplyTo(accountQuery.AsQueryable<Account>()) as IQueryable<dynamic>;
  21.             var result = finalQuery.FirstOrDefault();
  22.             if (result == null)
  23.             {
  24.                 return NotFound();
  25.             }
  26.             return Ok(result);
  27.         }
  28.     }
复制代码
这里代码使用了 ODataQueryOptions,因此没有使用 [EnableQuery]。
我们查看 OData 路由,Account 不在路径中了。

但是我们还是可以使用 OData 语法来进行查询:

细心的同学发现:

  • 我使用了 $count,但是返回的内容并没有计数结果。
  • 返回对象中没有 @odata.context 指示对应实体的 EDM 配置信息。
  • 在定义了 OData EDM 的对象中,返回数组类型是 "Value":[]  的形式,而没有定义 EDM 的对象会直接返回数组对象,这个在与前端进行交互的过程中需要特别注意。
限制

不使用 EDM 模式,在使用 OData 查询时还是有很多限制:

  • 类似$count 之类的语句暂时还不支持。
  • 不支持复杂对象(ComplexType)的 $select。
  • 无法配置 EntityType 的 Ignore ,不支持一些 OData 的高级特性。
  • 不能实现 OData Routing 映射,可能会造成 Versioning 之类的操作困难。
因此,还是建议在使用 OData 时使用并正确配置 EDM,这样可以获得最全面的 OData 特性支持。

来源:https://www.cnblogs.com/podolski/archive/2023/05/12/17395382.html
免责声明:由于采集信息均来自互联网,如果侵犯了您的权益,请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x

举报 回复 使用道具