EntityFramework Core饥饿加载忽略导航属性问题

前言

.NET Core项目利用EntityFramework Core作为数据访问层一直在进行中，一直没有过多的去关注背后生成的SQL语句，然后老大捞出日志文件一看，恩，有问题了，所以本文产生了，也是有点疑惑，若有知情者，还望告知。

EntityFramework Core忽略导航属性

在前面我们已经探讨过利用Serilog日志框架来输出日志，所以对于本节查询日志的输出依然借助Seilog。我们在Startup.cs类中Starup方法中是创建日志实例。

 Log.Logger = new LoggerConfiguration()
            .MinimumLevel.Debug()
            .WriteTo.RollingFile(Path.Combine(
                env.ContentRootPath, "{Date}.log"))
            .CreateLogger();

接着我们只需要将Serilog注入到日志管道中即可在Configure方法中注入。

 loggerFactory.AddSerilog();

完成上述日志输出只需要安装如下三个包即可。

接下来记录日志只需要在控制器类或者其他类构造函数注入即可。

    public class HomeController : Controller
    {
        private readonly ILogger _logger;

        private IBlogRepository _blogRepository;
        public HomeController(ILogger<HomeController> logger)
        {
            _logger = logger;
            _blogRepository = blogRepository;
        }
    }

关于EntityFramework Core中映射等就不再阐述，请参看前面EntityFramework Core系列。下面我们直接给出查询操作

        public async Task<IEnumerable<Post>> GetPosts()
        {
            var posts = await _context.Blogs
                   .AsNoTracking()
                   .Include(d => d.Posts)
                   .SelectMany(d => d.Posts)
                   .Select(p => new Post()
                   {
                       Id = p.Id,
                       Title = p.Title,
                       Content = p.Content
                   }).ToListAsync();

            return await Task.FromResult(posts);
        }

不必太纠结上述查询语句，当有多表查询时我们最终需要获取Blog中的Post，最终才有了上述语句。我们看到如下日志文件。

我们来查看其中生成的Linq语句。

继续往下看我们将看到如下语句：

2017-09-28 00:36:58.901 +08:00 [Warning] The Include operation for navigation: 'd.Posts' was ignored because the target navigation is not reachable in the final query results. To configure this warning use the DbContextOptionsBuilder.ConfigureWarnings API (event id 'CoreEventId.IncludeIgnoredWarning'). ConfigureWarnings can be used when overriding the DbContext.OnConfiguring method or using AddDbContext on the application service provider.

上述警告语句提示导航属性Posts被忽略了因为其未能到达最终的查询结果，但是最终我们还是能看到里面确确实实是有数据的。

然后查看EntityFramework Core官方文档已经说明了此情况何时发生。

当利用饥饿加载进行查询操作时，最终并未返回原实体的实例此时将忽略Include导航属性。但是上述最终还是返回了数据，这是不是就暗示着并未利用饥饿加载而是在内存中操作呢。然后通过SQL Profiler进行监控得知只生成了一条SQL语句。

到这里还是没明白官方文档中所叙述的忽略导航属性究竟是什么意思？如果忽略了导航属性上述利用Linq进行查询应该会出现异常才对或者不会进行内连接，不知所云。所以上述查询我们只能返回Blog，而非其他实体，例如如下：

        public async Task<IEnumerable<Blog>> GetPosts()
        {
            var posts = await _context.Blogs
                   .AsNoTracking()
                   .Include(d => d.Posts)
                   .ToListAsync();

            return await Task.FromResult(posts);
        }

或者

        public async Task<IEnumerable<Blog>> GetPosts()
        {
            var posts = await _context.Blogs
                   .AsNoTracking()
                   .Include(d => d.Posts)
                   .Select(b => b)
                   .ToListAsync();

            return await Task.FromResult(posts);
        }

通过在github上找到如下issue：【https://github.com/aspnet/EntityFrameworkCore/issues/7153】 文中所述在1.1版本中将优化这种查询，目前我所使用版本为1.1.2，既然能正确返回值为何还打印警告日志提醒呢，看来这并不是问题，虽然忽略了但是还是进行了优化查询能够正确查询出数据。

总结

该问题演示在EntityFramework Core 1.1.2版本中，既然给出了提示那么应该是未解决，如果未解决那么将出现性能问题，如果我们进行投影然后ToList，此时利用Include进行饥饿加载，但是Include却被忽略，此时将生成一条单个SQL语句来查询获取结果集中每个元素的导航属性。若Include未被忽略并按照我们设想进行表连接，此时性能会更好。文中日志记录显示Include被忽略，但是生成SQL语句没有问题，却还是输出日志警告提醒，这究竟是为何，郁闷？