淺談 SpringBoot 註解大全

1、註解(annotations)列表 

@SpringBootApplication：包含了@ComponentScan、@Configuration和@EnableAutoConfiguration註解。其中@ComponentScan讓spring Boot掃描到Configuration類並把它加入到程序上下文。

@Configuration 等同於spring的XML配置文件；使用Java代碼能夠檢查類型安全。

@EnableAutoConfiguration 自動配置。

@ComponentScan 組件掃描，可自動發現和裝配一些Bean。

@Component可配合CommandLineRunner使用，在程序啓動後執行一些基礎任務。

@RestController註解是@Controller和@ResponseBody的合集,表示這是個控制器bean,而且是將函數的返回值直 接填入HTTP響應體中,是REST風格的控制器。

@Autowired自動導入。

@PathVariable獲取參數。

@JsonBackReference解決嵌套外鏈問題。

@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。

2、註解(annotations)詳解

@SpringBootApplication：申明讓spring boot自動給程序進行必要的配置，這個配置等同於：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三個配置。

?

1 2 3 4 5 6 7 8 9 10

package com.example.myproject; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;   @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }

@ResponseBody：表示該方法的返回結果直接寫入HTTP response body中，通常在異步獲取數據時使用，用於構建RESTful的api。在使用@RequestMapping後，返回值一般解析爲跳轉路徑，加上@responsebody後返回結果不會被解析爲跳轉路徑，而是直接寫入HTTP response body中。好比異步獲取json數據，加上@responsebody後，會直接返回json數據。該註解通常會配合@RequestMapping一塊兒使用。示例代碼：

?

1 2 3 4 5

@RequestMapping(「/test」) @ResponseBody public String test(){ return」ok」; }

@Controller：用於定義控制器類，在spring 項目中由控制器負責將用戶發來的URL請求轉發到對應的服務接口（service層），通常這個註解在類中，一般方法須要配合註解@RequestMapping。示例代碼：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14

@Controller @RequestMapping(「/demoInfo」) publicclass DemoController { @Autowired private DemoInfoService demoInfoService;   @RequestMapping("/hello") public String hello(Map<String,Object> map){   System.out.println("DemoController.hello()");   map.put("hello","from TemplateController.helloHtml");   //會使用hello.html或者hello.ftl模板進行渲染顯示.   return"/hello"; } }

@RestController：用於標註控制層組件(如struts中的action)，@ResponseBody和@Controller的合集。示例代碼：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

package com.kfit.demo.web;   import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;     @RestController @RequestMapping(「/demoInfo2」) publicclass DemoController2 {   @RequestMapping("/test") public String test(){   return"ok"; } }

@RequestMapping：提供路由信息，負責URL到Controller中的具體函數的映射。

@EnableAutoConfiguration：Spring Boot自動配置（auto-configuration）：嘗試根據你添加的jar依賴自動配置你的Spring應用。例如，若是你的classpath下存在HSQLDB，而且你沒有手動配置任何數據庫鏈接beans，那麼咱們將自動配置一個內存型（in-memory）數據庫」。你能夠將@EnableAutoConfiguration或者@SpringBootApplication註解添加到一個@Configuration類上來選擇自動配置。若是發現應用了你不想要的特定自動配置類，你可使用@EnableAutoConfiguration註解的排除屬性來禁用它們。

@ComponentScan：表示將該類自動發現掃描組件。我的理解至關於，若是掃描到有@Component、@Controller、@Service等這些註解的類，並註冊爲Bean，能夠自動收集全部的Spring組件，包括@Configuration類。咱們常用@ComponentScan註解搜索beans，並結合@Autowired註解導入。能夠自動收集全部的Spring組件，包括@Configuration類。咱們常用@ComponentScan註解搜索beans，並結合@Autowired註解導入。若是沒有配置的話，Spring Boot會掃描啓動類所在包下以及子包下的使用了@Service,@Repository等註解的類。

@Configuration：至關於傳統的xml配置文件，若是有些第三方庫須要用到xml文件，建議仍然經過@Configuration類做爲項目的配置主類——可使用@ImportResource註解加載xml配置文件。

@Import：用來導入其餘配置類。

@ImportResource：用來加載xml配置文件。

@Autowired：自動導入依賴的bean

@Service：通常用於修飾service層的組件

@Repository：使用@Repository註解能夠確保DAO或者repositories提供異常轉譯，這個註解修飾的DAO或者repositories類會被ComponetScan發現並配置，同時也不須要爲它們提供XML配置項。

@Bean：用@Bean標註方法等價於XML中配置的bean。

@Value：注入Spring boot application.properties配置的屬性的值。示例代碼：

?

1 2	@Value(value = 「#{message}」) private String message;

@Inject：等價於默認的@Autowired，只是沒有required屬性；

@Component：泛指組件，當組件很差歸類的時候，咱們可使用這個註解進行標註。

@Bean:至關於XML中的,放在方法的上面，而不是類，意思是產生一個bean,並交給spring管理。

@AutoWired：自動導入依賴的bean。byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它能夠對類成員變量、方法及構造函數進行標註，完成自動裝配的工做。當加上（required=false）時，就算找不到bean也不報錯。

@Qualifier：當有多個同一類型的Bean時，能夠用@Qualifier(「name」)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據名字進行注入，但能進行更細粒度的控制如何選擇候選者，具體使用方式以下：

?

1 2 3

@Autowired @Qualifier(value = 「demoInfoService」) private DemoInfoService demoInfoService;

@Resource(name=」name」,type=」type」)：沒有括號內內容的話，默認byName。與@Autowired幹相似的事。

3、JPA註解

@Entity：@Table(name=」「)：代表這是一個實體類。通常用於jpa這兩個註解通常一塊使用，可是若是表名和實體類名相同的話，@Table能夠省略

@MappedSuperClass:用在肯定是父類的entity上。父類的屬性子類能夠繼承。

@NoRepositoryBean:通常用做父類的repository，有這個註解，spring不會去實例化該repository。

@Column：若是字段名與列名相同，則能夠省略。

@Id：表示該屬性爲主鍵。

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = 「repair_seq」)：表示主鍵生成策略是sequence（能夠爲Auto、IDENTITY、native等，Auto表示可在多個數據庫間切換），指定sequence的名字是repair_seq。

@SequenceGeneretor(name = 「repair_seq」, sequenceName = 「seq_repair」, allocationSize = 1)：name爲sequence的名稱，以便使用，sequenceName爲數據庫的sequence名稱，兩個名稱能夠一致。

@Transient：表示該屬性並不是一個到數據庫表的字段的映射,ORM框架將忽略該屬性。若是一個屬性並不是數據庫表的字段映射,就務必將其標示爲@Transient,不然,ORM框架默認其註解爲@Basic。@Basic(fetch=FetchType.LAZY)：標記能夠指定實體屬性的加載方式

@JsonIgnore：做用是json序列化時將Java bean中的一些屬性忽略掉,序列化和反序列化都受影響。

@JoinColumn（name=」loginId」）:一對一：本表中指向另外一個表的外鍵。一對多：另外一個表指向本表的外鍵。

@OneToOne、@OneToMany、@ManyToOne：對應hibernate配置文件中的一對一，一對多，多對一。

4、springMVC相關注解

@RequestMapping：@RequestMapping(「/path」)表示該控制器處理全部「/path」的UR L請求。RequestMapping是一個用來處理請求地址映射的註解，可用於類或方法上。 

用於類上，表示類中的全部響應請求的方法都是以該地址做爲父路徑。該註解有六個屬性：

1. params:指定request中必須包含某些參數值是，才讓該方法處理。
2. headers:指定request中必須包含某些指定的header值，才能讓該方法處理請求。
3. value:指定請求的實際地址，指定的地址能夠是URI Template 模式
4. method:指定請求的method類型， GET、POST、PUT、DELETE等
5. consumes:指定處理請求的提交內容類型（Content-Type），如application/json,text/html;
6. produces:指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回

@RequestParam：用在方法的參數前面。 

?

1 2 3 4 5 6 7 8 9

@RequestParam  String a =request.getParameter(「a」)。   @PathVariable:路徑變量。如   RequestMapping(「user/get/mac/{macAddress}」) public String getByMacAddress(@PathVariable String macAddress){ //do something; }

參數與大括號裏的名字同樣要相同。

5、全局異常處理

@ControllerAdvice：包含@Component。能夠被掃描到。統一處理異常。

@ExceptionHandler（Exception.class）：用在方法上面表示遇到這個異常就執行如下方法。