A. spring常用註解
一、組件註解
1、 @Component(「xxx」)
指定某個類是容器的bean, @Component(value="xx") 相當於 ,其中 value 可以不寫。
用於標注類為spring容器bean的註解有四個, 主要用於區別不同的組件類,提高代碼的可讀性:
a、 @Component, 用於標注一個普通的bean
b、 @Controller 用於標注一個控制器類(控制層 controller)
c、 @Service 用於標注業務邏輯類(業務邏輯層 service)
d、 @Repository 用於標注DAO數據訪問類 (數據訪問層 )
對於上面四種註解的解析可能是相同的,盡量使用不同的註解提高代碼可讀性。
註解用於修飾類,當不寫value屬性值時,默認值為類名首字母小寫。
2、 @Scope(「prototype」)
該註解和 @Component 這一類註解聯合使用,用於標記該類的作用域,默認 singleton 。
也可以和 @Bean 一起使用,此時 @Scope 修飾一個方法。關於@Bean稍後有說明
3、 @Lazy(true)
指定bean是否延時初始化,相當於 ,默認false。@Lazy可以和@Component這一類註解聯合使用修飾類,也可以和@Bean一起使用修飾方法
注 :此處初始化不是指不執行 init-method ,而是不創建bean實例和依賴注入。只有當該bean(被@Lazy修飾的類或方法)被其他bean引用(可以是自動注入的方式)或者執行getBean方法獲取,才會真正的創建該bean實例,其實這也是BeanFactory的執行方式。
4、 @DepondsOn({「aa」,「bb」})
該註解也是配合 @Component 這類註解使用,用於強制初始化其他bean
上面的代碼指定,初始化bean 「userAction"之前需要先初始化「aa」和「bb」兩個bean,但是使用了@Lazy(true)所以spring容器初始化時不會初始化"userAction」 bean。
5、 @PostConstructor和@PreDestroy
@PostConstructor 和 @PreDestroy 這兩個註解是j2ee規范下的註解。這兩個註解用於修飾方法,spring用這兩個註解管理容器中spring生命周期行為。
a、 @PostConstructor 從名字可以看出構造器之後調用,相當於 。就是在依賴注入之後執行
b、 @PreDestroy 容器銷毀之前bean調用的方法,相當於
6、 @Resource(name=「xx」)
@Resource 可以修飾成員變數也可以修飾set方法。當修飾成員變數時可以不寫set方法,此時spring會直接使用j2ee規范的Field注入。
@Resource有兩個比較重要的屬性,name和type
a、 如果指定了name和type,則從Spring容器中找到唯一匹配的bean進行裝配,找不到則拋出異常;
b、 如果指定了name,則從spring容器查找名稱(id)匹配的bean進行裝配,找不到則拋出異常;
c、 如果指定了type,則從spring容器中找到類型匹配的唯一bean進行裝配,找不到或者找到多個,都會拋出異常;
d、 如果既沒有指定name,又沒有指定type,則自動按照byName方式進行裝配
如果沒有寫name屬性值時
a、 修飾成員變數,此時name為成員變數名稱
b、 修飾set方法,此時name 為set方法的去掉set後首字母小寫得到的字元串
7、 @Autowired(required=false)
@Autowired可以修飾構造器,成員變數,set方法,普通方法。@Autowired默認使用byType方式自動裝配。required標記該類型的bean是否是必須的,默認為必須存在(true)。
可以配合 @Qualifier(value="xx") ,實現按beanName注入:
a、 required=true(默認),為true時,從spring容器查找和指定類型匹配的bean,匹配不到或匹配多個則拋出異常
b、 使用 @Qualifier("xx") ,則會從spring容器匹配類型和 id 一致的bean,匹配不到則拋出異常
@Autowired會根據修飾的成員選取不同的類型:
a、 修飾成員變數。該類型為成員變數類型
b、 修飾方法,構造器。注入類型為參數的數據類型,當然可以有多個參數
8、demo
業務邏輯層:
數據訪問層:
測試類:
輸出結果:
可以看到雖然UserDao 使用@Lazy,但是還是在spring容器初始化的時候還是創建了UserDao實例。原因很簡單,因為在UserService中需要注入UserDao,所以在此時創建的UserDao實例也屬於延時初始化。
在上面我們還使用了兩個介面InitializingBean 和DisposableBean,這兩個介面用於管理 singleton 作用域的bean的生命周期,類似init-method和destroy-method。不同之處就是調用的循序不一致:
a、 初始化調用順序 :@PostConstructor > InitializingBean > init-method 用於指定bean依賴注入後的行為
b、 銷毀調用順序 @PreDestroy > DisposableBean > destroy-method 用於定製bean銷毀之前的行為
該註解是AspectJ中的註解,並不是spring提供的,所以還需要導入aspectjweaver.jar,aspectjrt.jar,除此之外還需要依賴aopalliance.jar
依賴包:
UserDao.java
配置文件 applicationContext.xml:
測試類:
1、 @Aspect
修飾Java類,指定該類為切面類。當spring容器檢測到某個bean被@Aspect修飾時,spring容器不會對該bean做增強處理(bean後處理器增強,代理增強)
2、 @Before
修飾方法,before增強處理。用於對目標方法(切入點表達式表示方法)執行前做增強處理。可以用於許可權檢查,登陸檢查。
常用屬性:
value: 指定切入點表達式 或者引用一個切入點
對com.example.aop 包下所有的類的所有方法做 before增強處理:
結果:
如果同一條切入點表達式被使用多次,可以使用更友好的方式。定義一個切入點:
增強方法可以接受一個JoinPoint 類型的參數,用於獲取被執行目標方法的一下屬性。
結果:
3、 @AfterReturning
修飾方法,afterreturning增強處理。目標方法正常結束後做增強處理。
常用屬性:
a、 pointcut/value:指定切入點表達式
b、 returning:指定一個參數名,用於接受目標方法正常結束時返回的值。參數名稱需要在增強方法中定義同名的參數。
注意:
a、 如果使用了returning 。那麼增強方法中的數據類型必須是返回結果的類型或者父類型,否則不會調用該增強處理。
b、 使用了returning 還可以用來 修改返回結果 。
以上面的例子來說,目標方法返回結果類型應該滿足下面的條件
修改返回值:
結果:
可以看到 AfterReturning 修改了返回結果。
4、 @AfterThrowing
修飾方法,afterthrowing增強處理。當目標程序方法拋出 異常或者異常無法捕獲時,做增強處理。
常用屬性:
a、 pointcut/value :指定切入點表達式
b、 throwing:指定一個形參,在增強方法中定義同名形參,用於訪問目標方法拋出的異常
參數類型必須是 Throwable 的子類,同樣也會有上面@AfterReturning 參數類型匹配的問題。
5、 @After
修飾方法 ,after增強處理。無論方法是否正常結束,都會調用該增強處理(@After= @AfterReturning+@AfterThrowing)。但是該增強方式無法獲取目標方法的返回結果,也獲取目標方法拋出的異常。所以一般用於進行釋放資源,功能類似於 finally。
常用屬性:
a、 value :指定切入點表達式
結果:
從上面的結果來看 After 增加處理 ,因為不能接受返回結果作為參數,所以不能修改返回結果。
6、 @Around
修飾方法, around增強處理。該處理可以目標方法執行之前和執行之後織入增強處理(@Before+@AfterReturning)。
Around增強處理通常需要在線程安全的環境下使用,如果@Before和@AfterReturning可以處理就沒必要使用@Around。
常用屬性:
a、 value :指定切入點表達式
當定義一個Aound增前處理時,增強方法第一形參需要時ProceedingJoinPoint類型。ProceedingJoinPoint有一個Object proceed()方法,用於執行目標方法。當然也可以為目標方法傳遞數組參數,來修改目前方法的傳入參數。
around小結:
a、 Around增強處理通常需要 在線程安全 的環境下使用
b、 調用 proceed()可以獲取返回結果,所以可以修改目標方法的返回值
c、 proceed(Object[] var1) 可以修改入參,修改目標方法的入參
d、 可以進行目標方法執行之前和執行之後織入增強處理
around 和 afterReturning 都可以修改返回結果。不過兩者的原理不同:
a、 around:可以任意修改,或者返回不相關的值。這個返回值完全可以自主控制
b、 afterReturning,通過方法參數 ,使用對象引用的方式來修改對象。修改對象引用地址那麼修改時無效的
除此之外從輸出結果來看,增強處理是有序的:
around 和 afterReturning小結:
a、 只有 around 和 afterReturning 可以獲取並修改返回結果。需要注意兩種方式修改的區別。
b、 around 需要線程安全
c、 雖然增強處理都需要 切入點表達式,並不是都支持 pointcut 屬性,所以最好都是用value 屬性指定。當註解只需要value屬性時,value可以省略
7、 @Pointcut
修飾方法,定義一個切入點表達式用於被其他增強調用。使用該方式定義切入點方便管理,易復用。
切入點方法定義和測試方法定義類似,具有以下特點:
a、 無返回值 (void)
b、 無參數
c、 方法體為空
d、 方法名就是切入點名稱
e、 方法名不能為 execution
切入點表達式
切入點表達式可以通過 && 、 || 、 ! 連接
1)、execution 表達式:
2)、within 表達式:
a、匹配指定類下的所有方法。
b、匹配執行包及其子包下所有類的所有方法。
所以within可以看做execution的簡寫,不需要指定返回類型、方法名、參數( 最小作用單位是類 )
3)、 @annotation:匹配使用指定註解修飾的目標方法;
匹配使用@CustomMethodAnnotation註解的目標方法。
4)、 @within: 用於匹配使用指定註解修飾的類下的所有方法
within 作用范圍是類,@within的作用范圍與其一致。不同的是@within 指定的不是類而是註解
匹配使用@ResponseBody 註解的類 下的所有方法。
AOP小結:
1)、 Around增強處理通常需要 在線程安全 的環境下使用
2)、 使用 around 和 afterReturning 可以獲取並修改返回結果
3)、 增強處理指定 切入點表達式時,最好使用value 屬性
4)、 切入點 名稱(方法名)不能為 execution
5)、 AfterReturning 指定了 returning 屬性接受目標方法返回結果,注意 參數類型需要和返回結果類型一致(滿足 resutType instanceof argsType )
增強方式的順序:
1、 @Bean(name=「xxx」)
修飾方法,該方法的返回值為spring容器中管理的bean。當然該註解和上面的@Component效果一樣,主要用於做區分。
@Bean 通常使用在 @Configuration 修飾的配置類中,該註解功能相當於 元素
常用的屬性:
a、 name:bean id 。name可以省略,省略時bean名稱為方法名。也可以指定多個名稱(逗號隔開)。
b、 autowire: 是否自動注入,默認Autowire.NO
c、 initMethod:bean的初始化方法。在依賴注入之後執行
d、 destroyMethod: spring容器關閉時bean調用的方法
當然 @Bean 還可以配合 @Scope 指定bean的作用域
2、 @ConfigurationProperties
用於從屬性文件中獲取值 application.properties 或者 application.yml 。當然了 如果在配置文件中引入其他配置文件,也可以獲取到屬性值。
包含的屬性:
a、 value | prefix 兩者互為別名。指定前綴,默認為""
b、 ignoreUnknownFields:默認為true。是否忽略未知欄位,當實體中的欄位在配置文件中不存在時,是忽略還是拋出異常
c、 ignoreInvalidFields: 默認false。 是否忽略不合法的欄位,此處的不合法是指類型不合適,配置文件中存在改配置但是無法轉化為指定的欄位類型。
Mybatis屬性配置
application.properties:
ConfigurationProperties 可以配置前綴,然後會根據實體的變數名拼接前綴,去配置文件中查詢配置。
3、 @Configuration
修飾一個Java類,被修飾的類相當於一個xml配置文件。功能類似於 。在springboot中大量使用了該註解,該註解提供了一種使用Java類方式配置bean。
可以發現 @Configuration使用了@Component 註解修飾。
實例 :
配置Mybatis會話工廠
4、 @Import
功能和 類似,修飾Java類,用於向當前類導入其他配置類。 可以導入多個配置文件,通常用於導入不在包掃描范圍內的配置文件。可以被掃描的配置類可以直接訪問,沒有必要使用@Import 導入。
比如 SpringBoot的啟動類指定的包掃描路徑為 com.example
資料庫的配置文件在 com包下。
在MyBatisConfig 中引入 DataSourceConfig, 就會解析DataSourceConfig。將解析出的Bean交給容器管理
5、 @ImportResource
修飾Java類,用於向類引入xml配置文件。
用於導入包含bean定義的配置文件,功能和 類似。默認情況下可以處理後綴為 .groovy 和.xml 的配置文件
6、 @Value("${expression}")
修飾成員變數或者 方法、構造器的參數,用於屬性值注入(在配置文件中配置的值)。
注意: @Value不能對 static 屬性注入。
如果的確需要注入到靜態變數,可以通過以下方式間接進行注入:
1)、設置一個私有靜態 實例
2)、通過構造函數或者 @PostConstruct 註解為 靜態實例 賦值,指向本身(this)
3)、對成員屬性注入內容
4)、提供靜態方法,使用靜態實例獲取成員屬性
7、@PropertySource(value=「classpath:jdbc.properties」)
該註解用來載入屬性文件。
常用屬性:
a、 ignoreResourceNotFound: 當資源文件找不到的時候是否會忽略該配置,而不是拋出錯誤。一般用於可選項
b、 encoding : 資源文件使用什麼編碼方式
c、 value : 指定屬性文件位置。可以配置多個屬性文件,不可以使用通配符。
在 PropertySource 中可以指定多個路徑,並且會將屬性文件中的值載入到 Environment 中。
@ConfigurationProperties 和 @PropertySource
它們的使用有一些差異:
1)、 @PropertySource 使用該註解載入的是 相對獨立的屬性文件,可以同時載入多個文件 (xxx.properties),而且 不支持自動注入 , 不支持前綴注入
2)、 @ConfigurationProperties 用於載入配置文件(application.properties | application.yml)。該註解功能更強大:
a、 支持前綴注入 ( prefix )
b、 相同屬性名的自動注入
c、 $("") 支持EL表達式注入
應用實例:
在以往的開發中通常會將資料庫連接信息存放在單獨的屬性文件中(jdbc.properties)。而在spring boot 中我們會將資料庫的信息存放在配置文件中,這會極大便利開發工作。
jdbc.properties:
可以通過 @Value 註解將配置文件的值注入到實體類中
也可以注入Environment ,通過Environment 獲取值
1、 @ResponseBody
控制器方法返回值會使用 HttpMessageConverter 進行數據格式化,轉化為JSON字元串。
同樣的 ResponseBodyAdvice: 針對使用@ResponseBody的註解的類,方法做增強處理。
2、 @RestController
@RestController = @Controller + @ResponseBody , 所以通常直接使用@RestController 註解
3、 @RequestBody
從Reuqest請求體中獲取內容,綁定到方法的指定參數上。 SpringMVC 使用HttpMessageConverter 介面將請求體中的數據轉化為方法參數類型。
SpringMVC 給用戶對參數的處理提供了很大支配權。 我們可以使用 介面RequestBodyAdvice 來實現對參數進行攔截處理。
注意
1)、 RequestBodyAdvice : 針對所有以@RequestBody的參數做處理
2)、 自定義的處理對象類上必須得加上@ControllerAdvice註解!
利用此功能我們可以做以下處理工作:
1)、參數做解密處理。
2)、修改接受的參數數據。
4、 @RequestParam
從Request請求中獲取指定的參數。
可以設置的屬性:
1)、 required : 默認為true 參數必須存在 。參數不存在時拋出異常(). 提示信息
2)、 defaultValue : 設置參數默認值。 當參數沒有提供或者為空值時生效, 包含隱式定義 required=false
3)、 name | value , 互為別名的屬性, 綁定請求中的參數名。 request.getParameter(name);
5、 @RequestMapping
用於設置 請求 和 Method 的映射關系。指明何種請求可以和方法匹配
可配置屬性值:
1)、 path、value、 name, 互為別名,設置可以處理的url。
2)、 consumes,字元串數組。 指定可以處理的 媒資類型,僅當請求頭中的 Content-Type 與其中一種媒體類型匹配時,才會映射請求。所以該配置會縮小可匹配的請求。 當url 匹配但是consumes不匹配時, 狀態碼415。 不設置的話,表示不限制媒資類型,參數的具體使用何種方式解析,SpringMVC會選擇合適的處理器處理。
3)、 proces,字元串數組。 生成的媒資類型,該屬性會影響實際的輸出類型。和consumes一樣,改配置會縮小匹配的范圍。 只有當請求頭中的 Accept 與 配置的任意一個媒資類型匹配時,才會映射請求。 當url 匹配與consumes不匹配時, 狀態碼406 。 比如:為了生成UTF-8編碼的JSON響應,應使用 MediaType.APPLICATION_JSON_UTF8_VALUE。