溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

還怕不記得Spring Boot注解嗎?5類(lèi)注解全在這里了(建議收藏)

發(fā)布時(shí)間:2020-07-24 20:31:27 來(lái)源:網(wǎng)絡(luò) 閱讀:298 作者:架構(gòu)師追風(fēng) 欄目:編程語(yǔ)言

前言

使用注解的優(yōu)勢(shì):
1.采用純java代碼,不在需要配置繁雜的xml文件
2.在配置中也可享受面向?qū)ο髱?lái)的好處
3.類(lèi)型安全對(duì)重構(gòu)可以提供良好的支持
4.減少?gòu)?fù)雜配置文件的同時(shí)亦能享受到springIoC容器提供的功能

Spring Boot的核心就是注解。Spring Boot通過(guò)各種組合注解,極大地簡(jiǎn)化了Spring項(xiàng)目的搭建和開(kāi)發(fā)。在Spring Boot中有一些注解是其中的關(guān)鍵,必須掌握。接下來(lái)就給大家做詳細(xì)的介紹。

一、注解(annotations)列表

@SpringBootApplication:包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan讓spring Boot掃描到Configuration類(lèi)并把它加入到程序上下文。
@Configuration 等同于spring的XML配置文件;使用Java代碼可以檢查類(lèi)型安全。
@EnableAutoConfiguration 自動(dòng)配置。
@ComponentScan 組件掃描,可自動(dòng)發(fā)現(xiàn)和裝配一些Bean。@Component可配合CommandLineRunner使用,在程序啟動(dòng)后執(zhí)行一些基礎(chǔ)任務(wù)。
br/>@Component可配合CommandLineRunner使用,在程序啟動(dòng)后執(zhí)行一些基礎(chǔ)任務(wù)。
br/>@Autowired自動(dòng)導(dǎo)入。
br/>@JsonBackReference解決嵌套外鏈問(wèn)題。

二、注解(annotations)詳解

@SpringBootApplication:申明讓spring boot自動(dòng)給程序進(jìn)行必要的配置,這個(gè)配置等同于:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三個(gè)配置。

package com.example.myproject;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

@ResponseBody:表示該方法的返回結(jié)果直接寫(xiě)入HTTP response body中,一般在異步獲取數(shù)據(jù)時(shí)使用,用于構(gòu)建RESTful的api。在使用@RequestMapping后,返回值通常解析為跳轉(zhuǎn)路徑,加上@responsebody后返回結(jié)果不會(huì)被解析為跳轉(zhuǎn)路徑,而是直接寫(xiě)入HTTP response body中。比如異步獲取json數(shù)據(jù),加上@responsebody后,會(huì)直接返回json數(shù)據(jù)。該注解一般會(huì)配合@RequestMapping一起使用。示例代碼:

@RequestMapping(“/test”)
@ResponseBody 
public String test(){
return”ok”;
}

@Controller:用于定義控制器類(lèi),在spring 項(xiàng)目中由控制器負(fù)責(zé)將用戶發(fā)來(lái)的URL請(qǐng)求轉(zhuǎn)發(fā)到對(duì)應(yīng)的服務(wù)接口(service層),一般這個(gè)注解在類(lèi)中,通常方法需要配合注解@RequestMapping。示例代碼:

@Controller 
@RequestMapping(“/demoInfo”)
publicclass DemoController {
@Autowired 
private DemoInfoService demoInfoService;
@RequestMapping("/hello")
public String hello(Map<String,Object> map){
System.out.println("DemoController.hello()");
map.put("hello","from TemplateController.helloHtml");
//會(huì)使用hello.html或者h(yuǎn)ello.ftl模板進(jìn)行渲染顯示.
return"/hello";
}
}

@RestController:用于標(biāo)注控制層組件(如struts中的action),@ResponseBody和@Controller的合集。示例代碼:

package com.kfit.demo.web;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController 
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {
@RequestMapping("/test")
public String test(){
return"ok";
}
}

@RequestMapping:提供路由信息,負(fù)責(zé)URL到Controller中的具體函數(shù)的映射。
@EnableAutoConfiguration:Spring Boot自動(dòng)配置(auto-configuration):嘗試根據(jù)你添加的jar依賴(lài)自動(dòng)配置你的Spring應(yīng)用。例如,如果你的classpath下存在HSQLDB,并且你沒(méi)有手動(dòng)配置任何數(shù)據(jù)庫(kù)連接beans,那么我們將自動(dòng)配置一個(gè)內(nèi)存型(in-memory)數(shù)據(jù)庫(kù)”。你可以將@EnableAutoConfiguration或者@SpringBootApplication注解添加到一個(gè)@Configuration類(lèi)上來(lái)選擇自動(dòng)配置。如果發(fā)現(xiàn)應(yīng)用了你不想要的特定自動(dòng)配置類(lèi),你可以使用@EnableAutoConfiguration注解的排除屬性來(lái)禁用它們。
@ComponentScan:表示將該類(lèi)自動(dòng)發(fā)現(xiàn)掃描組件。個(gè)人理解相當(dāng)于,如果掃描到有@Component、@Controller、@Service等這些注解的類(lèi),并注冊(cè)為Bean,可以自動(dòng)收集所有的Spring組件,包括@Configuration類(lèi)。我們經(jīng)常使用@ComponentScan注解搜索beans,并結(jié)合@Autowired注解導(dǎo)入??梢宰詣?dòng)收集所有的Spring組件,包括@Configuration類(lèi)。我們經(jīng)常使用@ComponentScan注解搜索beans,并結(jié)合@Autowired注解導(dǎo)入。如果沒(méi)有配置的話,Spring Boot會(huì)掃描啟動(dòng)類(lèi)所在包下以及子包下的使用了@Service,@Repository等注解的類(lèi)。@Configuration:相當(dāng)于傳統(tǒng)的xml配置文件,如果有些第三方庫(kù)需要用到xml文件,建議仍然通過(guò)@Configuration類(lèi)作為項(xiàng)目的配置主類(lèi)——可以使用@ImportResource注解加載xml配置文件。
br/>@Configuration:相當(dāng)于傳統(tǒng)的xml配置文件,如果有些第三方庫(kù)需要用到xml文件,建議仍然通過(guò)@Configuration類(lèi)作為項(xiàng)目的配置主類(lèi)——可以使用@ImportResource注解加載xml配置文件。
br/>@ImportResource:用來(lái)加載xml配置文件。
br/>@Service:一般用于修飾service層的組件
br/>@Bean:用@Bean標(biāo)注方法等價(jià)于XML中配置的bean。

@Value(value = “#{message}”)
private String message;

@Inject:等價(jià)于默認(rèn)的@Autowired,只是沒(méi)有required屬性;@Component:泛指組件,當(dāng)組件不好歸類(lèi)的時(shí)候,我們可以使用這個(gè)注解進(jìn)行標(biāo)注。
br/>@Component:泛指組件,當(dāng)組件不好歸類(lèi)的時(shí)候,我們可以使用這個(gè)注解進(jìn)行標(biāo)注。
br/>@AutoWired:自動(dòng)導(dǎo)入依賴(lài)的bean。byType方式。把配置好的Bean拿來(lái)用,完成屬性、方法的組裝,它可以對(duì)類(lèi)成員變量、方法及構(gòu)造函數(shù)進(jìn)行標(biāo)注,完成自動(dòng)裝配的工作。當(dāng)加上(required=false)時(shí),就算找不到bean也不報(bào)錯(cuò)。

@Autowired 
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;

@Resource(name=”name”,type=”type”):沒(méi)有括號(hào)內(nèi)內(nèi)容的話,默認(rèn)byName。與@Autowired干類(lèi)似的事。

三、JPA注解

@Entity:@Table(name=”“):表明這是一個(gè)實(shí)體類(lèi)。一般用于jpa這兩個(gè)注解一般一塊使用,但是如果表名和實(shí)體類(lèi)名相同的話,@Table可以省略@MappedSuperClass:用在確定是父類(lèi)的entity上。父類(lèi)的屬性子類(lèi)可以繼承。
br/>@MappedSuperClass:用在確定是父類(lèi)的entity上。父類(lèi)的屬性子類(lèi)可以繼承。
br/>@Column:如果字段名與列名相同,則可以省略。
@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的名稱(chēng),以便使用,sequenceName為數(shù)據(jù)庫(kù)的sequence名稱(chēng),兩個(gè)名稱(chēng)可以一致。@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í)體屬性的加載方式
br/>@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í)體屬性的加載方式
br/>@JoinColumn(name=”loginId”):一對(duì)一:本表中指向另一個(gè)表的外鍵。一對(duì)多:另一個(gè)表指向本表的外鍵。

四、springMVC相關(guān)注解

@RequestMapping:@RequestMapping(“/path”)表示該控制器處理所有“/path”的UR L請(qǐng)求。RequestMapping是一個(gè)用來(lái)處理請(qǐng)求地址映射的注解,可用于類(lèi)或方法上。
用于類(lèi)上,表示類(lèi)中的所有響應(yīng)請(qǐng)求的方法都是以該地址作為父路徑。該注解有六個(gè)屬性:
params:指定request中必須包含某些參數(shù)值是,才讓該方法處理。
headers:指定request中必須包含某些指定的header值,才能讓該方法處理請(qǐng)求。
value:指定請(qǐng)求的實(shí)際地址,指定的地址可以是URI Template 模式
method:指定請(qǐng)求的method類(lèi)型, GET、POST、PUT、DELETE等consumes:指定處理請(qǐng)求的提交內(nèi)容類(lèi)型(Content-Type),如application/json,text/html;
produces:指定返回的內(nèi)容類(lèi)型,僅當(dāng)request請(qǐng)求頭中的(Accept)類(lèi)型中包含該指定類(lèi)型才返回
@RequestParam:用在方法的參數(shù)前面。
br/>consumes:指定處理請(qǐng)求的提交內(nèi)容類(lèi)型(Content-Type),如application/json,text/html;
produces:指定返回的內(nèi)容類(lèi)型,僅當(dāng)request請(qǐng)求頭中的(Accept)類(lèi)型中包含該指定類(lèi)型才返回
@RequestParam:用在方法的參數(shù)前面。
String a =request.getParameter(“a”)。
@PathVariable:路徑變量。如

RequestMapping(“user/get/mac/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){
//do something;
}

參數(shù)與大括號(hào)里的名字一樣要相同。

五、全局異常處理

@ControllerAdvice:包含@Component??梢员粧呙璧健=y(tǒng)一處理異常。
@ExceptionHandler(Exception.class):用在方法上面表示遇到這個(gè)異常就執(zhí)行以下方法。

最后
歡迎大家一起交流,喜歡文章記得點(diǎn)個(gè)贊喲,感謝支持!

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI