Files
serein-flow/Library/Api/ISereinIoc.cs

118 lines
4.8 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using System.Text;
namespace Serein.Library.Api
{
2024-10-11 19:31:34 +08:00
/// <summary>
/// <para>单例模式IOC容器内部维护了一个实例字典默认使用类型的FullName作为Key</para>
/// <para>如果以“接口-实现类”的方式注册那么将使用接口类型的FullName作为Key。</para>
2024-10-11 19:31:34 +08:00
/// <para>当某个类型注册绑定成功后,将不会因为其它地方尝试注册相同类型的行为导致类型被重新创建。</para>
/// </summary>
public interface ISereinIOC
{
/// <summary>
2024-10-11 19:31:34 +08:00
/// 慎用重置IOC容器除非再次注册绑定否则将导致不能创建注入依赖类的临时对象。
/// </summary>
/// <returns></returns>
ISereinIOC Reset();
/// <summary>
/// 通过指定类型的方式注册实例,该类型的实例由你提供
/// </summary>
/// <param name="type">实例类型</param>
/// <returns></returns>
ISereinIOC Register(Type type);
/// <summary>
/// 通过指定类型的方式注册实例该类型将由IOC容器自动创建
/// </summary>
/// <param name="type">实例类型</param>
/// <param name="getInstance">获取实例的回调函数</param>
/// <returns></returns>
ISereinIOC Register(Type type, Func<object> getInstance);
/// <summary>
/// 通过泛型的方式注册类型该类型将由IOC容器自动创建
/// </summary>
/// <typeparam name="T">实例类型</typeparam>
/// <returns></returns>
ISereinIOC Register<T>();
/// <summary>
/// 通过泛型的方式注册类型,该类型的实例由你提供
/// </summary>
/// <typeparam name="T">实例类型</typeparam>
/// <param name="getInstance">获取实例的回调函数</param>
/// <returns></returns>
ISereinIOC Register<T>(Func<T> getInstance);
2024-10-07 15:15:18 +08:00
/// <summary>
/// 注册接口的实例,该接口类型的实现类实例由你提供
/// </summary>
/// <typeparam name="TService">接口类型</typeparam>
/// <typeparam name="TImplementation">实例类型</typeparam>
/// <param name="getInstance">获取实例的回调函数</param>
/// <returns></returns>
ISereinIOC Register<TService, TImplementation>(Func<TService> getInstance) where TImplementation : TService;
/// <summary>
/// 注册接口的实现类
/// </summary>
/// <typeparam name="TService">接口类型</typeparam>
/// <typeparam name="TImplementation">实例类型</typeparam>
/// <returns></returns>
ISereinIOC Register<TService, TImplementation>() where TImplementation : TService;
/// <summary>
2024-10-11 19:31:34 +08:00
/// 获取类型的实例。如果需要获取的类型以“接口-实现类”的方式注册,请使用接口的类型。
/// </summary>
object Get(Type type);
2024-10-11 19:31:34 +08:00
/// <summary>
/// 获取类型的实例。如果需要获取的类型以“接口-实现类”的方式注册,请使用接口的类型。
/// </summary>
T Get<T>();
/// <summary>
/// <para>给定一个类型由IOC容器负责创建实例如果存在多个构造函数将由参数最多的构造函数开始尝试创建。</para>
2024-10-11 19:31:34 +08:00
/// <para></para>
/// </summary>
object CreateObject(Type type);
2024-10-11 19:31:34 +08:00
/// <summary>
/// <para>给定一个类型由IOC容器负责创建实例如果存在多个构造函数将由参数最多的构造函数开始尝试创建。</para>
2024-10-11 19:31:34 +08:00
/// <para></para>
/// </summary>
T CreateObject<T>();
/// <summary>
/// 给定一个实例,尽可能地在该实例中具有[AutoInjection]特性的属性上设置为IOC容器中已有的对应类型的对象。
/// </summary>
/// <typeparam name="T">对应的类型</typeparam>
/// <param name="instance">传入的实例</param>
/// <returns></returns>
T InjectDependenciesProperty<T>(T instance);
2024-10-11 19:31:34 +08:00
/// <summary>
/// 搜寻已注册的类型生成依赖关系依次实例化并注入依赖项缓存在由IOC容器维护的Map中直到手动调用Reset()方法。
/// </summary>
/// <returns></returns>
ISereinIOC Build();
/// <summary>
/// 从容器中获取某个类型的实例进行运行
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="action"></param>
/// <returns></returns>
ISereinIOC Run<T>(Action<T> action);
ISereinIOC Run<T1, T2>(Action<T1, T2> action);
ISereinIOC Run<T1, T2, T3>(Action<T1, T2, T3> action);
ISereinIOC Run<T1, T2, T3, T4>(Action<T1, T2, T3, T4> action);
}
}