SpringBoot註解大全，springboot註解

SpringBoot註解大全，springboot註解

一、註解(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使用。

二、註解(annotations)詳解

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

  1 package com.example.myproject;  2 import org.springframework.boot.SpringApplication;  3 import org.springframework.boot.autoconfigure.SpringBootApplication;  4   5 @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan   6 public class Application {  7    public static void main(String[] args) {  8      SpringApplication.run(Application.class, args);  9    } 10 }

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

  1 @RequestMapping(“/test”)  2 @ResponseBody  3 public String test(){  4    return”ok”;  5 }

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

  1 @Controller  2 @RequestMapping(“/demoInfo”)  3 public class DemoController {  4 @Autowired  5 private DemoInfoService demoInfoService;  6   7 @RequestMapping("/hello")  8 public String hello(Map<String,Object> map){  9    System.out.println("DemoController.hello()"); 10    map.put("hello","from TemplateController.helloHtml"); 11    //會使用hello.html或者hello.ftl模板進行渲染顯示. 12    return"/hello"; 13 } 14 }

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

  1 package com.kfit.demo.web;  2   3 import org.springframework.web.bind.annotation.RequestMapping;  4 import org.springframework.web.bind.annotation.RestController;  5   6   7 @RestController  8 @RequestMapping(“/demoInfo2”)  9 publicclass DemoController2 { 10  11 @RequestMapping("/test") 12 public String test(){ 13    return "ok"; 14 } 15 }

@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配置的屬性的值。範例程式碼：

  1 @Value(value = “#{message}”)  2 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 @Autowired  2 @Qualifier(value = “demoInfoService”)  3 private DemoInfoService demoInfoService;

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

三、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:路徑變數。如

  1 RequestMapping(“user/get/mac/{macAddress}”)  2 public String getByMacAddress(@PathVariable String macAddress){  3    //do something;   4 }

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

五、全域異常處理

@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類型，可查看源碼的注釋知道

@PreUpdate和@PrePersist

@PreUpdate

1.用於為相應的生命週期事件指定回調方法。

2.該注釋可以應用於實體類，映射超類或回調監聽器類的方法。

3.用於setter 如果要每次更新實體時更新實體的屬性，可以使用@PreUpdate注釋。

4.使用該注釋，您不必在每次更新使用者實體時顯式更新相應的屬性。

5.preUpdate不允許您更改您的實體。 您只能使用傳遞給事件的計算的更改集來修改原始欄位值。

@Prepersist

1.查看@PrePersist注釋，協助您在持久化之前自動填滿實體屬性。

2.可以用來在使用jpa的時記錄一些業務無關的欄位，比如最後更新時間等等。生命週期方法註解（delete沒有生命週期事件）

3.@PrePersist save之前被調用，它可以返回一個DBObject代替一個空的 @PostPersist save到datastore之後被調用 

4.@PostLoad 在Entity被映射之後被調用 @EntityListeners 指定外部生命週期事件實作類別 

實體Bean生命週期的回調事件

方法的標註： @PrePersist @PostPersist @PreRemove @PostRemove @PreUpdate @PostUpdate @PostLoad 。

它們標註在某個方法之前，沒有任何參數。這些標註下的方法在實體的狀態改變前後時進行調用，相當於攔截器;

pre 表示在狀態切換前觸發，post 則表示在切換後觸發。 

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

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

2. 執行 JPA QL 查詢過後； 

3. EntityManager.refresh( )方法被調用後。 

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

@PrePersist 事件在調用 EntityManager.persist()方法後立刻發生，級聯儲存也會發生此事件，此時的資料還沒有真實插入進資料庫。

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

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

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

@PreRemove 和 @PostRemove 事件的觸發由刪除實體引起，@ PreRemove 事件在實體從資料庫刪除之前觸發，即調用了 EntityManager.remove()方法或者串聯刪除

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

@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事件在實體從資料庫中刪除後觸發。@NoArgsConstructor & @AllArgsConstructor（lombok）

@NoArgsConstructor，提供一個無參的構造方法。

@AllArgsConstructor，提供一個全參的構造方法。

@Configuration

引用：tanwei81;Java高手真經. 進階編程卷