SpringBoot中全部注解歸納解釋

目錄

• 1 springboot注解
  • 1.1 引言
  • 1.2 基本注解
  • 1.3 JPA注解
  • 1.4 SpringMVC相關注解
  • 1.5 全局異常處理
  • 1.6 項目中具體配置解析和使用環境
  • 1.7 Lombok注解
  • 1.8 數據庫實體相關注解

1 springboot注解

1.1 引言

spring boot是采用純java代碼，不在需要配置繁雜的xml文件，在配置中也可享受面向對象帶來的好處，類型安全對重構可以提供良好的支持，減少復雜配置文件的同時亦能享受到springIoC容器提供的功能

1.2 基本注解

• @SpringBootApplication：申明讓spring boot自動給程序進行必要的配置，這個配置等同於：@Configuration ，@EnableAutoConfiguration 和 @ComponentScan 三個配置。
• @ResponseBody：表示該方法的返回結果直接寫入HTTP response body中，一般在異步獲取數據時使用，用於構建RESTful的api。在使用@RequestMapping后，返回值通常解析為跳轉路徑，加上@Responsebody后返回結果不會被解析為跳轉路徑，而是直接寫入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 Boot會掃描啟動類所在包下以及子包下的使用了@Service,@Repository等注解的類。
• @Configuration：相當於傳統的xml配置文件，如果有些第三方庫需要用到xml文件，建議仍然通過@Configuration類作為項目的配置主類——可以使用@ImportResource注解加載xml配置文件。
• @Import：用來導入其他配置類。
• @ImportResource：用來加載xml配置文件
• @Service：一般用於修飾service層的組件
• @Repository：使用@Repository注解可以確保DAO或者repositories提供異常轉譯，這個注解修飾的DAO或者repositories類會被ComponetScan發現並配置，同時也不需要為它們提供XML配置項
• @Value：注入Spring boot application.properties配置的屬性的值。
• @Inject：等價於默認的@Autowired，只是沒有required屬性；
• @Component：泛指組件，當組件不好歸類的時候，我們可以使用這個注解進行標注。
• @Bean:用@Bean標注方法等價於XML中配置的bean，放在方法的上面，而不是類，意思是產生一個bean,並交給spring管理。
• @AutoWired：自動導入依賴的bean。byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變量、方法及構造函數進行標注，完成自動裝配的工作。當加上（required=false）時，就算找不到bean也不報錯。
• @Qualifier：當有多個同一類型的Bean時，可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據名字進行注入，但能進行更細粒度的控制如何選擇候選者
• @Resource(name=”name”,type=”type”)：沒有括號內內容的話，默認byName。與@Autowired干類似的事。
• @PathVariable：獲取參數。
• @JsonBackReference：解決嵌套外鏈問題。
• @RepositoryRestResourcepublic：配合spring-boot-starter-data-rest使用

1.3 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配置文件中的一對一，一對多，多對一

1.4 SpringMVC相關注解

• @RequestMapping：@RequestMapping(“/path”)表示該控制器處理所有/path的URL請求。RequestMapping是一個用來處理請求地址映射的注解，可用於類或方法上
  用於類上，表示類中的所有響應請求的方法都是以該地址作為父路徑。該注解有六個屬性：

1. params:指定request中必須包含某些參數值是，才讓該方法處理。
2. headers:指定request中必須包含某些指定的header值，才能讓該方法處理請求。
3. value:指定請求的實際地址，指定的地址可以是URI Template 模式
4. method:指定請求的method類型， GET、POST、PUT、DELETE等
5. consumes:指定處理請求的提交內容類型（Content-Type），如application/json,text/html;
6. produces:指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回

• @RequestParam：用在方法的參數前面，用以綁定請參數
• @PathVariable:路徑變量。參數與大括號里的名字一樣要相同

1.5 全局異常處理

• @ControllerAdvice：包含@Component。可以被掃描到。統一處理異常。
• @ExceptionHandler（Exception.class）：用在方法上面表示遇到這個異常就執行以下方法
• 具體spring boot的異常使用示例：https://jingzh.blog.csdn.net/article/details/89521229

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

• @MappedSuperclass：

@MappedSuperclass 注解使用在父類上面，是用來標識父類的
@MappedSuperclass 標識的類表示其不能映射到數據庫表，因為其不是一個完整的實體類，但是它所擁有的屬性能夠映射在其子類對用的數據庫表中
@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屬性無效double類型若在columnDefinition屬性中指定數字類型為decimal並指定精度，則最終以columnDefinition為准
2. BigDecimal類型在數據庫中映射為decimal類型，precision和scale屬性有效
3. precision和scale屬性只在BigDecimal類型中有效

3.@Column標注的columnDefinition屬性: 表示該字段在數據庫中的實際類型.通常 ORM 框架可以根據屬性類型自動判斷數據庫中字段的類型,但是對於Date類型仍無法確定數據庫中字段類型究竟是DATE,TIME還是TIMESTAMP.此外,String的默認映射類型為VARCHAR,如果要將 String 類型映射到特定數據庫的 BLOB 或TEXT字段類型.
4.@Column標注也可置於屬性的getter方法之前

1.7 Lombok注解

• @Setter：注解在屬性上；為屬性提供 setting 方法
• @Getter：注解在屬性上；為屬性提供 getting 方法
• @Data：注解在類上；提供類所有屬性的 getting 和 setting 方法，此外還提供了equals、canEqual、hashCode、toString 方法
• @Log4j2 ：注解在類上；為類提供一個 屬性名為log 的 log4j 日志對象，和@Log4j注解類似
• @NoArgsConstructor：注解在類上；為類提供一個無參的構造方法
• @AllArgsConstructor：注解在類上；為類提供一個全參的構造方法
• @EqualsAndHashCode:默認情況下，會使用所有非瞬態(non-transient)和非靜態(non-static)字段來生成equals和hascode方法，也可以指定具體使用哪些屬性。
• @toString:生成toString方法，默認情況下，會輸出類名、所有屬性，屬性會按照順序輸出，以逗號分割。
• @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor：無參構造器、部分參數構造器、全參構造器，當我們需要重載多個構造器的時候，只能自己手寫了
• @NonNull：注解在屬性上，如果注解了，就必須不能為Null
• @val:注解在屬性上，如果注解了，就是設置為final類型，可查看源碼的注釋知道

1.8 數據庫實體相關注解

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

• @javax.persistence.PostLoad：加載后。

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

• @javax.persistence.PostPersist：持久化后。

• @javax.persistence.PreUpdate：更新前。

• @javax.persistence.PostUpdate：更新后。

• @javax.persistence.PreRemove：刪除前。

• @javax.persistence.PostRemove：刪除后。

• 數據庫查詢
  @PostLoad事件在下列情況下觸發：

執行EntityManager.find()或getreference()方法載入一個實體后
執行JPQL查詢后
EntityManager.refresh()方法被調用后

• 數據庫插入
  @PrePersist和@PostPersist事件在實體對象插入到數據庫的過程中發生：
  @PrePersist事件在調用persist()方法后立刻發生，此時的數據還沒有真正插入進數據庫
  @PostPersist事件在數據已經插入進數據庫后發生

• 數據庫更新
  @PreUpdate和@PostUpdate事件的觸發由更新實體引起：
  @PreUpdate事件在實體的狀態同步到數據庫之前觸發，此時的數據還沒有真正更新到數據庫。
  @PostUpdate事件在實體的狀態同步到數據庫之后觸發，同步在事務提交時發生

• 數據庫刪除
  @PreRemove和@PostRemove事件的觸發由刪除實體引起：
  @PreRemove事件在實體從數據庫刪除之前觸發，即在調用remove()方法刪除時發生，此時的數據還沒有真正從數據庫中刪除。
  @PostRemove事件在實體從數據庫中刪除后觸發。