spring boot 常用注釋

WEB 模塊相關(guān)

  • spring-boot-starter:核心模塊,包括自動(dòng)配置支持、日志和YAML
  • spring-boot-starter-test:測(cè)試模塊,包括JUnit、Hamcrest托慨、Mockito
  • spring-boot-starter-web

常用注解

  • @RequestMapping =》處理地址映射的注解

  • @PathVariable =》 用來獲取請(qǐng)求路徑(url)中的動(dòng)態(tài)參數(shù)

    1. 示例
        /**
        * @RequestMapping(value = "user/login/{id}/{name}/{status}") 中的 {id}/{name}/{status}
        * 與 @PathVariable int id、@PathVariable String name暇榴、@PathVariable boolean status
        * 一一對(duì)應(yīng)厚棵,按名匹配。
        */
    
        @RequestMapping(value = "user/login/{id}/{name}/{status}")
        @ResponseBody
        //@PathVariable注解下的數(shù)據(jù)類型均可用
        public User login(@PathVariable int id, @PathVariable String name, @PathVariable boolean status) {
        //返回一個(gè)User對(duì)象響應(yīng)ajax的請(qǐng)求
            return new User(id, name, status);
        }
    
  • @ResponseBody => 將客戶端請(qǐng)求的數(shù)據(jù)解析為json 數(shù)據(jù)或者 xml 格式返回給HTTP響應(yīng)正文(ResponseBody)中蔼紧, 也就是客戶端需要的數(shù)據(jù)婆硬。

  • @Controller =》 spring mvc 中配置view 成的注解 ,可以通過此返回jsp 頁面奸例,重定向等 彬犯,配合 @ResponseBody 就可以返回頁面需要的數(shù)據(jù) ,比如json 等查吊。

  • @RestController => @RestController注解相當(dāng)于@ResponseBody +@Controller合在一起的作用谐区。但是如果只是使用@RestController注解Controller,則Controller中的方法無法返回jsp頁面逻卖。@RestController 注解更適合 restfulApi 項(xiàng)目的使用 宋列。

  • @RequestParam=> 頁面?zhèn)魅雲(yún)?shù)名與方法參數(shù)名不一致時(shí)可以使用此注解綁定。

  • @RequestBody=> 將ajax(datas)發(fā)出的請(qǐng)求寫入 User 對(duì)象中评也。

  • 組合注解(RequestMapping的升級(jí)版)

    1. @GetMapping = @RequestMapping(method = RequestMethod.GET)
    2. @PostMapping = @RequestMapping(method = RequestMethod.POST)
    3. @PutMapping = @RequestMapping(method = RequestMethod.PUT)
    4. @DeleteMapping = @RequestMapping(method = RequestMethod.DELETE)
    組合注解是方法級(jí)別的炼杖,只能用在方法上灭返,我們的實(shí)例基本都用組合注解。


@SpringBootApplication:

包含@Configuration坤邪、@EnableAutoConfiguration熙含、@ComponentScan
通常用在主類上。

@Repository:

用于標(biāo)注數(shù)據(jù)訪問組件艇纺,即DAO組件怎静。

@Service:

用于標(biāo)注業(yè)務(wù)層組件。

@Controller:

用于標(biāo)注 controller 層黔衡。

@Component:

泛指組件蚓聘,當(dāng)組件不好歸類的時(shí)候,我們可以使用這個(gè)注解進(jìn)行標(biāo)注员帮。

@RestController:

用于標(biāo)注控制層組件(如struts中的action)或粮,包含@Controller和@ResponseBody导饲。

@ResponseBody:

表示該方法的返回結(jié)果直接寫入HTTP response body中
一般在異步獲取數(shù)據(jù)時(shí)使用捞高,在使用@RequestMapping后,返回值通常解析為跳轉(zhuǎn)路徑渣锦,加上@responsebody后返回結(jié)果不會(huì)被解析為跳轉(zhuǎn)路徑硝岗,而是直接寫入HTTP response body中。比如異步獲取json數(shù)據(jù)袋毙,加上@responsebody后型檀,會(huì)直接返回json數(shù)據(jù)。

@PathVariable:

路徑變量听盖。參數(shù)與大括號(hào)里的名字一樣要相同胀溺。

@RequestParam:

用在方法的參數(shù)前面皆看,用來接收 get 請(qǐng)求 表單數(shù)據(jù) 仓坞,約束是否是必須的 腰吟, 默認(rèn)值,起別名用來接收表單值 等如 :

http://127.0.0.1:8080/user/login?username=admin&password=admin

public void test(@RequestParam(default="admintest",required=true) String username,@RequestParam(name="password") String pwd){
    
}

@ComponentScan:

當(dāng)主啟動(dòng)類不在其他類的 父包中時(shí)毛雇,使用此注解掃描包含了所有類的包嫉称。

組件掃描。個(gè)人理解相當(dāng)于<context:component-scan>灵疮,如果掃描到有@Component @Controller @Service等這些注解的類,則把這些類注冊(cè)為bean蒲稳。

@Configuration:

指出該類是 Bean 配置的信息源氮趋,相當(dāng)于XML中的<beans></beans>,一般加在主類上江耀。

@Bean:

相當(dāng)于XML中的<bean></bean>,放在方法的上面剩胁,而不是類,意思是產(chǎn)生一個(gè)bean,并交給spring管理祥国。

@EnableAutoConfiguration:

讓 Spring Boot 根據(jù)應(yīng)用所聲明的依賴來對(duì) Spring 框架進(jìn)行自動(dòng)配置,一般加在主類上啊犬。

@AutoWired:

byType方式。把配置好的Bean拿來用觉至,完成屬性睡腿、方法的組裝,它可以對(duì)類成員變量席怪、方法及構(gòu)造函數(shù)進(jìn)行標(biāo)注应闯,完成自動(dòng)裝配的工作挂捻。
當(dāng)加上(required=false)時(shí),就算找不到bean也不報(bào)錯(cuò)骨田。

@Qualifier:

當(dāng)有多個(gè)同一類型的Bean時(shí),可以用@Qualifier("name")來指定态贤。與@Autowired配合使用

@Resource(name="name",type="type"):

沒有括號(hào)內(nèi)內(nèi)容的話捧搞,默認(rèn)byName。與@Autowired干類似的事胎撇。

@RequestMapping:

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)類型中包含該指定類型才返回

@Profiles
Spring Profiles提供了一種隔離應(yīng)用程序配置的方式荞胡,并讓這些配置只能在特定的環(huán)境下生效了嚎。
任何@Component或@Configuration都能被@Profile標(biāo)記廊营,從而限制加載它的時(shí)機(jī)歪泳。

@Configuration
@Profile("prod")
public class ProductionConfiguration {
    // ...
}

@ConfigurationProperties
Spring Boot將嘗試校驗(yàn)外部的配置露筒,默認(rèn)使用JSR-303(如果在classpath路徑中)。
你可以輕松的為你的@ConfigurationProperties類添加JSR-303 javax.validation約束注解:

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
@NotNull
private InetAddress remoteAddress;
// ... getters and setters
}

@ControllerAdvice:
包含@Component慎式。可以被掃描到癣防。
統(tǒng)一處理異常掌眠。

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末蓝丙,一起剝皮案震驚了整個(gè)濱河市望拖,隨后出現(xiàn)的幾起案子挫鸽,更是在濱河造成了極大的恐慌,老刑警劉巖丢郊,帶你破解...
    沈念sama閱讀 211,290評(píng)論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異迅诬,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)侈贷,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,107評(píng)論 2 385
  • 文/潘曉璐 我一進(jìn)店門等脂,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人上遥,你說我怎么就攤上這事±绷担” “怎么了模软?”我有些...
    開封第一講書人閱讀 156,872評(píng)論 0 347
  • 文/不壞的土叔 我叫張陵,是天一觀的道長燃异。 經(jīng)常有香客問我,道長逛腿,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,415評(píng)論 1 283
  • 正文 為了忘掉前任单默,我火速辦了婚禮灵莲,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己线欲,他們只是感情好汽摹,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,453評(píng)論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著逼泣,像睡著了一般。 火紅的嫁衣襯著肌膚如雪嗜憔。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,784評(píng)論 1 290
  • 那天吉捶,我揣著相機(jī)與錄音皆尔,去河邊找鬼。 笑死慷蠕,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的澎现。 我是一名探鬼主播浪感,決...
    沈念sama閱讀 38,927評(píng)論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼饼问,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼!你這毒婦竟也來了莱革?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,691評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤捐名,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后镶蹋,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,137評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡淆两,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,472評(píng)論 2 326
  • 正文 我和宋清朗相戀三年拂酣,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片婶熬。...
    茶點(diǎn)故事閱讀 38,622評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖虽另,靈堂內(nèi)的尸體忽然破棺而出饺谬,到底是詐尸還是另有隱情洲赵,我是刑警寧澤商蕴,帶...
    沈念sama閱讀 34,289評(píng)論 4 329
  • 正文 年R本政府宣布,位于F島的核電站苛谷,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏腹殿。R本人自食惡果不足惜例书,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,887評(píng)論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望决采。 院中可真熱鬧,春花似錦树瞭、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,741評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽衣盾。三九已至,卻和暖如春迅涮,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背叮姑。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評(píng)論 1 265
  • 我被黑心中介騙來泰國打工据悔, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人极颓。 一個(gè)月前我還...
    沈念sama閱讀 46,316評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像兵琳,于是被迫代替她去往敵國和親骇径。 傳聞我的和親對(duì)象是個(gè)殘疾皇子躯肌,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,490評(píng)論 2 348

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