1 var services = new ServiceCollection(); 2 //方式一 AddDbContext註冊方式,會引發內存泄露 3 //services.AddDbContext<EFCoreDbContext>(options => options.UseSqlServer("connectionString")); 4 5 //方式二 使用AddScoped模擬AddDbContext註冊方式,new EFCoreDbContext()時參數由DI提供,會引發內存泄露 6 services.AddMemoryCache(); // 手動高亮點1 7 8 Action<DbContextOptionsBuilder> optionsAction = o => o.UseSqlServer("connectionString"); 9 Action<IServiceProvider, DbContextOptionsBuilder> optionsAction2 = (sp, o) => optionsAction.Invoke(o); 10 11 services.TryAdd(new ServiceDescriptor(typeof(DbContextOptions<EFCoreDbContext>), 12 p => DbContextOptionsFactory<EFCoreDbContext>(p, optionsAction2), 13 ServiceLifetime.Scoped)); 14 services.Add(new ServiceDescriptor(typeof(DbContextOptions), 15 p => p.GetRequiredService<DbContextOptions<EFCoreDbContext>>(), 16 ServiceLifetime.Scoped)); 17 18 services.AddScoped(s => new EFCoreDbContext(s.GetRequiredService<DbContextOptions<EFCoreDbContext>>())); 19 20 //方式三 直接使用AddScoped,new EFCoreDbContext()時參數本身提供。不會引發內存泄露 21 //var options = new DbContextOptionsBuilder<EFCoreDbContext>() 22 // .UseSqlServer("connectionString") 23 // .Options; 24 //services.AddScoped(s => new EFCoreDbContext(options)); 25 26 //爲了排除干擾,去掉靜態ServiceLocator 27 //ServiceLocator.Init(services); 28 //for (int i = 0; i < 1000; i++) 29 //{ 30 // var test = new TestUserCase(); 31 // test.InvokeMethod(); 32 //} 33 34 //去掉靜態ServiceLocator後的代碼 35 var rootServiceProvider = services.BuildServiceProvider(); // 這一句放在循環外就可避免內存泄露,挪到循環內就會內存泄露 36 for (int i = 0; i < 1000; i++) 37 { 38 using (var test = new TestUserCase(rootServiceProvider)) 39 { 40 test.InvokeMethod(); 41 } 42 }
2、上一步中引用的DbContextOptionsFactory<T>方法,放到Main方法後面便可html
private static DbContextOptions<TContext> DbContextOptionsFactory<TContext>(IServiceProvider applicationServiceProvider, Action<IServiceProvider, DbContextOptionsBuilder> optionsAction) where TContext : DbContext { var builder = new DbContextOptionsBuilder<TContext>( new DbContextOptions<TContext>(new Dictionary<Type, IDbContextOptionsExtension>())); builder.UseApplicationServiceProvider(applicationServiceProvider); // 手動高亮點2 optionsAction?.Invoke(applicationServiceProvider, builder); return builder.Options; }
3、EFCoreDbContext也作一些更改,不須要重寫OnConfiguring方法,構造方法參數類型改成DbContextOptions<EFCoreDbContext>git
public class EFCoreDbContext : DbContext { public EFCoreDbContext(DbContextOptions<EFCoreDbContext> options) : base(options) { } public DbSet<TestA> TestA { get; set; } }
services.AddMemoryCache()
和github
builder.UseApplicationServiceProvider(applicationServiceProvider);
他的原話是「我測試過,Asp.net core並無這個問題,EF6.x和EF core1.0也沒這個問題,只有.net core console + EF core2.0會出現內存泄露。
通過測試是Microsoft.Extensions.DependencyInjection1.0升級到Microsoft.Extensions.DependencyInjection2.0形成的,只在console出現。」
這句話中的Asp.net core沒有這個問題是有誤導的,經測試,這個問題在ASP.NET Core中照樣是有的,只不過平時你們在使用ASP.NET Core使用DI時通常都是直接獲取IServiceProvider的實例,而不會直接用到ServiceCollection,更不會循環屢次調用BuildServiceProvider。
就算在ASP.NET Core內部使用了ServiceCollection,通常也是用戶本身新建立的,和Startup.ConfigureServices(IServiceCollection services)內的services沒有關係。
而EF Core的註冊到通常也是註冊到services的,因此用戶本身建立的ServiceCollection也就和EF Core扯不上關係,更不會引發EF Core內存泄露了。
關於,ASP.NET Core中復現內存泄露,我後面會給出測試代碼。
由於微軟在官方給出的使用依賴注入的建議其中有兩項就是: 避免靜態訪問服務 應用程序代碼中避免服務位置(ServiceLocator) 文檔地址:https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/dependency-injection?view=aspnetcore-2.1
//EF Core內部生成緩存key的代碼 //代碼位置:Microsoft.EntityFrameworkCore.Internal.ServiceProviderCache //所在方法:IServiceProvider GetOrAdd(IDbContextOptions options, bool providerRequired) var key = options.Extensions .OrderBy(e => e.GetType().Name) .Aggregate(0L, (t, e) => (t * 397) ^ ((long)e.GetType().GetHashCode() * 397) ^ e.GetServiceProviderHashCode());
能夠看到方法簽名的其中一個參數是IDbContextOptions類型,並且key也是用它計算的。數據庫
var key = options.Extensions .OrderBy(e => e.GetType().Name) .Aggregate(0L, (t, e) => (t * 397) ^ ((long)e.GetType().GetHashCode() * 397) ^ e.GetServiceProviderHashCode()); Console.WriteLine($"EF Core當前DbContextOptions實例生成的緩存key爲:{key}");
果真,獲得的結果是:內存泄露時每次打印到的key值都不同,沒有內存泄露時打印出來的都同樣(測試代碼快速切換內存泄露/沒有內存泄露方法,將前面提到的 var rootServiceProvider = services.BuildServiceProvider() 這句移動到循環內/外便可)。api
詳細信息以下圖:緩存
public class EFCoreDbContext : DbContext { public EFCoreDbContext(DbContextOptions<EFCoreDbContext> options) : base(options) { //模擬生成EF Core 緩存key var key = options.Extensions .OrderBy(e => e.GetType().Name) .Aggregate(0L, (t, e) => (t * 397) ^ ((long)e.GetType().GetHashCode() * 397) ^ e.GetServiceProviderHashCode()); Console.WriteLine($"EF Core當前DbContextOptions實例生成的緩存key爲:{key}"); //打印一下影響生成緩存key值的對象名、HashCore、自定義的ServiceProviderHashCode var oExtensions = options.Extensions.OrderBy(e => e.GetType().Name); Console.WriteLine($"打印引發key變化的IDbContextOptionsExtension實例列表"); foreach (var item in oExtensions) { Console.WriteLine($"item name:{item.GetType().Name} HashCode:{item.GetType().GetHashCode()} ServiceProviderHashCore:{item.GetServiceProviderHashCode()}"); } //從上一步打印結果來看,oExtensions內包含兩個對象,SqlServerOptionsExtension和CoreOptionsExtension //SqlServerOptionsExtension的HashCode和ServiceProviderHashCode每次都同樣,不是變化因素,再也不跟蹤 //CoreOptionsExtension 用來表示由EF Core 管理的選項,而不是由數據庫提供商或擴展管理的選項。 //前面提到過的 builder.UseApplicationServiceProvider(applicationServiceProvider); //就是把當前使用的 ServiceProvider 賦值到 CoreOptionsExtension .ApplicationServiceProvider var coreOptionsExtension = options.FindExtension<CoreOptionsExtension>(); if (coreOptionsExtension != null) { var x = coreOptionsExtension; Console.WriteLine($"\n打印CoreOptionsExtension的一些HashCode\n" + $"GetServiceProviderHashCode:{x.GetServiceProviderHashCode()} \n" + $"HashCode:{x.GetHashCode()} \n" + $"ApplicationServiceProvider HashCode:{x.ApplicationServiceProvider?.GetHashCode()} \n" + $"InternalServiceProvider HashCode:{x.InternalServiceProvider?.GetHashCode()}"); //模擬GetServiceProviderHashCode的生成過程 var memoryCache = x.MemoryCache ?? x.ApplicationServiceProvider?.GetService<IMemoryCache>(); var loggerFactory = x.LoggerFactory ?? x.ApplicationServiceProvider?.GetService<ILoggerFactory>(); var isSensitiveDataLoggingEnabled = x.IsSensitiveDataLoggingEnabled; var warningsConfiguration = x.WarningsConfiguration; var hashCode = loggerFactory?.GetHashCode() ?? 0L; hashCode = (hashCode * 397) ^ (memoryCache?.GetHashCode() ?? 0L); hashCode = (hashCode * 397) ^ isSensitiveDataLoggingEnabled.GetHashCode(); hashCode = (hashCode * 397) ^ warningsConfiguration.GetServiceProviderHashCode(); if (x.ReplacedServices != null) { hashCode = x.ReplacedServices.Aggregate(hashCode, (t, e) => (t * 397) ^ e.Value.GetHashCode()); } Console.WriteLine($"\n模擬生成GetServiceProviderHashCode:{hashCode}"); if (x.GetServiceProviderHashCode() == hashCode) { Console.WriteLine($"模擬生成的GetServiceProviderHashCode和GetServiceProviderHashCode()獲取的一致"); } //打印GetServiceProviderHashCode的生成步驟,對比差別 Console.WriteLine($"\n影響GetServiceProviderHashCode值的因素"); Console.WriteLine($"loggerFactory:{loggerFactory?.GetHashCode() ?? 0L}"); Console.WriteLine($"memoryCache:{memoryCache?.GetHashCode() ?? 0L}"); Console.WriteLine($"isSensitiveDataLoggingEnabled:{isSensitiveDataLoggingEnabled.GetHashCode()}"); Console.WriteLine($"warningsConfiguration:{warningsConfiguration.GetServiceProviderHashCode()}"); } } public DbSet<TestA> TestA { get; set; } }
再次運行項目,截圖以下:app
第二次ide
第四次測試
能夠看到,雖然也有一些變化的地方,但變更的值沒有參與計算key,只有上圖我圈的部分才參與了key生成,因此緩存能夠獲得重用。ui
class Program { static void Main(string[] args) { var services = new ServiceCollection(); services.AddLogging(); //test 1 var options = new DbContextOptionsBuilder<EFCoreDbContext>() .UseSqlServer(Config.connectionString) .Options; ////test 2 模擬 AddDbContext //services.AddMemoryCache(/*c=> { c.ExpirationScanFrequency = new TimeSpan(0,0,5);c.CompactionPercentage = 1;c.SizeLimit = 20000; }*/); //Action<DbContextOptionsBuilder> optionsAction = o => o.UseSqlServer(Config.connectionString); //Action<IServiceProvider, DbContextOptionsBuilder> optionsAction2 = (sp, o) => optionsAction.Invoke(o); //services.TryAdd(new ServiceDescriptor(typeof(DbContextOptions<EFCoreDbContext>), p => //{ // Console.WriteLine($"正在從ServiceProvider[{p.GetHashCode().ToString()}]中獲取/建立DbContextOptions<EFCoreDbContext>實例"); // //Console.ReadKey(); // return DbContextOptionsFactory<EFCoreDbContext>(p, optionsAction2); //}, ServiceLifetime.Scoped)); //services.Add(new ServiceDescriptor(typeof(DbContextOptions), p => p.GetRequiredService<DbContextOptions<EFCoreDbContext>>(), ServiceLifetime.Scoped)); //這兩個註冊方式二選一, 使用第一行表示啓用test 1, 使用第二行表示啓用test 2 //services.AddScoped(s => new EFCoreDbContext(options)); //services.AddScoped(s => new EFCoreDbContext(s.GetRequiredService<DbContextOptions<EFCoreDbContext>>())); services.AddScoped<IMemoryCacheTest, MemoryCacheTest>(); services.AddDbContext<EFCoreDbContext>((p, o) => { Console.WriteLine($"UseInternalServiceProvider[{p.GetHashCode().ToString()}]"); o.UseSqlServer(Config.connectionString); }); //services.AddEntityFrameworkSqlServer().AddDbContext<EFCoreDbContext>((p,o)=> { // Console.WriteLine($"UseInternalServiceProvider[{p.GetHashCode().ToString()}]"); // o.UseSqlServer(Config.connectionString).UseInternalServiceProvider(p); }); ILogger log; var rootServiceProvider = services.BuildServiceProvider(); for (int i = 0; i < 10; i++) { Console.WriteLine($"rootServiceProvider[{rootServiceProvider.GetHashCode().ToString()}]"); //log = rootServiceProvider.GetService<ILoggerFactory>().AddConsole().CreateLogger<Program>(); //log.LogInformation("日誌輸出正常"); using (var test = new TestUserCase(rootServiceProvider)) { test.InvokeMethod(); } } //rootServiceProvider.Dispose(); //rootServiceProvider = null; Console.WriteLine("執行完畢,請按任意鍵繼續..."); Console.ReadKey(); } private static DbContextOptions<TContext> DbContextOptionsFactory<TContext>(IServiceProvider applicationServiceProvider, Action<IServiceProvider, DbContextOptionsBuilder> optionsAction) where TContext : DbContext { var builder = new DbContextOptionsBuilder<TContext>( new DbContextOptions<TContext>(new Dictionary<Type, IDbContextOptionsExtension>())); Console.WriteLine($"將ServiceProvider[{applicationServiceProvider.GetHashCode().ToString()}]設置爲ApplicationServiceProvider"); //Console.ReadKey(); builder.UseApplicationServiceProvider(applicationServiceProvider); optionsAction?.Invoke(applicationServiceProvider, builder); return builder.Options; } } //調試時使用查看一下當前系統內的緩存狀態 public interface IMemoryCacheTest { void Test(); } public class MemoryCacheTest : IMemoryCacheTest { private IMemoryCache _cache; public MemoryCacheTest(IMemoryCache memoryCache) { _cache = memoryCache; } public void Test() { var x = _cache.GetType(); } } public class TestUserCase : IDisposable { //private IServiceCollection services; private IServiceScope serviceScope; private IServiceProvider _serviceProvider; private EFCoreDbContext _context; public TestUserCase(/*IServiceCollection services,*/IServiceProvider serviceProvider) { //this.services = services; _serviceProvider = serviceProvider; } public void InvokeMethod() { //_serviceProvider = services.BuildServiceProvider(); using (serviceScope = _serviceProvider.GetRequiredService<IServiceScopeFactory>().CreateScope()) { var internalServiceProvider = serviceScope.ServiceProvider; Console.WriteLine($"獲取一個新的ServiceProvider[{internalServiceProvider.GetHashCode().ToString()}]"); Console.WriteLine($"獲取一個新的ServiceProviderType[{internalServiceProvider.GetType().GetHashCode().ToString()}]"); var memoryCache = internalServiceProvider?.GetService<IMemoryCache>(); var loggerFactory = internalServiceProvider?.GetService<ILoggerFactory>(); Console.WriteLine($"當前ServiceProvider.GetService<IMemoryCache>():{memoryCache.GetHashCode().ToString()}"); Console.WriteLine($"當前ServiceProvider.GetService<ILoggerFactory>():{loggerFactory.GetHashCode().ToString()}"); //using (_context = internalServiceProvider.GetRequiredService<EFCoreDbContext>()) //{ _context = internalServiceProvider.GetRequiredService<EFCoreDbContext>(); Printf(_serviceProvider, internalServiceProvider, _context, serviceScope); //} var cacheTest = _serviceProvider.GetRequiredService<IMemoryCacheTest>(); cacheTest.Test(); //(internalServiceProvider as IDisposable)?.Dispose(); //internalServiceProvider = null; } } public void Printf(IServiceProvider sp, IServiceProvider _serviceProvider, EFCoreDbContext _context, IServiceScope _serviceScope) { for (var i = 0; i < 100; i++) { var testA = _context.TestA.AsNoTracking().FirstOrDefault(); //_context.TestA.Add(new TestA() { Name = "test"}); //_context.SaveChanges(); Console.WriteLine($"RootSP:{sp.GetHashCode()} CurrentSP:{_serviceProvider.GetHashCode()} DbContext:{_context?.GetHashCode()} Index:{i}"); } } private bool disposed = false; public void Dispose() { Console.WriteLine($"{this.GetType().Name}.Dispose()..."); Dispose(true); GC.SuppressFinalize(this); } protected virtual void Dispose(bool disposing) { if (!this.disposed) { // Note disposing has been done. disposed = true; //serviceScope?.Dispose(); //serviceScope = null; //// ////(_serviceProvider as IDisposable)?.Dispose(); ////_serviceProvider = null; //_context?.Dispose(); //_context = null; } } } public class EFCoreDbContext : DbContext { public EFCoreDbContext(DbContextOptions<EFCoreDbContext> options) : base(options) { //模擬生成EF Core 緩存key var key = options.Extensions .OrderBy(e => e.GetType().Name) .Aggregate(0L, (t, e) => (t * 397) ^ ((long)e.GetType().GetHashCode() * 397) ^ e.GetServiceProviderHashCode()); Console.WriteLine($"EF Core當前DbContextOptions實例生成的緩存key爲:{key}"); //打印影響生成緩存key值的對象名、HashCore、自定義的ServiceProviderHashCode var oExtensions = options.Extensions.OrderBy(e => e.GetType().Name); Console.WriteLine($"打印引發key變化的IDbContextOptionsExtension實例列表"); foreach (var item in oExtensions) { Console.WriteLine($"item name:{item.GetType().Name} HashCode:{item.GetType().GetHashCode()} ServiceProviderHashCore:{item.GetServiceProviderHashCode()}"); } //從上一步打印結果來看,oExtensions內包含兩個對象,SqlServerOptionsExtension和CoreOptionsExtension //SqlServerOptionsExtension的HashCode和ServiceProviderHashCode每次都同樣,不是變化因素,再也不跟蹤 //CoreOptionsExtension 用來表示由EF Core 管理的選項,而不是由數據庫提供商或擴展管理的選項。 //上面的代碼中 builder.UseApplicationServiceProvider(applicationServiceProvider); 這句就是把當前 ServiceProvider 設置到該類型實例的 ApplicationServiceProvider 屬性 var coreOptionsExtension = options.FindExtension<CoreOptionsExtension>(); if (coreOptionsExtension != null) { var x = coreOptionsExtension; Console.WriteLine($"\n打印CoreOptionsExtension的一些HashCode\n" + $"GetServiceProviderHashCode:{x.GetServiceProviderHashCode()} \n" + $"HashCode:{x.GetHashCode()} \n" + $"ApplicationServiceProvider HashCode:{x.ApplicationServiceProvider?.GetHashCode()} \n" + $"InternalServiceProvider HashCode:{x.InternalServiceProvider?.GetHashCode()}"); //模擬GetServiceProviderHashCode的生成過程 var memoryCache = x.MemoryCache ?? x.ApplicationServiceProvider?.GetService<IMemoryCache>(); var loggerFactory = x.LoggerFactory ?? x.ApplicationServiceProvider?.GetService<ILoggerFactory>(); var isSensitiveDataLoggingEnabled = x.IsSensitiveDataLoggingEnabled; var warningsConfiguration = x.WarningsConfiguration; var hashCode = loggerFactory?.GetHashCode() ?? 0L; hashCode = (hashCode * 397) ^ (memoryCache?.GetHashCode() ?? 0L); hashCode = (hashCode * 397) ^ isSensitiveDataLoggingEnabled.GetHashCode(); hashCode = (hashCode * 397) ^ warningsConfiguration.GetServiceProviderHashCode(); if (x.ReplacedServices != null) { hashCode = x.ReplacedServices.Aggregate(hashCode, (t, e) => (t * 397) ^ e.Value.GetHashCode()); } Console.WriteLine($"\n模擬生成GetServiceProviderHashCode:{hashCode}"); if (x.GetServiceProviderHashCode() == hashCode) { Console.WriteLine($"模擬生成的GetServiceProviderHashCode和GetServiceProviderHashCode()獲取的一致"); } //打印GetServiceProviderHashCode的生成步驟,對比差別 Console.WriteLine($"\n影響GetServiceProviderHashCode值的因素"); Console.WriteLine($"loggerFactory:{loggerFactory?.GetHashCode() ?? 0L}"); Console.WriteLine($"memoryCache:{memoryCache?.GetHashCode() ?? 0L}"); Console.WriteLine($"isSensitiveDataLoggingEnabled:{isSensitiveDataLoggingEnabled.GetHashCode()}"); Console.WriteLine($"warningsConfiguration:{warningsConfiguration.GetServiceProviderHashCode()}"); } } public DbSet<TestA> TestA { get; set; } } public class TestA { public long Id { get; set; } public string Name { get; set; } }
循環20次以上就可看到這樣的提示。
爲英文很差的同窗獻上google翻譯(google真TM機智,把microsoft.com翻譯成google.com)