SpringBoot註解最全詳解(整合超詳細版本)

使用註解的優勢：

     1.採用純java程式碼，不在需要配置繁雜的xml檔案

     2.在配置中也可享受物件導向帶來的好處

     3.型別安全對重構可以提供良好的支援

     4.減少複雜配置檔案的同時亦能享受到springIoC容器提供的功能

 

一、註解詳解（配備了完善的釋義）------(可採用ctrl+F 來進行搜尋哦~~~~)

@SpringBootApplication：申明讓spring boot自動給程式進行必要的配置，這個配置等同於：

@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三個配置。

@ResponseBody：表示該方法的返回結果直接寫入HTTP response body中，一般在非同步獲取資料時使用，用於構建RESTful的api。在使用@RequestMapping後，返回值通常解析為跳轉路徑，加上@esponsebody後返回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中。比如非同步獲取json資料，加上@Responsebody後，會直接返回json資料。該註解一般會配合@RequestMapping一起使用。

@Controller：用於定義控制器類，在spring專案中由控制器負責將使用者發來的URL請求轉發到對應的服務介面（service層），一般這個註解在類中，通常方法需要配合註解@RequestMapping。

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

@RequestMapping：提供路由資訊，負責URL到Controller中的具體函式的對映。

@EnableAutoConfiguration：SpringBoot自動配置（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配置的屬性的值。示例程式碼：

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

@Component：泛指元件，當元件不好歸類的時候，我們可以使用這個註解進行標註。

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

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

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

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

二、註解列表如下

@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使用。

三、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配置檔案中的一對一，一對多，多對一。

四、springMVC相關注解

@RequestMapping：@RequestMapping(“/path”)表示該控制器處理所有“/path”的UR L請求。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：用在方法的引數前面。
@RequestParam
String a =request.getParameter(“a”)。

@PathVariable:路徑變數。如

引數與大括號裡的名字一樣要相同。

五、全域性異常處理

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

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

---

六、專案中具體配置解析和使用環境

@MappedSuperclass：

1.@MappedSuperclass 註解使用在父類上面，是用來標識父類的

2.@MappedSuperclass 標識的類表示其不能對映到資料庫表，因為其不是一個完整的實體類，但是它所擁有的屬效能夠對映在其子類對用的資料庫表中

3.@MappedSuperclass 標識的類不能再有@Entity或@Table註解

@Column：

1.當實體的屬性與其對映的資料庫表的列不同名時需要使用@Column標註說明，該屬性通常置於實體的屬性宣告語句之前，還可與 @Id 標註一起使用。

2.@Column 標註的常用屬性是name，用於設定對映資料庫表的列名。此外，該標註還包含其它多個屬性，如：unique、nullable、length、precision等。具體如下：

  1 name屬性：name屬性定義了被標註欄位在資料庫表中所對應欄位的名稱

  2 unique屬性：unique屬性表示該欄位是否為唯一標識，預設為false，如果表中有一個欄位需要唯一標識，則既可以使用該標記，也可以使用@Table註解中的@UniqueConstraint

  3 nullable屬性：nullable屬性表示該欄位是否可以為null值，預設為true

  4 insertable屬性：insertable屬性表示在使用”INSERT”語句插入資料時，是否需要插入該欄位的值

  5 updateable屬性：updateable屬性表示在使用”UPDATE”語句插入資料時，是否需要更新該欄位的值

  6 insertable和updateable屬性：一般多用於只讀的屬性，例如主鍵和外來鍵等，這些欄位通常是自動生成的

  7 columnDefinition屬性：columnDefinition屬性表示建立表時，該欄位建立的SQL語句，一般用於通過Entity生成表定義時使用，如果資料庫中表已經建好，該屬性沒有必要使用

  8 table屬性：table屬性定義了包含當前欄位的表名

  9 length屬性：length屬性表示欄位的長度，當欄位的型別為varchar時，該屬性才有效，預設為255個字元

 10 precision屬性和scale屬性：precision屬性和scale屬性一起表示精度，當欄位型別為double時，precision表示數值的總長度，scale表示小數點所佔的位數

 

    具體如下：
   1.double型別將在資料庫中對映為double型別，precision和scale屬性無效
   2.double型別若在columnDefinition屬性中指定數字型別為decimal並指定精度，則最終以columnDefinition為準
   3.BigDecimal型別在資料庫中對映為decimal型別，precision和scale屬性有效
   4.precision和scale屬性只在BigDecimal型別中有效

3.@Column 標註的columnDefinition屬性: 表示該欄位在資料庫中的實際型別.通常 ORM 框架可以根據屬性型別自動判斷資料庫中欄位的型別,但是對於Date型別仍無法確定資料庫中欄位型別究竟是DATE,TIME還是TIMESTAMP.此外,String的預設對映型別為VARCHAR,如果要將 String 型別對映到特定資料庫的 BLOB 或TEXT欄位型別.

4.@Column標註也可置於屬性的getter方法之前

@Getter和@Setter（Lombok）

@Setter：註解在屬性上；為屬性提供 setting 方法 @Getter：註解在屬性上；為屬性提供 getting 方法

  1 @Data：註解在類上；提供類所有屬性的 getting 和 setting 方法，此外還提供了equals、canEqual、hashCode、toString 方法
  2 
  3 @Setter：註解在屬性上；為屬性提供 setting 方法
  4 
  5 @Getter：註解在屬性上；為屬性提供 getting 方法
  6 
  7 @Log4j2 ：註解在類上；為類提供一個 屬性名為log 的 log4j 日誌物件，和@Log4j註解類似
  8 
  9 @NoArgsConstructor：註解在類上；為類提供一個無參的構造方法
 10 
 11 @AllArgsConstructor：註解在類上；為類提供一個全參的構造方法
 12 
 13 @EqualsAndHashCode:預設情況下，會使用所有非瞬態(non-transient)和非靜態(non-static)欄位來生成equals和hascode方法，也可以指定具體使用哪些屬性。
 14 
 15 @toString:生成toString方法，預設情況下，會輸出類名、所有屬性，屬性會按照順序輸出，以逗號分割。
 16 
 17 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor
 18 無參構造器、部分引數構造器、全參構造器，當我們需要過載多個構造器的時候，只能自己手寫了
 19 
 20 @NonNull：註解在屬性上，如果註解了，就必須不能為Null
 21 
 22 @val:註解在屬性上，如果註解了，就是設定為final型別，可檢視原始碼的註釋知道

 

當你在執行各種持久化方法的時候，實體的狀態會隨之改變，狀態的改變會引發不同的生命週期事件。這些事件可以使用不同的註釋符來指示發生時的回撥函式。

@javax.persistence.PostLoad：載入後。

@javax.persistence.PrePersist：持久化前。

@javax.persistence.PostPersist：持久化後。

@javax.persistence.PreUpdate：更新前。

@javax.persistence.PostUpdate：更新後。

@javax.persistence.PreRemove：刪除前。

@javax.persistence.PostRemove：刪除後。

1）資料庫查詢

@PostLoad事件在下列情況下觸發：

執行EntityManager.find()或getreference()方法載入一個實體後。

執行JPQL查詢後。

EntityManager.refresh()方法被呼叫後。

2）資料庫插入

@PrePersist和@PostPersist事件在實體物件插入到資料庫的過程中發生：

@PrePersist事件在呼叫persist()方法後立刻發生，此時的資料還沒有真正插入進資料庫。

@PostPersist事件在資料已經插入進資料庫後發生。

3）資料庫更新

@PreUpdate和@PostUpdate事件的觸發由更新實體引起：

@PreUpdate事件在實體的狀態同步到資料庫之前觸發，此時的資料還沒有真正更新到資料庫。

@PostUpdate事件在實體的狀態同步到資料庫之後觸發，同步在事務提交時發生。

4）資料庫刪除

@PreRemove和@PostRemove事件的觸發由刪除實體引起：

@PreRemove事件在實體從資料庫刪除之前觸發，即在呼叫remove()方法刪除時發生，此時的資料還沒有真正從資料庫中刪除。

@PostRemove事件在實體從資料庫中刪除後觸發。