c# - 包括属性(property)但排除该属性(property)的属性(property)之一

Question

假设我的一个 Controller 中有这样的方法:

[Route("api/Products")]
public IQueryable<Product> GetProducts() {
    return db.Products
             .Include(p => p.Category);
}

使用它我可以从数据库中获取产品并包含其类别属性。

在我的 CategoryController 中我有这个方法:

[Route("api/Categories")]
public IQueryable<Category> GetCategories() {
    return db.Categories
             .Include(c => c.Parent)
             .Include(c => c.Products)
             .Include(c => c.SubCategories);
}

当我向 CategoryController 发送 GET 请求时，它按预期工作，我得到了类别、它的父类别、它的产品及其子类别。但是，当我向 ProductController 发送 GET 请求时，我不想包含所请求产品类别中的所有产品，我只需要有关该类别的基本信息。

那么，如何让 GetProducts() 返回数据库中的产品，包括每个产品的 Category 属性，但不包括类别的 Products 列表属性，仍然保留其他属性，如 id、title 等？

谢谢。

Answer 1

如评论中所述，第一步是禁用延迟加载。您可以通过从集合属性中删除 virtual 修饰符来做到这一点，这是永久性的，或者通过每个上下文实例禁用它，这是临时的:

context.Configuration.ProxyCreationEnabled = false;

(禁用代理创建也会禁用延迟加载，但会保持生成的对象更轻量级)。

在断开连接的情况下，例如 Web API，由于这种序列化程序-延迟加载级联，人们通常更喜欢默认禁用延迟加载。

但是，您无法阻止 Entity Framework 执行关系修正。加载 Product 会将其附加到上下文。 Include() - 将其类别附加到上下文，EF 将使用附加的产品填充它们的 Products 集合，无论您喜欢与否.循环引用仍然是个问题。

您可以通过使用 AsNoTracking 获取产品来稍微减少这种影响(这可以防止实体被附加，即更改跟踪):

return db.Products.AsNoTracking()
         .Include(p => p.Category);

现在类别将只有他们的 Products 填充它们所属类别的 Product。

顺便说一句，在断开连接的情况下，也最好使用 AsNoTracking。无论如何，实体永远不会被同一个上下文实例保存，这会提高性能。

解决方案

• 返回 DTO，而不是实体类型

通过使用 DTO 对象，您可以完全控制将被序列化的对象图。延迟加载不会让您感到惊讶。但是，是的，所需的 DTO 类的数量可能是巨大的。

• 返回匿名类型。

这会引起一些人的注意，因为我们不应该从方法中返回匿名类型，对吧？好吧，他们将操作方法​​保留为 Json 字符串，就像命名类型一样，而 javascript 客户端不知道其中的区别。你可能会说它只是让弱类型的 javascript 环境更近了一步。唯一的问题是命名的 DTO 类型用作(某种)数据协定，并且匿名类型可以(太)容易地更改并破坏客户端代码。

• 调整序列化程序。

您可以告诉 Json.Net 序列化程序忽略引用循环。直接使用JsonConvert，看起来是这样的:

var products = db.Products.AsNoTracking().Include(p => p.Category);
var setting = new JsonSerializerSettings
{
    Formatting = Newtonsoft.Json.Formatting.Indented, // Just for humans
    ReferenceLoopHandling = ReferenceLoopHandling.Ignore
};
var json = JsonConvert.SerializeObject(products, setting);

结合 AsNoTracking() 这将序列化具有空 Products 数组的类别 ("Products": [])，因为 Product - Category - Product 是一个引用循环。

在 Web API 中，有几种方法可以配置内置的 Json.Net 序列化程序，您可能需要这样做 per action method .

就个人而言，我更喜欢使用 DTO。我喜欢控制(也控制跨线的属性)并且我不特别喜欢依赖序列化程序来为我解决我忽略的事情。