Simple Injector v5.0.0 Release Notes

Release Date: 2020-06-11 // almost 4 years ago
  • ๐Ÿš€ Release Notes

    ๐Ÿš€ Simple Injector v5 is available through Nuget. For more background information about this release and a general overview, please read the blog post.

    โฌ†๏ธ Before you upgrade to v5.0, please make sure you upgrade your application to the latest 4.x version of Simple Injector first.

    ๐Ÿš€ For the release notes of the ASP.NET Core integration packages, go here.

    Overview

    ๐Ÿš€ The most prominent changes and improvements in this release are:

    • #692 No more .NET 4.0. We decided to drop support for the legacy version 4.0 of the .NET Framework. Minimum supported versions are .NET 4.5 and .NET Standard 1.0.
    • #557 No more first-chance exceptions. The chance of having your IDE stop at an exception that can safely be continued (a first-chance exception), are now much smaller.
    • #747 Container is now automatically verified when first resolved.
    • #780 Unregistered concrete types are no longer resolved.
    • #747 Simplified registration of disposable components. Disposables can now more easily be registered using Lifestyle.Scoped because Simple Injector now allows Transient dependencies to be injected without causing verification errors.
    • ๐ŸŽ #820: Registration/startup performance improved. We managed make your application load faster. In extreme cases startup performance is improved up to 60%.
    • #791 Asynchronous disposal. Container and Scope classes now implement IAsyncDisposable to allow asynchronous disposal of components (only in .NET 4.6.1, .NET Standard 2.0, and .NET Standard 2.1 versions)
    • ๐Ÿ“‡ #393 Injection of metadata. In more advanced scenarios, infrastructural components can benefit from receiving additional metadata for injected components. You can now out-of-the-box inject SimpleInjector.DependencyMetadata<TService> into your infrastructural components to get the actual implementation type, even when that component is intercepted with decorators. This also works for collections.

    ๐Ÿ’ฅ Breaking changes

    ๐Ÿ‘ Below you find the complete list of all the breaking changes in the core library and all officially supported integration libraries.

    Simple Injector core library

    • #747 Verification is now automatically performed upon the very first call to GetInstance(). You will be affected if you purposely skipped verifying the container. This behavior can be disabled by setting Container.Options.EnableAutoVerification = false;
    • #694 When calling RegisterConditional, the PredicateContext.Consumer property will now never return null, but instead it throws an exception. Use the new PredicateContext.HasConsumer property instead of checking for null. You will be affected when you checked PredicateContext.Consumer for null.
    • #816 Verification now allows Transient components to be injected into Scoped components by default. This behavior can be disabled by setting Container.Options.UseStrictLifestyleMismatchBehavior = true
    • ๐Ÿšš #393 The where TService : class type constraint was removed from InstanceProducer<TService>
    • InstanceProducer constructor became obsolete.
    • ๐Ÿ‘ป #700 Decorating container-uncontrolled collections with a singleton decorator will now throw an exception.
    • ๐Ÿšš #692 Removed support for .NET 4.0.
    • 0๏ธโƒฃ #557 ConstructorInfo GetConstructor(Type) method of IConstructorResolutionBehavior interface replaced with ConstructorInfo? TryGetConstructor(Type, out string?) method. You will be affected when you replaced the default constructor resolution behavior.
    • 0๏ธโƒฃ #557 void Verify(InjectionConsumerInfo) method of IDependencyInjectionBehavior interface replaced with bool VerifyDependency(InjectionConsumerInfo, out string?) method. You will be affected when you replaced the default dependency injection behavior.
    • ๐Ÿ”ง #780 Unregistered concrete types will not be resolved any longer. You will be affected when your configuration depends on unregistered concrete types. This behavior can be disabled by setting Container.Options.ResolveUnregisteredConcreteTypes = true;.
    • #275 Options.EnableDynamicAssemblyCompilation is now obsolete and replaced with a new Options.ExpressionCompilationBehavior.
    • ๐Ÿš€ #809 Several obsoleted methods and classes that previously caused compile errors (due to the use of the ObsoleteAttribute) have been removed. To prevent any problems, make sure you upgrade to the latest v4.x release first before upgrading to v5. Only upgrade to v5 after fixing all compiler warnings and errors .
    • #810 Several obsoleted properties, methods, and classes that where marked as obsoleted are now marked with Obsolete(error: true) which will cause a compiler error when used:
      • All AdvancedExtensions methods (IsLocked, IsVerifying, GetItem, SetItem, GetOrSetItem<T>, and AppendToCollection)
      • Container.RegisterCollection overloads (they have been replaced with Container.Collection.Register)
      • Container.RegisterSingleton overloads for registering already existing instances (they have been replaced with Container.RegisterInstance methods)
      • Scope's default constructor
    • ๐Ÿ’… #820: Lifestyle: protected Lifestyle.CreateRegistrationCore<T>(Container) method removed. You should now inherit from Lifestyle.CreateRegistrationCore(Type, Container). It has the same semantics.
    • ๐Ÿ’… #820: Registration: Type implemenationType and Func<object> instanceCreator = null parameters added to Registration constructor. You will be affected when you developed a custom lifestyle.
    • ๐Ÿ’… #820: Registration: BuildTransientDelegate<TService>(Func<TService>) removed. You can call BuildTransientDelegate() instead. You will be affected when you developed a custom lifestyle.
    • ๐Ÿ’… #820: Registration: BuildTransientExpression<TService>(Func<TService>) removed. You can call BuildTransientExpression() instead. You will be affected when you developed a custom lifestyle.

    ๐ŸŒ Packaging, WCF, Web, and Web API Integration

    • ๐Ÿš€ #809 Several obsoleted methods and classes have been removed. To prevent any problems, make sure you upgrade to the latest v4.x release first before upgrading to v5. Only upgrade to v5 after fixing all compiler warnings and errors

    API changes

    Simple Injector core library

    • ๐Ÿ’… #229 Lifestyle.Singleton.CreateRegistration(Type, object, Container) method added for the creation of Registration instances for already-created instances, including value types.
    • ๐Ÿ‘€ #694 PredicateContext.HasConsumer property added to see whether there is a consumer or the type is being resolved directly from the container.
    • ๐Ÿ’… #816 Options.UseStrictLifestyleMismatchBehavior property added that replaces the old Options.UseLoosenedLifestyleMismatchBehavior.
    • #393 InstanceProducer.ImplementationType property added.
    • ๐Ÿ“‡ #393 DependencyMetadata<TService> class added. You can now inject a DependencyMetadata<TService> or IEnumerable<DependencyMetadata<TService>> into a consumer to get metadata about the injected dependency.
    • #791 Container now implements IAsyncDisposable (only in .NET 4.6.1, .NET Standard 2.0, and .NET Standard 2.1 versions).
    • #791 Scope now implements IAsyncDisposable (only in .NET 4.6.1, .NET Standard 2.0, and .NET Standard 2.1 versions).
    • #557 static DependencyInjectionBehaviorExtensions class added with Verify extension method to mimic the old behavior of IDependencyInjectionBehavior.
    • #557 static ConstructorResolutionBehaviorExtensions class added with GetConstructor extension method to mimic the old behavior of IConstructorResolutionBehavior.
    • #810 Container.IsLocked property added.

    API Difs

    Complete list of bugs, features and improvements

    ๐Ÿ’… -#229 Remove the reference-type restriction from Container.RegisterConditional and Lifestyle.CreateRegistration

    • 0๏ธโƒฃ #747 Enable Automatically perform verification upon first resolve by default.
    • #694 Prevent PredicateContext.Consumer from returning null.
    • ๐Ÿ’… #816 Make 'loosened lifestyle mismatch behavior' the default.
    • ๐Ÿ“‡ #393 Allow dependency to be injected with additional metadata.
    • #791 Add IAsyncDisposable integration using Scope.AsyncDispose and Container.AsyncDispose.
    • ๐Ÿ‘ #700 Drop support for decorating uncontrolled collections using a singleton decorator.
    • ๐Ÿšš #692 Remove support for .NET 4.0.
    • #557 Prevent first-chance exceptions.
    • #589 Allow the registration and resolving of ActiveX / Proxy instances.
    • 0๏ธโƒฃ #780 Disable resolving concrete types by default.
    • ๐Ÿšš #275 Move Dynamic Assembly Compilation to different assembly.
    • ๐ŸŽ #820 Improve startup/configure performance by replacing. Lifestyle.CreateRegistrationCore<T>(Container) with Lifestyle.CreateRegistrationCore(Type, Container).
    • ๐Ÿ‘ป #818 Unresolved conditional root types lead to confusing exception message
    • #815 Resolving a stream collection always resolves the first instance