c# - 排除/包括导航属性

Question

我有以下实体类，其中包含两个标量属性和两个导航属性

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

    public string Name { get; set; }

    public ICollection<ArtistGenre> ArtistGenres { get; set; }

    public ICollection<ArtistImage> ArtistImages { get; set; }
}

就此示例而言，我会调用 Controller 内的实体上下文

using (var revrbContext = new RevrbContext())
{
    var response = revrbContext.Artists.Find(1);

    return Request.CreateResponse(HttpStatusCode.OK, response);
}

响应数据确实是这样的

{"Id":1,"Name":"Test","ArtistGenres":null,"ArtistImages":null}

我的问题是，我将如何从响应字符串中排除导航属性，但我仍然希望在它们不为 null 或需要时包含导航属性。

理想情况下，我想做这样的事情来包含导航属性

http://somewebsite.com/api/artist?id=1&bucket=genres&bucket=images

但是，如果 URL 不继续任何存储桶参数，则响应不应包含任何相应的导航属性。

更新

我想出了一种通过将结果映射到匿名类型来省略属性的方法(我也可以使用 DTO)，但仍然无法找到一种在需要时包含导航属性的干净方法

将实体类型和单个导航属性映射到匿名类型:

var response =
await
revrbContext.Artists.Include("ArtistGenres.Genre")
            .Where(artist => artist.Id == 1)
            .Select(artist => new
                {
                    artist.Id,
                    Genre = artist.ArtistGenres.Select(
                                        article => new {article.Genre.Name})
                }).FirstOrDefaultAsync();

但是，如果我想包含多个导航属性，我可以有这样的东西:

if (bucket.Contains("images") && bucket.Contains("genres"))
{
    var response =
        await
        revrbContext.Artists.Include("ArtistArticles.Article")
                                .Include("ArtistImages.Image")
                                ...etc
}

if (bucket.Contains("images"))
{
    var response =
        await
        revrbContext.Artists.Include("ArtistImages.Image")
                            ...etc
}

如您所见，代码开始变得重复和困惑。我希望有一种方法可以明确地链接导航属性，无论它们是否在执行查询之前被请求过。

Answer 1

Asp.Net Web API 在幕后使用 Json.Net 进行 JSON 序列化。在这种情况下，您可以将序列化程序设置为忽略空属性值。换句话说，当属性的值为 null 时，它不会出现在输出中。

为此，将以下行添加到 App_Start 文件夹中的 WebApiConfig.cs 文件:

config.Formatters.JsonFormatter.SerializerSettings.NullValueHandling = 
    Newtonsoft.Json.NullValueHandling.Ignore;

然后您可以按照您的建议在您的方法中使用 URL 参数来确定是否在您的对象上设置这些属性值，从而有选择地将它们包含在响应中。