【乾貨】Spring Boot註解大全

一、SpingBoot註解

@SpringBootApplication:申明讓spring boot自動給程序進行必要的配置,這個配置等同於:@ComponentScan、@Configuration和@EnableAutoConfiguration註解。
@ComponentScan:讓spring Boot掃描到Configuration類並把它加入到程序上下文。
@Configuration: 等同於spring的XML配置文件,使用Java代碼可以檢查類型安全。如果有些第三方庫需要用到xml文件,建議仍然通過@Configuration類作爲項目的配置主類,可以使用@ImportResource註解加載xml配置文件。
@EnableAutoConfiguration :啓用Spring Boot自動配置(auto-configuration),嘗試根據你添加的jar依賴自動配置你的Spring應用。如果發現應用了你不想要的特定自動配置類,你可以使用@EnableAutoConfiguration註解的排除屬性來禁用它們。
@ComponentScan 組件掃描表示將該類自動發現掃描組件,可自動發現和裝配一些Bean。如果掃描到有@Component、@Controller、@Service等這些註解的類,並註冊爲Bean,可以自動收集所有的Spring組件,包括@Configuration類。我們經常使用@ComponentScan註解搜索beans,並結合@Autowired註解導入。
@ResponseBody:表示該方法的返回結果直接寫入HTTP response body中,一般在異步獲取數據時使用,用於構建RESTful的api。該註解一般會配合@RequestMapping一起使用。
@RequestMapping:提供路由信息,負責URL到Controller中的具體函數的映射。在使用@RequestMapping後,返回值通常解析爲跳轉路徑,加上@responsebody後返回結果不會被解析爲跳轉路徑,而是直接寫入HTTP response body中。
@Controller:用於定義控制器類,在spring 項目中由控制器負責將用戶發來的URL請求轉發到對應的服務接口(service層)。一般這個註解在類中,通常方法需要配合註解@RequestMapping。
@RestController註解是@Controller和@ResponseBody的合集,表示這是個控制器bean,並且是將函數的返回值直 接填入HTTP響應體中,是REST風格的控制器。
@Import:用來導入其他配置類。
@ImportResource:用來加載xml配置文件。
@Autowired:自動導入依賴的bean。把配置好的Bean拿來用,完成屬性、方法的組裝,它可以對類成員變量、方法及構造函數進行標註,完成自動裝配的工作。當加上(required=false)時,就算找不到bean也不報錯。
@Service:一般用於修飾service層的組件。
@Repository:使用@Repository註解可以確保DAO或者repositories提供異常轉譯,這個註解修飾的DAO或者repositories類會被ComponetScan發現並配置,同時也不需要爲它們提供XML配置項。
@Component:泛指組件,當組件不好歸類的時候,我們可以使用這個註解進行標註。可配合CommandLineRunner使用,在程序啓動後執行一些基礎任務。
@Bean:意思是產生一個bean,並交給spring管理。用@Bean標註方法等價於XML中配置的bean。
@Value:注入Spring boot application.properties配置的屬性的值。
@Inject:等價於默認的@Autowired,只是沒有required屬性。
@Qualifier:當有多個同一類型的Bean時,可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據名字進行注入,但能進行更細粒度的控制如何選擇候選者。
@Resource:@Resource(name=”name”,type=”type”)中沒有括號內內容的話,默認byName,與@Autowired幹類似的事。
@PathVariable獲取參數。
@JsonBackReference解決嵌套外鏈問題。
@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。

二、JPA註解

@Entity:表明這是一個實體類。一般用於jpa,@Entity和@Table(name=”“)這兩個註解一般一塊使用,但是如果表名和實體類名相同的話,@Table可以省略。
@MappedSuperClass:用在確定是父類的entity上。父類的屬性子類可以繼承。
@NoRepositoryBean:一般用作父類的repository,有這個註解,spring不會去實例化該repository。
@Column:如果字段名與列名相同,則可以省略。
@Id:表示該屬性爲主鍵。
@GeneratedValue:@GeneratedValue(strategy=GenerationType.SEQUENCE,generator= “repair_seq”)表示主鍵生成策略是sequence(可以爲Auto、IDENTITY、native等,Auto表示可在多個數據庫間切換),指定sequence的名字是repair_seq。
@SequenceGeneretor:@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:@JoinColumn(name=”loginId”),一對一:本表中指向另一個表的外鍵。一對多:另一個表指向本表的外鍵。
@OneToOne、@OneToMany、@ManyToOne:對應hibernate配置文件中的一對一,一對多,多對一。

三、全局異常處理

@ControllerAdvice:包含@Component。可以被掃描到。統一處理異常。
@ExceptionHandler:@ExceptionHandler(Exception.class)用在方法上面表示遇到這個異常就執行以下方法。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章