排除/包括导航属性

时间:2013-04-12 01:04:53

标签: c# entity-framework asp.net-mvc-4 asp.net-web-api

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

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; }
}

仅为此示例,我将使用

调用控制器内的实体上下文
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}

我的问题是,我如何从响应字符串中排除导航属性,但是当它们不为空或需要时,我仍希望能够包含导航属性。

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

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

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

更新

我已经找到了一种通过将结果映射到匿名类型来省略属性的方法(我也可以使用DTO),但仍然无法找到一种在需要时包含导航属性的简洁方法< / p>

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

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
}

正如您所看到的,代码开始变得重复和混乱。我希望有一种方法可以明确地链接导航属性,无论是否在执行查询之前请求它们。

1 个答案:

答案 0 :(得分:2)

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

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

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

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