關於Spring注解開發教程,打包全送你


摘要:spring是我們web開發中必不可少的一個框架,基於傳統的xml方式配置bean總覺得太過繁瑣,從spring2.5之后注解的出現可以大大簡化我們的配置。

本文分享自華為雲社區《如何高效提升Java開發效率—Spring注解開發全套教程!》,作者: 灰小猿。

一、使用注解標識組件

為了不再在IOC中一個個的聲明類對象,首先根據每一個類的功能的不同,Spring中先規定了基於組件的注解,大致可以分為以下四種:

①普通組件:@Component

標識一個受Spring IOC容器管理的組件,我們也可以理解為是除了數據庫層、業務邏輯層、控制層組件以外的其他組件使用的注解。

②持久化層組件:@Respository

標識一個受Spring IOC容器管理的持久化層組件,一般就是用來標注數據庫層

③業務邏輯層組件:@Service

標識一個受Spring IOC容器管理的業務邏輯層組件,

④表述層控制器組件:@Controller

標識一個受Spring IOC容器管理的表述層控制器組件。

同時這幾個注解后面也可以添加一些參數,比如比較常用的一個是注解的括號中加value屬性,來表示這個組件在容器中的ID,如果不設置value值時,默認的ID是類名的全稱(第一個字母小寫)。

如下實例,我們為一個Dao層組件添加一個@Respository注解

/**
 * 數據庫層注解
 * */
@Repository
public class BookDao {
    public void saveBook() {
        System.out.println("bookDao中的圖書已保存...");
    }
}

通過這四個注解我們首先就可以將所有的組件逐一分類。置於為什么要使用注解進行分類,說到底其實就是為了方便方便快速的知道哪一個類是做了什么類型的功能,同時方便之后通過這四個注解將組件加入到IOC容器中。

所以你也可以把這四個注解理解為是Spring分發給不同功能組件的一個“身份證”,只有擁有這四種“身份證”,那么這個組件就可以被加入到IOC容器中。

在這里有一點需要注意:事實上Spring並沒有能力識別一個組件到底是不是它所標記的類型,即使將@Respository注解用在一個表述層控制器組件上面也不會產生任何錯誤,所以@Respository、@Service、@Controller這幾個注解僅僅是為了讓開發人員自己明確當前的組件扮演的角色。方便將組件加入到容器中去。

二、組件掃描

1、普通掃描

現在倒是對所有的組件進行了詳細的分類,但是這樣就等於將所有的組件已經加入到IOC容器中了嘛?如果真的是這樣的話,那么我們就真正的實現了低代碼時代了...

所以現在我們就是應該如何將擁有注解標識的組件加入到IOC容器中呢?在這里Spring在IOC中提供了一個包掃描的功能,通過這個名字我們就可以知道,Spring可以自動的掃描整個項目中被標記了這四個注解的組件,並且將其加入到IOC容器中。

進行包掃描的具體操作是這樣的:

進行包掃描依賴於Context名稱空間,所以需要在IOC中加入該名稱空間,加入名稱空間的方法有兩種,一種是在IOC的頭文件中加入如下代碼:

xmlns:context="http://www.springframework.org/schema/context"

但是因為這種不好記所以不推薦,

還有一種就是直接在界面點擊下方的Namespaces,在其中找到並勾選Context,

​在容器中進行包掃描的代碼是:

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

其中base-package屬性指定一個需要掃描的基類包,Spring容器將會掃描這個基類包及其子包中的所有類。當需要掃描多個包時可以使用逗號分隔。如上面的代碼就是掃描com.spring包下面的所有類。

2、包含與排除特定組件

但是這樣進行掃描的范圍有時候未免還是有一些大,那么能不能再縮小進行包掃描的范圍呢?當然是可以的。

如果僅希望掃描特定的類而非基包下的所有類,可使用resource-pattern屬性過濾特定的類,如:

<context:component-scan base-package="com.atguigu.component" resource-pattern="autowire/*.class"/>

(1)掃描包含特定組件

如果我們僅僅是想要掃描包含特定特征的組件,那么我們可以如下方法:

<context:include-filter>子節點表示要包含的目標類

但是需要注意的是:由於context:component-scan默認是將所有的類全部都添加進去,所以在此基礎上再添加是沒有用的,需要在context:component-scan中加入屬性參數use-default-filters,use-default-filters="true" 表示默認將所有的類都添加進去,false表示將所有的類都不添加進去,

如下代碼表示僅僅掃描包含include-filter中所指特征的組件,其中的type用來表示使用何種類型的掃描表達式,expression后面跟表達式。

<context:component-scan base-package="com.spring" use-default-filters="false">
    <context:include-filter type="annotation" expression="org.springframework.stereotype.Repository"/>
</context:component-scan>

(2)掃描排除特定組件

盡然有掃描包含特定組件,那么就有掃描排除特定組件,

<context:exclude-filter>子節點表示要排除在外的目標類。

以下代碼表示掃描除以下特征外的其他組件。

<context:component-scan base-package="com.spring">
    <context:exclude-filter type="assignable" expression="com.spring.service.BookService"/>  
</context:component-scan> 

同時component-scan下可以擁有若干個include-filter和exclude-filter子節點,來表示可以包含多個哪種特征的組件或排除具有哪種特征的組件。

關於上面說到的type中填寫的過濾表達式類型及作用如下表:

最常用的上面兩個,以下三個幾乎不用:

type="aspectj" aspectj表達式

type="custom" 定義一個TypeFile,自己寫一個類定義使用哪一個

type="regex" 利用正則表達式

注意有bug:有些小伙伴們在進行注解開發的時候注解和掃描都寫的很完美,可就是不起作用,原因可能是缺少相應特有的一個jar包,在這里需要導入額外的一個aop包

spring-aop-4.0.0.RELEASE.jar​

到這里,將組件添加到容器中的操作就算是完成了,

在我們將組件添加成功之后呢,我們可以在組件圖標的右上角看到一個小S的圖標,這個時候就表示這個組件已經成功的加入到了容器中,

3、實現注解的三步驟

總結一下實現注解的三步驟:

  1. 添加context依賴
    context:component-scan
  2. 為類添加相應的注解
    1. 導入aop包
      spring-aop-4.0.0.RELEASE.jar

三、組件自動裝配

但是這樣就結束了嘛?就這么輕松了嘛?之前學習的bean的作用域與生命周期這些都沒用了嘛?當然不是!!!更重要的是組件還沒獲取呢!!!

那么接下來就來和大家講一下使用注解開發的高端操作,讓你知道使用注解是多么的香!!!

我們平常在使用類的時候,難免會在類中調用其他自定義的類對吧,就比如說,Controller組件中往往需要用到Service組件的實例,Service組件中往往需要用到Repository組件的實例。

那么如果我們對這些需要實例化的組件一個一個的在類中進行實例化,是不是就顯得太麻煩了呢?哎,聰明機智的程序員們怎么會沒有想到這一點呢!所以組件的自動裝配就出現了,​

在spring中我們可以通過注解的形式來對組件進行自動的裝配,那么到底如何對組件進行裝配的呢?

其實是這樣的,在IOC中指定要掃描的包時,<context:component-scan> 元素會自動注冊一個bean的后置處理器:AutowiredAnnotationBeanPostProcessor的實例。該后置處理器可以自動裝配標記了@Autowired、@Resource或@Inject注解的屬性。

而上面的@Autowired、@Resource或@Inject這三個注解,就是我們在進行組件的自動裝配時最常用的注解,

下面我和大家介紹一下這三種注解的具體使用。

1、@autowired注解

@autowired注解能夠根據類型實現自動裝配。無論是構造器、普通字段(即使是非public)、還是一切具有參數的方法都可以應用@Autowired注解

默認情況下,所有使用@Autowired注解的屬性都需要被設置。當Spring找不到匹配的bean裝配屬性時,會拋出異常。

(1)@autowired裝配原理

接下里我來和大家詳細的講一下@autowired注解的裝配原理:

1、使用自動裝配時,首先會根據類型去容器中查找相應的組件,這就類似於

getBean("bookService.class"),

2、如果沒有找到就拋異常,如果找到一個就賦值

3、如果找到多個,那么也是有一定的裝配依據的,並不是隨便找一個進行裝配。

首先根據屬性名作為ID進行繼續尋找,找到對應屬性名的組件就進行裝配,沒有找到就報錯,報錯的原因是:使用變量名作為id進行匹配時候,沒有找到對應的屬性名

(2)@Qualifier指定裝配ID

對於這種報錯其實還有一種解決:就是使用@Qualifier("bookService")指定查找ID,找到就裝配,找不到報錯,指定查找ID的代碼示例如下:

// 添加注解表示自動裝填
@Autowired
@Qualifier("bookdao")
private BookDao bookDao;

(3)required—裝配報錯解決

那么要是每次找不到就報錯,這樣程序不是就崩了嗎?對於這樣的情況應該怎么辦呢?其實還有一種解決辦法,解決找不到報錯:使用required參數,

@Autowired(required=false) required=false表示如果實在找不到,就裝配null

反正裝配的依據就是,按照多種規則查找合適的裝配對象,直到查找成功,實在不成功就返回null。

(4)特殊屬性的自動裝配

上面是使用@Autowired注解的基本原理與步驟,我們直到spring的注解開發是十分強大的,下面我們再來說幾個特殊的屬性的裝配。

@Autowired注解可以應用在數組類型的屬性上,此時Spring將會把所有匹配的bean進行自動裝配。

@Autowired注解也可以應用在集合屬性上,此時Spring讀取該集合的類型信息,然后自動裝配所有與之兼容的bean。

@Autowired注解用在java.util.Map上時,若該Map的鍵值為String,那么 Spring將自動裝配與值類型兼容的bean作為值,並以bean的id值作為鍵。

這樣一來,@Autowired注解的自動裝配是不是就顯得十分的強大了,以后媽媽再也不用擔心我new對象了!!!​

2、@Resource注解

@Resource注解要求提供一個bean名稱的屬性,若該屬性為空,則自動采用標注處的變量或方法名作為bean的名稱。

3、@Inject注解

@Inject和@Autowired注解一樣也是按類型注入匹配的bean,但沒有reqired屬性。

以上就是進行自動裝配時使用的三個注解,在這里再總結一下,

@autoWried是spring自帶的,更強大一些,能夠實現required=false

@Resource也是java自帶的,擴展性更強,所以如果切換成另一個容器框架,@Resource還是可以用的,而@Inject和@Autowired注解一樣也是按類型注入匹配的bean,但沒有reqired屬性。其實在日常開發中,我們最常用到的、功能最強大的注解還是@Autowired注解。所以記住這一個基本上就可以了。

然后再總結一下使用注解的好處,主要就是節省了new對象時麻煩,直接使用一個@Autowired注解,spring就可以自動的為該屬性賦值,一般來說將組件加入到IOC的注解和@Autowired是結合使用的。

四、注解使用的小細節

其實在使用注解進行開發時還有一些小細節需要注意,我在這里給大家總結一下。

1、整合多個配置文件

當我們開發時的項目過大的時候,在一個配置文件寫如配置有時候就不能滿足我們的需求,所以Spring允許通過<import>將多個配置文件引入到一個文件中,進行配置文件的集成。這樣在啟動Spring容器時,僅需要指定這個合並好的配置文件就可以。import元素的resource屬性支持Spring的標准的路徑資源,

如下示例,我們有springmvc.xml和spring.xml兩個配置文件,現在我們想要將spring.xml引入到springmvc.xml中,方法是:在springmvc.xml中寫入下面代碼:

<import resource="spring.xml"/>

2、路徑書寫問題

對於spring中常用地址書寫,有時候需要使用classpath,而有時候又需要其他,針對不同的路徑書寫,有不一樣的含義和使用:具體看下表:

3、獲取組件時的問題

對於使用注解方法添加到容器中的組件,我們在IOC容器中是看不到的,那么獲取它的時候應該如何獲取呢?

我們上面也說了,在注解中不指定id的前提下,spring是會自動的為每一個組件設置一個第一個字母小寫的組件的全稱作為ID,(如Book類的ID默認是book)。在容器中獲取組件的方法和以往一樣,但是如果是單實例的話,一般建議以類為參數進行獲取。如:

Book book = (Book)ioc.getBean(Book.class);

五、寫在最后

以上就是Spring注解開發的全部知識點了,是不是覺得使用注解開發比原生代碼簡潔多了,注解也是SSM框架乃至之后開發會經常用到的東西,

 

點擊關注,第一時間了解華為雲新鮮技術~


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM