【Spring基础系列3】Spring常用的注解
主要讲解Spring中常用的注解和使用姿势。
前言
前两篇文章分别讲解了Sping IOC的基础知识，以及Spring通过注解装配Bean的常用方式，包括@Component、@Repository、@Service、@Controller、@Autowired、@Resource和@Qualifier，这篇文章主要对剩余高频的注解进行讲解。
@ComponentScan
之前我们都是在applicationContext.xml中指定扫描路径，这样Spring才能将该包下面的注解扫描出来：
<!--使用context命名空间，通知spring扫描指定目录，进行注解的解析-->
<context:component-scan base-package="com.java.annotation"/>
然后使用的时候需要引入配置文件：
ApplicationContext context =new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
Pets pets=context.getBean("pets", Pets.class);
System.out.println(pets.toString());
通过xml配置的方式告诉扫描路径，简直太Low了，我们可以通过@ComponentScan指定扫描路径，然后通过Spring IoC容器的实现类AnnotationConfigApplicationContext去生成容器，使用姿势如下：
@Data
@Service
@ComponentScan({"com.java.annotation.spring.bean.test5"})
public class Pets {
@Resource
private Dog dog;
@Resource
private Cat cat;
public static void main(String args[]) {
ApplicationContext context = new AnnotationConfigApplicationContext(Pets.class);
Pets pets = context.getBean(Pets.class);
System.out.println(pets.toString());
}
}
那么Spring就会将com.java.annotation.spring.bean.test5包下面的Bean注册到Spring中，包括Dog、Cat和Pets，我之前的示例一直需要在配置文件中加入Pets的配置，现在连下面这一行代码都省掉了，是不是很酷：
// 直接省略掉
<bean id="pets" class="com.java.annotation.spring.bean.test5.Pets"/>
如果@ComponentScan未指定路径，那么默认只扫描当前的包，所以需要实体和配置所在的包必须一致，不过我们一般不这么用，因为一般用该注解都需要指定路径。当然你也可以指定具体需要扫描的类，不过这些都不常用，知道有这个就行：
@ComponentScan(basePackageClasses = {Dog.class, Cat.class, Pets.class})
未使用@ComponentScan注解的代码示例，可以参考文章《【Spring基础系列1】基于注解装配Bean》
@Configuration
指示一个类声明一个或者多个@Bean声明的方法并且由Spring容器统一管理，以便在运行时为这些bean生成bean的定义和服务请求的类。我们先定义一个MyBean类：
public class MyBean {
public MyBean(){
System.out.println("generate MyBean Instance");
}
public void init(){
System.out.println("MyBean Resources Initialized");
}
}
然后再通过@Configuration，定义一个MyConfiguration环境配置类：
@Configuration
@ToString
public class MyConfiguration {
private String name = "配置测试";
@Bean
public MyBean myBean(){
System.out.println("myBean Initialized");
return new MyBean();
}
}
MyConfiguration是一个配置类，能够在此类下面声明管理多个Bean，我们声明了一个MyBean的bean，希望它被容器加载和管理。
我们来看一下测试用例：
public static void main(String[] args) {
ApplicationContext context1 = new AnnotationConfigApplicationContext(MyConfiguration.class);
MyConfiguration myConfiguration = context1.getBean(MyConfiguration.class);
System.out.println(myConfiguration.toString());
}
// 输出：
// myBean Initialized
// generate MyBean Instance
// MyConfiguration(name=配置测试)
从输出的结果可以看到，默认名称为myBean 的bean随着容器的加载而加载，因为myBean方法返回一个myBean的构造方法，所以myBean被初始化了，然后MyConfiguration也作为一个Bean注入到Spring框架中。
通过这种方式，我们就省略了在XML中配置MyBean，同时也省略了配置MyConfiguration和MyBean的依赖关系，具体的XML配置，我就不贴了，如果大家看了我之前的两篇文章，应该很容易写出来。
@Bean
Bean注解主要用于方法上，有点类似于工厂方法，当使用了@Bean注解，我们可以连续使用多种定义bean时用到的注解，譬如用@Qualifier注解定义工厂方法的名称，用@Scope注解定义该bean的作用域范围，譬如是singleton还是prototype等。
Spring 中新的 Java 配置支持的核心就是@Configuration 注解的类。这些类主要包括 @Bean 注解的方法来为 Spring 的 IoC 容器管理的对象定义实例，配置和初始化逻辑，除了和@Configuration配合使用，@Bean自身也有一些特有的用法，我再简单扩展一下。
接受生命周期回调
我们可以指定Bean的生命周期，比如我们基于上述代码，进行简单修改：
@Configuration
@ToString
public class MyConfiguration {
private String name = "配置测试";
@Bean(initMethod = "init") // 新增init
public MyBean myBean(){
System.out.println("myBean Initialized");
return new MyBean();
}
}
用同样的测试用例测试，输出：
myBean Initialized
generate MyBean Instance
MyBean Resources Initialized // 新增输出
MyConfiguration(name=配置测试)
对于上面的例子，也可以手动调用init()方法，与上面的方式等效：
public MyBean myBean(){
System.out.println("myBean Initialized");
MyBean myBean = new MyBean();
myBean.init();
return myBean;
}
Bean的作用域
默认情况下，Spring应用上下文中所有bean都是作为以单例（singleton）的形式创建的。也就是不管给定的一个bean被注入到其他bean多少次，每次所注入的都是同一个实例。
大多数情况下，单例bean是很理想的方案。初始化和垃圾回收对象实例所带来的成本只留给一些小规模任务，在这些任务中，让对象保持无状态并且在应用中反复重用这些对象可能并不合理。
有时候，所使用的类是易变的（mutable），它们会保持一些状态，因此重用是不安全的。在这种情况下，不应该将class声明为单例的bean，因为对象会被污染，重用的时候会出现意想不到的问题。
@Configuration
@ToString
public class MyConfiguration {
private String name = "配置测试";
@Bean(initMethod = "init")
@Scope("prototype") // 新增作用范围
public MyBean myBean(){
System.out.println("myBean Initialized");
return new MyBean();
}
}
Spring定义了多种作用域：
单例（Singleton）：在整个应用中，只创建bean的一个实例。 原型（Prototype）：每次注入或者通过Spring应用上下文获取的时候，都会创建一个新的bean实例。 会话（Session）：在Web应用中，为每个会话创建一个bean实例。 请求（Rquest）：在Web应用中，为每个请求创建一个bean实例。
通过XML定义的Bean，都可以指定他们的作用域，等同：
<bean id="louzai" class="xxx" scope="prototype" />
Bean其它用法
Bean可以指定名称：
@Bean(name="louzai")
public MyBean myBean(){
System.out.println("myBean Initialized");
return new MyBean();
}
或者指定别名：
@Bean({"dataSource", "dataSourceA", "dataSourceB"})
public MyBean myBean(){
System.out.println("myBean Initialized");
return new MyBean();
}
或者指定描述：
@Bean(name="louzai")
@Description("此方法的bean名称为louzai")
public MyBean myBean(){
System.out.println("myBean Initialized");
return new MyBean();
}
@Bean主要和@Configuration配合使用，去获取配置文件中的配置数据，这个等看到这一块，我再完善这部分内容，目前只给出基本用法。
@Transactional
由于这个注解需要讲述的内容比较多，一方面该注解非常重要，另一方面非常容易入坑，所以这个注解的内容，就单独放到下一篇文章来讲。
总结
关于Java Spring的内容，基础知识可以参考这篇万字长文《【Spring基础系列2】很全的Spring IOC基础知识》，MVC相关的注解可以参考《【Spring基础系列1】基于注解装配Bean》，还有一部分注解内容，虽然不是Spring家族，但是用的也非常多，可以参考《【Java基础系列1】Lombok常用注解》，然后加上这篇文章讲解的注解，Spring中高频的注解基本就能掌握，如果后面遇到其它的注解，我也会继续连载这个系列。
下一篇文章主要讲述@Transactional和容易遇到的坑，之后就开始学习AOP相关的内容，希望本周能完成Spring基础知识的学习。
欢迎大家多多点赞，更多文章，请关注微信公众号“楼仔进阶之路”，点关注，不迷路~~