帶你快速入門掌握Spring的那些註解使用

2022-02-14 19:00:19

一、前言

這是spring專欄的第三篇文章，是關於spring的註解開發，包括完全註解和非完全註解開發。自己整理了學習的筆記，希望大家喜歡。

二、基本介紹

前面兩篇關於spring的知識點學習，我都是用xml組態檔來一步步講解的，但是Spring是輕程式碼而重設定的框架，xml組態檔比較繁重，影響開發效率，所以註解開發是一種趨勢，註解代替xml組態檔可以簡化設定，提高開發效率。
因此，我在寫這篇文章之前，一直在思考，如何用一種方式來讓小夥伴們理解的更加深刻呢？最後決定，我在講解註解使用的時候，要與使用xml組態檔的方式進行一個對比，儘量讓小夥伴們知其所以然！

三、非全註解開發

1、第一組註解

這組註解關於物件的範例化建立，在功能上都沒有區別

@Component 使用在類上用於範例化Bean
@Controller 使用在web層類上用於範例化Bean
@Service 使用在service層類上用於範例化Bean
@Repository 使用在dao層類上用於範例化Bean

接下來讓我們從具體的程式碼分析，理解和掌握它們吧！

先建立一個UserDao介面，隨便寫一個sayHello()方法

public interface UserDao {
    void sayHello();
}

然後寫一個介面實現類UserDaoImpl類，實現介面的方法，輸出“大家好，我是捲心菜~~”

//<bean id="userDao" class="com.sht.dao.impl.UserDaoImpl"></bean>
@Repository(value = "userDao")
public class UserDaoImpl implements UserDao {
    @Override
    public void sayHello() {
        System.out.println("大家好，我是捲心菜~~");
    }
}

分析：在類上加上@Repository(value = "userDao")就表示把這個類的範例放進了spring容器中，value = "userDao"就相當於<bean id="userDao" class="com.sht.dao.impl.UserDaoImpl"></bean>中的id屬性值，我們使用註解的時候，就不需要在指定類的包路徑了，因此省略了class屬性值

注意，使用非全註解開發，意味著要設定spring檔案，與之前不同的是，我們要在組態檔中加上一個包掃描，才能讓註解生效

<?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">
    <!--掃描包及其子包-->    
    <context:component-scan base-package="com.sht"/>
</beans>

寫一個測試程式碼：

@Test
    public void test4() {
        ApplicationContext applicationContext =
                new ClassPathXmlApplicationContext("applicationContext.xml");
        UserService userService = applicationContext.getBean(UserService.class);
        userService.sayHello();
    }

執行結果：

2、第二組註解

這一組註解的功能是屬性注入，讓我們寫一個程式碼看看他們的使用方法

@Autowired
@Resource
@Qulifier：和@Autowired一起使用

建立一個介面UserService，寫一個方法sayHello()

public interface UserService {
    void sayHello();
}

建立一個介面實現類，實現其方法，我們在方法中呼叫UserDaoImpl類的方法，程式碼如下：

//<bean id="userService"  class="com.sht.service.impl.UserServiceImpl"></bean>
@Service(value = "userService")
public class UserServiceImpl implements UserService {
//    <property name="userDao" ref="userDao"></property>
    @Autowired
    @Qualifier(value = "userDao")
    private UserDao userDao;
    //可以省略不寫
//    public void setUserDao(UserDao userDao) {
//        this.userDao = userDao;
//    }
    @Override
    public void sayHello() {
        userDao.sayHello();
    }
}

分析：註解@Service(value = "userService")就不多說了，使用方法跟第一組註解相同，我們在類中引入了private UserDao userDao;，該如何注入屬性呢？可以使用@Autowired+@Qualifier(value = “userDao”)，其中的value屬性值相當於<property name="userDao" ref="userDao"></property>中的ref屬性值，可以開心的是，使用xml組態檔的方式，我們還要寫屬性對應的set方法，但是使用了註解後，就不需要寫set方法了，是不是很方便呢？@Autowired+@Qualifier(value = “userDao”)這兩個註解可以替換為@Resource(name=“userDao”)，但是不建議使用；@Autowired+@Qualifier(value = “userDao”)還可以替換為單獨的@Autowired，表示的是根據型別注入屬性，當有多個相同型別時，就會報錯，謹慎使用哦

3、第三組註解

這一組註解的功能是字串的注入，但是不單單是普通的字串注入，讓我們寫一個程式碼看看它的使用方法

@Value：進行字串的注入
@PropertySource：引入外部properties檔案
@Bean：將方法的返回值注入spring容器中

在UserServiceImp類中加入一下程式碼，使用@Value註解注入自己需要的字串內容

@Value("我是一棵捲心菜")
    private String name;
    public void print() {
        System.out.println(name);
    }

寫一個測試程式碼，檢驗效果：

  @Test
    public void test4() {
        ApplicationContext applicationContext =
                new ClassPathXmlApplicationContext("applicationContext.xml");
        UserServiceImpl userService = applicationContext.getBean(UserServiceImpl.class);
        userService.print();
    }

執行結果：

這只是@Value註解的一種使用方法，接下來看看它的另一種使用方式

首先設定一個xml檔案，用來設定Druid資料來源，連線MySQL資料庫，這裡的內容在我的Spring專欄中講解的非常清楚，不懂的小夥伴們可以去學習一下

<?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">
        
    <context:property-placeholder location="classpath:jdbc.properties"/>
    
    <context:component-scan base-package="com.sht"/>
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
    
    <property name="driverClassName" value="${jdbc.driver}"></property>
    <property name="url" value="${jdbc.url}"></property>
    <property name="username" value="${jdbc.username}"></property>
    <property name="password" value="${jdbc.password}"></property>
    </bean>
</beans>

在resources下設定一個jdbc.properties檔案

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=0315

接著在UserServiceImp類的上面加上註解@PropertySource(value = {"classpath:jdbc.properties"})，spring組態檔中<context:property-placeholder location=“classpath:jdbc.properties”/>就可以不要了，一個註解就解決了，是不是很方便呢？

需要注意的是，在@PropertySource註解中，通過進入原始碼發現，它的屬性值是一個陣列型別，這就表明，我們可以引入多個properties檔案

然後再UserServiceImp類中寫一個方法，用來獲取連線物件

@Value("${jdbc.driver}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean("dataSource")
    public DataSource getDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

分析：我們用註解@Value把properties檔案的值拿到，然後在方法中進行連線設定，註解@Bean把獲取的物件放進spring容器中，方便以後的使用，它的屬性值是相當於bean標籤裡面的id

設定是否成功呢？我們來寫一個測試程式碼：

  @Test
    public void test5() throws SQLException {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        DataSource dataSource = (DataSource) context.getBean("dataSource");
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }

執行結果：

到這裡，我們發現spring組態檔中還多了一個包掃描，孤苦伶仃的；我們該能不能不使用組態檔呢？答案是肯定可以的，接下來就來看看完全註解開發

四、完全註解開發

1、第一組註解

這三個註解不是很重要，瞭解即可

@Scope：決定物件是多例還是單例
@PostConstruct：標註初始化方法
@PreDestroy：標登出毀方法

2、第二組註解

這一組註解開始開啟我們全註解開發的大門

@Configuration 用於指定當前類是一個 Spring 設定類，當建立容器時會從該類上載入註解
@ComponentScan 用於指定 Spring 在初始化容器時要掃描的包。
@PropertySource 用於載入.properties 檔案中的設定
@Import 用於匯入其他設定類

使用全註解開發，我們首先建立一個主類SpringConfig

@Configuration
//<context:component-scan base-package="com.sht"/>
@ComponentScan(value = {"com.sht"})
public class SpringConfig {
    private int age = 18;
    public void print() {
        System.out.println("我的年齡是" + age + "歲");
    }
}

分析： @Configuration告訴spring這是一個設定類，@ComponentScan的屬性值要填寫包掃描的路徑，它的功能跟<context:component-scan base-package="com.sht"/>一樣，到了這裡，我們就可以完全的不需要spring組態檔了

接下來用程式碼測試一下：

@Test
    public void test6() {
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        SpringConfig config = context.getBean(SpringConfig.class);
        config.print();
    }

執行結果：

那麼問題又來了，如果我有別的設定類，如何將它們放進spring容器裡面呢？這時候就需要用到@Import註解了

上面內容中，我在UserServiceImp類中寫一個方法，用來獲取連線物件，我現在把它們寫在一個UtilGetDataSource類中，程式碼如下：

@PropertySource(value = {"classpath:jdbc.properties"})
public class UtilGetDataSource {
    @Value("${jdbc.driver}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean("dataSource")
    public DataSource getDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

我們要想使用這個方法，就需要把它放進spring容器中；用@Import註解，它的屬性值也是一個陣列型別的，可以引入多個類

@Import(UtilGetDataSource.class)
public class SpringConfig{ 
}

最後寫個測試類看看是否正確

@Test
    public void test6() throws SQLException {
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        DataSource dataSource = (DataSource) context.getBean("dataSource");
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }

執行結果：