Rougamo.Extensions.DependencyInjection.AspNetCore
4.0.0-priview-1723973798
New version strategy, see the following URL for details. https://github.com/inversionhourglass/Rougamo.DI/blob/master/README_en.md#versioning-guidelines.
See the version list below for details.
dotnet add package Rougamo.Extensions.DependencyInjection.AspNetCore --version 4.0.0-priview-1723973798
NuGet\Install-Package Rougamo.Extensions.DependencyInjection.AspNetCore -Version 4.0.0-priview-1723973798
<PackageReference Include="Rougamo.Extensions.DependencyInjection.AspNetCore" Version="4.0.0-priview-1723973798" />
paket add Rougamo.Extensions.DependencyInjection.AspNetCore --version 4.0.0-priview-1723973798
#r "nuget: Rougamo.Extensions.DependencyInjection.AspNetCore, 4.0.0-priview-1723973798"
// Install Rougamo.Extensions.DependencyInjection.AspNetCore as a Cake Addin #addin nuget:?package=Rougamo.Extensions.DependencyInjection.AspNetCore&version=4.0.0-priview-1723973798&prerelease // Install Rougamo.Extensions.DependencyInjection.AspNetCore as a Cake Tool #tool nuget:?package=Rougamo.Extensions.DependencyInjection.AspNetCore&version=4.0.0-priview-1723973798&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 | Purpose |
---|---|
Rougamo.Extensions.DependencyInjection.AspNetCore | Uses the official DependencyInjection with the current HttpContext to return the correct scoped IServiceProvider . |
Rougamo.Extensions.DependencyInjection.GenericHost | Uses the official DependencyInjection , designed for non-AspNetCore Generic Host projects. |
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>();
}
}
Product | Versions 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. |
-
.NETCoreApp 3.1
- Rougamo.Extensions.DependencyInjection.GenericHost (>= 4.0.0-priview-1723973798)
-
net5.0
- Rougamo.Extensions.DependencyInjection.GenericHost (>= 4.0.0-priview-1723973798)
-
net6.0
- Rougamo.Extensions.DependencyInjection.GenericHost (>= 4.0.0-priview-1723973798)
-
net7.0
- Rougamo.Extensions.DependencyInjection.GenericHost (>= 4.0.0-priview-1723973798)
-
net8.0
- Rougamo.Extensions.DependencyInjection.GenericHost (>= 4.0.0-priview-1723973798)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
8.0.1-preview-1726208425 | 110 | 9/13/2024 | |
8.0.0 | 310 | 8/21/2024 | |
7.0.1-preview-1726207796 | 98 | 9/13/2024 | |
7.0.0 | 153 | 8/21/2024 | |
6.0.1-preview-1726206834 | 91 | 9/13/2024 | |
6.0.0 | 153 | 8/21/2024 | |
4.0.0 | 143 | 8/18/2024 | |
4.0.0-priview-1723973798 | 129 | 8/18/2024 | |
3.0.1-preview-1726205321 | 106 | 9/13/2024 | |
3.0.0 | 148 | 8/21/2024 | |
3.0.0-preview-1724277574 | 122 | 8/21/2024 | |
3.0.0-preview-1724277179 | 131 | 8/21/2024 |
# Rougamo.DI
`Rougamo.DI`提供了一系列 Rougamo(https://github.com/inversionhourglass/Rougamo) 的IoC/DI扩展,使你在使用 [Rougamo](https://github.com/inversionhourglass/Rougamo) 时获得更好的IoC/DI交互体验。
## 当前扩展一览
| 包名 | 用途 |
|:------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------|
| [Rougamo.Extensions.DependencyInjection.AspNetCore](#rougamoextensionsdependencyinjectionaspnetcore) | 使用官方`DependencyInjection`,结合当前`HttpContext`,返回正确scope的`IServiceProvider` |
| [Rougamo.Extensions.DependencyInjection.GenericHost](#rougamoextensionsdependencyinjectiongenerichost) | 使用官方`DependencyInjection`,适用于非AspNetCore的Generic Host项目 |
## Rougamo.Extensions.DependencyInjection.AspNetCore
### 快速开始
```csharp
// 注册Rougamo(注:如果你不使用IoC/DI功能,Rougamo默认是不需要注册操作的)
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// ...省略其他步骤
builder.Services.AddRougamoAspNetCore();
// ...省略其他步骤
}
// 在切面类型中获取IServiceProvider实例并使用
public class TestAttribute : MoAttribute
{
public override void OnEntry(MethodContext context)
{
// 使用扩展方法GetServiceProvider获取IServiceProvider实例
var services = context.GetServiceProvider();
// 使用IServiceProvider
var xxx = services.GetService<IXxx>();
}
}
```
### 非HttpContext Scope
默认情况下通过`MethodContext`的扩展方法`MethodContext`只会尝试获取当前`HttpContext`对应scope的`IServiceProvider`,如果当前没有`HttpContext`,那么就会返回根`IServiceProvider`。这样的设计是因为一般而言我们不会在AspNetCore的项目中手动创建一个scope,如果你确实有手动创建scope的场景需求,请按如下的方式操作:
```csharp
public static void Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
// ...省略其他步骤
builder.Services.AddNestableHttpContextScopeAccessor(); // 额外注册步骤
builder.Services.AddRougamoAspNetCore();
// ...省略其他步骤
}
public class Cls(IServiceProvider services)
{
public void M()
{
// 调用扩展方法CreateResolvableScope创建scope,这里如果使用CreateScope来创建,那么这个scope将无法在切面类型中获取到
using var scope = services.CreateResolvableScope();
}
}
```
## Rougamo.Extensions.DependencyInjection.GenericHost
```csharp
// 注册Rougamo(注:如果你不使用IoC/DI功能,Rougamo默认是不需要注册操作的)
public static void Main(string[] args)
{
var builder = Host.CreateDefaultBuilder();
// ...省略其他步骤
builder.ConfigureServices(services => services.AddRougamoGenericHost());
// ...省略其他步骤
}
// 在切面类型中获取IServiceProvider实例并使用
public class TestAttribute : MoAttribute
{
public override void OnEntry(MethodContext context)
{
// 使用扩展方法GetServiceProvider获取IServiceProvider实例
var services = context.GetServiceProvider();
// 使用IServiceProvider
var xxx = services.GetService<IXxx>();
}
}
```