SpringBoot最最最常用的注解梳理

來(lái)源:https://s.yam.com/w6mfR

一错妖、注解(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ù)惫恼。

@RestController注解是@Controller和@ResponseBody的合集,表示這是個(gè)控制器bean,并且是將函數(shù)的返回值直 接填入HTTP響應(yīng)體中,是REST風(fēng)格的控制器。

@Autowired自動(dòng)導(dǎo)入。

@PathVariable獲取參數(shù)倾哺。

@JsonBackReference解決嵌套外鏈問(wèn)題。

@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用叼耙。

二、注解(annotations)詳解

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

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é)將用戶(hù)發(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的合集跋核。
示例代碼:

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配置文件。

@Import:用來(lái)導(dǎo)入其他配置類(lèi)竭钝。

@ImportResource:用來(lái)加載xml配置文件梨撞。

@Autowired:自動(dòng)導(dǎo)入依賴(lài)的bean

@Service:一般用于修飾service層的組件

@Repository:使用@Repository注解可以確保DAO或者repositories提供異常轉(zhuǎn)譯,這個(gè)注解修飾的DAO或者repositories類(lèi)會(huì)被ComponetScan發(fā)現(xiàn)并配置香罐,同時(shí)也不需要為它們提供XML配置項(xiàng)卧波。

@Bean:用@Bean標(biāo)注方法等價(jià)于XML中配置的bean。

@Value:注入Spring boot application.properties配置的屬性的值庇茫。
示例代碼:

@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)注。

@Bean:相當(dāng)于XML中的,放在方法的上面宁炫,而不是類(lèi)偿曙,意思是產(chǎn)生一個(gè)bean,并交給spring管理。

@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ò)搅吁。

@Qualifier:當(dāng)有多個(gè)同一類(lèi)型的Bean時(shí)威创,可以用@Qualifier(“name”)來(lái)指定。與@Autowired配合使用谎懦。@Qualifier限定描述符除了能根據(jù)名字進(jìn)行注入肚豺,但能進(jìn)行更細(xì)粒度的控制如何選擇候選者,具體使用方式如下:

@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)可以繼承。

@NoRepositoryBean: 一般用作父類(lèi)的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的名稱(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í)體屬性的加載方式

@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è)用來(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ù)前面。
@RequestParam
String a =request.getParameter(“a”)屋摇。

@PathVariable:路徑變量揩魂。如

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

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

五炮温、全局異常處理

@ControllerAdvice:包含@Component火脉。可以被掃描到柒啤。統(tǒng)一處理異常倦挂。
@ExceptionHandler(Exception.class):用在方法上面表示遇到這個(gè)異常就執(zhí)行以下方法。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末担巩,一起剝皮案震驚了整個(gè)濱河市方援,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌涛癌,老刑警劉巖犯戏,帶你破解...
    沈念sama閱讀 207,248評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異拳话,居然都是意外死亡先匪,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門(mén)弃衍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)呀非,“玉大人,你說(shuō)我怎么就攤上這事镜盯〗” “怎么了坦冠?”我有些...
    開(kāi)封第一講書(shū)人閱讀 153,443評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)哥桥。 經(jīng)常有香客問(wèn)我,道長(zhǎng)激涤,這世上最難降的妖魔是什么拟糕? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,475評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮倦踢,結(jié)果婚禮上送滞,老公的妹妹穿的比我還像新娘。我一直安慰自己辱挥,他們只是感情好犁嗅,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,458評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著晤碘,像睡著了一般褂微。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上园爷,一...
    開(kāi)封第一講書(shū)人閱讀 49,185評(píng)論 1 284
  • 那天宠蚂,我揣著相機(jī)與錄音,去河邊找鬼童社。 笑死求厕,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的扰楼。 我是一名探鬼主播呀癣,決...
    沈念sama閱讀 38,451評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼弦赖!你這毒婦竟也來(lái)了项栏?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 37,112評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤腾节,失蹤者是張志新(化名)和其女友劉穎忘嫉,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體案腺,經(jīng)...
    沈念sama閱讀 43,609評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡庆冕,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,083評(píng)論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了劈榨。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片访递。...
    茶點(diǎn)故事閱讀 38,163評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖同辣,靈堂內(nèi)的尸體忽然破棺而出拷姿,到底是詐尸還是另有隱情惭载,我是刑警寧澤,帶...
    沈念sama閱讀 33,803評(píng)論 4 323
  • 正文 年R本政府宣布响巢,位于F島的核電站描滔,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏踪古。R本人自食惡果不足惜含长,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,357評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望伏穆。 院中可真熱鬧拘泞,春花似錦、人聲如沸枕扫。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,357評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)烟瞧。三九已至诗鸭,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間燕刻,已是汗流浹背只泼。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,590評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留卵洗,地道東北人请唱。 一個(gè)月前我還...
    沈念sama閱讀 45,636評(píng)論 2 355
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像过蹂,于是被迫代替她去往敵國(guó)和親十绑。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,925評(píng)論 2 344

推薦閱讀更多精彩內(nèi)容