【幹貨】Spring Boot注解大全

一、SpingBoot注解

@SpringBootApplication：申明讓spring boot自動給程式進行必要的配置，這個配置等同于：@ComponentScan、@Configuration和@EnableAutoConfiguration注解。

@ComponentScan：讓spring Boot掃描到Configuration類并把它加入到程式上下文。

@Configuration： 等同于spring的XML配置檔案，使用Java代碼可以檢查類型安全。如果有些第三方庫需要用到xml檔案，建議仍然通過@Configuration類作為項目的配置主類，可以使用@ImportResource注解加載xml配置檔案。

@EnableAutoConfiguration ：啟用Spring Boot自動配置（auto-configuration），嘗試根據你添加的jar依賴自動配置你的Spring應用。如果發現應用了你不想要的特定自動配置類，你可以使用@EnableAutoConfiguration注解的排除屬性來禁用它們。

@ComponentScan 元件掃描表示将該類自動發現掃描元件，可自動發現和裝配一些Bean。如果掃描到有@Component、@Controller、@Service等這些注解的類，并注冊為Bean，可以自動收集所有的Spring元件，包括@Configuration類。我們經常使用@ComponentScan注解搜尋beans，并結合@Autowired注解導入。

@ResponseBody：表示該方法的傳回結果直接寫入HTTP response body中，一般在異步擷取資料時使用，用于建構RESTful的api。該注解一般會配合@RequestMapping一起使用。

@RequestMapping：提供路由資訊，負責URL到Controller中的具體函數的映射。在使用@RequestMapping後，傳回值通常解析為跳轉路徑，加上@responsebody後傳回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中。

@Controller：用于定義控制器類，在spring 項目中由控制器負責将使用者發來的URL請求轉發到對應的服務接口（service層）。一般這個注解在類中，通常方法需要配合注解@RequestMapping。

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

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

@ImportResource：用來加載xml配置檔案。

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

@Service：一般用于修飾service層的元件。

@Repository：使用@Repository注解可以確定DAO或者repositories提供異常轉譯，這個注解修飾的DAO或者repositories類會被ComponetScan發現并配置，同時也不需要為它們提供XML配置項。

@Component：泛指元件，當元件不好歸類的時候，我們可以使用這個注解進行标注。可配合CommandLineRunner使用，在程式啟動後執行一些基礎任務。

@Bean：意思是産生一個bean,并交給spring管理。用@Bean标注方法等價于XML中配置的bean。

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

@Inject：等價于預設的@Autowired，隻是沒有required屬性。

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

@Resource：@Resource(name=”name”,type=”type”)中沒有括号内内容的話，預設byName，與@Autowired幹類似的事。

@PathVariable擷取參數。

@JsonBackReference解決嵌套外鍊問題。

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

二、JPA注解

@Entity：表明這是一個實體類。一般用于jpa，@Entity和@Table(name=”“)這兩個注解一般一塊使用，但是如果表名和實體類名相同的話，@Table可以省略。

@MappedSuperClass:用在确定是父類的entity上。父類的屬性子類可以繼承。

@NoRepositoryBean:一般用作父類的repository，有這個注解，spring不會去執行個體化該repository。

@Column：如果字段名與列名相同，則可以省略。

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

@GeneratedValue：@GeneratedValue(strategy=GenerationType.SEQUENCE,generator= “repair_seq”)表示主鍵生成政策是sequence（可以為Auto、IDENTITY、native等，Auto表示可在多個資料庫間切換），指定sequence的名字是repair_seq。

@SequenceGeneretor：@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：@JoinColumn（name=”loginId”），一對一：本表中指向另一個表的外鍵。一對多：另一個表指向本表的外鍵。

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

三、全局異常處理

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

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