springboot调⽤第三⽅接⼝_SpringBoot初始化⼏⼤招式,看了
终于明⽩了
背景
在⽇常开发时,我们常常需要 在SpringBoot 应⽤启动时执⾏某⼀段逻辑,如下⾯的场景:
获取⼀些当前环境的配置或变量
向数据库写⼊⼀些初始数据
连接某些第三⽅系统,确认对⽅可以⼯作..
在实现这些功能时,我们可能会遇到⼀些"坑"。为了利⽤SpringBoot框架的便利性,我们不得不将整个应⽤的执⾏控制权交给容器,于是
造成了⼤家对于细节是⼀⽆所知的。那么在实现初始化逻辑代码时就需要⼩⼼了,⽐如,我们并不能简单的将初始化逻辑在Bean类的构造
springboot框架的作用⽅法中实现,类似下⾯的代码:
@Componentpublic class InvalidInitExampleBean { @Autowired private Environment env; public InvalidInitExampleBean() { ActiveP
这⾥,我们在InvalidInitExampleBean的构造⽅法中试图访问⼀个⾃动注⼊的env字段,当真正执⾏时,你⼀定会得到⼀个空指针异常(NullPointerException)。
原因在于,当构造⽅法被调⽤时,Spring上下⽂中的Environment这个Bean很可能还没有被实例化,同时也仍未注⼊到当前对象,所以并不能这样进⾏调⽤。
下⾯,我们来看看在SpringBoot中实现"安全初始化"的⼀些⽅法:
1、 @PostConstruct 注解
@PostConstruct 注解其实是来⾃于 javax的扩展包中(⼤多数⼈的印象中是来⾃于Spring框架),它的作⽤在于声明⼀个Bean对象初始化
完成后执⾏的⽅法。
来看看它的原始定义:
The PostConstruct annotation is used on a method that needs to be executed after dependency injection is done to perform any initialization
也就是说,该⽅法会在所有依赖字段注⼊后才执⾏,当然这⼀动作也是由Spring框架执⾏的。
下⾯的代码演⽰了使⽤@PostConstruct的例⼦:
2、 InitializingBean 接⼝
InitializingBean 是由Spring框架提供的接⼝,其与@PostConstruct注解的⼯作原理⾮常类似。如果不使⽤注解的话,你需要让Bean实
例继承 InitializingBean接⼝,并实现afterPropertiesSet()这个⽅法。
下⾯的代码,展⽰了这种⽤法:
3、 @Bean initMethod⽅法
我们在声明⼀个Bean的时候,可以同时指定⼀个initMethod属性,该属性会指向Bean的⼀个⽅法,表⽰在初始化后执⾏。
如下所⽰:
然后,这⾥将initMethod指向init⽅法,相应的我们也需要在Bean中实现这个⽅法:
上⾯的代码是基于Java注解的⽅式,使⽤Xml配置也可以达到同样的效果:
该⽅式在早期的 Spring版本中⼤量被使⽤
4、构造器注⼊
如果依赖的字段在Bean的构造⽅法中声明,那么Spring框架会先实例这些字段对应的Bean,再调⽤当前的构造⽅法。此时,构造⽅法中的⼀些操作也是安全的,如下:
5、 ApplicationListener
ApplicationListener 是由 spring-context组件提供的⼀个接⼝,主要是⽤来监听 "容器上下⽂的⽣命周期事件"。它的定义如下:
这⾥的event可以是任何⼀个继承于ApplicationEvent的事件对象。对于初始化⼯作来说,我们可以通过监听ContextRefreshedEvent这个事件来捕捉上下⽂初始化的时机。如下⾯的代码:
在Spring上下⽂初始化完成后,这⾥定义的⽅法将会被执⾏。与前⾯的InitializingBean不同的是,通过ApplicationListener监听的⽅式是全局性的,也就是当所有的Bean都初始化完成后才会执⾏⽅法。
Spring 4.2 之后引⼊了新的 @EventListener注解,可以实现同样的效果:
6、 CommandLineRunner
SpringBoot 提供了⼀个CommanLineRunner接⼝,⽤来实现在应⽤启动后的逻辑控制,其定义如下:
这⾥的run⽅法会在Spring 上下⽂初始化完成后执⾏,同时会传⼊应⽤的启动参数。如下⾯的代码:
此外,对于多个CommandLineRunner的情况下可以使⽤@Order注解来控制它们的顺序。
7、 ApplicationRunner
与 CommandLineRunner接⼝类似, Spring boot 还提供另⼀个ApplicationRunner 接⼝来实现初始化逻辑。不同的地⽅在于ApplicationRunner.run()⽅法接受的是封装好的ApplicationArguments参数对象,⽽不是简单的字符串参数。
ApplicationArguments对象提供了⼀些⾮常⽅便的⽅法,可以⽤来直接获取解析后的参数,⽐如:
java -jar application.jar --debug --ip=xxxx
此时通过 ApplicationArguments的getOptionNames就会得到["debug","ip"]这样的值。
测试代码
下⾯,通过⼀个⼩测试来演⽰⼏种初始化⽅法的执⾏次序。
按如下代码实现⼀个复合式的Bean:
执⾏这个Bean的初始化,会发现⽇志输出如下:
所以,这⼏种初始化的顺序为:
1. 构造器⽅法
2. @PostConstruct 注解⽅法
3. InitializingBean的afterPropertiesSet()
4. Bean定义的initMethod属性⽅法
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论