1. Spring IOC 基础
此部分内容是借鉴于凯涛的博客:IoC 之 2.1 IoC 基础 ——跟我学 Spring3
1.1 IoC 是什么
Ioc—Inversion of Control,即“控制反转”,不是什么技术,而是一种设计思想。在 Java 开发中,Ioc 意味着将你设计好的对象交给容器控制,而不是传统的在你的对象内部直接控制。如何理解好 Ioc 呢?理解好 Ioc 的关键是要明确“谁控制谁,控制什么,为何是反转(有反转就应该有正转了),哪些方面反转了”,那我们来深入分析一下:
- 谁控制谁,控制什么:传统 Java SE 程序设计,我们直接在对象内部通过 new 进行创建对象,是程序主动去创建依赖对象;而 IoC 是有专门一个容器来创建这些对象,即由 Ioc 容器来控制对象的创建;谁控制谁?当然是 IoC 容器控制了对象;控制什么?那就是主要控制了外部资源获取(不只是对象包括比如文件等)。
- 为何是反转,哪些方面反转了:有反转就有正转,传统应用程序是由我们自己在对象中主动控制去直接获取依赖对象,也就是正转;而反转则是由容器来帮忙创建及注入依赖对象;为何是反转?因为由容器帮我们查找及注入依赖对象,对象只是被动的接受依赖对象,所以是反转;哪些方面反转了?依赖对象的获取被反转了。
用图例说明一下,传统程序设计如图,都是主动去创建相关对象然后再组合起来:
当有了 IoC/DI 的容器后,在客户端类中不再主动去创建这些对象了,如图所示:
1.2 IoC 能做什么
IoC 不是一种技术,只是一种思想,一个重要的面向对象编程的法则,它能指导我们如何设计出松耦合、更优良的程序。传统应用程序都是由我们在类内部主动创建依赖对象,从而导致类与类之间高耦合,难于测试;有了 IoC 容器后,把创建和查找依赖对象的控制权交给了容器,由容器进行注入组合对象,所以对象与对象之间是松散耦合,这样也方便测试,利于功能复用,更重要的是使得程序的整个体系结构变得非常灵活。
其实 IoC 对编程带来的最大改变不是从代码上,而是从思想上,发生了“主从换位”的变化。应用程序原本是老大,要获取什么资源都是主动出击,但是在 IoC/DI 思想中,应用程序就变成被动的了,被动的等待 IoC 容器来创建并注入它所需要的资源了。
IoC 很好的体现了面向对象设计法则之一—— 好莱坞法则:“别找我们,我们找你”;即由 IoC 容器帮对象找相应的依赖对象并注入,而不是由对象主动去找。
1.3 IoC 和 DI
DI—Dependency Injection,即“依赖注入”:是组件之间依赖关系由容器在运行期决定,形象的说,即由容器动态的将某个依赖关系注入到组件之中。依赖注入的目的并非为软件系统带来更多功能,而是为了提升组件重用的频率,并为系统搭建一个灵活、可扩展的平台。通过依赖注入机制,我们只需要通过简单的配置,而无需任何代码就可指定目标需要的资源,完成自身的业务逻辑,而不需要关心具体的资源来自何处,由谁实现。
理解 DI 的关键是:“谁依赖谁,为什么需要依赖,谁注入谁,注入了什么”,那我们来深入分析一下:
- 谁依赖于谁:当然是应用程序依赖于 IoC 容器;
- 为什么需要依赖:应用程序需要 IoC 容器来提供对象需要的外部资源;
- 谁注入谁:很明显是 IoC 容器注入应用程序某个对象,应用程序依赖的对象;
- 注入了什么:就是注入某个对象所需要的外部资源(包括对象、资源、常量数据)。
IoC 和 DI 由什么关系呢?其实它们是同一个概念的不同角度描述,由于控制反转概念比较含糊(可能只是理解为容器控制对象这一个层面,很难让人想到谁来维护对象关系),所以 2004 年大师级人物 Martin Fowler 又给出了一个新的名字:“依赖注入”,相对 IoC 而言,“依赖注入”明确描述了“被注入对象依赖 IoC 容器配置依赖对象”。
1.4 IOC 初始化 bean 创建方式
在 IOC 容器在初始化的时候会将 bean 对象注入到容器中,提供给客户端类使用。IOC 容器的演变也给出了很多种 bean 对象的注入方式,主要的几种方式博主在这总结了一下,也许你在不知不觉中用过却没有察觉。
- XMl 方式,在 xml 文件中,使用
<bean></bean>
标签来实现定义类,然后通过对 xml 文件的加载,把指定的 bean 注入到容器中,这种方式在之前 Spring MVC 中用的很多,但是随着技术的革新,Spring Boot 逐渐替代 spring MVC,慢慢的这种配置使用的也越来越少。 - 注解方式,这种方式是当前使用最广泛的,最常用是
@Component
系列注解。 @Bean
注解方式,这个注解并不陌生,在之前 Spring MVC 占据主导的时候,使用的少,但是随着 Spring Boot 的兴起,这个注解用的越来越多。Spring MVC 的时候,我们创建 Redis 连接池、数据库连接池都是使用 xml 方式,但是在 Spring Boot 中,xml 很少见,而更多的是配置类(Configuration)和@Bean
注解配合,创建各种连接池的 bean 实例。@Conditional
注解方式,这个比较生僻,使用的场景不多,从字面上理解就是根据何种条件来创建对应的 bean。@Import
注解方式,这种方式下有很多实现的小点,也是值得学习的,虽然项目中基本用不上,但是可以作为下午茶时间的谈资。FactoryBean
创建方式,这里是通过实现FactoryBean
相关类来完成的,当然这里也是要配置@Bean
使用的。
2. IOC 初始化 bean 的 N 中方式分析
2.1 XML
配置文件的编写:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<!--初始化对象-->
<bean id="zdydoit" class="com.zdydoit.core.model.Person">
<property name="age" value="18"/>
<property name="name" value="zdydoit"/>
</bean>
</beans>
Person 实体类:
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/7 17:21
*/
public class Person {
public String name;
public Integer age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Person() {
}
public Person(String name, Integer age) {
this.name = name;
this.age = age;
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}
单元测试类:
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: xml方式向IOC容器中注入bean
*/
public class XmlInitTest {
@Test
public void xmlTest() {
ApplicationContext app = new ClassPathXmlApplicationContext("initBean.xml");
Person zdydoit = (Person) app.getBean("zdydoit");
System.out.println("===>" + zdydoit);
}
}
/*
输出结果:
===>Person{name='zdydoit', age=18}
*/
看输出的结果,输出的Person
实体类对象就是在 xml 中注入的。
2.2 @Bean
单独的@Bean
是不能完成初始化的过程,需要通过和@Configuration
注解配合完成。
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: 配置类
*/
@Configuration
public class AnnotationInit {
@Bean("zdydoit")
public Person person() {
return new Person("程序猿洞晓", 29);
}
}
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: 测试类
*/
public class AnnotationInitTest {
@Test
public void test() {
ApplicationContext app = new AnnotationConfigApplicationContext(AnnotationInit.class);
Person person = (Person) app.getBean("zdydoit");
System.out.println("===>" + person);
}
}
/*
输出结果:
===>Person{name='程序猿洞晓', age=29}
*/
通过@Bean
向容器中加入实例,可以通过注解的 value
属性指定实例的名称,也可以直接采用方法名作为实例名称(直接加注解,不设置属性值,默认方法名作为实例名称)。另外在 Spring 中,加入到容器中的实例,不在特殊指定的情况下,都是单例的。
2.3 @Conditional
在AnnotationInit
类中添加两个方法:
// 根据条件创建mac计算机实例
@Conditional(value = {MacCondition.class})
@Bean
public Computer macComputer() {
return new Computer("MAC", "19999");
}
// 根据条件创建win计算机实例
@Conditional(value = {WinCondition.class})
@Bean
public Computer winComputer() {
return new Computer("WIN", "9999");
}
创建条件类MacCondition
和WinCondition
,实现 Condition
接口,重写matchs
方法。
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: mac本创建的条件
*/
public class MacCondition implements Condition {
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
Environment environment = context.getEnvironment();
String osName = environment.getProperty("os.name");
if (osName.toLowerCase().contains("mac")) return true;
return false;
}
}
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: win电脑创建条件
*/
public class WinCondition implements Condition {
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
Environment environment = context.getEnvironment();
String osName = environment.getProperty("os.name");
if (osName.toLowerCase().contains("window")) return true;
return false;
}
}
单元测试类中添加test2
方法:
@Test
public void test2() {
ApplicationContext app = new AnnotationConfigApplicationContext(AnnotationInit.class);
for (String name : app.getBeanDefinitionNames()) {
System.out.println("===>" + name);
}
}
输出的结果如下:
……
……
===>zdydoit // Person实例
===>macComputer //Mac Computer实例
从结果可以看到,这里Person
实例和Computer
实例都生成了,但是WinComputer
没有生成。由此可见对于条件的判断是成功的。
2.4 @Import
这个使用也不是很多,这种导入方式也有几种不同的体现形式。下面来一一的介绍一下。
2.4.1 @Import 直接引入目标类
这种方式最简单,只要在配置类上加上@Import
注解,然后指定需要导入的目标类即可。代码如下:
// 直接加在AnnotationInit类上
@Import(value={Computer.class})
依然是运行上一步的测试代码test2
,得到的结果如下:
……
……
===>com.zdydoit.core.model.Computer //import导入的类
===>zdydoit // Person实例
===>macComputer //Mac Computer实例
这里通过@Import
加入到容器后的实例名是一个全类名,这个存在不方便,至少是在getBean
的时候比较麻烦。
2.4.2 实现 ImportSelector 接口
实现接口代码:
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: importSelector实现类
*/
public class ZdydoitSelector implements ImportSelector {
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
return new String[]{"com.zdydoit.core.model.Person"};
}
}
// AnnotationInit类上@Import注解添加ZdydoitSelector.class
@Import(value={Computer.class,ZdydoitSelector.class})
同样运行test2
的测试代码结果如下:
……
……
===>com.zdydoit.core.model.Computer //import导入的类
===>zdydoit // Person实例
===>macComputer //Mac Computer实例
===>com.zdydoit.core.model.Person //import导入的类
这种方式加入的实例名依然是全类名。
2.4.3 实现 ImportBeanDefinitionRegistrar 接口
实现接口代码:
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: ImportBeanDefinitionRegistrar实现类
*/
public class ZdyDoitBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
RootBeanDefinition definition = new RootBeanDefinition(Dog.class);
registry.registerBeanDefinition("singleDog", definition);
}
}
// AnnotationInit类上@Import注解添加ZdydoitSelector.class
@Import(value={Computer.class,ZdydoitSelector.class,ZdyDoitBeanDefinitionRegistrar.clas})
运行test2
的测试代码结果如下:
……
……
===>com.zdydoit.core.model.Computer //import导入的类
===>zdydoit // Person实例
===>macComputer //Mac Computer实例
===>com.zdydoit.core.model.Person //import导入的类
===>singleDog //import导入的类
这种方法和之前的有所不同,在容器中存储的名字并不再是全类名,而是可以自定义的,这个就更为的人性化。
如果在这三种方式给我选择的话,更为倾向的是第三种,但是不一定前两种就不使用,存在既有道理。
2.5 @Component 系列
@Component
系列,看其名就不止一个,继承了@Component
的注解都在这个系列之中,其中有@Controller
、@Service
、@Repository
,当然也包括@Component
本身。源码体现:
/**
* Indicates that an annotated class is a "component".
* Such classes are considered as candidates for auto-detection
* when using annotation-based configuration and classpath scanning.
*
* <p>Other class-level annotations may be considered as identifying
* a component as well, typically a special kind of component:
* e.g. the {@link Repository @Repository} annotation or AspectJ's
* {@link org.aspectj.lang.annotation.Aspect @Aspect} annotation.
*
* @author Mark Fisher
* @since 2.5
* @see Repository //一般用于dao层
* @see Service //一般用于service层
* @see Controller //一般用于controller层
* @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
//没有明确到dao、service、controller分层的模块实体类,采用Component
public @interface Component {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any
*/
String value() default "";
}
其实关于这个实现,并不陌生,每时每刻都在使用,这里就大概描述一下,在配置类上添加一个@ComponentScan(value = {"com.zdydoit.core.model"})
注解,value
值可以有多个,大括号里面可以接着写,逗号分隔即可。
这样就大功告成了,容器启动初始化的时候,会去扫描com.zdydoit.core.model
包,以及其子包,将加了@Component
系列注解的类都会创建 bean 并添加到容器中。
2.6 FactoryBean
FactoryBean
是一个能生产或者修饰对象生成的工厂 Bean,它的实现与设计模式中的工厂模式和修饰器模式类似,在这里也可以通过 FactoryBean
来实现 bean 的初始化和加入容器中。
代码实现:
/**
* @Author: 程序猿洞晓
* @Date: 2018/6/8
* @Project: lazy-scope
* @Desc: FactoryBean实现
*/
public class ZdydoitFactoryBean implements FactoryBean<Dog> {
public Dog getObject() throws Exception {
return new Dog("singleDog");
}
public Class<?> getObjectType() {
return Dog.class;
}
public boolean isSingleton() {
return true;
}
}
// 在AnnotationInit类中加入下面的方法
@Bean
public ZdydoitFactoryBean factoryBean() {
return new ZdydoitFactoryBean();
}
// 在测试类的test2方中加入下面的内容
// FactoryBean实现方式
Dog dog = (Dog)app.getBean("factoryBean");
System.out.println("===>"+dog);
运行后输出的结果是:
……
===>Dog{dogName='singleDog'}
在AnnotationInit
类中,返回的是ZdydoitFactoryBean
对象,但是这里在加入 IOC 容器后,会被再次封装和修饰,最后返回的是ZdydoitFactoryBean
对象,实际是其内部创建的Dog
对象的引用。在源码中有具体的代码体现,在最后的返回会去调用getObject()
方法。
如果这里确实需要得到 FactoryBean
实例的话,就使用这种方式:getBean("&factoryBean")
。(源码有体现)
这里先埋个坑,源码上的分析以后有时间再开博客具体解释一下。
3. 总结
每种实现方式都给出了对应是示例,可见各有优缺点,在实现项目中,我们并不会都用到,可能只会取其一两种实现方式,基本用到的就下面两种:
@Bean
配合@Configuration
注解实现 bean 的注入,常用在 Spring boot 下的 Redis 连接池、线程池等 bean 的初始化。@Component
系列注解,用于 Controller 层、Service 层等的 bean 注入。
为什么常用的就这两种,其他的也介绍呢。第一在别人和你聊这些的时候,你不至于一脸懵逼,第二偶尔自己也可以装装,增强自信心。最最重要的是面试造火箭是能用上的,虽然上班后的你只是拧螺丝。
4. 补充@ConditionalOnProperty 和@ConditionalOnExpression
最近在接触其他的项目,看到项目中用到其他一些创建 Bean 对象的方式,感觉挺有意思。也许用到的少,不过可以作为一个不错谈资。这两个注解都是和配置文件相结合使用的,可以通过配置文件来指定,确定对象是否创建,这让对象的创建过程更灵活。下面来看看这两个注解具体怎么使用。
4.1 @ConditionalOnProperty
根据属性是否符合来确定是否要创建这个 Bean 对象,看一下这个注解的源码:
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {
/**
* 用来和prefix组合,得到一个完整的属性key
*/
String[] value() default {};
/**
* prefix用来表示属性key的前缀,常与value或者name联合使用
*/
String prefix() default "";
/**
* 和value的使用方法基本相同
*/
String[] name() default {};
/**
* 用来和属性key对应的属性值做比较,相等则返回true
*/
String havingValue() default "";
/**
* 根据属性值是否存在来确定是否加载当前这个类
*/
boolean matchIfMissing() default false;
/**
* 是否可以松散匹配
*/
boolean relaxedNames() default true;
}
使用实例:
application.properties
配置文件中配置了用户的手机号user.phone=13511223344
代码类中使用注解
@ConditionalOnProperty
//场景1:这个使用会到配置文件中找user.phone对应的属性值,显然这个属性值是和注解中havingValue定义的值相同,条件最终结果是true,ConditionalOnPropertyUser对象会被创建并注入到IOC容器中 @ConditionalOnProperty(prefix="user",value="phone",havingValue="13511223344") public class ConditionalOnPropertyUser{ } //场景2:此时在配置文件中并没有找到user.address属性值,此时就会匹配matchIfMissing,matchIfMissing没有指定,默认值是false,条件最终结果是false,对象不会被创建 @ConditionalOnProperty(prefix="user",value="address",havingValue="上海") public class ConditionalOnPropertyUser{ } //场景2:此时在配置文件中并没有找到user.address属性值,但是定义了matchIfMissing为true,表示没有找到返回最终条件结果为true,此时还是被创建 @ConditionalOnProperty(prefix="user",value="address",havingValue="上海",matchIfMissing=true) public class ConditionalOnPropertyUser{ }
4.2 @ConditionalOnExpression
其实这个和上面差不多,同样是从配置文件中获取对应的属性值,完成表达式的编写,根据表达式最终返回的结果来确定是否做对象的创建,使用的是 SpEL
表达式。这个注解的属性值只有一个value
。看源码如下:
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnExpressionCondition.class)
public @interface ConditionalOnExpression {
/**
* 默认就是返回true
* The SpEL expression to evaluate. Expression should return {@code true} if the
* condition passes or {@code false} if it fails.
* @return the SpEL expression
*/
String value() default "true";
}
使用实例:
application.properties
配置文件中有以下属性user.phone=13512121212 user.address=上海
代码中使用
@ConditionalOnExpression
注解//${user.age:null},首先从配置文件中找user.age对应的属性值,如果不存在,设置默认值为null //根据SpEL表达式得到最终判断结果,如果是true则创建对象,如果是false则不创建。 @ConditionalOnExpression("'${user.age:null}'=='null' && '${user.phone:null}'=='13512121212' && '${user.address:null}'=='上海'") public class ConditionalOnExpressionUser{ }