SpringBoot 常用注解

@Conponent組件:沒有明確的角色。

@Servise:在業(yè)務邏輯層使用(service層)壤靶。

@Repository:在數(shù)據(jù)訪問曾使用(dao層)娇未。

@Controller:在展現(xiàn)層使用(MVC-Spring- MVC)决帖。

@Autowired:Spring提供的注解菱父。

@Inject:JSR-330提供的注解。

@Resource:JSR-250提供的注解自晰。

***:可用在set方法或者屬性上凝化。

SpringBootApplication 將三個有用的組件注解組合在了一起:

@Configuration: 標明該類使用Spring基于java的配置。

@ComponentScan: 啟用組件掃描酬荞,寫的Web控制器類和其他組件才能被自動發(fā)現(xiàn)并注冊為Spring應用程序上下文中的Bean搓劫。

@EnableAutoConfiguration: 開啟Spring Boot自動配置。

@Configuration:聲明當前類是一個配置類混巧,相當于一個Spring配置的xml文件枪向。

@ComponentScan:自動掃描包名下所有使用@Servise、@Repository牲剃、@Conponent遣疯、@Controller的類,并注冊為Bean凿傅。

@Bean:注解在一個方法上缠犀,生命當前方法返回值為一個Bean。

全局配置(如數(shù)據(jù)庫相關配置聪舒、MVC相關配置)使用Java配置辨液,業(yè)務Bean的配置使用注解配置(@Servise、@Repository箱残、@Conponent滔迈、@Controller)。


1. @SpringBootApplication

@SpringBootApplication 注解等價于以默認屬性使用 @Configuration被辑,@EnableAutoConfiguration 和 @ComponentScan燎悍,通常作為主類的注解;

2. @Configuration

指出該類是bean配置的信息源盼理,相當于xml中的<beans></beans>標簽谈山,通常用于主類上。

3. @EnableAutoConfiguration

讓 Spring Boot 根據(jù)應用所聲明的依賴來對 Spring 框架進行自動配置宏怔,一般加在主類上奏路。

4. @ComponentScan

我們經(jīng)常使用 @ComponentScan 注解搜索beans,并結合 @Autowired 構造器注入臊诊,你的所有應用程序組件( @Component , @Service , @Repository , @Controller 等)將被自動注冊為Spring Beans鸽粉。

5. @Repository

被這個注解所修飾的DAO或repositories類會被ComponentScan發(fā)現(xiàn)并配置。

6. @Service

用于修飾Service層組件抓艳。

7. @Controller

用于定義控制器類触机,由控制器將用戶發(fā)來的URL請求發(fā)送至對應的service進行處理。

8. @ResponseBody

作用于方法上,表示該方法的返回結果直接寫入HTTP response body中威兜,一般在異步獲取數(shù)據(jù)時使用销斟,在使用@RequestMapping后,返回值通常解析為跳轉(zhuǎn)路徑椒舵,加上@responsebody后返回結果不會被解析為跳轉(zhuǎn)路徑,而是直接寫入HTTP response body中约谈。比如異步獲取json數(shù)據(jù)笔宿,加上@responsebody后,會直接返回json數(shù)據(jù)棱诱。

9. @RestController

@Controller與@ResponseBody的合集泼橘。

10. @RequestMapping

@RequestMapping是一個用來處理請求地址映射的注解,用于類或方法上迈勋,用于類上炬灭,表示類中所有響應請求的方法都是以該路徑為父路徑;

自帶屬性:

path:請求的地址靡菇;

method:請求的方法重归;

headers:指定request中必須包含某些指定的header值,才能讓該方法處理請求厦凤;

params:指定request中必須包含某些參數(shù)值是鼻吮,才讓該方法處理;

consumes:指定處理請求的提交內(nèi)容類型(Content-Type)较鼓,如application/json,text/html椎木;

produces:指定返回的內(nèi)容類型,僅當request請求頭中的(Accept)類型中包含該指定類型才返回博烂;

11. @Autowired

自動裝配香椎,自動導入依賴的beans;

12. @RequestParam

用在方法的參數(shù)前面禽篱;@RequestParam String a =request.getParameter("a")畜伐。

13. @PathVariable

作為路徑中的變量


一、注解(annotations)列表?

@SpringBootApplication:包含了@ComponentScan谆级、@Configuration和@EnableAutoConfiguration注解烤礁。其中@ComponentScan讓Spring Boot掃描到Configuration類并把它加入到程序上下文。

@Configuration 等同于spring的XML配置文件肥照;使用java代碼可以檢查類型安全脚仔。

@EnableAutoConfiguration 自動配置。

@ComponentScan 組件掃描舆绎,可自動發(fā)現(xiàn)和裝配一些Bean鲤脏。

@Component可配合CommandLineRunner使用,在程序啟動后執(zhí)行一些基礎任務。

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

@Autowired自動導入窥突。

@PathVariable獲取參數(shù)。

@JsonBackReference解決嵌套外鏈問題硫嘶。

@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用阻问。

二、注解(annotations)詳解

@SpringBootApplication:申明讓spring boot自動給程序進行必要的配置沦疾,這個配置等同于:@Configuration 称近,@EnableAutoConfiguration 和 @ComponentScan 三個配置。?

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:表示該方法的返回結果直接寫入HTTP response body中哮塞,一般在異步獲取數(shù)據(jù)時使用刨秆,用于構建RESTful的api。在使用@RequestMapping后忆畅,返回值通常解析為跳轉(zhuǎn)路徑衡未,加上@responsebody后返回結果不會被解析為跳轉(zhuǎn)路徑,而是直接寫入HTTP response body中家凯。比如異步獲取json數(shù)據(jù)缓醋,加上@responsebody后,會直接返回json數(shù)據(jù)肆饶。該注解一般會配合@RequestMapping一起使用改衩。示例代碼:?

@RequestMapping(“/test”)?

@ResponseBody?

public String test(){?

return”ok”;?

}

@Controller:用于定義控制器類,在spring 項目中由控制器負責將用戶發(fā)來的URL請求轉(zhuǎn)發(fā)到對應的服務接口(service層)驯镊,一般這個注解在類中葫督,通常方法需要配合注解@RequestMapping。示例代碼:?

@Controller?

@RequestMapping(“/demoInfo”)?

publicclass DemoController {?

@Autowired?

private DemoInfoService demoInfoService;

@RequestMapping("/hello")

public String hello(Map map){

System.out.println("DemoController.hello()");

map.put("hello","from TemplateController.helloHtml");

//會使用hello.html或者hello.ftl模板進行渲染顯示.

return"/hello";

}

}

@RestController:用于標注控制層組件(如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:提供路由信息,負責URL到Controller中的具體函數(shù)的映射冯乘。

@EnableAutoConfiguration:Spring Boot自動配置(auto-configuration):嘗試根據(jù)你添加的jar依賴自動配置你的Spring應用洽胶。例如,如果你的classpath下存在HSQLDB裆馒,并且你沒有手動配置任何數(shù)據(jù)庫連接beans姊氓,那么我們將自動配置一個內(nèi)存型(in-memory)數(shù)據(jù)庫”。你可以將@EnableAutoConfiguration或者@SpringBootApplication注解添加到一個@Configuration類上來選擇自動配置喷好。如果發(fā)現(xiàn)應用了你不想要的特定自動配置類翔横,你可以使用@EnableAutoConfiguration注解的排除屬性來禁用它們。

@ComponentScan:表示將該類自動發(fā)現(xiàn)掃描組件梗搅。個人理解相當于禾唁,如果掃描到有@Component效览、@Controller、@Service等這些注解的類荡短,并注冊為Bean丐枉,可以自動收集所有的Spring組件,包括@Configuration類掘托。我們經(jīng)常使用@ComponentScan注解搜索beans瘦锹,并結合@Autowired注解導入∩量可以自動收集所有的Spring組件沼本,包括@Configuration類。我們經(jīng)常使用@ComponentScan注解搜索beans锭沟,并結合@Autowired注解導入。如果沒有配置的話识补,Spring Boot會掃描啟動類所在包下以及子包下的使用了@Service,@Repository等注解的類族淮。

@Configuration:相當于傳統(tǒng)的xml配置文件,如果有些第三方庫需要用到xml文件凭涂,建議仍然通過@Configuration類作為項目的配置主類——可以使用@ImportResource注解加載xml配置文件祝辣。

@Import:用來導入其他配置類。

@ImportResource:用來加載xml配置文件切油。

@Autowired:自動導入依賴的bean

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

@Repository:使用@Repository注解可以確保DAO或者repositories提供異常轉(zhuǎn)譯蝙斜,這個注解修飾的DAO或者repositories類會被ComponetScan發(fā)現(xiàn)并配置,同時也不需要為它們提供XML配置項澎胡。

@Bean:用@Bean標注方法等價于XML中配置的bean孕荠。

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

@Value(value = “#{message}”)?

private String message;

@Inject:等價于默認的@Autowired攻谁,只是沒有required屬性稚伍;

@Component:泛指組件,當組件不好歸類的時候戚宦,我們可以使用這個注解進行標注个曙。

@Bean:相當于XML中的,放在方法的上面,而不是類受楼,意思是產(chǎn)生一個bean,并交給spring管理垦搬。

@AutoWired:自動導入依賴的bean。byType方式艳汽。把配置好的Bean拿來用猴贰,完成屬性、方法的組裝骚灸,它可以對類成員變量糟趾、方法及構造函數(shù)進行標注,完成自動裝配的工作。當加上(required=false)時义郑,就算找不到bean也不報錯蝶柿。

@Qualifier:當有多個同一類型的Bean時,可以用@Qualifier(“name”)來指定非驮。與@Autowired配合使用交汤。@Qualifier限定描述符除了能根據(jù)名字進行注入,但能進行更細粒度的控制如何選擇候選者劫笙,具體使用方式如下:?

@Autowired?

@Qualifier(value = “demoInfoService”)?

private DemoInfoService demoInfoService;

@Resource(name=”name”,type=”type”):沒有括號內(nèi)內(nèi)容的話芙扎,默認byName。與@Autowired干類似的事填大。

三戒洼、JPA注解

@Entity:@Table(name=”“):表明這是一個實體類。一般用于jpa這兩個注解一般一塊使用允华,但是如果表名和實體類名相同的話圈浇,@Table可以省略

@MappedSuperClass:用在確定是父類的entity上。父類的屬性子類可以繼承靴寂。

@NoRepositoryBean:一般用作父類的repository磷蜀,有這個注解,spring不會去實例化該repository百炬。

@Column:如果字段名與列名相同褐隆,則可以省略。

@Id:表示該屬性為主鍵剖踊。

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = “repair_seq”):表示主鍵生成策略是sequence(可以為Auto庶弃、IDENTITY、native等蜜宪,Auto表示可在多個數(shù)據(jù)庫間切換)虫埂,指定sequence的名字是repair_seq。

@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1):name為sequence的名稱圃验,以便使用掉伏,sequenceName為數(shù)據(jù)庫的sequence名稱,兩個名稱可以一致澳窑。

@Transient:表示該屬性并非一個到數(shù)據(jù)庫表的字段的映射,ORM框架將忽略該屬性斧散。如果一個屬性并非數(shù)據(jù)庫表的字段映射,就務必將其標示為@Transient,否則,ORM框架默認其注解為@Basic。@Basic(fetch=FetchType.LAZY):標記可以指定實體屬性的加載方式

@JsonIgnore:作用是json序列化時將java bean中的一些屬性忽略掉,序列化和反序列化都受影響摊聋。

@JoinColumn(name=”loginId”):一對一:本表中指向另一個表的外鍵鸡捐。一對多:另一個表指向本表的外鍵。

@OneToOne麻裁、@OneToMany箍镜、@ManyToOne:對應Hibernate配置文件中的一對一源祈,一對多,多對一色迂。

四香缺、springMVC相關注解

@RequestMapping:@RequestMapping(“/path”)表示該控制器處理所有“/path”的UR L請求。RequestMapping是一個用來處理請求地址映射的注解歇僧,可用于類或方法上图张。?

用于類上,表示類中的所有響應請求的方法都是以該地址作為父路徑诈悍。該注解有六個屬性:?

params:指定request中必須包含某些參數(shù)值是祸轮,才讓該方法處理。?

headers:指定request中必須包含某些指定的header值侥钳,才能讓該方法處理請求适袜。?

value:指定請求的實際地址,指定的地址可以是URI Template 模式?

method:指定請求的method類型舷夺, GET痪蝇、POST、PUT冕房、DELETE等?

consumes:指定處理請求的提交內(nèi)容類型(Content-Type),如application/json,text/html;?

produces:指定返回的內(nèi)容類型趁矾,僅當request請求頭中的(Accept)類型中包含該指定類型才返回

@RequestParam:用在方法的參數(shù)前面耙册。?

@RequestParam?

String a =request.getParameter(“a”)。

@PathVariable:路徑變量毫捣。如?

RequestMapping(“user/get/mac/{macAddress}”)?

public String getByMacAddress(@PathVariable String macAddress){?

//do something;?

}?

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

五、全局異常處理

@ControllerAdvice:包含@Component蔓同∪恼蓿可以被掃描到。統(tǒng)一處理異常斑粱。

@ExceptionHandler(Exception.class):用在方法上面表示遇到這個異常就執(zhí)行以下方法

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末弃揽,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子则北,更是在濱河造成了極大的恐慌矿微,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件尚揣,死亡現(xiàn)場離奇詭異涌矢,居然都是意外死亡,警方通過查閱死者的電腦和手機快骗,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進店門娜庇,熙熙樓的掌柜王于貴愁眉苦臉地迎上來塔次,“玉大人,你說我怎么就攤上這事名秀±海” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵泰偿,是天一觀的道長熄守。 經(jīng)常有香客問我,道長耗跛,這世上最難降的妖魔是什么裕照? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮调塌,結果婚禮上晋南,老公的妹妹穿的比我還像新娘。我一直安慰自己羔砾,他們只是感情好负间,可當我...
    茶點故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著姜凄,像睡著了一般政溃。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上态秧,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天董虱,我揣著相機與錄音,去河邊找鬼申鱼。 笑死愤诱,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的捐友。 我是一名探鬼主播淫半,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼匣砖!你這毒婦竟也來了科吭?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤猴鲫,失蹤者是張志新(化名)和其女友劉穎砌溺,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體变隔,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡规伐,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了匣缘。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片猖闪。...
    茶點故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡鲜棠,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出培慌,到底是詐尸還是另有隱情豁陆,我是刑警寧澤,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布吵护,位于F島的核電站盒音,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏馅而。R本人自食惡果不足惜祥诽,卻給世界環(huán)境...
    茶點故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望瓮恭。 院中可真熱鬧雄坪,春花似錦、人聲如沸屯蹦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽登澜。三九已至阔挠,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間脑蠕,已是汗流浹背谒亦。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留空郊,地道東北人。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓切揭,卻偏偏與公主長得像狞甚,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子廓旬,可洞房花燭夜當晚...
    茶點故事閱讀 44,914評論 2 355

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

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理哼审,服務發(fā)現(xiàn),斷路器孕豹,智...
    卡卡羅2017閱讀 134,657評論 18 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,811評論 6 342
  • springboot注解:@Service:注解在類上涩盾,表示這是一個業(yè)務層bean@Controller:注解在類...
    摩西子閱讀 1,320評論 0 0
  • @RequestMapping 這個注解可以用于類和方法上,用于類上励背,表示父路徑春霍,如類上是demo,方法上是/de...
    fad2aa506f5e閱讀 405評論 0 0
  • 1叶眉、啟動類中常用的注解 @ComponentScan 自動掃描組件址儒,可自動發(fā)現(xiàn)和裝配一些Bean芹枷。(如Contro...
    Jarvis_Huang閱讀 2,652評論 0 4