Spring常用注解介紹【經典總結】

Spring的一個核心功能是IOC，就是将Bean初始化加載到容器中，Bean是如何加載到容器的，可以使用Spring注解方式或者Spring XML配置方式。

Spring注解方式減少了配置檔案内容，更加便于管理，并且使用注解可以大大提高了開發效率！

Spring的一個核心功能是IOC，就是将Bean初始化加載到容器中，Bean是如何加載到容器的，可以使用Spring注解方式或者Spring XML配置方式。

下面安裝分類講解Spring中常用的一些注解。

一：元件類注解

思考：spring怎麼知道應該哪些Java類當初bean類處理？
答案：使用配置檔案或者注解的方式進行辨別需要處理的java類!

1、注解類介紹

@Component ：标準一個普通的spring Bean類。

@Repository：标注一個DAO元件類。

@Service：标注一個業務邏輯元件類。

@Controller：标注一個控制器元件類。

這些都是注解在平時的開發過程中出鏡率極高，@Component、@Repository、@Service、@Controller實質上屬于同一類注解，用法相同，功能相同，差別在于辨別元件的類型。@Component可以代替@Repository、@Service、@Controller，因為這三個注解是被@Component标注的。如下代碼

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
    String value() default "";
}

2、舉例詳解

（1）當一個元件代表資料通路層（DAO）的時候，我們使用@Repository進行注解，如下

@Repository
public class HappyDaoImpl implements HappyDao{
private final static Logger LOGGER = LoggerFactory.getLogger(HappyDaoImpl .class);
public void  club(){
        //do something ,like drinking and singing
    }
}

（2）當一個元件代表業務層時，我們使用@Service進行注解，如下

@Service(value="goodClubService")
//使用@Service注解不加value ,預設名稱是clubService
public class ClubServiceImpl implements ClubService {
    @Autowired
    private ClubDao clubDao;
  
    public void doHappy(){
        //do some Happy
    }
 }

（3）當一個元件作為前端互動的控制層，使用@Controller進行注解，如下

@Controller
public class HappyController {
	@Autowired //下面進行講解
    private ClubService clubService;
    
	// Control the people entering the Club
	// do something
}
/*Controller相關的注解下面進行詳細講解，這裡簡單引入@Controller*/

3、總結注意點

1、被注解的java類當做Bean執行個體，Bean執行個體的名稱預設是Bean類的首字母小寫，其他部分不變。@Service也可以自定義Bean名稱，但是必須是唯一的！

2、盡量使用對應元件注解的類替換@Component注解，在spring未來的版本中，@Controller，@Service，@Repository會攜帶更多語義。并且便于開發和維護！

3、指定了某些類可作為Spring Bean類使用後，最好還需要讓spring搜尋指定路徑，在Spring配置檔案加入如下配置：

<!-- 自動掃描指定包及其子包下的所有Bean類 -->
<context:component-scan base-package="org.springframework.*"/>

二：裝配bean時常用的注解

1、注解介紹

@Autowired：屬于Spring 的org.springframework.beans.factory.annotation包下,可用于為類的屬性、構造器、方法進行注值

@Resource：不屬于spring的注解，而是來自于JSR-250位于java.annotation包下，使用該annotation為目标bean指定協作者Bean。

@PostConstruct 和 @PreDestroy 方法實作初始化和銷毀bean之前進行的操作

2、舉例說明

（1）：@Autowired

```

@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

public @interface Autowired {

boolean required() default true;

}

@Controller

public class HappyController {

@Autowired //預設依賴的ClubDao 對象（Bean）必須存在

//@Autowired(required = false) 改變預設方式

@Qualifier("goodClubService")

private ClubService clubService;

// Control the people entering the Club
// do something

（2）：@Resource

@Target({TYPE, FIELD, METHOD})

@Retention(RUNTIME)

public @interface Resource {

String name() default "";

Class type() default java.lang.Object.class;

...

public class AnotationExp {

@Resource(name = "HappyClient")
private HappyClient happyClient;

@Resource(type = HappyPlayAno .class)
private HappyPlayAno happyPlayAno;

<h4><font color="red">3、總結</font></h4>
（1）：相同點
<font color="red">
@Resource的作用相當于@Autowired，均可标注在字段或屬性的setter方法上。
</font>
（2）：不同點
<font color="red">
a：**提供方** @Autowired是Spring的注解，@Resource是javax.annotation注解，而是來自于JSR-250，J2EE提供，需要JDK1.6及以上。
b ：**注入方式** @Autowired隻按照Type 注入；@Resource預設按Name自動注入，也提供按照Type 注入；
c：**屬性** 
@Autowired注解可用于為類的屬性、構造器、方法進行注值。預設情況下，其依賴的對象必須存在（bean可用），如果需要改變這種預設方式，可以設定其required屬性為false。
還有一個比較重要的點就是，@Autowired注解**預設按照類型裝配**，如果容器中包含多個同一類型的Bean，那麼啟動容器時會報找不到指定類型bean的異常，解決辦法是結合**@Qualified**注解進行限定，指定注入的bean名稱。
@Resource有兩個中重要的屬性：name和type。name屬性指定byName，如果沒有指定name屬性，當注解标注在字段上，即預設取字段的名稱作為bean名稱尋找依賴對象，當注解标注在屬性的setter方法上，即預設取屬性名作為bean名稱尋找依賴對象。
需要注意的是，@Resource如果沒有指定name屬性，并且按照預設的名稱仍然找不到依賴對象時， @Resource注解會回退到按類型裝配。但一旦指定了name屬性，就隻能按名稱裝配了。
</font><font color="red">
d：@Resource注解的使用性更為靈活，可指定名稱，也可以指定類型 ；@Autowired注解進行裝配容易抛出異常，特别是裝配的bean類型有多個的時候，而解決的辦法是需要在增加@Qualitied進行限定。
</font>

<a href="http://qiangmzsx.blog.51cto.com/2052549/1359952" target="_blank">Spring中 @Autowired注解與@Resource注解的差別</a>


<h4>注意點：使用@Resource也要注意添加配置檔案到Spring，如果沒有配置</h4>

context:component-scan

需要配置

context:annotation-config/

<h3>三：@Component vs @Configuration and @Bean</h3>
  <h4>1、簡單介紹</h4>
  Spring的官方團隊說@Component可以替代 @Configuration注解，事實上我們看源碼也可以發現看到，如下

@Target({ElementType.TYPE})

@Component //看這裡！！！

public @interface Configuration {

String value() default "";

雖然說可以替代但是兩個注解之間還是有差別的！

Bean注解主要用于方法上，有點類似于工廠方法，當使用了@Bean注解，我們可以連續使用多種定義bean時用到的注解，譬如用@Qualifier注解定義工廠方法的名稱，用@Scope注解定義該bean的作用域範圍，譬如是singleton還是prototype等。

Spring 中新的 Java 配置支援的核心就是@Configuration 注解的類。這些類主要包括 @Bean 注解的方法來為 Spring 的 IoC 容器管理的對象定義執行個體，配置和初始化邏輯。

使用@Configuration 來注解類表示類可以被 Spring 的 IoC 容器所使用，作為 bean 定義的資源。

@Configuration

public class AppConfig {

@Bean

public MyService myService() {

return new MyServiceImpl();

這和 Spring 的 XML 檔案中的<beans/>非常類似

@Bean 注解扮演了和元素相同的角色。

2、舉例說明@Component 和 @Configuration

public static class Config {

@Bean
public SimpleBean simpleBean() {
    return new SimpleBean();
}

@Bean
public SimpleBeanConsumer simpleBeanConsumer() {
    return new SimpleBeanConsumer(simpleBean());
}

@Component

@Bean
public SimpleBean simpleBean() {
    return new SimpleBean();
}

@Bean
public SimpleBeanConsumer simpleBeanConsumer() {
    return new SimpleBeanConsumer(simpleBean());
}

第一個代碼正常工作，正如預期的那樣，**SimpleBeanConsumer**将會得到一個單單SimpleBean的連結。第二個配置是完全錯誤的，因為spring會建立一個SimpleBean的單例bean，但是SimpleBeanConsumer将獲得另一個SimpleBean執行個體，該執行個體是spring上下文控件之外的。

  <h4>3、原因總結</h4>
  使用@ configuration，所有标記為@ bean的方法将被包裝成一個CGLIB包裝器，它的工作方式就好像是這個方法的第一個調用，那麼原始方法的主體将被執行，最終的對象将在spring上下文中注冊。所有進一步的調用隻傳回從上下文檢索的bean。
  
在上面的第二個代碼塊中，新的SimpleBeanConsumer(simpleBean())隻調用一個純java方法。為了糾正第二個代碼塊，我們可以這樣做

@Autowired

SimpleBean simpleBean;

@Bean
public SimpleBean simpleBean() {
    return new SimpleBean();
}

@Bean
public SimpleBeanConsumer simpleBeanConsumer() {
    return new SimpleBeanConsumer(simpleBean);
}

<a href="http://dimafeng.com/2015/08/29/spring-configuration_vs_component/">Spring @Configuration vs @Component</a>
<a href="https://wizardforcel.gitbooks.io/spring-doc-3x/content/28.html">基本概念：@Configuration 和@Bean</a>


<h3>四：spring MVC子產品注解</h3>
  <h4>1、web子產品常用到的注解</h4>

 - @Controller ：表明該類會作為與前端作互動的控制層元件，通過服務接口定義的提供通路應用程式的一種行為，解釋使用者的輸入，将其轉換成一個模型然後将試圖呈獻給使用者。

//do something

Spring MVC 使用 @Controller 定義控制器，它還允許自動檢測定義在類路徑下的元件（配置檔案中配置掃描路徑）并自動注冊。
 

 - @RequestMapping ： 這個注解用于将url映射到整個處理類或者特定的處理請求的方法。可以隻用通配符！

@RequestMapping("/happy")

public class HappyController {

private HappyService happyService;

@RequestMapping(/hello/)

public void sayHello(){

//請求為 /happy/hello/ 都會進入這個方法！

//例如：/happy/hello/123 /happy/hello/adb

//可以通過get/post 請求

@RequestMapping(value="/haha",method=RequestMethod.GET)

public void sayHaHa(){

//隻能通過get請求

@RequestMapping 既可以作用在類級别，也可以作用在方法級别。當它定義在類級别時，标明該控制器處理所有的請求都被映射到 /favsoft 路徑下。@RequestMapping中可以使用 method 屬性标記其所接受的方法類型，如果不指定方法類型的話，可以使用 HTTP GET/POST 方法請求資料，但是一旦指定方法類型，就隻能使用該類型擷取資料。
 
 - @RequestParam ：将請求的參數綁定到方法中的參數上，有required參數，預設情況下，required=true，也就是改參數必須要傳。如果改參數可以傳可不傳，可以配置required=false。

public String sayHappy(

@RequestParam(value = "name", required = false) String name,

@RequestParam(value = "age", required = true) String age) {

//age參數必須傳，name可傳可不傳

- @PathVariable ： 該注解用于方法修飾方法參數，會将修飾的方法參數變為可供使用的uri變量（可用于動态綁定）。

@RequestMapping(value="/happy/{dayid}",method=RequestMethod.GET)

public String findPet(@PathVariable String dayid, Model mode) {

//使用@PathVariable注解綁定 {dayid} 到String dayid

@PathVariable中的參數可以是任意的簡單類型，如int, long, Date等等。Spring會自動将其轉換成合适的類型或者抛出 TypeMismatchException異常。當然，我們也可以注冊支援額外的資料類型。
  @PathVariable支援使用正規表達式，這就決定了它的超強大屬性，它能在路徑模闆中使用占位符，可以設定特定的字首比對，字尾比對等自定義格式。
 
 - @RequestBody ：  @RequestBody是指方法參數應該被綁定到HTTP請求Body上。

@RequestMapping(value = "/something", method = RequestMethod.PUT)

public void handle(@RequestBody String body，@RequestBody User user){

//可以綁定自定義的對象類型

-  @ResponseBody  ： @ResponseBody與@RequestBody類似，它的作用是将傳回類型直接輸入到HTTP response body中。
 @ResponseBody在輸出JSON格式的資料時，會經常用到。

@RequestMapping(value = "/happy", method =RequestMethod.POST)

@ResponseBody

public String helloWorld() {

return "Hello World";//傳回String類型

- @RestController ：控制器實作了REST的API，隻為服務于JSON，XML或其它自定義的類型内容，@RestController用來建立REST類型的控制器，與@Controller類型。@RestController就是這樣一種類型，它避免了你重複的寫@RequestMapping與@ResponseBody。
 
 
 
 -  @ModelAttribute ：@ModelAttribute可以作用在方法或方法參數上，當它作用在方法上時，标明該方法的目的是添加一個或多個模型屬性（model attributes）。
 該方法支援與@RequestMapping一樣的參數類型，但并不能直接映射成請求。控制器中的@ModelAttribute方法會在@RequestMapping方法調用之前而調用。
 
  @ModelAttribute方法有兩種風格：一種是添加隐形屬性并傳回它。另一種是該方法接受一個模型并添加任意數量的模型屬性。使用者可以根據自己的需要選擇對應的風格。
      
  
<h3>五：Spring事務子產品注解</h3>
  <h4>1、常用到的注解</h4>
  在處理dao層或service層的事務操作時，譬如删除失敗時的復原操作。使用**@Transactional** 作為注解，但是需要在配置檔案激活

<tx:annotation-driven transaction-manager="transactionManager" />

<h4>2、舉例</h4>

@Service

public class CompanyServiceImpl implements CompanyService {

private CompanyDAO companyDAO;

@Transactional(propagation = Propagation.REQUIRED, readOnly = false, rollbackFor = Exception.class)

public int deleteByName(String name) {

int result = companyDAO.deleteByName(name);
return company;

<h4>3、總結</h4>
事務的傳播機制和隔離機制比較重要！

事務傳播行為類型|說明
----|--
PROPAGATION_REQUIRED	|如果目前沒有事務，就建立一個事務，如果已經存在一個事務中，加入到這個事務中。這是最常見的選擇。
PROPAGATION_SUPPORTS	|支援目前事務，如果目前沒有事務，就以非事務方式執行。
PROPAGATION_MANDATORY	|使用目前的事務，如果目前沒有事務，就抛出異常。
PROPAGATION_REQUIRES_NEW	|建立事務，如果目前存在事務，把目前事務挂起。
PROPAGATION_NOT_SUPPORTED	|以非事務方式執行操作，如果目前存在事務，就把目前事務挂起。
PROPAGATION_NEVER	|以非事務方式執行，如果目前存在事務，則抛出異常
PROPAGATION_NESTED	|如果目前存在事務，則在嵌套事務内執行。如果目前沒有事務，則執行與PROPAGATION_REQUIRED類 似的操作


----------


<a href="http://ju.outofmemory.cn/entry/113944">一圖學習 Spring事務傳播性</a>

----------


readOnly  : 事務的讀寫屬性，取true或者false，true為隻讀、預設為false
rollbackFor  : 復原政策，當遇到指定異常時復原。譬如上例遇到異常就復原
timeout （補充的）  : 設定逾時時間，機關為秒
isolation  : 設定事務隔離級别，枚舉類型，一共五種
類型 | 說明
-----| -----
DEFAULT	|采用資料庫預設隔離級别
READ_UNCOMMITTED	|讀未送出的資料（會出現髒讀取）
READ_COMMITTED|	讀已送出的資料（會出現幻讀，即前後兩次讀的不一樣）
REPEATABLE_READ|	可重複讀，會出現幻讀
SERIALIZABLE	串行化|（對資源消耗較大，一般不使用）

<a href="https://www.ibm.com/developerworks/cn/java/j-master-spring-transactional-use/index.html">
透徹的掌握 Spring 中@transactional 的使用</a>
<a href="http://opiece.me/2016/03/18/spring-transactional-introduce/">
Spring事務配置及事務的傳播性與隔離級别詳解</a>


<h3>參考博文</h3>
<a href="http://www.voidcn.com/blog/Justnow_/article/p-6195068.html" target="_blank">spring 常用注解</a>
<a href="http://favccxx.blog.51cto.com/2890523/1582185" target="_blank">詳解Spring MVC 4常用的那些注解</a>

----------


歡迎通路我的csdn部落格，我們一同成長！

"<font size=4 color="blue">不管做什麼，隻要堅持下去就會看到不一樣！在路上，不卑不亢!</font>"

 部落格首頁：<a href="http://blog.csdn.net/u010648555" target="_blank">http://blog.csdn.net/u010648555</a>

作者：阿飛雲

出處：部落格園阿飛雲的技術部落格--http://www.cnblogs.com/aflyun

您的支援是對部落客最大的鼓勵，感謝您的認真閱讀。

本文版權歸作者所有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接配接，否則保留追究法律責任的權利。

Spring常用注解介紹【經典總結】

一：元件類注解

1、注解類介紹

2、舉例詳解

3、總結注意點

二：裝配bean時常用的注解

1、注解介紹

2、舉例說明

2、舉例說明@Component 和 @Configuration

繼續閱讀

MyBatis-Plus 之AR模式

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法

Spring常用注解介紹【經典總結】

一： 元件類注解

1、注解類介紹

2、舉例詳解

3、總結注意點

二：裝配bean時常用的注解

1、注解介紹

2、舉例說明

2、舉例說明@Component 和 @Configuration

繼續閱讀

一：元件類注解