Cyclops.DI

项目概述

Cyclops.DI是企服版框架中的依赖注入核心库，提供了增强型的依赖注入功能，扩展了.NET标准依赖注入容器的能力。该库不仅支持标准的依赖注入模式，还提供了基于接口的自动注册、AOP代理拦截、生命周期管理以及丰富的配置选项，使开发者能够构建更加灵活、可维护的企业级应用。

核心功能模块

1. 生命周期管理接口

1.1 依赖注入生命周期接口

• ITransient：瞬态生命周期接口，每次请求都会创建新实例
• IScoped：作用域生命周期接口，在同一作用域内共享一个实例
• ISingleton：单例生命周期接口，应用程序生命周期内只创建一次实例

这些接口直接继承自IDependency，为依赖注入提供了清晰的生命周期标识。

2. 服务描述符工具

2.1 服务描述符核心功能

• ServiceDescriptorUtil：服务描述符工具类，提供了丰富的服务注册和管理功能
• ServiceProviderUtil：服务提供者工具类，用于服务实例的获取和管理

2.2 主要功能点

• 生命周期解析：根据接口类型自动解析对应的ServiceLifetime
• 调度代理创建：支持创建AOP代理，实现方法拦截
• 自动注册：支持按类型自动注册服务到依赖注入容器
• 注入模式配置：支持多种服务注册模式（Self、All、SelfWithFirstInterface等）

3. AOP代理系统

3.1 代理基础架构

• AspectDispatchProxy：代理基类，提供方法拦截和代理功能
• AspectDispatchProxyGenerator：代理生成器，动态创建代理类型
• DispatchProxyHandler：代理处理器，处理代理方法的调用逻辑

3.2 代理功能特性

• 方法拦截：支持拦截服务方法的调用，在执行前后添加自定义逻辑
• 异常处理：可以在代理层面统一处理异常
• 性能监控：可以在方法调用前后记录性能指标
• 日志记录：自动记录服务方法的调用情况
• 授权验证：在方法执行前进行权限验证

4. 依赖注入特性

4.1 核心特性

• InjectionAttribute：注入特性，用于配置服务的注册行为
• SuppressProxyAttribute：抑制代理特性，用于标记不需要创建代理的类

4.2 注入配置选项

• Action：注入操作类型（Add、TryAdd等）
• Pattern：注入模式（Self、All、SelfWithFirstInterface等）
• Order：注入顺序，用于控制依赖注入的优先级
• Proxy：自定义代理类型，允许为特定服务指定自定义代理实现

5. 接口和抽象

5.1 核心接口

• IDependency：所有依赖注入类型的基础接口
• IDispatchProxy：调度代理接口，定义了代理的基本行为
• IGlobalDispatchProxy：全局调度代理接口，提供全局方法拦截功能

5.2 上下文和模型

• ProxyMethodResolverContext：代理方法解析上下文，包含方法调用的相关信息
• EnumInjectionActions：注入操作枚举，定义了支持的注入操作类型
• EnumInjectionPatterns：注入模式枚举，定义了支持的服务注册模式
• PackedArgs：打包参数，用于在代理调用中传递参数信息

技术栈

• 开发框架：.NET 8.0
• 项目类型：类库（Class Library）
• 核心依赖：
  • Microsoft.Extensions.DependencyInjection.Abstractions (10.0.0) - .NET依赖注入抽象
  • Cyclops.Common - 提供基础工具类支持

环境依赖要求

• .NET 8.0 SDK 或更高版本
• 引用的Cyclops.Common项目

安装与配置

安装方式

可以通过以下方式安装Cyclops.DI包：

1. NuGet包管理器：

   Install-Package TJC.Cyclops.DI

2. .NET CLI：

   dotnet add package TJC.Cyclops.DI

基本配置

在使用Cyclops.DI之前，需要在应用程序的启动类中进行配置：

using Cyclops.DI; public class Startup { public void ConfigureServices(IServiceCollection services) { // 自动注入所有实现了IDependency的类型（包含ITransient、IScoped、ISingleton） services.AutoInjectAllCustomerServices(); // 其他服务注册... } }

核心功能代码示例

1. 基础服务注册

1.1 通过接口注册服务

// 定义服务接口 public interface IUserService { User GetUserById(int id); void SaveUser(User user); } // 实现服务并指定生命周期 public class UserService : IUserService, IScoped { private readonly IDbContext _dbContext; public UserService(IDbContext dbContext) { _dbContext = dbContext; } public User GetUserById(int id) { return _dbContext.Users.FirstOrDefault(u => u.Id == id); } public void SaveUser(User user) { if (user.Id == 0) { _dbContext.Users.Add(user); } else { _dbContext.Users.Update(user); } _dbContext.SaveChanges(); } }

1.2 使用注入特性

// 使用InjectionAttribute配置注入行为 [Injection(Order = 10, Pattern = EnumInjectionPatterns.All)] public class ProductService : IProductService, ISingleton { // 服务实现... } // 抑制代理创建 [SuppressProxy] public class LoggingService : ILoggingService, ITransient { // 服务实现... }

2. AOP代理实现

2.1 创建自定义代理

// 创建自定义代理类 public class LoggingProxy : AspectDispatchProxy { public IServiceProvider Services { get; set; } public object Target { get; set; } private ILogger _logger; private ILogger Logger => _logger ??= Services.GetRequiredService<ILogger>(); protected override object Invoke(MethodInfo targetMethod, object[] args) { // 方法调用前 var methodName = targetMethod.Name; var className = Target.GetType().Name; Logger.Info($"[{className}.{methodName}] 开始执行"); try { // 执行实际方法 var result = targetMethod.Invoke(Target, args); // 方法调用后 Logger.Info($"[{className}.{methodName}] 执行完成"); return result; } catch (Exception ex) { // 异常处理 Logger.Error($"[{className}.{methodName}] 执行出错: {ex.InnerException?.Message}", ex); throw ex.InnerException ?? ex; } } }

2.2 使用自定义代理

// 在服务上指定自定义代理 [Injection(Proxy = typeof(LoggingProxy))] public class OrderService : IOrderService, IScoped { // 服务实现... } // 手动添加调度代理 public void ConfigureServices(IServiceCollection services) { // 手动添加调度代理 ServiceDescriptorUtil.AddDispatchProxy( services, typeof(IScoped), typeof(PaymentService), typeof(TransactionProxy), typeof(IPaymentService) ); }

3. 高级服务注册

3.1 自动注入配置

public void ConfigureServices(IServiceCollection services) { // 自动注入所有实现了IDependency的服务 services.AutoInjectAllCustomerServices(); // 其他配置... }

3.2 手动注册服务

public void ConfigureServices(IServiceCollection services) { // 手动注册服务 var injectionAttribute = new InjectionAttribute { Pattern = EnumInjectionPatterns.SelfWithFirstInterface, Action = EnumInjectionActions.Add }; ServiceDescriptorUtil.Register( services, typeof(IScoped), typeof(CustomerService), injectionAttribute, typeof(ICustomerService) ); }

4. 生命周期管理

4.1 不同生命周期的服务使用示例

// 服务层 - 作用域生命周期 public class UserService : IUserService, IScoped { private readonly IRepository _repository; // 假设也是IScoped private readonly ICacheService _cacheService; // 假设是ISingleton public UserService(IRepository repository, ICacheService cacheService) { _repository = repository; _cacheService = cacheService; } public User GetUser(int id) { // 优先从缓存获取 var cacheKey = $"user:{id}"; var user = _cacheService.Get<User>(cacheKey); if (user == null) { // 缓存未命中，从数据库获取 user = _repository.GetById<User>(id); // 更新缓存 if (user != null) { _cacheService.Set(cacheKey, user, TimeSpan.FromMinutes(30)); } } return user; } }

4.2 作用域创建和使用

public class SomeService { private readonly IServiceProvider _serviceProvider; public SomeService(IServiceProvider serviceProvider) { _serviceProvider = serviceProvider; } public void ProcessBatch(List<int> ids) { foreach (var id in ids) { // 为每个操作创建单独的作用域 using (var scope = _serviceProvider.CreateScope()) { var scopedService = scope.ServiceProvider.GetRequiredService<IScopedService>(); scopedService.Process(id); } } } }

使用注意事项

1. 接口继承顺序：实现类在继承ITransient、IScoped或ISingleton时，应确保它们是最后继承的接口之一，以避免类型解析问题

2. 生命周期使用建议：

   • 无状态服务优先使用ITransient
   • 数据库上下文等使用IScoped
   • 配置、缓存等全局服务使用ISingleton

3. 代理使用注意：

   • 代理会增加一定的性能开销，对性能敏感的场景应谨慎使用
   • 使用SuppressProxyAttribute可以对特定类禁用代理

4. 依赖注入循环引用：避免服务之间形成循环依赖，这可能导致服务初始化失败

5. 线程安全：在使用ISingleton服务时，务必确保其是线程安全的，特别是在并发环境下

6. 作用域管理：在长生命周期的服务中使用作用域服务时，应手动创建和管理作用域

7. 异常处理：在代理中捕获和处理异常时，注意保留原始异常信息，以便于调试

8. 服务注册顺序：对于有依赖关系的服务，应确保先注册被依赖的服务

9. 日志记录：在代理中添加日志时，注意控制日志级别，避免过多的日志影响性能

10. 内存管理：长时间运行的应用程序中，注意监控单例服务的内存使用情况，避免内存泄漏

贡献者

• yswenli

许可证

保留所有权利