來源：素文宅博客
轉自：https://blog.yoodb.com/yoodb/article/detail/1563
Spring Boot是目前非常流行的框架，而註解是Spring Boot的核心功能，接下來主要說一說Spring Boot常用註解的含義以及部分註解在項目中的使用方法。
@RestController和@RequestMapping
@RestController被稱爲一個構造型（stereotype）註解。它爲閱讀代碼的開發人員提供建議。對於Spring來說，該類扮演了一個特殊角色。它繼承自@Controller註解。
在Spring4.0之前的版本，Spring MVC的組件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性，我們可以開發REST服務的時候不需要使用@Controller而專門的@RestController。
@RestController：@Controller和@ResponseBody的合集，用於標註控制層組件（如struts中的action），配置在controller層表示該控制層裏面的方法是以json的格式進行輸出。
在本實例中，Example的類是一個web @Controller，所以當處理進來的web請求時，Spring會詢問它。實例代碼如下：
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.stereotype.*;
import org.springframework.web.bind.annotation.*;
@RestController
@EnableAutoConfiguration
public class Example {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) throws Exception {
SpringApplication.run(Example.class, args);
}
}
@RequestMapping：提供路由信息。此註解告訴Spring任何來自"/"路徑的HTTP請求都應該被映射到home方法。@RestController註解告訴Spring以字符串的形式渲染結果，並直接返回給調用者。該註解有六個屬性：
params，指定request中必須包含某些參數值是，才讓該方法處理；
headers，指定request中必須包含某些指定的header值，才能讓該方法處理請求；
value，指定請求的實際地址，指定的地址可以是URI Template 模式；
method，指定請求的method類型， GET、POST、PUT、DELETE等；
consumes，指定處理請求的提交內容類型（Content-Type），如application/json,text/html；
produces，指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回。
在本實例中，請求test方法渲染結果後返回給調用者。實例代碼如下：
@RequestMapping("/test")
@ResponseBody
public String test(){
return "歡迎關注“Java精選”公衆號，Spring Boot從入門到精通，持續更新中";
}
注意：@RestController和@RequestMapping註解是Spring MVC註解（它們不是Spring Boot的特定部分）。
@EnableAutoConfiguration
@EnableAutoConfiguration：嘗試根據開發者添加的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類上來選擇自動配置。實例代碼如下：
import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;
@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
// ...
}
注意：只需要添加一個@EnableAutoConfiguration註解。建議將它添加到主@Configuration類上，如果發現應用不想要的特定自動配置類，可以使用@EnableAutoConfiguration註解的排除屬性來禁用它們。
@Configuration
Spring Boot提倡基於Java的配置。儘管可以使用一個XML源來調用SpringApplication.run()，但官方建議使用@Configuration類作爲主要源。
一般定義main方法的類也是主要@Configuration的一個很好候選。不需要將所有的@Configuration放進一個單獨的類。
@Import：用來導入其他配置類，將class導入容器中。
@ComponentScan：註解自動收集所有的Spring組件，包括@Configuration類。
如果需要使用基於XML的配置，官方建議仍舊從一個@Configuration類開始。可以使用附加的@ImportResource註解加載XML配置文件。
@Configuration：等同於Spring的XML配置文件beans；用@Bean標註方法等價於XML中配置bean，使用Java代碼可以檢查類型安全。實例代碼如下：
@ComponentScan(basePackages = "com.yoodb.blog",
includeFilters = {@ComponentScan.Filter(Aspect.class)})
@ComponentScan：表示將該類自動發現掃描組件。如果掃描到有@Component、@Controller、@Service等這些註解的類，並註冊爲Bean，可以自動收集所有的Spring組件，包括@Configuration類。
使用@ComponentScan註解搜索beans，並結合@Autowired註解導入。可以自動收集所有的Spring組件，包括@Configuration類。如果沒有配置，Spring Boot會掃描啓動類所在包下以及子包下的使用了@Service,@Repository等註解的類。
@SpringBootApplication
大多數Spring Boot開發者總是使用@Configuration，@EnableAutoConfiguration和@ComponentScan註解他們的main類。由於這些註解被如此頻繁地一起使用，Spring Boot提供一個方便的@SpringBootApplication選擇。
@SpringBootApplication：註解等價於以默認屬性使用@Configuration，@EnableAutoConfiguration和@ComponentScan。實例代碼如下：
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
//@SpringBootApplication 等同於
//@Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Spring Boot將嘗試校驗外部的配置，默認使用JSR-303（如果在classpath路徑中）。可以輕鬆的爲@ConfigurationProperties類添加JSR-303 javax.validation約束註解，實例代碼如下：
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}
@Profiles
Spring Profiles提供了一種隔離應用程序配置的方式，並讓這些配置只能在特定的環境下生效。任何@Component或@Configuration都能被@Profile標記，從而限制加載它的時機。
@Profiles：在類或@bean註解的方法上可以實現不同的配置實例化不同的類，然後通過jvm參數來指定spring.profiles.active值就能做到運行切換配置環境。實例代碼如下：
@Configuration
@Profile("production")
public class ProductionConfiguration {
// ...
}
全局異常處理
@ControllerAdvice是Spring3.2提供的新註解,它是一個Controller增強器,可對controller中被 @RequestMapping註解的方法加一些邏輯處理。最常用的就是異常處理。
@ControllerAdvice：包含@Component。可以被掃描到。統一處理異常。需要配合@ExceptionHandler使用。
@ExceptionHandler（Exception.class）：用在方法上面表示遇到這個異常就執行以下方法。
全局異常處理，實例代碼如下：
/**
* 全局異常處理
*/
@ControllerAdvice
public class GlobalDefaultExceptionHandler {
public static final String DEFAULT_ERROR_VIEW = "error";
@ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})
public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {
ModelAndView mav = new ModelAndView();
mav.addObject("error","參數類型錯誤");
mav.addObject("exception", e);
mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));
mav.addObject("timestamp", new Date());
mav.setViewName(DEFAULT_ERROR_VIEW);
return mav;
}
}
@Value：將外部的值動態注入到Bean中，使用的情況包括有注入普通字符串；注入操作系統屬性；注入表達式結果；注入其他Bean屬性；注入文件資源；注入URL資源。
通過@value註解可以用於讀取application.properties裏面的配置，實例配置參考如下：
/************** application.properties *************/
qq_api_key=********1***********
qq_api_secrt=******2***********
/************* Java **************/
@Value("${qq_api_key}")
private String API_KEY;
@Value("${qq_api_secrt}")
private String API_SECRET;
注意：使用@Value註解的時其使用的類如果被其他類作爲對象引用，必須要使用注入的方式而不能new，一般常用的配置在application.properties文件。
@RequestParam
@RequestParam：用在方法的參數前面，將請求參數綁定到控制器的方法參數上是Spring MVC中接收普通參數的註解，@RequestParam(value="參數名",required="true/false",defaultValue="")，實例代碼如下：
@RequestParam(value="name",required="true/false",defaultValue="")
@RequestParam String name =request.getParameter("name");
value，參數名；
required，是否包含該參數，默認爲true，表示該請求路徑中必須包含該參數，如果不包含就報錯；
defaultValue，默認參數值，如果設置了該值，required=true將失效，自動爲false,如果沒有傳該參數，就使用默認值。
@PathVariable
@PathVariable是帶佔位符的URL，Spring3.0新增的功能，該功能在SpringMVC向REST目標挺進發展過程中具有里程碑的意義。
@PathVariable：路徑變量註解，其參數與大括號裏的名字一樣要保持一致，實例代碼如下：
RequestMapping("yoodb/detail/{id}")
public String getByMacAddress(@PathVariable String id){
//do something;
}
通過@PathVariable可以將URL中佔位符參數綁定到控制器處理方法的入參中：URL 中的{xxx}佔位符可以通過@PathVariable("xxx") 綁定到操作方法的入參中。
其他註解
@ResponseBody：表示該方法的返回結果直接寫入HTTP response body中一般在異步獲取數據時使用，在使用@RequestMapping後，返回值通常解析爲跳轉路徑，加上@Responsebody後返回結果不會被解析爲跳轉路徑，而是直接寫入HTTP response body中。如異步獲取json數據，加上@Responsebody後，會直接返回json數據。
@Component：泛指組件，當組件不好歸類時，可以使用這個註解進行標註。一般公共的方法會用上這個註解。
@Inject：等價於默認的@Autowired，只是沒有required屬性。
@Bean：相當於XML中的,放在方法的上面，而不是類，意思是產生一個bean,並交給spring管理。
@AutoWired：自動導入依賴的bean。byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變量、方法及構造函數進行標註，完成自動裝配的工作。當加上（required=false）時，就算找不到bean也不報錯。
@Qualifier：當有多個同一類型的Bean時，可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據名字進行注入，但能進行更細粒度的控制如何選擇候選者，實例代碼如下：
@Autowired @Qualifier(value = "demoInfoService") private DemoInfoService demoInfoService;
@Resource(name="name",type="type")：沒有括號內內容的話，默認byName。與@Autowired類似。
Spring Boot常用註解的含義及如何使用就簡單介紹到這裏，後期會針對每個註解深入講解其含義和用法，歡迎大家持續關注微信公衆號“Java精選”，下面大家可以寫代碼試一試吧。