關於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註解
/** * 資料庫層註解 * */ @Repositorypublic class BookDao { public void saveBook() { System.out.println("bookDao中的圖書已儲存..."); } }
通過這四個註解我們首先就可以將所有的元件逐一分類。置於為什麼要使用註解進行分類,說到底其實就是為了方便方便快速的知道哪一個類是做了什麼型別的功能,同時方便之後通過這四個註解將元件加入到IOC容器中。
所以你也可以把這四個註解理解為是Spring分發給不同功能元件的一個“身份證”,只有擁有這四種“身份證”,那麼這個元件就可以被加入到IOC容器中。
在這裡有一點需要注意:事實上Spring並沒有能力識別一個元件到底是不是它所標記的型別
二、元件掃描
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、實現註解的三步驟
總結一下實現註解的三步驟:
- 新增context依賴
context:component-scan - 為類新增相應的註解
- 匯入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框架乃至之後開發會經常用到的東西,