Skip to content

1.AutoConfiguration和Bean

俞正东 edited this page Dec 5, 2022 · 17 revisions

让一个配置类去注册一些对象到DI容器内

  • 打了AutoConfiguration标签的Class就是配置类
  • 在AutoConfiguration标签的Class里面打了Bean标签的返回对象就是要注册到autofac容器的类

image

原理解释:

框架会扫描打了【AutoConfiguration】的class,然后会再扫描打了【Bean】标签的方法并且Invoke该方法,拿到方法返回的对象并默认是瞬时注册到DI容器中!

  • 瞬时的意思是:每次从容器中都是拿到一个新的对象
  • 对比单例的话:只有第一次从容器中拿会创建一个对象,后面再从容器中拿依然是这个,可以按照如下方式配置是否单例还是瞬时
    // Bean的注册默认是瞬时的,可以指定为单例的
    [Bean(AutofacScope = AutofacScope.SingleInstance)]
    public TestBeanScopeCls2 initTestBeanScopeCls2()
    {
        return new TestBeanScopeCls2();
    }

如果你希望本框架打了[Bean]和[Component]全部默认都是单例模式注册的话 可以全局配置:

var builder = new ContainerBuilder();
// autofac打标签模式
builder.RegisterModule(new AutofacAnnotationModule(typeof(TestBeanScope).Assembly).SetDefaultAutofacScopeToSingleInstance());
  • 顺序是: 优先使用[Bean]和[Component]注解的AutofacScope属性值,没有配置则用上面设置的全局Scope

AutoConfiguration标签支持下面几个参数配置

image

  • Key:如果指定key
  • OrderIndex:值越大越先处理

Bean标签支持下面几个参数配置

  • Key:如果指定key,如果一个类指定了多个可以根据key来区分
  • AutofacScope:默认是单例SingleInstance
  • InitMethod 当初始化完成后指定执行的方法
  • DestroyMethod 当容器Dispose前的时候指定执行的方法

AutoConfiguration的Key使用方法请查看下面的实例代码的注释

image

    //这个会加载
    [AutoConfiguration("Test")]
    public class MyConfig
    {
        [Bean]
        public MyModel GetMyModel()
        {
            return new MyModel
            {
                Name = "yuzd"
            };
        }
    }
    
    //这个不会被加载
    [AutoConfiguration("Prod")]
    public class MyConfig2
    {
        [Bean]
        public MyModel GetMyModel()
        {
            return new MyModel
            {
                Name = "yuzd"
            };
        }
    }
    
    // autofac打标签模式 并且调用了 SetAutofacConfigurationKey方法 指定了 Key 为 “Test”
    // 所有只会加载 打了且指定了Key=“Test”的AutoConfiguration标签class
    builder.RegisterModule(new AutofacAnnotationModule(typeof(MyConfig).Assembly).SetAutofacConfigurationKey("Test"));
    
    //这个会加载
    [AutoConfiguration]
    public class MyConfig
    {
        [Bean]
        public MyModel GetMyModel()
        {
            return new MyModel
            {
                Name = "yuzd"
            };
        }
    }
    
    //这个会被加载
    [AutoConfiguration]
    public class MyConfig2
    {
        [Bean]
        public MyModel GetMyModel()
        {
            return new MyModel
            {
                Name = "yuzd"
            };
        }
    }
    
    // autofac打标签模式 
    // 没有指定Key 所以 上面2个都会加载
    builder.RegisterModule(new AutofacAnnotationModule(typeof(MyConfig).Assembly));
    

Bean标签的方法的参数支持注入DI已存在的,或者Value标签

        //方法的参数支持注入DI已存在的,或者Value标签
        [Bean]
        public MyModel GetMyModel(OtherClass other,[Value("${connetionString}")] connetionString)
        {
            return new MyModel
            {
                Name = "yuzd"
            };
        }
        

AutoConfiguration本身注册自己是单例

打了AutoConfiguration的class也会被单例的形式注册到容器中

在业务代码里面的使用场景

  1. 使用Key指定可以实现不同的环境配置不同的对象到DI容器
  2. 一些复杂的对象实例可以使用Bean的方式注册的DI容器