Spring注解开发详解

image.png

前言

在《Spring快速入门详解》中主要介绍了通过xml配置文件的方式进行开发，其实还可以通过注解方式进行开发。
Spring3.0升级了纯注解开发模式，使用Java类替代配置文件，开启了Spring快速开发赛道。本文主要详细讲解Spring注解方式开发。

注解开发

1. 快速入门

1.1 注解开发定义bean

1.1.1 使用@Component定义bean

@Component("bookDao")
public class BookDaoImpl implements BookDao {
}
@Component
public class BookServiceImpl implements BookService {
}

注意：如果没有定义名称，那么只能通过类型获取。

1.1.2 核心配置文件中通过组件扫描加载bean

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       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
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

  <context:component-scan base-package="com.hao"/>
</beans>

扫描base-package包下的所有添加@Component注解的类

1.1.3 Spring提供@Component注解的三个衍生注解

@Controller：用于表现层bean定义
@Service：用于业务层bean定义
@Repository：用于数据层bean定义

@Repository("bookDao")
public class BookDaoImpl implements BookDao {
}
@Service
public class BookServiceImpl implements BookService {
}

1.2 纯注解开发

Spring3.0升级了纯注解开发模式，使用Java类替代配置文件，开启了Spring快速开发赛道。本文主要详细讲解Spring注解方式开发。

1.2.1 Java类代替Spring核心配置文件

xml配置文件被Java类代替，创建Java类如下：

@Configuration
@ComponentScan({"com.hao.service", "com.hao.dao"})
public class SpringConfig {
}

@Configuration注解用于设定当前类为配置类。
@ComponentScan注解用于设定扫描路径，此注解只能添加一次，多个数据请用数组格式。

1.2.2 读取Spring核心配置文件初始化容器对象切换为读取Java配置类初始化容器对象

// 加载配置文件初始化容器
ApplicationContext cxt = new ClassPathXmlApplicationContext("applicationContext.xml");
// 加载配置类初始化容器
ApplicationContext cxt = new AnnotationConfigApplicationContext(SpringConfig.class);

2. bean管理

2.1 bean作用范围

2.1.1 使用@Scope定义bean作用范围

@Repository
@Scope("singleton")
public class BookDaoImpl implements BookDao {
}

@Scope默认是单例singleton，可以不写，如果需要非单例模式，修改为prototype即可。

2.2 bean生命周期

2.2.1 使用@PostConstruct、@PreDestroy定义bean生命周期

@Repository
public class BookDaoImpl implements BookDao {

    public BookDaoImpl() {
        System.out.println("book dao constructor...");
    }
    @PostConstruct
    public void init() {
        System.out.println("book dao init...");
    }
    @PreDestroy
    public void destroy() {
        System.out.println("book dao destroy...");
    }
}

自定义init()和destroy()方法添加相应注解即可。

3. 依赖注入

3.1 自动装配

3.1.1 使用@Autowired注解开启自动装配模式（按类型）

@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;
    public void setBookDao(BookDao bookDao) {
        this.bookDao = bookDao;
    }
    @Override
    public void save() {
        System.out.println("book service save...");
        bookDao.save();
    }
}

注意：自动装配基于反射设计创建对象并暴力反射对应属性为私有属性初始化数据，因此无需提供setter方法
注意：自动装配建议使用无参构造方法创建对象（默认），如果不提供对应构造方法，请提供唯一的构造方法

3.1.2 使用@Qualifier注解开启指定名称装配bean

@Service
public class BookServiceImpl implements BookService {
    @Autowired
    @Qualifier("bookDao")
    private BookDao bookDao;
}

注意：@Qualifier注解无法单独使用，必须配合@Autowired注解使用

3.1.3 使用@Value注解实现简单类型注入

@Repository("bookDao")
public class BookDaoImpl implements BookDao {
    @Value("it_hao528")
    private String name;
    @Override
    public void save() {
        System.out.println("book dao save..." + name);
    }
}

3.2 加载properties文件

3.2.1 使用@PropertySource注解加载properties文件

@Configuration
@ComponentScan({"com.hao"})
@PropertySource({"jdbc.properties"})
public class SpringConfig {
}

注意：路径仅支持单一文件配置，多文件请使用数组格式配置，不允许使用通配符*

4. 第三方bean管理

这里还是以druid为例。

4.1 第三方bean管理

4.1.1 使用@Bean注解配置第三方bean

定义一个方法获得要管理的对象
添加@Bean，表示当前方法的返回值是一个bean

@Configuration
public class SpringConfig {
    @Bean
    public DataSource dataSource() {
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName("com.mysql.jdbc.Driver");
        ds.setUrl("jdbc:mysql://localhost:3306/spring_db");
        ds.setUsername("root");
        ds.setPassword("123456");
        return ds;
    }
}

4.1.2 使用独立的配置类管理第三方bean

创建一个独立的三方配置类
定义一个方法获得要管理的对象
添加@Bean，表示当前方法的返回值是一个bean

public class JdbcConfig {
    @Bean
    public DataSource dataSource() {
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName("com.mysql.jdbc.Driver");
        ds.setUrl("jdbc:mysql://localhost:3306/spring_db");
        ds.setUsername("root");
        ds.setPassword("hao123456");
        return ds;
    }
}

4.1.3 将独立的配置类加入核心配置

4.1.3.1 方式一：导入式

public class JdbcConfig {
    @Bean
    public DataSource dataSource() {
        DruidDataSource ds = new DruidDataSource();
        /* 相关配置 */  
        return ds;
    }
}

使用@Import注解手动加入配置类到核心配置，此注解只能添加一次，多个数据请用数组格式。

@Configuration
@Import({JdbcConfig.class})
public class SpringConfig {
}

4.1.3.2 方式二：扫描式

@Configuration
public class JdbcConfig {
    @Bean
    public DataSource dataSource() {
        DruidDataSource ds = new DruidDataSource();
        /* 相关配置 */  
        return ds;
    }
}

使用@ComponentScan注解扫描配置类所在的包，加载对应的配置类信息。

@Configuration
@ComponentScan({"com.hao.config", "com.hao.service", "com.hao.dao"})
public class SpringConfig {
}

4.2 第三方bean依赖注入

4.2.1 简单类型依赖注入

public class JdbcConfig {
    @Value("com.mysql.jdbc.Driver")
    private String driver;
    @Value("jdbc:mysql://localhost:3306/spring_db")
    private String url;
    @Value("root")
    private String username;
    @Value("123456")
    private String password;
    @Bean
    public DataSource dataSource() {
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName(driver);
        ds.setUrl(url);
        ds.setUsername(username);
        ds.setPassword(password);
        return ds;
    }
}

简单类型注入使用@Value注解给属性设置数据值。

4.2.2 引用类型依赖注入

public class JdbcConfig {
    @Bean
    public DataSource dataSource(BookDao bookDao) {
        System.out.println(bookDao);
        /* 属性设置 */
        return ds;
    }
}

引用类型注入只需要为bean定义方法设置形参即可，容器会根据类型自动装配对象。

5. XML配置与注解配置比较