前言

1根吁、最近在看大佬狂神的課程员淫，Javaweb>spring>springMVC>mybatis>spring高級，一路走來击敌，跌跌撞撞介返，發(fā)現(xiàn)spring也不過爾爾，說白了沃斤，spring就是想盡辦法將new做的更簡單圣蝎，更完美，更可配置衡瓶。

2徘公、本身Spring的一個(gè)核心功能是IOC，就是將Bean初始化加載到容器中哮针，Bean是如何加載到容器的关面，可以使用Spring注解方式或者Spring XML配置方式。注解本身是沒有功能的十厢，和xml一樣缭裆，注解和xml都是一種元數(shù)據(jù)，元數(shù)據(jù)即解釋數(shù)據(jù)的數(shù)據(jù)寿烟，也就是所謂的配置。

3辛燥、而且Spring注解方式減少了配置文件內(nèi)容筛武，更加便于管理，并且使用注解可以大大提高了開發(fā)效率挎塌！

所以本文主要對網(wǎng)上的springboot常見注解和自己本人在學(xué)習(xí)的過程中遇到的注解的一次總結(jié)徘六，本文會持續(xù)更新，不斷地?cái)U(kuò)充

一. Spring Boot注解

@EnableAutoConfiguration此注解通常被用在主應(yīng)用class上榴都，告訴Spring Boot自動基于當(dāng)前包添加Bean待锈、對bean的屬性進(jìn)行設(shè)置等。

@SpringBootApplication此注解用在Spring Boot項(xiàng)目的應(yīng)用主類上（此類需要在base package中）嘴高。使用了此注解的類首先會讓Spring Boot啟動對base package以及其sub-pacakage下的類進(jìn)行component scan竿音。

此注解同時(shí)添加了以下幾個(gè)注解：

• @Configuration

• @EnableAutoConfiguration

• @ComponentScan

二. 核心注解

@Required此注解用于bean的setter方法上。表示此屬性是必須的拴驮，必須在配置階段注入春瞬，否則會拋出BeanInitializationExcepion。

@Autowired此注解用于bean的field套啤、setter方法以及構(gòu)造方法上宽气，顯式地聲明依賴。根據(jù)type來autowiring。

當(dāng)在field上使用此注解萄涯，并且使用屬性來傳遞值時(shí)绪氛，Spring會自動把值賦給此field。也可以將此注解用于私有屬性(不推薦)涝影，如下枣察。

@Component
public class User {
    @Autowired
    private Address address;
}

最經(jīng)常的用法是將此注解用于settter上，這樣可以在setter方法中添加自定義代碼袄琳。如下：

@Component
public class User {
     private Address address;

     @AutoWired
   public setAddress(Address address) {
      // custom code
      this.address=address;
   }
}

當(dāng)在構(gòu)造方法上使用此注解的時(shí)候询件，需要注意的一點(diǎn)就是一個(gè)類中只允許有一個(gè)構(gòu)造方法使用此注解。此外唆樊，在Spring4.3后宛琅，如果一個(gè)類僅僅只有一個(gè)構(gòu)造方法，那么即使不使用此注解逗旁，那么Spring也會自動注入相關(guān)的bean嘿辟。如下：

@Component
public class User {
    private Address address;

     public User(Address address) {
        this.address=address;
     }
}

<bean id="user" class="xx.User"/>

@Qualifier此注解是和@Autowired一起使用的。使用此注解可以讓你對注入的過程有更多的控制片效。

@Qualifier可以被用在單個(gè)構(gòu)造器或者方法的參數(shù)上红伦。當(dāng)上下文有幾個(gè)相同類型的bean, 使用@Autowired則無法區(qū)分要綁定的bean，此時(shí)可以使用@Qualifier來指定名稱淀衣。

@Component
public class User {
    @Autowired
    @Qualifier("address1")
    private Address address;
    ...
}

@Configuration此注解用在class上來定義bean昙读。其作用和xml配置文件相同，表示此bean是一個(gè)Spring配置膨桥。此外蛮浑，此類可以使用@Bean注解來初始化定義bean。

@Configuartion
public class SpringCoreConfig {
    @Bean
    public AdminUser adminUser() {
        AdminUser adminUser = new AdminUser();
        return adminUser;
    }
}

@ComponentScan此注解一般和@Configuration注解一起使用只嚣，指定Spring掃描注解的package沮稚。如果沒有指定包，那么默認(rèn)會掃描此配置類所在的package册舞。

@Lazy此注解使用在Spring的組件類上蕴掏。默認(rèn)的，Spring中Bean的依賴一開始就被創(chuàng)建和配置调鲸。如果想要延遲初始化一個(gè)bean盛杰，那么可以在此類上使用Lazy注解，表示此bean只有在第一次被使用的時(shí)候才會被創(chuàng)建和初始化线得。此注解也可以使用在被@Configuration注解的類上饶唤，表示其中所有被@Bean注解的方法都會延遲初始化。

@Value此注解使用在字段贯钩、構(gòu)造器參數(shù)和方法參數(shù)上募狂。@Value可以指定屬性取值的表達(dá)式办素，支持通過#{}使用SpringEL來取值，也支持使用${}來將屬性來源中(Properties文件祸穷、本地環(huán)境變量性穿、系統(tǒng)屬性等)的值注入到bean的屬性中。此注解值的注入發(fā)生在AutowiredAnnotationBeanPostProcessor類中雷滚。

三. Stereotype注解

@Component此注解使用在class上來聲明一個(gè)Spring組件(Bean), 將其加入到應(yīng)用上下文中需曾。

@Controller前文已經(jīng)提到過

@Service此注解使用在class上，聲明此類是一個(gè)服務(wù)類祈远，執(zhí)行業(yè)務(wù)邏輯呆万、計(jì)算、調(diào)用內(nèi)部api等车份。是@Component注解的一種具體形式谋减。

@Repository此類使用在class上聲明此類用于訪問數(shù)據(jù)庫，一般作為DAO的角色扫沼。

此注解有自動翻譯的特性出爹，例如：當(dāng)此種component拋出了一個(gè)異常，那么會有一個(gè)handler來處理此異常缎除，無需使用try-catch塊严就。

四. Spring MVC和REST注解

@Controller此注解使用在class上聲明此類是一個(gè)Spring controller，是@Component注解的一種具體形式器罐。

@RequestMapping此注解可以用在class和method上梢为，用來映射web請求到某一個(gè)handler類或者h(yuǎn)andler方法上。當(dāng)此注解用在Class上時(shí)轰坊，就創(chuàng)造了一個(gè)基礎(chǔ)url抖誉，其所有的方法上的@RequestMapping都是在此url之上的。

可以使用其method屬性來限制請求匹配的http method衰倦。

@Controller
@RequestMapping("/users")
public class UserController {
    @RequestMapping(method = RequestMethod.GET)
    public String getUserList() {
        return "users";
    }
}

此外，Spring4.3之后引入了一系列@RequestMapping的變種旁理。如下：

• @GetMapping

• @PostMapping

• @PutMapping

• @PatchMapping

• @DeleteMapping

分別對應(yīng)了相應(yīng)method的RequestMapping配置樊零。

@CookieValue此注解用在@RequestMapping聲明的方法的參數(shù)上，可以把HTTP cookie中相應(yīng)名稱的cookie綁定上去孽文。

@ReuestMapping("/cookieValue")
      public void getCookieValue(@CookieValue("JSESSIONID") String cookie){

}

cookie即http請求中name為JSESSIONID的cookie值驻襟。

@CrossOrigin此注解用在class和method上用來支持跨域請求，是Spring 4.2后引入的芋哭。

@CrossOrigin(maxAge = 3600)
@RestController
@RequestMapping("/users")
public class AccountController {
    @CrossOrigin(origins = "http://xx.com")
    @RequestMapping("/login")
    public Result userLogin() {
        // ...
    }
}

@ExceptionHandler此注解使用在方法級別沉衣，聲明對Exception的處理邏輯〖跷可以指定目標(biāo)Exception豌习。

@InitBinder此注解使用在方法上存谎，聲明對WebDataBinder的初始化(綁定請求參數(shù)到JavaBean上的DataBinder)。在controller上使用此注解可以自定義請求參數(shù)的綁定肥隆。

@MatrixVariable此注解使用在請求handler方法的參數(shù)上既荚，Spring可以注入matrix url中相關(guān)的值。這里的矩陣變量可以出現(xiàn)在url中的任何地方栋艳，變量之間用;分隔恰聘。如下：

// GET /pets/42;q=11;r=22
@RequestMapping(value = "/pets/{petId}")
public void findPet(@PathVariable String petId, @MatrixVariable int q) {
    // petId == 42
    // q == 11
}

需要注意的是默認(rèn)Spring mvc是不支持矩陣變量的，需要開啟吸占。

<mvc:annotation-driven enable-matrix-variables="true" />

注解配置則需要如下開啟：

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        UrlPathHelper urlPathHelper = new UrlPathHelper();
        urlPathHelper.setRemoveSemicolonContent(false);
        configurer.setUrlPathHelper(urlPathHelper);
    }
}

@PathVariable此注解使用在請求handler方法的參數(shù)上晴叨。@RequestMapping可以定義動態(tài)路徑，如:.

@RequestMapping("/users/{uid}")

可以使用@PathVariable將路徑中的參數(shù)綁定到請求方法參數(shù)上矾屯。

@RequestMapping("/users/{uid}")
public String execute(@PathVariable("uid") String uid){
}
@RequestAttribute

此注解用在請求handler方法的參數(shù)上兼蕊，用于將web請求中的屬性(request attributes，是服務(wù)器放入的屬性值)綁定到方法參數(shù)上问拘。

@RequestBody此注解用在請求handler方法的參數(shù)上遍略，用于將http請求的Body映射綁定到此參數(shù)上。HttpMessageConverter負(fù)責(zé)將對象轉(zhuǎn)換為http請求骤坐。

@RequestHeader此注解用在請求handler方法的參數(shù)上绪杏，用于將http請求頭部的值綁定到參數(shù)上。

@RequestParam此注解用在請求handler方法的參數(shù)上纽绍，用于將http請求參數(shù)的值綁定到參數(shù)上蕾久。

@RequestPart此注解用在請求handler方法的參數(shù)上，用于將文件之類的multipart綁定到參數(shù)上拌夏。

@ResponseBody此注解用在請求handler方法上僧著。和@RequestBody作用類似，用于將方法的返回對象直接輸出到http響應(yīng)中障簿。

@ResponseStatus此注解用于方法和exception類上盹愚，聲明此方法或者異常類返回的http狀態(tài)碼≌竟剩可以在Controller上使用此注解皆怕，這樣所有的@RequestMapping都會繼承。

@ControllerAdvice此注解用于class上西篓。前面說過可以對每一個(gè)controller聲明一個(gè)ExceptionMethod愈腾。這里可以使用@ControllerAdvice來聲明一個(gè)類來統(tǒng)一對所有@RequestMapping方法來做

@ExceptionHandler、@InitBinder以及@ModelAttribute處理岂津。

@RestController此注解用于class上虱黄，聲明此controller返回的不是一個(gè)視圖而是一個(gè)領(lǐng)域?qū)ο蟆Ｆ渫瑫r(shí)引入了@Controller和@ResponseBody兩個(gè)注解吮成。

@RestControllerAdvice此注解用于class上橱乱，同時(shí)引入了@ControllerAdvice和@ResponseBody兩個(gè)注解辜梳。

@SessionAttribute此注解用于方法的參數(shù)上，用于將session中的屬性綁定到參數(shù)仅醇。

@SessionAttributes此注解用于type級別冗美，用于將JavaBean對象存儲到session中。一般和@ModelAttribute注解一起使用析二。如下：

@ModelAttribute("user")

public PUser getUser() {}

// controller和上面的代碼在同一controller中
@Controller
@SeesionAttributes(value = "user", types = {
    User.class
})

public class UserController {}

五. 測試注解

@ContextConfiguration此注解使用在Class上粉洼，聲明測試使用的配置文件，此外叶摄，也可以指定加載上下文的類属韧。 此注解一般需要搭配SpringJUnit4ClassRunner使用。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringCoreConfig.class)
public class UserServiceTest {

}

六. 數(shù)據(jù)訪問注解

@Transactional此注解使用在接口定義蛤吓、接口中的方法宵喂、類定義或者類中的public方法上。需要注意的是此注解并不激活事務(wù)行為会傲，它僅僅是一個(gè)元數(shù)據(jù)锅棕，會被一些運(yùn)行時(shí)基礎(chǔ)設(shè)施來消費(fèi)。

七. 任務(wù)執(zhí)行淌山、調(diào)度注解

@Scheduled此注解使用在方法上裸燎，聲明此方法被定時(shí)調(diào)度。使用了此注解的方法返回類型需要是Void泼疑，并且不能接受任何參數(shù)德绿。

@Scheduled(fixedDelay=1000)
public void schedule() {

}

@Scheduled(fixedRate=1000)
public void schedulg() {

}

第二個(gè)與第一個(gè)不同之處在于其不會等待上一次的任務(wù)執(zhí)行結(jié)束。

@Async此注解使用在方法上退渗，聲明此方法會在一個(gè)單獨(dú)的線程中執(zhí)行移稳。不同于Scheduled注解，此注解可以接受參數(shù)会油。

使用此注解的方法的返回類型可以是Void也可是返回值个粱。但是返回值的類型必須是一個(gè)Future续徽。