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

Spring的一個核心功能是IOC，就是將Bean初始化加載到容器中，Bean是如何加載到容器的，可以使用Spring注解方式或者Spring XML配置方式。
Spring注解方式減少了配置文件內容，更加便於管理，並且使用注解可以大大提高了開發效率！
下面安裝分類講解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})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@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

``` @Configuration public static class Config {

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

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

}

@Component
public static class Config {

@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方法。為了糾正第二個代碼塊，我們可以這樣做

@Component
public static class Config {
@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 ：表明該類會作為與前端作交互的控制層組件，通過服務接口定義的提供訪問應用程序的一種行為，解釋用戶的輸入，將其轉換成一個模型然后將試圖呈獻給用戶。
 

@Controller
public class HappyController {
//do something
...
}

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

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

@Controller
@RequestMapping("/happy")
public class HappyController {

@Autowired
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。
 

@RequestMapping("/happy")
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 {
@Autowired
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>