关于spring:小伙伴们在催更Spring系列于是我写下了这篇注解汇总

39次阅读

共计 10955 个字符，预计需要花费 28 分钟才能阅读完成。

写在后面

因为在更新其余专题的文章，Spring 系列文章有很长一段时间没有更新了，很多小伙伴都在公众号后盾留言或者间接私信我微信催更 Spring 系列文章。

看来是要持续更新 Spring 文章了。想来想去，写一篇对于 Spring 中注解相干的文章吧，因为之前更新 Spring 系列的文章始终也是在更新 Spring 注解驱动开发。这篇文章也算是对之前文章的一个小小的总结吧，预计更新完这篇，咱们会进入 Spring 的 AOP 章节的更新。

没有看过 Spring 其余文章的小伙伴，能够到【冰河技术】公号的【Spring 系列】专题中进行浏览。

文章已收录到：

https://github.com/sunshinelyz/technology-binghe

https://gitee.com/binghe001/technology-binghe

xml 配置与类配置

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/sp
    <bean id="person" class="com.binghe.spring.Person"></bean>
</beans>

获取 Person 实例如下所示。

public static void main(String[] args ){ClassPathXmlApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml");
    System.out.println(ctx.getBean("person"));
}

2. 类配置

@Configuration
public class MainConfig {
    @Bean
    public Person person(){return new Person();
    }
}

这里，有一个须要留神的中央：通过 @Bean 的模式是应用的话，bean 的默认名称是办法名，若 @Bean(value=”bean 的名称 ”)那么 bean 的名称是指定的。

获取 Person 实例如下所示。

public static void main(String[] args ){AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(MainConfig.class);
    System.out.println(ctx.getBean("person"));
}

@CompentScan 注解

咱们能够应用 @CompentScan 注解来进行包扫描，如下所示。

@Configuration
@ComponentScan(basePackages = {"com.binghe.spring"})
    public class MainConfig {}

excludeFilters 属性

当咱们应用 @CompentScan 注解进行扫描时，能够应用 @CompentScan 注解的 excludeFilters 属性来排除某些类，如下所示。

@Configuration
@ComponentScan(basePackages = {"com.binghe.spring"},excludeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Controller.class}),
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,value = {PersonService.class})
})
public class MainConfig {}

includeFilters 属性

当咱们应用 @CompentScan 注解进行扫描时，能够应用 @CompentScan 注解的 includeFilters 属性将某些类蕴含进来。这里须要留神的是：须要把 useDefaultFilters 属性设置为 false（true 示意扫描全副的）

@Configuration
@ComponentScan(basePackages = {"com.binghe.spring"},includeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Controller.class, PersonService.class})
},useDefaultFilters = false)
public class MainConfig {}

@ComponentScan.Filter type 的类型

  • 注解模式的 FilterType.ANNOTATION @Controller @Service @Repository @Compent
  • 指定类型的 FilterType.ASSIGNABLE_TYPE @ComponentScan.Filter(type =FilterType.ASSIGNABLE_TYPE,value = {Person.class})
  • aspectj 类型的 FilterType.ASPECTJ(不罕用)
  • 正则表达式的 FilterType.REGEX(不罕用)
  • 自定义的 FilterType.CUSTOM
public enum FilterType {
    // 注解模式 比方 @Controller @Service @Repository @Compent
    ANNOTATION,
    // 指定的类型
    ASSIGNABLE_TYPE,
    //aspectJ 模式的
    ASPECTJ,
    // 正则表达式的
    REGEX,
    // 自定义的
    CUSTOM
}

FilterType.CUSTOM 自定义类型

public class CustomFilterType implements TypeFilter {
@Override
public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
    // 获取以后类的注解源信息
    AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
    // 获取以后类的 class 的源信息
    ClassMetadata classMetadata = metadataReader.getClassMetadata();
    // 获取以后类的资源信息
    Resource resource = metadataReader.getResource();
     return classMetadata.getClassName().contains("Service");
}
    
@ComponentScan(basePackages = {"com.binghe.spring"},includeFilters = {@ComponentScan.Filter(type = FilterType.CUSTOM,value = CustomFilterType.class)
},useDefaultFilters = false)
public class MainConfig {}

配置 Bean 的作用域对象

不指定 @Scope

在不指定 @Scope 的状况下，所有的 bean 都是单实例的 bean，而且是饿汉加载(容器启动实例就创立好了)

@Bean
public Person person() {return new Person();
}

@Scope 为 prototype

指定 @Scope 为 prototype 示意为多实例的，而且还是懒汉模式加载（IOC 容器启动的时候，并不会创建对象，而是在第一次应用的时候才会创立）

@Bean
@Scope(value = "prototype")
public Person person() {return new Person();
}

@Scope 取值

  • singleton 单实例的(默认)
  • prototype 多实例的
  • request 同一次申请
  • session 同一个会话级别

懒加载

Bean 的懒加载 @Lazy(次要针对单实例的 bean 容器启动的时候，不创建对象，在第一次应用的时候才会创立该对象)

@Bean
@Lazy
public Person person() {return new Person();
}

@Conditional 条件判断

场景，有二个组件 CustomAspect 和 CustomLog，我的 CustomLog 组件是依赖于 CustomAspect 的组件
利用：本人创立一个 CustomCondition 的类 实现 Condition 接口

public class CustomCondition implements Condition {
/****
@param context
* @param metadata
* @return
*/
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 判断容器中是否有 CustomAspect 的组件
        return context.getBeanFactory().containsBean("customAspect");
    }    
} 

public class MainConfig {
    @Bean
    public CustomAspect customAspect() {return new CustomAspect();
    } 
    @Bean
    @Conditional(value = CustomCondition.class)
    public CustomLog customLog() {return new CustomLog();
    }
}

向 IOC 容器增加组件

（1）通过 @CompentScan +@Controller @Service @Respository @compent。实用场景: 针对咱们本人写的组件能够通过该形式来进行加载到容器中。

（2）通过 @Bean 的形式来导入组件(实用于导入第三方组件的类)

（3）通过 @Import 来导入组件（导入组件的 id 为全类名门路）

@Configuration
@Import(value = {Person.class})
public class MainConfig {}

通过 @Import 的 ImportSeletor 类实现组件的导入 (导入组件的 id 为全类名门路)

public class CustomImportSelector implements ImportSelector {    
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {return new String[]{"com.binghe.spring"};
    }
} 
Configuration
@Import(value = {Person.class}
public class MainConfig {}

通过 @Import 的 ImportBeanDefinitionRegister 导入组件 (能够指定 bean 的名称)

public class DogBeanDefinitionRegister implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 创立一个 bean 定义对象
        RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Dog.class);
        // 把 bean 定义对象导入到容器中
        registry.registerBeanDefinition("dog",rootBeanDefinition);
    }
} 
@Configuration
@Import(value = {Person.class, Car.class, CustomImportSelector.class, DogBeanDefinitionRegister.class})
public class MainConfig {}

通过实现 FacotryBean 接口来实现注册 组件

public class CarFactoryBean implements FactoryBean<Car> {
    @Override
    public Car getObject() throws Exception {return new Car();
    } 
    @Override
    public Class<?> getObjectType() {return Car.class;} 

    @Override
    public boolean isSingleton() {return true;}
}

Bean 的初始化与销毁

指定 bean 的初始化办法和 bean 的销毁办法

由容器治理 Bean 的生命周期，咱们能够通过本人指定 bean 的初始化办法和 bean 的销毁办法

@Configuration
public class MainConfig {// 指定了 bean 的生命周期的初始化办法和销毁办法.@Bean(initMethod = "init",destroyMethod = "destroy")
    public Car car() {return new Car();
    }
}

针对单实例 bean 的话，容器启动的时候，bean 的对象就创立了，而且容器销毁的时候，也会调用 Bean 的销毁办法

针对多实例 bean 的话, 容器启动的时候，bean 是不会被创立的而是在获取 bean 的时候被创立，而且 bean 的销毁不受 IOC 容器的治理

通过 InitializingBean 和 DisposableBean 实现

通过 InitializingBean 和 DisposableBean 个接口实现 bean 的初始化以及销毁办法

@Component
public class Person implements InitializingBean,DisposableBean {public Person() {System.out.println("Person 的构造方法");
    } 
    @Override
    public void destroy() throws Exception {System.out.println("DisposableBean 的 destroy()办法");
    } 
    @Override
    public void afterPropertiesSet() throws Exception {System.out.println("InitializingBean 的 afterPropertiesSet 办法");
    }
}

通过 JSR250 标准

通过 JSR250 标准 提供的注解 @PostConstruct 和 @ProDestory 标注的办法

@Component
public class Book {public Book() {System.out.println("book 的构造方法");
    } 
    @PostConstruct
    public void init() {System.out.println("book 的 PostConstruct 标记的办法");
    } 
    @PreDestroy
    public void destory() {System.out.println("book 的 PreDestory 标注的办法");
    }
}

通过 BeanPostProcessor 实现

通过 Spring 的 BeanPostProcessor 的 bean 的后置处理器会拦挡所有 bean 创立过程

  • postProcessBeforeInitialization 在 init 办法之前调用
  • postProcessAfterInitialization 在 init 办法之后调用
@Component
public class CustomBeanPostProcessor implements BeanPostProcessor {
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {System.out.println("CustomBeanPostProcessor...postProcessBeforeInitialization:"+beanName);
           return bean;
    } 
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {System.out.println("CustomBeanPostProcessor...postProcessAfterInitialization:"+beanName);
        return bean;
    }
}

BeanPostProcessor 的执行机会

populateBean(beanName, mbd, instanceWrapper)
initializeBean{applyBeanPostProcessorsBeforeInitialization()
    invokeInitMethods{isInitializingBean.afterPropertiesSet()
    自定义的 init 办法
}
applyBeanPostProcessorsAfterInitialization()办法}

通过 @Value +@PropertySource 来给组件赋值

public class Person {
    // 通过一般的形式
    @Value("独孤")
    private String firstName;
    //spel 形式来赋值
    @Value("#{28-8}")
    private Integer age;
    通过读取内部配置文件的值
    @Value("${person.lastName}")
    private String lastName;
} 
@Configuration
@PropertySource(value = {"classpath:person.properties"}) // 指定内部文件的地位
public class MainConfig {
    @Bean
    public Person person() {return new Person();
    }
}

主动拆卸

@AutoWired 的应用

主动注入

@Repository
public class CustomDao {
} 
@Service
public class CustomService {
    @Autowired
    private CustomDao customDao;
}

论断:
（1）主动拆卸首先时依照类型进行拆卸，若在 IOC 容器中发现了多个雷同类型的组件，那么就依照 属性名称来进行拆卸

@Autowired
private CustomDao customDao;

比方，我容器中有二个 CustomDao 类型的组件 一个叫 CustomDao 一个叫 CustomDao2 那么咱们通过 @AutoWired 来润饰的属性名称时 CustomDao，那么拿就加载容器的 CustomDao 组件，若属性名称为 tulignDao2 那么他就加载的时 CustomDao2 组件

（2）假如咱们须要指定特定的组件来进行拆卸，咱们能够通过应用 @Qualifier(“CustomDao”)来指定拆卸的组件
或者在配置类上的 @Bean 加上 @Primary 注解

@Autowired
@Qualifier("CustomDao")
private CustomDao customDao2

（3）假如咱们容器中即没有 CustomDao 和 CustomDao2, 那么在拆卸的时候就会抛出异样

No qualifying bean of type 'com.binghhe.spring.dao.CustomDao' available

若咱们想不抛异样，咱们须要指定 required 为 false 的时候能够了

@Autowired(required = false)
@Qualifier("customDao")
private CustomDao CustomDao2;

（4）@Resource(JSR250 标准)
性能和 @AutoWired 的性能差不多一样，然而不反对 @Primary 和 @Qualifier 的反对

（5）@InJect（JSR330 标准）
须要导入 jar 包依赖，性能和反对 @Primary 性能 , 然而没有 Require=false 的性能

<dependency>
    <groupId>javax.inject</groupId>
    <artifactId>javax.inject</artifactId>
    <version>1</version>
</dependency>

（6）应用 @Autowired 能够标注在办法上

  • 标注在 set 办法上
//@Autowired
public void setCustomLog(CustomLog customLog) {this.customLog = customLog;}
  • 标注在构造方法上
@Autowired
public CustomAspect(CustomLog customLog) {this.customLog = customLog;}

标注在配置类上的入参中（能够不写）

@Bean
public CustomAspect CustomAspect(@Autowired CustomLog customLog) {CustomAspect customAspect = new CustomAspect(customLog);
    return ustomAspect;
}

XXXAwarce 接口

咱们本人的组件 须要应用 spring ioc 的底层组件的时候, 比方 ApplicationContext 等咱们能够通过实现 XXXAware 接口来实现

@Component
public class CustomCompent implements ApplicationContextAware,BeanNameAware {
    private ApplicationContext applicationContext;
    @Override
    public void setBeanName(String name) {System.out.println("current bean name is :【"+name+"】");
    } 
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;}
}

@Profile 注解

通过 @Profile 注解 来依据环境来激活标识不同的 Bean

  • @Profile 标识在类上，那么只有以后环境匹配，整个配置类才会失效
  • @Profile 标识在 Bean 上，那么只有以后环境的 Bean 才会被激活
  • 没有标记为 @Profile 的 bean 不论在什么环境都能够被激活
@Configuration
@PropertySource(value = {"classpath:ds.properties"})
public class MainConfig implements EmbeddedValueResolverAware {@Value("${ds.username}")
    private String userName;
    @Value("${ds.password}")
    private String password;
    private String jdbcUrl;
    private String classDriver;
    @Override
    public void setEmbeddedValueResolver(StringValueResolver resolver) {this.jdbcUrl = resolver.resolveStringValue("${ds.jdbcUrl}");
        this.classDriver = resolver.resolveStringValue("${ds.classDriver}");
    } 
    @Bean
    @Profile(value = "test")
    public DataSource testDs() {return buliderDataSource(new DruidDataSource());
    }
    @Bean
    @Profile(value = "dev")
    public DataSource devDs() {return buliderDataSource(new DruidDataSource());
    } 
    @Bean
    @Profile(value = "prod")
    public DataSource prodDs() {return buliderDataSource(new DruidDataSource());
    } 
    private DataSource buliderDataSource(DruidDataSource dataSource) {dataSource.setUsername(userName);
        dataSource.setPassword(password);
        dataSource.setDriverClassName(classDriver);
        dataSource.setUrl(jdbcUrl);
        return dataSource;
    }
}

激活切换环境的办法

（1）运行时 jvm 参数来切换

 -Dspring.profiles.active=test|dev|prod

（2）通过代码的形式来激活

public static void main(String[] args) {AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
    ctx.getEnvironment().setActiveProfiles("test","dev");
    ctx.register(MainConfig.class);
    ctx.refresh();
    printBeanName(ctx);
}

好了，明天就到这儿吧，我是冰河，大家有啥问题能够在下方留言，，一起交换技术，一起进阶，一起牛逼~~

正文完
spring
发表至： spring
2021-06-15
 0
关于spring:Spring-源码学习-10prepareBeanFactory-和-postProcessBeanFactory
关于spring:spring-aop-分析
关于spring:SpringIOC理论推导
关于spring:思spring的IOC