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

使用注解的優勢：

     1.采用純java代碼，不在需要配置繁雜的xml檔案

     2.在配置中也可享受面向對象帶來的好處

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

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

Springboot 新增的注解

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

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

@Configuration

這不是一個新的注解，從Spring3.0起，@Configuration用于定義配置類，作用相當于xml配置檔案，可替換xml配置檔案，被注解的類内部包含有一個或多個被@Bean注解的方法，這些方法将會被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext類進行掃描，并用于建構bean定義，初始化Spring容器。

注意：@Configuration注解的配置類有如下要求：

1. @Configuration不可以是final類型；
2. @Configuration不可以是匿名類；
3. 嵌套的configuration必須是靜态類。

@Configuration的用法

一、用@Configuration加載spring

1.1、@Configuration配置spring并啟動spring容器

1.2、@Configuration啟動容器[email protected]注冊Bean

         在@Configuration類中，将Bean類顯式地用代碼建立并加@Bean注解

1.3、@Configuration啟動容器[email protected]注冊Bean

         在Bean類上加@Component注解，聲明目前類是一個Bean，需要注冊到Spring中管理

1.4、使用 AnnotationConfigApplicationContext 注冊 AppContext 類的兩種方法

1.5、配置Web應用程式(web.xml中配置AnnotationConfigApplicationContext)

二、組合多個配置類

2.1、在@configuration中引入spring的xml配置檔案

2.2、在@configuration中引入其它注解配置

2.3、@configuration嵌套（嵌套的Configuration必須是靜态類）

三、@EnableXXX注解

四、@Profile邏輯組配置

五、使用外部變量

@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：

[email protected] 注解使用在父類上面，是用來辨別父類的

[email protected] 辨別的類表示其不能映射到資料庫表，因為其不是一個完整的實體類，但是它所擁有的屬性能夠映射在其子類對用的資料庫表中

[email protected] 辨別的類不能再有@Entity或@Table注解

@Column：

1.當實體的屬性與其映射的資料庫表的列不同名時需要使用@Column标注說明，該屬性通常置于實體的屬性聲明語句之前，還可與 @Id 标注一起使用。

[email protected] 标注的常用屬性是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類型中有效

[email protected] 标注的columnDefinition屬性: 表示該字段在資料庫中的實際類型.通常 ORM 架構可以根據屬性類型自動判斷資料庫中字段的類型,但是對于Date類型仍無法确定資料庫中字段類型究竟是DATE,TIME還是TIMESTAMP.此外,String的預設映射類型為VARCHAR,如果要将 String 類型映射到特定資料庫的 BLOB 或TEXT字段類型.

[email protected]标注也可置于屬性的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事件在實體從資料庫中删除後觸發

————————————————

版權聲明：本文為CSDN部落客「VV-醬」的原創文章，遵循 CC 4.0 BY-SA 版權協定，轉載請附上原文出處連結及本聲明。

原文連結：https://blog.csdn.net/weixin_40753536/article/details/81285046