Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions 1.0.0-preview-1724277574

This is a prerelease version of Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions --version 1.0.0-preview-1724277574                
NuGet\Install-Package Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions -Version 1.0.0-preview-1724277574                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions" Version="1.0.0-preview-1724277574" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions --version 1.0.0-preview-1724277574                
#r "nuget: Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions, 1.0.0-preview-1724277574"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions as a Cake Addin
#addin nuget:?package=Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions&version=1.0.0-preview-1724277574&prerelease

// Install Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions as a Cake Tool
#tool nuget:?package=Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions&version=1.0.0-preview-1724277574&prerelease                

Rougamo.DI

Rougamo.DI provides a set of IoC/DI extensions for Rougamo that enhance the IoC/DI interaction experience when using Rougamo.

Available Extensions

Package Name Description
Rougamo.Extensions.DependencyInjection.AspNetCore Uses the official DependencyInjection and integrates with HttpContext to return the correct scoped IServiceProvider
Rougamo.Extensions.DependencyInjection.GenericHost Uses the official DependencyInjection, suitable for non-AspNetCore Generic Host projects
Rougamo.Extensions.DependencyInjection.Autofac.AspNetCore Uses Autofac and integrates with HttpContext to return the correct scoped ILifetimeScope
Rougamo.Extensions.DependencyInjection.Autofac Uses Autofac, suitable for non-AspNetCore projects
Rougamo.Extensions.DependencyInjection.Abstractions The base abstraction package for all other packages
Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions The base abstraction package for all AspNetCore-related packages

Versioning Guidelines

All version numbers follow the Semantic Versioning (SemVer) format

  1. The version numbers of the two foundational abstraction packages start from 1.0.0 and increase incrementally:
    • Rougamo.Extensions.DependencyInjection.Abstractions
    • Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions
  2. For Microsoft official DI extension packages, the major version matches the corresponding official package (e.g., Microsoft.Extensions.*):
    • Rougamo.Extensions.DependencyInjection.AspNetCore
    • Rougamo.Extensions.DependencyInjection.GenericHost
  3. For Autofac extension packages, the major version matches the corresponding official Autofac package:
    • Rougamo.Extensions.DependencyInjection.Autofac.AspNetCore
    • Rougamo.Extensions.DependencyInjection.Autofac

Rougamo.Extensions.DependencyInjection.AspNetCore

Quick Start

// Register Rougamo (Note: Rougamo does not require registration if you do not need IoC/DI features)
public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);
    // ... other setup steps
    builder.Services.AddRougamoAspNetCore();
    // ... other setup steps
}

// Accessing IServiceProvider in an aspect
public class TestAttribute : MoAttribute
{
    public override void OnEntry(MethodContext context)
    {
        // Use the extension method GetServiceProvider to obtain the IServiceProvider instance
        var services = context.GetServiceProvider();

        // Utilize IServiceProvider
        var xxx = services.GetService<IXxx>();
    }
}

Non-HttpContext Scope

By default, the extension method GetServiceProvider on MethodContext only attempts to retrieve the IServiceProvider for the current HttpContext scope. If there is no HttpContext, it will return the root IServiceProvider. This design assumes that in AspNetCore projects, scopes are typically not manually created. If you have a scenario where you need to manually create a scope, follow the steps below:

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);
    // ... other setup steps
    builder.Services.AddNestableHttpContextScopeAccessor();  // Additional registration step
    builder.Services.AddRougamoAspNetCore();
    // ... other setup steps
}

public class Cls(IServiceProvider services)
{
    public void M()
    {
        // Use the extension method CreateResolvableScope to create a scope.
        // If you use CreateScope, that scope will not be accessible in aspect types.
        using var scope = services.CreateResolvableScope();
    }
}

Rougamo.Extensions.DependencyInjection.GenericHost

// Register Rougamo (Note: Rougamo does not require registration if you do not need IoC/DI features)
public static void Main(string[] args)
{
    var builder = Host.CreateDefaultBuilder();
    // ... other setup steps
    builder.ConfigureServices(services => services.AddRougamoGenericHost());
    // ... other setup steps
}

// Accessing IServiceProvider in an aspect
public class TestAttribute : MoAttribute
{
    public override void OnEntry(MethodContext context)
    {
        // Use the extension method GetServiceProvider to obtain the IServiceProvider instance
        var services = context.GetServiceProvider();

        // Utilize IServiceProvider
        var xxx = services.GetService<IXxx>();
    }
}

Rougamo.Extensions.DependencyInjection.Autofac.AspNetCore

Quick Start

// Register Rougamo (Note: Rougamo does not require registration if you do not need IoC/DI features)
public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);
    builder.Host
            .UseServiceProviderFactory(new AutofacServiceProviderFactory())
            .ConfigureContainer<ContainerBuilder>(builder =>
            {
                builder.RegisterRougamoAspNetCore();
            });
    
    // Registering IHttpContextAccessor is also required
    builder.Services.AddHttpContextAccessor();
}

// Accessing ILifetimeScope in an aspect
public class TestAttribute : MoAttribute
{
    public override void OnEntry(MethodContext context)
    {
        // Use the extension method GetAutofacCurrentScope to obtain the ILifetimeScope instance
        var scope = context.GetAutofacCurrentScope();

        // Utilize ILifetimeScope
        var xxx = scope.Resolve<IXxx>();
    }
}

Non-HttpContext Scope

By default, the GetAutofacCurrentScope extension method on MethodContext only attempts to retrieve the ILifetimeScope for the current HttpContext. If there is no HttpContext, it will return the root IServiceProvider. This design assumes that in AspNetCore projects, scopes are typically not manually created. If you have a scenario where you need to manually create a scope, follow the steps below:

public static void Main(string[] args)
{
    var builder = WebApplication.CreateBuilder(args);
    builder.Host
            .UseServiceProviderFactory(new AutofacServiceProviderFactory())
            .ConfigureContainer<ContainerBuilder>(builder =>
            {
                builder.RegisterAutofacNestableHttpContextScopeAccessor(); // Additional registration step
                builder.RegisterRougamoAspNetCore();
            });
    
    // Registering IHttpContextAccessor is also required
    builder.Services.AddHttpContextAccessor();
}

public class Cls(IServiceProvider services)
{
    public void M()
    {
        // Use the extension method BeginResolvableLifetimeScope to create a scope.
        // If you use BeginLifetimeScope, that scope will not be accessible in aspect types.
        using var scope = services.BeginResolvableLifetimeScope();
    }
}

Rougamo.Extensions.DependencyInjection.Autofac

// Register Rougamo (Note: Rougamo does not require registration if you do not need IoC/DI features)
public static void Main(string[] args)
{
    var builder = Host.CreateDefaultBuilder();
    
    builder
        .UseServiceProviderFactory(new AutofacServiceProviderFactory())
        .ConfigureContainer<ContainerBuilder>(builder =>
        {
            builder.RegisterRougamo();
        });
}

// Accessing ILifetimeScope in an aspect
public class TestAttribute : MoAttribute
{
    public override void OnEntry(MethodContext context)
    {
        // Use the extension method GetAutofacCurrentScope to obtain the ILifetimeScope instance
        var scope = context.GetAutofacCurrentScope();

        // Utilize ILifetimeScope
        var xxx = scope.Resolve<IXxx>();
    }
}

Usage in Framework Projects

If your project is an older WebForm, WinForm, WPF, or similar project that does not use the Microsoft.Extensions.* packages, you can directly call the RegisterRougamo extension method when initializing the ContainerBuilder.

var builder = new ContainerBuilder();
builder.RegisterRougamo();
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Rougamo.Extensions.DependencyInjection.AspNetCore.Abstractions:

Package Downloads
Rougamo.Extensions.DependencyInjection.Autofac.AspNetCore

Provide extension methods to access Autofac in Rougamo aspect classes for AspNetCore projects.

Rougamo.Extensions.DependencyInjection.AspNetCore

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 231 9/18/2024
1.0.1-preview-1726204848 264 9/13/2024
1.0.0 531 8/21/2024
1.0.0-preview-1724277574 150 8/21/2024
1.0.0-preview-1724269602 185 8/21/2024

# Rougamo.DI

For more information, visit [release page on github](https://github.com/inversionhourglass/Rougamo.DI/releases).