SpringBoot必須掌握的一些注解
點(diǎn)擊上方藍(lán)色字體，選擇“標(biāo)星公眾號(hào)”
優(yōu)質(zhì)文章，第一時(shí)間送達(dá)
? 作者?|??童未惜
來源 |? urlify.cn/MFB36r
66套java從入門到精通實(shí)戰(zhàn)課程分享
一、注解 (annotations) 列表
@SpringBootApplication：包含了 @ComponentScan、@Configuration 和 @EnableAutoConfiguration 注解。其中 @ComponentScan 讓 spring Boot 掃描到 Configuration 類并把它加入到程序上下文。@Configuration?等同于 spring 的 XML 配置文件；使用 Java 代碼可以檢查類型安全。**@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?解決嵌套外鏈問題。@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
public?class?Application?{
????public?static?void?main(String[]?args)?{
????????SpringApplication.run(Application.class,?args);
????}
}
@ResponseBody：表示該方法的返回結(jié)果直接寫入 HTTP response body 中，一般在異步獲取數(shù)據(jù)時(shí)使用，用于構(gòu)建 RESTful 的 api。在使用 @RequestMapping 后，返回值通常解析為跳轉(zhuǎn)路徑，加上 @responsebody 后返回結(jié)果不會(huì)被解析為跳轉(zhuǎn)路徑，而是直接寫入 HTTP response body 中。比如異步獲取 json 數(shù)據(jù)，加上 @responsebody 后，會(huì)直接返回 json 數(shù)據(jù)。該注解一般會(huì)配合 @RequestMapping 一起使用。示例代碼：
@RequestMapping(“/test”)
?@ResponseBody
?public?String?test(){
?????return”ok”;
}
@Controller：用于定義控制器類，在 spring 項(xiàng)目中由控制器負(fù)責(zé)將用戶發(fā)來的 URL 請(qǐng)求轉(zhuǎn)發(fā)到對(duì)應(yīng)的服務(wù)接口（service 層）一般這個(gè)注解在類中，通常方法需要配合注解 @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");
????????//會(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，并且你沒有手動(dòng)配置任何數(shù)據(jù)庫連接 beans，那么我們將自動(dòng)配置一個(gè)內(nèi)存型（in-memory）數(shù)據(jù)庫”。你可以將 @EnableAutoConfiguration 或者 @SpringBootApplication 注解添加到一個(gè) @Configuration 類上來選擇自動(dòng)配置。如果發(fā)現(xiàn)應(yīng)用了你不想要的特定自動(dòng)配置類，你可以使用 @EnableAutoConfiguration 注解的排除屬性來禁用它們。@ComponentScan：表示將該類自動(dòng)發(fā)現(xiàn)掃描組件。個(gè)人理解相當(dāng)于，如果掃描到有 @Component、@Controller、@Service 等這些注解的類，并注冊(cè)為 Bean，可以自動(dòng)收集所有的 Spring 組件，包括 @Configuration 類。我們經(jīng)常使用 @ComponentScan 注解搜索 beans，并結(jié)合 @Autowired 注解導(dǎo)入。可以自動(dòng)收集所有的 Spring 組件，包括 @Configuration 類。如果沒有配置的話，Spring Boot 會(huì)掃描啟動(dòng)類所在包下以及子包下的使用了 @Service,@Repository 等注解的類。@Configuration：相當(dāng)于傳統(tǒng)的 xml 配置文件，如果有些第三方庫需要用到 xml 文件，建議仍然通過 @Configuration 類作為項(xiàng)目的配置主類——可以使用 @ImportResource 注解加載 xml 配置文件。@Import：用來導(dǎo)入其他配置類。@ImportResource：用來加載 xml 配置文件。@Autowired：自動(dòng)導(dǎo)入依賴的 bean@Service：一般用于修飾 service 層的組件@Repository：使用 @Repository 注解可以確保 DAO 或者 repositories 提供異常轉(zhuǎn)譯，這個(gè)注解修飾的 DAO 或者 repositories 類會(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，只是沒有 required 屬性；@Component：泛指組件，當(dāng)組件不好歸類的時(shí)候，我們可以使用這個(gè)注解進(jìn)行標(biāo)注。@Bean：相當(dāng)于 XML 中的, 放在方法的上面，而不是類，意思是產(chǎn)生一個(gè) bean, 并交給 spring 管理。@AutoWired：自動(dòng)導(dǎo)入依賴的 bean。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 配合使用。@Qualifier 限定描述符除了能根據(jù)名字進(jìn)行注入，但能進(jìn)行更細(xì)粒度的控制如何選擇候選者，具體使用方式如下：
@Autowired
?@Qualifier(value?=?“demoInfoService”)
?private?DemoInfoService?demoInfoService;
@Resource(name=”name”,type=”type”)：沒有括號(hào)內(nèi)內(nèi)容的話，默認(rèn) byName。與 @Autowired 干類似的事。
三、JPA 注解
@Entity：@Table(name=”“)：表明這是一個(gè)實(shí)體類。一般用于 jpa 這兩個(gè)注解一般一塊使用，但是如果表名和實(shí)體類名相同的話，@Table 可以省略@MappedSuperClass: 用在確定是父類的 entity 上。父類的屬性子類可以繼承。@NoRepositoryBean: 一般用作父類的 repository，有這個(gè)注解，spring 不會(huì)去實(shí)例化該 repository。@Column：如果字段名與列名相同，則可以省略。@Id：表示該屬性為主鍵。@GeneratedValue(strategy=GenerationType.SEQUENCE,generator= “repair_seq”)：表示主鍵生成策略是 sequence（可以為 Auto、IDENTITY、native 等，Auto 表示可在多個(gè)數(shù)據(jù)庫間切換），指定 sequence 的名字是 repair_seq。@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)：name 為 sequence 的名稱，以便使用，sequenceName 為數(shù)據(jù)庫的 sequence 名稱，兩個(gè)名稱可以一致。@Transient：表示該屬性并非一個(gè)到數(shù)據(jù)庫表的字段的映射, ORM 框架將忽略該屬性。如果一個(gè)屬性并非數(shù)據(jù)庫表的字段映射, 就務(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è)用來處理請(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) 類型中包含該指定類型才返回@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í)行以下方法。
粉絲福利：實(shí)戰(zhàn)springboot+CAS單點(diǎn)登錄系統(tǒng)視頻教程免費(fèi)領(lǐng)取
???
?長(zhǎng)按上方微信二維碼?2 秒 即可獲取資料
感謝點(diǎn)贊支持下哈?