基於註解的IOC使用和基於XML方式的IOC的使用功能是一模一樣的,只是註解方式是另一種使用方式而已,通過使用註解,可以完成相關的聲明和配置。
先介紹一下XML和註解混合使用的情況,然後再改進爲全註解的形式。
IOC的配置
首先,在pom.xml文件中,導入Spring IOC相關的約束和依賴。
例如:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.itheima</groupId>
<artifactId>day02_eesy_01anno_ioc</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.0.2.RELEASE</version>
</dependency>
</dependencies>
</project>
其次,在resources
文件夾下,建立bean.xml文件,導入相關約束和bean的配置,例如:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
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">
<!--告知spring在創建容器時要掃描的包,配置所需要的標籤不是在beans的約束中,而是一個名稱爲
context名稱空間和約束中-->
<context:component-scan base-package="com.itheima"></context:component-scan>
</beans>
相比於XML方式,我們只需要在beans標籤內部,導入名爲context:component-scan
的標籤,其中base-package
屬性指定Spring在哪個包下去掃描註解,找到我們定義的組件。
到此,我們已經配好了有關IOC註解的環境。
接下來介紹下如何應用註解實現IOC。
IOC註解的使用
類比於XML方式,註解可以按功能分爲三類,即:
- 用於創建對象的
- 用於注入數據的
- 用於改變作用範圍的
- 和生命週期相關的
用於創建對象的註解
@Component:
作用:用於把當前類對象存入spring容器中
屬性:
value:用於指定bean的id。當我們不寫時,它的默認值是當前類名,且首字母改小寫。
我們只需要在我們的類對象定義上,寫入@Component
註解,就將該類聲明到了IOC容器當中,同時括號裏對value屬性賦值,即可指定bean的id。
例如:
@Component("accountService")
public class AccountServiceImpl implements IAccountService {
private IAccountDao accountDao = null;
public void saveAccount(){
accountDao.saveAccount();
}
}
類似如@Component註解,Spring又提供了三個類似的註解:
@Controller:一般用在表現層
@Service:一般用在業務層
@Repository:一般用在持久層
以上三個註解他們的作用和屬性與Component是一模一樣。
他們三個是spring框架爲我們提供明確的三層使用的註解,使我們的三層對象更加清晰。
例如:
@Service("accountService")
public class AccountServiceImpl implements IAccountService {
private IAccountDao accountDao = null;
public void saveAccount(){
accountDao.saveAccount();
}
}
用於注入數據的註解
他們的作用就和在xml配置文件中的bean標籤中寫一個標籤的作用是一樣的。
@Autowired:
作用:自動按照類型注入。只要容器中有唯一的一個bean對象類型和要注入的變量類型匹配,就可以注入成功。
如果ioc容器中沒有任何bean的類型和要注入的變量類型匹配,則報錯。
如果Ioc容器中有多個類型匹配時:
匹配變量名和bean的id一致的,若找不到與bean的id與該變量名一致,則匹配失敗。
出現位置:
可以是變量上,也可以是方法上
細節:
在使用註解注入時,set方法就不是必須的了。
需要注意的是,當使用@Autowired註解自動注入時,如果Ioc容器中有多個類型匹配,Spring自動匹配變量名和bean的id一致的,若找不到與bean的id與該變量名一致,則匹配失敗。
此時,我們可以通過**@Qualifier**註解,手動指定匹配容器中哪個id的bean。例如:
@Service("accountService")
public class AccountServiceImpl implements IAccountService {
@Autowired
@Qualifier("accountDao1")
private IAccountDao accountDao = null;
public void saveAccount(){
accountDao.saveAccount();
}
}
@Qualifier:
作用:在按照類中注入的基礎之上再按照名稱注入。
它在給類成員注入時不能單獨使用,需要和@Autowired一同使用。但是在給方法參數注入時可以。
屬性:
value:用於指定注入bean的id。
@Resource:
作用:直接按照bean的id注入。它可以獨立使用
屬性:
name:用於指定bean的id。
例如:
@Service("accountService")
public class AccountServiceImpl implements IAccountService {
@Resource(name = "accountDao2")
private IAccountDao accountDao = null;
public void saveAccount(){
accountDao.saveAccount();
}
}
以上三個注入都只能注入其他bean類型的數據,而基本類型和String類型無法使用上述註解實現。
另外,集合類型的注入只能通過XML來實現。
@Value:
作用:用於注入基本類型和String類型的數據
屬性:
value:用於指定數據的值。它可以使用spring中SpEL(也就是spring的el表達式)
SpEL的寫法:${表達式}
@PropertySource:
作用:用於指定properties文件的位置
屬性:
value:指定文件的名稱和路徑。
關鍵字:classpath,表示類路徑下
該註解的作用是,在我們使用@Value註解注入基本類型和String類型的數據時,我們注入的這些基本數據的值,是要存在一個後綴名爲.properties
的配置文件中。所以該註解,是指定存儲數據的properties文件的位置。
例如:
我們在resources目錄下創建一個名爲jdbcConfig.properties
的配置文件:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/eesy
jdbc.username=root
jdbc.password=1234
SpringConfiguration.java:
//@Configuration
@ComponentScan("com.itheima")
@Import(JdbcConfig.class)
@PropertySource("classpath:jdbcConfig.properties")
public class SpringConfiguration {
/**
* 用於創建一個 QueryRunner對象
*/
@Bean(name="runner")
Public QueryRunner createQueryRunner(DataSource dataSource)
{
return new QueryRunner(dataSource);
}
/**
* 創建數據源對象
*/
@Bean(name="dataSource")
public DataSource createDateSource(){
ComboPooledDataSource ds = new ComboPooledDataSource();
ds.serDriverClass("com.mysql.jdbc.Driver");
ds.serJdbcUrl("jdbc:mysql://localhost:3306/eesy");
ds.serUser("root");
ds.serPassword("1234");
return ds;
}
}
在JdbcConfig.java文件中,需要注入jdbcConfig.properties
文件中的數據:
public class JdbcConfig {
@Value("${jdbc.driver}")
private String driver;
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.username}")
private String username;
@Value("${jdbc.password}")
private String password;
//...... 省略
}
用於改變作用範圍的註解
他們的作用就和在bean標籤中使用scope屬性實現的功能是一樣的。
@Scope:
作用:用於指定bean的作用範圍
屬性:
value:指定範圍的取值。常用取值:singleton prototype
例如:
@Service("accountService")
@Scope("prototype")
public class AccountServiceImpl implements IAccountService {
@Autowired
private IAccountDao accountDao = null;
public void saveAccount(){
accountDao.saveAccount();
}
}
和生命週期相關的註解
他們的作用就和在bean標籤中使用init-method和destroy-methode的作用是一樣的。
@PreDestroy:
作用:用於指定銷燬方法
@PostConstruct:
作用:用於指定初始化方法
例如:
@Service("accountService")
public class AccountServiceImpl implements IAccountService {
@Resource(name = "accountDao2")
private IAccountDao accountDao = null;
@PostConstruct
public void init(){
System.out.println("初始化方法執行了");
}
@PreDestroy
public void destroy(){
System.out.println("銷燬方法執行了");
}
public void saveAccount(){
accountDao.saveAccount();
}
}
實現全註解形式
上面的例子,我們除了用到了註解形式,還是用到了XML配置文件,接下來,我們需要介紹更多的註解,實現全註解形式的IOC。
想要將XML配置文件取代,我們需要定義一個配置類。
我們在java目錄下,創建一個config包,再創建一個名爲SpringConfiguration.java
的配置類。
@Configuration:
作用:指定當前類是一個配置類
細節:當配置類作爲AnnotationConfigApplicationContext對象創建的參數時,該註解可以不寫,即該配置類爲主配置類。
@ComponentScan:
作用:用於通過註解指定spring在創建容器時要掃描的包
屬性:
value:它和basePackages的作用是一樣的,都是用於指定創建容器時要掃描的包。
我們使用此註解就等同於在xml中配置了:
<context:component-scan base-package="com.itheima"></context:component-scan>
@Bean:
作用:用於把當前方法的返回值作爲bean對象存入spring的ioc容器中
屬性:
name:用於指定bean的id。當不寫時,默認值是當前方法的名稱。
指定name屬性時,name關鍵詞不能省略,因爲參數中不止name一個參數。
細節:
當我們使用註解配置方法時,如果方法有參數,spring框架會去容器中查找有沒有可用的bean對象。
查找的方式和Autowired註解的作用是一樣的
前面我們講到的**@Component是寫在我們自定義類的上面,此時將該類加入到容器中。
而有時,我們需要非自定義的類作爲bean對象注入到容器時,此時,我們就需要用到@Bean**註解了。
例如,我們需要將xml裏配置的這兩個bean變成註解形式:
<!--配置QueryRunner-->
<bean id="runner" class="org.apache.commons.dbutils.QueryRunner" scope="prototype">
<!--注入數據源-->
<constructor-arg name="ds" ref="dataSource"></constructor-arg>
</bean>
<!-- 配置數據源 -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<!--連接數據庫的必備信息-->
<property name="driverClass" value="com.mysql.jdbc.Driver"></property>
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/eesy"></property>
<property name="user" value="root"></property>
<property name="password" value="1234"></property>
</bean>
我們知道,註解形式我們定義的SpringConfiguration.java
配置類文件,跟我們之前定義的XML配置文件是等價的,所以,要想將XML文件裏的這兩個bean轉變成註解形式的,我們只需在我們的SpringConfiguration.java
配置類中,註冊這兩個bean對象。
我們只需要定義一個函數,在該函數的返回值中,返回通過new創建的該類對象,並在該函數上面標註@Bean
註解,例如:
@Configuration
@ComponentScan("com.itheima")
public class SpringConfiguration {
/**
* 用於創建一個 QueryRunner對象
*/
@Bean(name="runner")
Public QueryRunner createQueryRunner(DataSource dataSource)
{
return new QueryRunner(dataSource);
}
/**
* 創建數據源對象
*/
@Bean(name="dataSource")
public DataSource createDateSource(){
ComboPooledDataSource ds = new ComboPooledDataSource();
ds.serDriverClass("com.mysql.jdbc.Driver");
ds.serJdbcUrl("jdbc:mysql://localhost:3306/eesy");
ds.serUser("root");
ds.serPassword("1234");
return ds;
}
}
@Import:
作用:用於導入其他的配置類
屬性:
value:用於指定其他配置類的字節碼。
當我們使用Import的註解之後,有Import註解的類就父配置類,而導入的都是子配置類
例如,我們再創建一個名爲JdbcConfig.java
的配置類,連接數據庫相關的配置
此時,我們只需要在我們的主配置類文件上使用@Import
導入該配置類。
例如:
@Configuration
@ComponentScan("com.itheima")
@Import(JdbcConfig.class)
public class SpringConfiguration {
/**
* 用於創建一個 QueryRunner對象
*/
@Bean(name="runner")
Public QueryRunner createQueryRunner(DataSource dataSource)
{
return new QueryRunner(dataSource);
}
/**
* 創建數據源對象
*/
@Bean(name="dataSource")
public DataSource createDateSource(){
ComboPooledDataSource ds = new ComboPooledDataSource();
ds.serDriverClass("com.mysql.jdbc.Driver");
ds.serJdbcUrl("jdbc:mysql://localhost:3306/eesy");
ds.serUser("root");
ds.serPassword("1234");
return ds;
}
}
到此爲止,已經將實現全註解的相關注解全部介紹完了。
註解形式的IOC調用
註解形式的ApplicationContext接口的實現類,我們需要創建名爲AnnotationConfigApplicationContext
的實現類,然後通過getbean
方法,獲取指定id的bean對象,例如:
public class QueryRunnerTest {
@Test
public void testQueryRunner(){
ApplicationContext ac = new AnnotationConfigApplicationContext(SpringConfiguration.class);
//獲取queryRunner對象
QueryRunner runner = ac.getBean("runner",QueryRunner.class);
}
}