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

來源_：blog.csdn.net/weixin_40753536/article/details/81285046_

使用註解的優勢：

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 使用。推薦：Java 面試練題寶典

三、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）：用在方法上面表示遇到這個異常就執行以下方法。推薦：Java 面試練題寶典

六、項目中具體配置解析和使用環境

@MappedSuperclass：

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

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

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

@Column：

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

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

• name 屬性：name 屬性定義了被標註字段在數據庫表中所對應字段的名稱

• unique 屬性：unique 屬性表示該字段是否爲唯一標識，默認爲 false，如果表中有一個字段需要唯一標識，則既可以使用該標記，也可以使用 @Table 註解中的 @UniqueConstraint

• nullable 屬性：nullable 屬性表示該字段是否可以爲 null 值，默認爲 true

• insertable 屬性：insertable 屬性表示在使用”INSERT” 語句插入數據時，是否需要插入該字段的值

• updateable 屬性：updateable 屬性表示在使用”UPDATE” 語句插入數據時，是否需要更新該字段的值

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

• columnDefinition 屬性：columnDefinition 屬性表示創建表時，該字段創建的 SQL 語句，一般用於通過 Entity 生成表定義時使用，如果數據庫中表已經建好，該屬性沒有必要使用

• table 屬性：table 屬性定義了包含當前字段的表名

• length 屬性：length 屬性表示字段的長度，當字段的類型爲 varchar 時，該屬性纔有效，默認爲 255 個字符

• 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 方法

• @Data：註解在類上；提供類所有屬性的 getting 和 setting 方法，此外還提供了 equals、canEqual、hashCode、toString 方法

• @Setter：註解在屬性上；爲屬性提供 setting 方法

• @Getter：註解在屬性上；爲屬性提供 getting 方法

• @Log4j2 ：註解在類上；爲類提供一個 屬性名爲 log 的 log4j 日誌對象，和 @Log4j 註解類似

• @NoArgsConstructor：註解在類上；爲類提供一個無參的構造方法

• @AllArgsConstructor：註解在類上；爲類提供一個全參的構造方法

• @EqualsAndHashCode: 默認情況下，會使用所有非瞬態 (non-transient) 和非靜態 (non-static) 字段來生成 equals 和 hascode 方法，也可以指定具體使用哪些屬性。

• @toString: 生成 toString 方法，默認情況下，會輸出類名、所有屬性，屬性會按照順序輸出，以逗號分割。

• @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor 無參構造器、部分參數構造器、全參構造器，當我們需要重載多個構造器的時候，只能自己手寫了

• @NonNull：註解在屬性上，如果註解了，就必須不能爲 Null

• @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 事件在實體從數據庫中刪除後觸發。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/YCoX4jNQWoIvO2iyxbGrAw