自动配置本质需要3个类
- 服务类(功能类)
这也是starter的本质目标,提供服务,但是化简配置。注意,一定是需要配置的服务才有必要设置starter,然后在yml里面配置。比如web服务,redis服务,mongo服务等。如果是是java的Date类这种,它直接能提供日期服务,但是不需要配置,所以这类都不是化简的目标。
如果存在配置,那么服务类内部就一定就需要配置字段,这些字段里写入的就是配置信息。其实开发者也可以new出来一个服务对象(当然可以使用spring进行注入,省去new),然后手动设置这些配置内容也可以,实际开发中也有使用,比如prodb中配置rabbitmq的时候。但是更多时候我们想要通过yml配置,同时如果是最常用的配置希望框架帮自己配好。这是我们的期待,也是springboot帮我们做的。
提供的的服务对象,不一定是一个,可能是多个,比如kafka的自动配置,就能提供KafkaTemplate、ProducerFactory、ConsumerFactory等多个bean,每个bean都能提供一部分功能(服务)。这些个bean都是在执行类中配置的。
- 配置类
类名一般都叫XXXProperties。它的字段就是服务类的字段,一模一样。然后它能够和yml里面的配置项一一对应起来。配置项里的key就是字段名。通过 @ConfigurationProperties注解绑定。
- 执行类
类名一般都叫XXXAutoConfiguration。 执行配置操作,实例化一个服务对象,放入spring的容器,然后把pojo中的字段赋值给它,同时对大部分有必要的字段(配置项)设定默认值。这样我们就可以使用yml配置某项服务,然后在没有配置的时候也按照默认配置使用服务。
这个类上有 @ConditionalOnClass和@ConditionalOnProperty 注解,说明服务文件和配置项都存在的时候就进行配置并实例化。换句话说就是当你导入某个服务的jar包,并且配置了它的内容时候,你就能在代码中使用了。如果@ConditionalOnProperty 注解的 matchIfMissing = true 进行了设置,那么就只需要导入jar包就能使用了。当然,此时使用的配置是默认配置。你也可以修改成自己需要的配置。
能提供服务的类,就是执行类中函数返回的对象,被配置成了服务bean,函数内部会使用配置类中的配置字段去set服务类内部的字段。用户会使用这些bean的时候直接注入即可。比如RedisTemplate。(也可能不直接用,可能是被框架用,用户感觉不到存在,但是也发挥作用了)
关于注解:
- 服务类
不需要加注解的。在这个自动配置的体系里,它只需要提供功能,被执行类配置就行。
- 配置类
@ConfigurationProperties(prefix = "hello"),用于说明在yml的配置文件中,本配置的前缀是什么。
- 执行类
个数不定,一般会有如下几个:
@EnableConfigurationProperties(HttpEncodingProperties.class),括号中的对象就是配置内容类 。
@ConditionalOnClass(CharacterEncodingFilter.class),括号内的类存在的时候进行配置。如果classpath下有这个服务类,那么就进行配置。
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true),某个配置存在的时候才实例化这个关联类。
最后的配置
最后要有一个spring.factories文件来配置有哪些内容是自动注册的;比如指定数据库是自动注册的,Date服务是不用管的
用starter pom,不光是引入了相关依赖的jar包,而且由于jar包的引入,引入了相关的类,触发自动配置。那么这些引入的内容的配置都按照默认值配好了。
所有内容的自动触发设置在autoconfigure那个包里面,简单的配置每个都有上面说的3个类。一些复杂的配置,可能有n个配置类,然后有m个执行类,配置出x个功能类。比如web的配置。