项目场景:springboot 配置定时任务
springboot项目中配置定时任务开关,控制多任务的开始结束
问题描述:
遇到的问题就是如下注解:
通过在配置文件中配制定时任务的开关,然后通过该注解读取,项目启动一直报错,如下图项目的配置:
@ConditionalOnProperty(prefix = "scheduling", name = "enabled", havingValue = "true")
如果配置文件的scheduling.enabled=true,那么项目启动不会报错。
如果把配置文件的开关改为false,那么项目启动报错。
@ConditionalOnProperty(prefix = "scheduling", name = "enabled", havingValue = "true")
原因分析:
启动的时候报的错误为,找不到ForecastScheduleTask这个类。该类不能被加载到容器中。
分析:首先要知道@ConditionalOnProperty注解的用处,有三个参数,prefix+name是用来读取配置文件的属性名的,havingValue表示配置文件中开关对应的值。如果代码中name为空,则直接返回false任务不执行(该类也不会被加载进spring容器)。如果name不为空则用havingValue的值和配置文件中的值比较,相同返回true,不同返回false。关键点来了:比较以后,如果为true那么该类就会被加载进spring容器中,如果不是那么就不会被加载。即使你在该类上加了@Comonent也不会被扫描加载进容器。
正常情况下这样是没问题的,但是假如ForecastScheduleTask这个类,在其他地方被注入了呢?比如我再其他controller里面注入了这个类或者其他server注入该类,结果那就是启动报错,因为加载其他类到容器里时候ForecastScheduleTask却不能被加载进容器
启动的时候就会报找不到该类。
解决方案:
问题的原因找到了,解决方法就是在其他类中不要注入ForecastScheduleTask这个类。如果要用该类的方法,可以把这些公用的方法抽取出来单独建立一个service。
总结:
@ConditionalOnProperty注解和@Component注解,当@ConditionalOnProperty注解返回的为false时候,使用该注解的类是不会被加载的。