c# - 在不公开 ORM 模型的情况下使用 OData 进行查询？

Question

在我的 web api 2 项目中，如果我想使用 OData 库(看起来很棒且非常诱人)来查询某些属性，这将迫使客户端知道我的数据库模型的确切属性。这是一个好习惯吗？有没有办法避免这种脱钩？

对于以下型号:

public class LetterEntity
    {
        public int Id {get; set;}

        public string Title {get; set;}

        public string Content {get; set;}

        public string Source {get; set;}

        public DateTime SendingTime {get; set;} 

        public string AnotherWierdString {get; set;
        ...
    }

    public class LetterDTO
    {
        public int Id {get; set;}

        public string Title {get; set;}

        public string LetterContent {get; set;}

        public string Source {get; set;}

        public DateTime SendingTime {get; set;} 
    }

    public class LetterInsideFolderDTO 
    {
        public string Title {get; set;}

        public string Source {get; set;}
    }


public class LettersController : ApiController
{
    // In this approach method, I hate the fact that a LetterEntity must be used for the query.
    [HttpGet]
    [Route("api/letters")]
    [EnableQuery]
    public IQueryable<LetterInsideFolderDTO> Get(ODataQueryOptions<LetterEntity> query) 
    { 
        IQueryable<Letter> letters = db.Letters;

        var afterQuery = query.ApplyTo(letters)

        IQueryable<LetterInsideFolderDTO> dtos = afterQuery.ProjectTo<LetterInsideFolderDTO>(afterQuery)

        return dtos;
    }


    // Is there a way to do something like the following?:  
    [HttpGet]
    [Route("api/letters")]
    [EnableQuery]
    public IQueryable<LetterInsideFolderDTO> Get(ODataQueryOptions<LetterDTO> query) 
    { 
        IQueryable<Letter> letters = db.Letters;

        // Convert the query to work on the entities somehow? Should I use a mapping between LetterDTO to LetterEntity?
        // I only have a map from LetterEntity to LetterDTO
        var afterQuery = query.ApplyTo(letters)

        IQueryable<LetterInsideFolderDTO> dtos = afterQuery.ProjectTo<LetterInsideFolderDTO>(afterQuery)

        return dtos;
    }
}

因为目前我直接在客户端查询中使用实体模型，所以客户端和服务器之间存在很强的耦合。例如，如果我想查询并获取 Content 字段中所有包含“abc”的字母，我需要路由到以下内容:

api/letters/?$filter=contains(Content,'abc')

如果明天我决定将该属性从“Content”更改为“LetterContent”，所有客户端代码都将被破坏。

我怎样才能超越它？

谢谢!

编辑:

请举个具体的例子，我还不明白 HATEOAS 是什么(如果这能帮助我解决这个问题)，文档服务如何帮助我？如果我决定更改我的 EDM 模型，它仍然会强制客户更改他们的代码吗？

Answer 1

我确实相信在大多数情况下直接公开您的实体是一种不好的做法。几乎在所有情况下我都会推荐 DTO。它允许您在不破坏 API 的情况下发展您的数据库和业务逻辑。 OData 有一些很好的用例，例如政府按原样发布数据的开放数据计划。

我必须构建一个应用程序，该应用程序本质上是基于数据的网格，具有所有过滤和排序选项。我想使用 OData，但我没有找到一种方法来查询实体，而是转换到 DTO，所以我构建了自己的库以将 jqgrid 过滤器转换为 IQueryable 查询 - https://github.com/KodarLtd/WebApiJQGridFilters请注意，我不建议使用此代码，因为它不是全功能库并且根本没有记录。我只是提供它作为我对 DTO 方法的坚定信念的证据。

我想被证明是错误的，这样我就可以使用 OData 但为我的下一个项目返回 DTO。