SpringBoot 註解大全

• 2019 年 10 月 7 日
• 筆記

https://www.cnblogs.com/tanwei81/p/6814022.html

一、註解(annotations)列表

@SpringBootApplication：包含了@ComponentScan、@Configuration和@EnableAutoConfiguration註解。其中@ComponentScan讓spring Boot掃描到Configuration類並把它加入到程式上下文。

@Configuration 等同於spring的XML配置文件；使用Java程式碼可以檢查類型安全。

@EnableAutoConfiguration 自動配置。

@ComponentScan 組件掃描，可自動發現和裝配一些Bean。

@Component可配合CommandLineRunner使用，在程式啟動後執行一些基礎任務。

@RestController註解是@Controller和@ResponseBody的合集,表示這是個控制器bean,並且是將函數的返回值直 接填入HTTP響應體中,是REST風格的控制器。

@Autowired自動導入。

@PathVariable獲取參數。

@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中，一般在非同步獲取數據時使用，用於構建RESTful的api。在使用@RequestMapping後，返回值通常解析為跳轉路徑，加上@responsebody後返回結果不會被解析為跳轉路徑，而是直接寫入HTTP response body中。比如非同步獲取json數據，加上@responsebody後，會直接返回json數據。該註解一般會配合@RequestMapping一起使用。示例程式碼：

@RequestMapping(「/test」)  @ResponseBody  public String test(){  return」ok」;  }

@Controller：用於定義控制器類，在spring 項目中由控制器負責將用戶發來的URL請求轉發到對應的服務介面（service層），一般這個註解在類中，通常方法需要配合註解@RequestMapping。示例程式碼：

@Controller  @RequestMapping(「/demoInfo」)  publicclass DemoController {  @Autowired  private DemoInfoService demoInfoService;    @RequestMapping("/hello")  public String hello(Map<String,Object> 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中的具體函數的映射。

@EnableAutoConfiguration：Spring Boot自動配置（auto-configuration）：嘗試根據你添加的jar依賴自動配置你的Spring應用。例如，如果你的classpath下存在HSQLDB，並且你沒有手動配置任何資料庫連接beans，那麼我們將自動配置一個記憶體型（in-memory）資料庫」。你可以將@EnableAutoConfiguration或者@SpringBootApplication註解添加到一個@Configuration類上來選擇自動配置。如果發現應用了你不想要的特定自動配置類，你可以使用@EnableAutoConfiguration註解的排除屬性來禁用它們。

@ComponentScan：表示將該類自動發現掃描組件。個人理解相當於，如果掃描到有@Component、@Controller、@Service等這些註解的類，並註冊為Bean，可以自動收集所有的Spring組件，包括@Configuration類。我們經常使用@ComponentScan註解搜索beans，並結合@Autowired註解導入。可以自動收集所有的Spring組件，包括@Configuration類。我們經常使用@ComponentScan註解搜索beans，並結合@Autowired註解導入。如果沒有配置的話，Spring Boot會掃描啟動類所在包下以及子包下的使用了@Service,@Repository等註解的類。

@Configuration：相當於傳統的xml配置文件，如果有些第三方庫需要用到xml文件，建議仍然通過@Configuration類作為項目的配置主類——可以使用@ImportResource註解載入xml配置文件。

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

@ImportResource：用來載入xml配置文件。

@Autowired：自動導入依賴的bean

@Service：一般用於修飾service層的組件

@Repository：使用@Repository註解可以確保DAO或者repositories提供異常轉譯，這個註解修飾的DAO或者repositories類會被ComponetScan發現並配置，同時也不需要為它們提供XML配置項。

@Bean：用@Bean標註方法等價於XML中配置的bean。

@Value：注入Spring boot application.properties配置的屬性的值。示例程式碼：

@Value(value = 「#{message}」)  private String message;

@Inject：等價於默認的@Autowired，只是沒有required屬性；

@Component：泛指組件，當組件不好歸類的時候，我們可以使用這個註解進行標註。

@Bean:相當於XML中的,放在方法的上面，而不是類，意思是產生一個bean,並交給spring管理。

@AutoWired：自動導入依賴的bean。byType方式。把配置好的Bean拿來用，完成屬性、方法的組裝，它可以對類成員變數、方法及構造函數進行標註，完成自動裝配的工作。當加上（required=false）時，就算找不到bean也不報錯。

@Qualifier：當有多個同一類型的Bean時，可以用@Qualifier(「name」)來指定。與@Autowired配合使用。@Qualifier限定描述符除了能根據名字進行注入，但能進行更細粒度的控制如何選擇候選者，具體使用方式如下：

@Autowired  @Qualifier(value = 「demoInfoService」)  private DemoInfoService demoInfoService;

@Resource(name=」name」,type=」type」)：沒有括弧內內容的話，默認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表示可在多個資料庫間切換），指定sequence的名字是repair_seq。

@SequenceGeneretor(name = 「repair_seq」, sequenceName = 「seq_repair」, allocationSize = 1)：name為sequence的名稱，以便使用，sequenceName為資料庫的sequence名稱，兩個名稱可以一致。

@Transient：表示該屬性並非一個到資料庫表的欄位的映射,ORM框架將忽略該屬性。如果一個屬性並非資料庫表的欄位映射,就務必將其標示為@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中必須包含某些參數值是，才讓該方法處理。 headers:指定request中必須包含某些指定的header值，才能讓該方法處理請求。 value:指定請求的實際地址，指定的地址可以是URI Template 模式 method:指定請求的method類型， GET、POST、PUT、DELETE等 consumes:指定處理請求的提交內容類型（Content-Type），如application/json,text/html; produces:指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回

@RequestParam：用在方法的參數前面。 @RequestParam String a =request.getParameter(「a」)。

@PathVariable:路徑變數。如

RequestMapping(「user/get/mac/{macAddress}」)  public String getByMacAddress(@PathVariable String macAddress){  //do something;  }

參數與大括弧里的名字一樣要相同。

五、全局異常處理

@ControllerAdvice：包含@Component。可以被掃描到。統一處理異常。

@ExceptionHandler（Exception.class）：用在方法上面表示遇到這個異常就執行以下方法。