springboot常用注解（包含spring及MVC）

說明：以下的注解為springboot，spring以及spinrgMVC中常見的部分注解，并不包含全部，我隻是列出了常用的一些。

@Controller

這個無需多言，表明某類是一個controller，配合@RequestMapping注解即可實作跳轉

@ResponseBody

表示該方法的傳回結果直接寫入HTTP response body中

一般在異步擷取資料時使用，在使用@RequestMapping後，傳回值通常解析為跳轉路徑，加上

@responsebody後傳回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中。比如

異步擷取json資料，加上@responsebody後，會直接傳回json資料。

@RestController

官方文檔：

@RestController is a stereotype annotation that combines @ResponseBody and @Controller.

該注解告訴Spring以字元串的形式渲染結果，并直接傳回給調用者。相當于@ResponseBody ＋ @Controller合在一起的作用。

@RequestMapping注解

RequestMapping是一個用來處理請求位址映射的注解，可用于類或方法上。用于類上，表示類中的所有響應請求的方法都是以該位址作為父路徑。

該注解有六個屬性：

params:指定request中必須包含某些參數值是，才讓該方法處理。

headers:指定request中必須包含某些指定的header值，才能讓該方法處理請求。

value:指定請求的實際位址，指定的位址可以是URI Template 模式

method:指定請求的method類型， GET、POST、PUT、DELETE等

consumes:指定處理請求的送出内容類型（Content-Type），如application/json,text/html;

produces:指定傳回的内容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才傳回

@RequestParam

該注解可點選連結檢視

@PathVariable

路徑變量。

如 RequestMapping(“user/get/mac/{macAddress}”)

public String getByMacAddress(@PathVariable String macAddress){

//do something;

}

參數與大括号裡的名字一樣要相同。

—-以下為springboot特有注解

@Configuration

@Configuration注解該類，等價 與XML中配置beans；如

<beans></beans>

Spring Boot提倡基于Java的配置。盡管你可以使用一個XML源來調用 SpringApplication.run() ，我們通常建議你使用 @Configuration 類作為主要源。一般定義 main 方法的類也是主要 @Configuration 的一個很好候選。你不需要将所有的 @Configuration 放進一個單獨的類。 @Import 注解可以用來導入其他配置類。@Import(xxx.class) //在配置類中導入xxx類的配置

相當于之前在spring的xml配置檔案中導入另一個配置檔案的xml，

<import resource="classpath*:/spring/xxx.xml" />

另外，你也可以使用 @ComponentScan 注解自動收集所有的Spring元件，包括 @Configuration類。

如果你絕對需要使用基于XML的配置，我們建議你仍舊從一個 @Configuration 類開始。你可以使用附加的 @ImportResource 注解加載XML配置檔案,類似于xml配置時的：

@Bean

标注方法等價于XML中配置bean,如

<bean></bean>

,

放在方法的上面，而不是類，意思是産生一個bean,并交給spring管理。

@EnableAutoConfiguration

這個注解告訴Spring Boot根據添加的jar依賴猜測你想如何配置Spring。由于 spring-boot-starter-web 添加了Tomcat和Spring MVC，是以auto-configuration将假定你正在開發一個web應用并相應地對Spring進行設定。Starter POMs和Auto-Configuration：設計auto-configuration的目的是更好的使用”Starter POMs”，但這兩個概念沒有直接的聯系。你可以自由地挑選starter POMs以外的jar依賴，并且Spring Boot将仍舊盡最大努力去自動配置你的應用。

你可以通過将 @EnableAutoConfiguration 或 @SpringBootApplication 注解添加到一個 @Configuration 類上來選擇自動配置。

注：你隻需要添加一個 @EnableAutoConfiguration 注解。我們建議你将它添加到主 @Configuration 類上。

如果發現應用了你不想要的特定自動配置類，你可以使用 @EnableAutoConfiguration 注解的排除屬性來禁用它們。

如

@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})

public class MyConfiguration {

}

@ComponentScan

個人了解相當于之前在spring配置檔案xml中的

<context:component-scan>

你可以自由地使用任何标準的Spring架構技術去定義beans和它們注入的依賴。簡單起見，我們經常使用 @ComponentScan 注解搜尋beans，并結合 @Autowired 構造器注入。

如果使用上面建議的結構組織代碼（将應用類放到根包下），你可以添加 @ComponentScan 注解而不需要任何參數。你的所有應用程式元件（ @Component , @Service , @Repository , @Controller 等）将被自動注冊為Spring Beans。

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan

該 @SpringBootApplication 注解等價于以預設屬性使用 @Configuration ，@EnableAutoConfiguration和 @ComponentScan 。

很多Spring Boot開發者總是使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 注解他們的main類。由于這些注解被如此頻繁地一塊使用（特别是你遵循以上最佳實踐時），Spring Boot提供一個友善的 @SpringBootApplication 選擇。

@AutoWired

byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變量、方法及構

造函數進行标注，完成自動裝配的工作。

當加上（required=false）時，就算找不到bean也不報錯。

@Qualifier

當有多個同一類型的Bean時，可以用@Qualifier(“name”)來指定。與@Autowired配合使用

@Resource(name=”name”,type=”type”)：

沒有括号内内容的話，預設byName。與@Autowired幹類似的事。