[springBoot系列]--springBoot注解大全

一绳姨、注解(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è)配置围苫。

package com.example.myproject; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan publicclass Application { publicstaticvoid 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")publicString hello(Map 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依賴自動(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)入依賴的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}”) privateString 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)入依賴的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”) privateDemoInfoService 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的名稱,以便使用锭汛,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è)用來(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閱讀 211,817評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件冰寻,死亡現(xiàn)場(chǎng)離奇詭異须教,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)斩芭,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,329評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門(mén)轻腺,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人划乖,你說(shuō)我怎么就攤上這事贬养。” “怎么了迁筛?”我有些...
    開(kāi)封第一講書(shū)人閱讀 157,354評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵煤蚌,是天一觀的道長(zhǎng)耕挨。 經(jīng)常有香客問(wèn)我,道長(zhǎng)尉桩,這世上最難降的妖魔是什么筒占? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,498評(píng)論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮蜘犁,結(jié)果婚禮上翰苫,老公的妹妹穿的比我還像新娘。我一直安慰自己这橙,他們只是感情好奏窑,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,600評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著屈扎,像睡著了一般埃唯。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上鹰晨,一...
    開(kāi)封第一講書(shū)人閱讀 49,829評(píng)論 1 290
  • 那天墨叛,我揣著相機(jī)與錄音,去河邊找鬼模蜡。 笑死漠趁,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的忍疾。 我是一名探鬼主播闯传,決...
    沈念sama閱讀 38,979評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼卤妒!你這毒婦竟也來(lái)了甥绿?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 37,722評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤则披,失蹤者是張志新(化名)和其女友劉穎妹窖,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體收叶,經(jīng)...
    沈念sama閱讀 44,189評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,519評(píng)論 2 327
  • 正文 我和宋清朗相戀三年共苛,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了判没。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,654評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡隅茎,死狀恐怖澄峰,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情辟犀,我是刑警寧澤俏竞,帶...
    沈念sama閱讀 34,329評(píng)論 4 330
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響魂毁,放射性物質(zhì)發(fā)生泄漏玻佩。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,940評(píng)論 3 313
  • 文/蒙蒙 一席楚、第九天 我趴在偏房一處隱蔽的房頂上張望咬崔。 院中可真熱鬧,春花似錦烦秩、人聲如沸垮斯。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,762評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)兜蠕。三九已至,卻和暖如春抛寝,著一層夾襖步出監(jiān)牢的瞬間熊杨,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,993評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工墩剖, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留猴凹,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,382評(píng)論 2 360
  • 正文 我出身青樓岭皂,卻偏偏與公主長(zhǎng)得像郊霎,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子爷绘,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,543評(píng)論 2 349

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

  • Spring Cloud為開(kāi)發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見(jiàn)模式的工具(例如配置管理书劝,服務(wù)發(fā)現(xiàn),斷路器土至,智...
    卡卡羅2017閱讀 134,633評(píng)論 18 139
  • 一购对、注解(annotations)列表 @SpringBootApplication:包含了@ComponentS...
    生活的探路者閱讀 752評(píng)論 0 0
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,773評(píng)論 6 342
  • 1.1 spring IoC容器和beans的簡(jiǎn)介 Spring 框架的最核心基礎(chǔ)的功能是IoC(控制反轉(zhuǎn))容器,...
    simoscode閱讀 6,702評(píng)論 2 22
  • 1. 圣誕夜那晚解幽,我們幾個(gè)朋友聚餐完,小妞就熱情高漲提議大家去看一場(chǎng)電影烘苹。 我也好久沒(méi)有走進(jìn)電影院了躲株,在酒后意猶未...
    暖暖屋_閱讀 533評(píng)論 0 0