SpringBoot注解最全詳解(整合超詳細(xì)版本)
超全面!Java核心知識(shí)總結(jié)(點(diǎn)擊查看)
超全面!Java核心知識(shí)總結(jié)(點(diǎn)擊查看)
來源:blog.csdn.net/weixin_40753536/article/details/81285046
使用注解的優(yōu)勢(shì):
采用純java代碼,不在需要配置繁雜的xml文件 在配置中也可享受面向?qū)ο髱淼暮锰?/span> 類型安全對(duì)重構(gòu)可以提供良好的支持 減少?gòu)?fù)雜配置文件的同時(shí)亦能享受到springIoC容器提供的功能
一、注解詳解(配備了完善的釋義)
可采用ctrl+F 來進(jìn)行搜索哦~~~~
@SpringBootApplication:申明讓spring boot自動(dòng)給程序進(jìn)行必要的配置,這個(gè)配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三個(gè)配置。
@Controller:用于定義控制器類,在spring項(xiàng)目中由控制器負(fù)責(zé)將用戶發(fā)來的URL請(qǐng)求轉(zhuǎn)發(fā)到對(duì)應(yīng)的服務(wù)接口(service層),一般這個(gè)注解在類中,通常方法需要配合注解@RequestMapping。
@RestController:用于標(biāo)注控制層組件(如struts中的action),@ResponseBody和@Controller的合集。
@RequestMapping:提供路由信息,負(fù)責(zé)URL到Controller中的具體函數(shù)的映射。
@Configuration:相當(dāng)于傳統(tǒng)的xml配置文件,如果有些第三方庫(kù)需要用到xml文件,建議仍然通過@Configuration類作為項(xiàng)目的配置主類——可以使用@ImportResource注解加載xml配置文件。
@Import:用來導(dǎo)入其他配置類。
@ImportResource:用來加載xml配置文件。
@Autowired:自動(dòng)導(dǎo)入依賴的bean
@Service:一般用于修飾service層的組件
@Repository:使用@Repository注解可以確保DAO或者repositories提供異常轉(zhuǎn)譯,這個(gè)注解修飾的DAO或者repositories類會(huì)被ComponetScan發(fā)現(xiàn)并配置,同時(shí)也不需要為它們提供XML配置項(xiàng)。
@Bean:用@Bean標(biāo)注方法等價(jià)于XML中配置的bean。
@Value:注入Spring boot application.properties配置的屬性的值。示例代碼:
@Inject:等價(jià)于默認(rèn)的@Autowired,只是沒有required屬性;
@Component:泛指組件,當(dāng)組件不好歸類的時(shí)候,我們可以使用這個(gè)注解進(jìn)行標(biāo)注。
@Bean:相當(dāng)于XML中的,放在方法的上面,而不是類,意思是產(chǎn)生一個(gè)bean,并交給spring管理。
@Qualifier:當(dāng)有多個(gè)同一類型的Bean時(shí),可以用@Qualifier(“name”)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據(jù)名字進(jìn)行注入,但能進(jìn)行更細(xì)粒度的控制如何選擇候選者,具體使用方式如下:
@Resource(name=”name”,type=”type”):沒有括號(hào)內(nèi)內(nèi)容的話,默認(rèn)byName。與@Autowired干類似的事。
二、注解列表如下
@SpringBootApplication:包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中
@ComponentScan:讓spring Boot掃描到Configuration類并把它加入到程序上下文。
@Configuration :等同于spring的XML配置文件;使用Java代碼可以檢查類型安全。
@EnableAutoConfiguration :自動(dòng)配置。
@ComponentScan :組件掃描,可自動(dòng)發(fā)現(xiàn)和裝配一些Bean。
@Component可配合CommandLineRunner使用,在程序啟動(dòng)后執(zhí)行一些基礎(chǔ)任務(wù)。
@RestController:注解是@Controller和@ResponseBody的合集,表示這是個(gè)控制器bean,并且是將函數(shù)的返回值直 接填入HTTP響應(yīng)體中,是REST風(fēng)格的控制器。
@Autowired:自動(dòng)導(dǎo)入。
@PathVariable:獲取參數(shù)。
@JsonBackReference:解決嵌套外鏈問題。
@RepositoryRestResourcepublic:配合spring-boot-starter-data-rest使用。推薦:Java面試練題寶典
三、JPA注解
@Entity:@Table(name=”“):表明這是一個(gè)實(shí)體類。一般用于jpa這兩個(gè)注解一般一塊使用,但是如果表名和實(shí)體類名相同的話,@Table可以省略
@MappedSuperClass:用在確定是父類的entity上。父類的屬性子類可以繼承。
@NoRepositoryBean:一般用作父類的repository,有這個(gè)注解,spring不會(huì)去實(shí)例化該repository。
@Column:如果字段名與列名相同,則可以省略。
@Id:表示該屬性為主鍵。
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”):表示主鍵生成策略是sequence(可以為Auto、IDENTITY、native等,Auto表示可在多個(gè)數(shù)據(jù)庫(kù)間切換),指定sequence的名字是repair_seq。
@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):name為sequence的名稱,以便使用,sequenceName為數(shù)據(jù)庫(kù)的sequence名稱,兩個(gè)名稱可以一致。
@Transient:表示該屬性并非一個(gè)到數(shù)據(jù)庫(kù)表的字段的映射,ORM框架將忽略該屬性。如果一個(gè)屬性并非數(shù)據(jù)庫(kù)表的字段映射,就務(wù)必將其標(biāo)示為@Transient,否則,ORM框架默認(rèn)其注解為@Basic。@Basic(fetch=FetchType.LAZY):標(biāo)記可以指定實(shí)體屬性的加載方式
@JsonIgnore:作用是json序列化時(shí)將Java bean中的一些屬性忽略掉,序列化和反序列化都受影響。
@JoinColumn(name=”loginId”):一對(duì)一:本表中指向另一個(gè)表的外鍵。一對(duì)多:另一個(gè)表指向本表的外鍵。
@OneToOne、@OneToMany、@ManyToOne:對(duì)應(yīng)hibernate配置文件中的一對(duì)一,一對(duì)多,多對(duì)一。
四、springMVC相關(guān)注解
@RequestMapping:@RequestMapping(“/path”)表示該控制器處理所有“/path”的UR L請(qǐng)求。RequestMapping是一個(gè)用來處理請(qǐng)求地址映射的注解,可用于類或方法上。
用于類上,表示類中的所有響應(yīng)請(qǐng)求的方法都是以該地址作為父路徑。該注解有六個(gè)屬性:
params:指定request中必須包含某些參數(shù)值是,才讓該方法處理。 headers:指定request中必須包含某些指定的header值,才能讓該方法處理請(qǐng)求。 value:指定請(qǐng)求的實(shí)際地址,指定的地址可以是URI Template 模式 method:指定請(qǐng)求的method類型, GET、POST、PUT、DELETE等 consumes:指定處理請(qǐng)求的提交內(nèi)容類型(Content-Type),如application/json,text/html; produces:指定返回的內(nèi)容類型,僅當(dāng)request請(qǐng)求頭中的(Accept)類型中包含該指定類型才返回
@RequestParam:用在方法的參數(shù)前面。
@RequestParam
String a =request.getParameter(“a”)。
@PathVariable:路徑變量。
參數(shù)與大括號(hào)里的名字一樣要相同。
五、全局異常處理
@ControllerAdvice:包含@Component。可以被掃描到。統(tǒng)一處理異常。
@ExceptionHandler(Exception.class):用在方法上面表示遇到這個(gè)異常就執(zhí)行以下方法。推薦:Java面試練題寶典
六、項(xiàng)目中具體配置解析和使用環(huán)境
@MappedSuperclass:
@MappedSuperclass 注解使用在父類上面,是用來標(biāo)識(shí)父類的
@MappedSuperclass 標(biāo)識(shí)的類表示其不能映射到數(shù)據(jù)庫(kù)表,因?yàn)槠洳皇且粋€(gè)完整的實(shí)體類,但是它所擁有的屬性能夠映射在其子類對(duì)用的數(shù)據(jù)庫(kù)表中
@MappedSuperclass 標(biāo)識(shí)的類不能再有@Entity或@Table注解
@Column:
1.當(dāng)實(shí)體的屬性與其映射的數(shù)據(jù)庫(kù)表的列不同名時(shí)需要使用@Column標(biāo)注說明,該屬性通常置于實(shí)體的屬性聲明語句之前,還可與 @Id 標(biāo)注一起使用。
2.@Column 標(biāo)注的常用屬性是name,用于設(shè)置映射數(shù)據(jù)庫(kù)表的列名。此外,該標(biāo)注還包含其它多個(gè)屬性,如:unique、nullable、length、precision等。具體如下:
name屬性:name屬性定義了被標(biāo)注字段在數(shù)據(jù)庫(kù)表中所對(duì)應(yīng)字段的名稱 unique屬性:unique屬性表示該字段是否為唯一標(biāo)識(shí),默認(rèn)為false,如果表中有一個(gè)字段需要唯一標(biāo)識(shí),則既可以使用該標(biāo)記,也可以使用@Table注解中的@UniqueConstraint nullable屬性:nullable屬性表示該字段是否可以為null值,默認(rèn)為true insertable屬性:insertable屬性表示在使用”INSERT”語句插入數(shù)據(jù)時(shí),是否需要插入該字段的值 updateable屬性:updateable屬性表示在使用”UPDATE”語句插入數(shù)據(jù)時(shí),是否需要更新該字段的值 insertable和updateable屬性:一般多用于只讀的屬性,例如主鍵和外鍵等,這些字段通常是自動(dòng)生成的 columnDefinition屬性:columnDefinition屬性表示創(chuàng)建表時(shí),該字段創(chuàng)建的SQL語句,一般用于通過Entity生成表定義時(shí)使用,如果數(shù)據(jù)庫(kù)中表已經(jīng)建好,該屬性沒有必要使用 table屬性:table屬性定義了包含當(dāng)前字段的表名 length屬性:length屬性表示字段的長(zhǎng)度,當(dāng)字段的類型為varchar時(shí),該屬性才有效,默認(rèn)為255個(gè)字符 precision屬性和scale屬性:precision屬性和scale屬性一起表示精度,當(dāng)字段類型為double時(shí),precision表示數(shù)值的總長(zhǎng)度,scale表示小數(shù)點(diǎn)所占的位數(shù)
具體如下:
double類型將在數(shù)據(jù)庫(kù)中映射為double類型,precision和scale屬性無效 double類型若在columnDefinition屬性中指定數(shù)字類型為decimal并指定精度,則最終以columnDefinition為準(zhǔn) BigDecimal類型在數(shù)據(jù)庫(kù)中映射為decimal類型,precision和scale屬性有效 precision和scale屬性只在BigDecimal類型中有效
3.@Column 標(biāo)注的columnDefinition屬性: 表示該字段在數(shù)據(jù)庫(kù)中的實(shí)際類型.通常 ORM 框架可以根據(jù)屬性類型自動(dòng)判斷數(shù)據(jù)庫(kù)中字段的類型,但是對(duì)于Date類型仍無法確定數(shù)據(jù)庫(kù)中字段類型究竟是DATE,TIME還是TIMESTAMP.此外,String的默認(rèn)映射類型為VARCHAR,如果要將 String 類型映射到特定數(shù)據(jù)庫(kù)的 BLOB 或TEXT字段類型.
4.@Column標(biāo)注也可置于屬性的getter方法之前
@Getter和@Setter(Lombok)
@Setter:注解在屬性上;為屬性提供 setting 方法 @Getter:注解在屬性上;為屬性提供 getting 方法
@Data:注解在類上;提供類所有屬性的 getting 和 setting 方法,此外還提供了equals、canEqual、hashCode、toString 方法 @Setter:注解在屬性上;為屬性提供 setting 方法 @Getter:注解在屬性上;為屬性提供 getting 方法 @Log4j2 :注解在類上;為類提供一個(gè) 屬性名為log 的 log4j 日志對(duì)象,和@Log4j注解類似 @NoArgsConstructor:注解在類上;為類提供一個(gè)無參的構(gòu)造方法 @AllArgsConstructor:注解在類上;為類提供一個(gè)全參的構(gòu)造方法 @EqualsAndHashCode:默認(rèn)情況下,會(huì)使用所有非瞬態(tài)(non-transient)和非靜態(tài)(non-static)字段來生成equals和hascode方法,也可以指定具體使用哪些屬性。 @toString:生成toString方法,默認(rèn)情況下,會(huì)輸出類名、所有屬性,屬性會(huì)按照順序輸出,以逗號(hào)分割。 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor無參構(gòu)造器、部分參數(shù)構(gòu)造器、全參構(gòu)造器,當(dāng)我們需要重載多個(gè)構(gòu)造器的時(shí)候,只能自己手寫了 @NonNull:注解在屬性上,如果注解了,就必須不能為Null @val:注解在屬性上,如果注解了,就是設(shè)置為final類型,可查看源碼的注釋知道
當(dāng)你在執(zhí)行各種持久化方法的時(shí)候,實(shí)體的狀態(tài)會(huì)隨之改變,狀態(tài)的改變會(huì)引發(fā)不同的生命周期事件。這些事件可以使用不同的注釋符來指示發(fā)生時(shí)的回調(diào)函數(shù)。
@javax.persistence.PostLoad:加載后。
@javax.persistence.PrePersist:持久化前。
@javax.persistence.PostPersist:持久化后。
@javax.persistence.PreUpdate:更新前。
@javax.persistence.PostUpdate:更新后。
@javax.persistence.PreRemove:刪除前。
@javax.persistence.PostRemove:刪除后。
1)數(shù)據(jù)庫(kù)查詢
@PostLoad事件在下列情況下觸發(fā):
執(zhí)行EntityManager.find()或getreference()方法載入一個(gè)實(shí)體后。
執(zhí)行JPQL查詢后。
EntityManager.refresh()方法被調(diào)用后。
2)數(shù)據(jù)庫(kù)插入
@PrePersist和@PostPersist事件在實(shí)體對(duì)象插入到數(shù)據(jù)庫(kù)的過程中發(fā)生:
@PrePersist事件在調(diào)用persist()方法后立刻發(fā)生,此時(shí)的數(shù)據(jù)還沒有真正插入進(jìn)數(shù)據(jù)庫(kù)。
@PostPersist事件在數(shù)據(jù)已經(jīng)插入進(jìn)數(shù)據(jù)庫(kù)后發(fā)生。
3)數(shù)據(jù)庫(kù)更新
@PreUpdate和@PostUpdate事件的觸發(fā)由更新實(shí)體引起:
@PreUpdate事件在實(shí)體的狀態(tài)同步到數(shù)據(jù)庫(kù)之前觸發(fā),此時(shí)的數(shù)據(jù)還沒有真正更新到數(shù)據(jù)庫(kù)。
@PostUpdate事件在實(shí)體的狀態(tài)同步到數(shù)據(jù)庫(kù)之后觸發(fā),同步在事務(wù)提交時(shí)發(fā)生。
4)數(shù)據(jù)庫(kù)刪除
@PreRemove和@PostRemove事件的觸發(fā)由刪除實(shí)體引起:
@PreRemove事件在實(shí)體從數(shù)據(jù)庫(kù)刪除之前觸發(fā),即在調(diào)用remove()方法刪除時(shí)發(fā)生,此時(shí)的數(shù)據(jù)還沒有真正從數(shù)據(jù)庫(kù)中刪除。
@PostRemove事件在實(shí)體從數(shù)據(jù)庫(kù)中刪除后觸發(fā)。
如有文章對(duì)你有幫助,
“在看”和轉(zhuǎn)發(fā)是對(duì)我最大的支持!
推薦, GitHub 書籍倉(cāng)庫(kù) https://github.com/ebooklist/awesome-ebooks-list 整理了大部分常用 技術(shù)書籍PDF,持續(xù)更新中... 你需要的技術(shù)書籍,這里可能都有...
點(diǎn)擊文末“閱讀原文”可直達(dá)
整理不易,麻煩各位小伙伴在GitHub中來個(gè)一鍵三連

