超級全面的 SpringBoot 註解介紹,每一個用途都應該清晰
一、註解(annotations)列表
1、@SpringBootApplication
包含了@ComponentScan
、@Configuration
和@EnableAutoConfiguration
註解。
其中@ComponentScan
讓Spring Boot
掃描到Configuration
類並把它加入到程式上下文。
2、@ComponentScan
元件掃描,可自動發現和裝配一些Bean
。
3、@Configuration
等同於Spring
的XML
配置檔案;使用Java
程式碼可以檢查型別安全。
4、@EnableAutoConfiguration
自動配置
5、@RestController
該註解是@Controller
和@ResponseBody
的合集,表示這是個控制器Bean
,並且是將函式的返回值直接填入HTTP
響應體中,是REST
風格的控制器。
6、@Autowired
自動匯入。
7、@PathVariable
獲取引數。
8、@JsonBackReference
解決巢狀外鏈問題。
9、@RepositoryRestResourcepublic
配合spring-boot-starter-data-rest使用。
二、註解(annotations)詳解
1、@SpringBootApplication
:申明讓Spring Boot
自動給程式進行必要的配置,這個配置等同於:@Configuration
@EnableAutoConfiguration
和@ComponentScan
三個配置。
import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan public class Application { public static voidmain(String[] args) { SpringApplication.run(Application.class, args); } }
2、@ResponseBody
:表示該方法的返回結果直接寫入HTTP Response Body
中,一般在非同步獲取資料時使用,用於構建RESTful
的api
。
在使用@RequestMapping
後,返回值通常解析為跳轉路徑,加上@ResponseBody
後返回結果不會被解析為跳轉路徑,而是直接寫入HTTP Response Body
中。
比如非同步獲取json
資料,加上@ResponseBody
後,會直接返回json
資料。
該註解一般會配合@RequestMapping
一起使用。
示例程式碼:
@RequestMapping(“/test”) @ResponseBody public String test(){ return ”ok”; }
3、@Controller
:用於定義控制器類,在spring
專案中由控制器負責將使用者發來的URL
請求轉發到對應的服務介面(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"; } }
4、@RestController
:用於標註控制層元件(如struts
中的action
),@ResponseBody
和@Controller
的合集。
示例程式碼:
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"; } }
5、@RequestMapping
:提供路由資訊,負責URL
到Controller
中的具體函式的對映。
6、@EnableAutoConfiguration
:Spring Boot
自動配置(auto-configuration
):嘗試根據你新增的jar
依賴自動配置你的Spring
應用。
例如,如果你的classpath
下存在HSQLDB,並且你沒有手動配置任何資料庫連線beans
,那麼我們將自動配置一個記憶體型(in-memory
)資料庫”。
你可以將@EnableAutoConfiguration
或者@SpringBootApplication
註解新增到一個@Configuration
類上來選擇自動配置。
如果發現應用了你不想要的特定自動配置類,你可以使用@EnableAutoConfiguration
註解的排除屬性來禁用它們。
搜尋Java知音公眾號,回覆“後端面試”,送你一份Java面試題寶典.pdf
7、@ComponentScan
:表示將該類自動發現掃描元件。
個人理解相當於,如果掃描到有@Component
、@Controller
、@Service
等這些註解的類,並註冊為Bean
,可以自動收集所有的Spring
元件,包括@Configuration
類。
我們經常使用@ComponentScan
註解搜尋beans
,並結合@Autowired
註解匯入。可以自動收集所有的Spring
元件,包括@Configuration
類。
如果沒有配置的話,Spring Boot
會掃描啟動類所在包下以及子包下的使用了@Service
、@Repository
等註解的類。
8、@Configuration
:相當於傳統的xml
配置檔案,如果有些第三方庫需要用到xml
檔案,建議仍然通過@Configuration
類作為專案的配置主類——可以使用@ImportResource
註解載入xml
配置檔案。
9、@Import
:用來匯入其他配置類。
10、@ImportResource
:用來載入xml
配置檔案。
11、@Autowired
:自動匯入依賴的bean
12、@Service
:一般用於修飾service
層的元件
13、@Repository
:使用@Repository
註解可以確保DAO
或者repositories
提供異常轉譯,這個註解修飾的DAO
或者repositories
類會被ComponetScan
發現並配置,同時也不需要為它們提供XML
配置項。
14、@Bean
:用@Bean
標註方法等價於XML
中配置的bean
。
15、@Value
:注入Spring boot
application.properties
配置的屬性的值。示例程式碼:
@Value(value = “#{message}”) private String message;
16、@Inject
:等價於預設的@Autowired
,只是沒有required
屬性;
17、@Component
:泛指元件,當元件不好歸類的時候,我們可以使用這個註解進行標註。
18、@Bean
:相當於XML
中的,放在方法的上面,而不是類,意思是產生一個bean
,並交給spring
管理。
19、@AutoWired
:自動匯入依賴的bean
。byType
方式。把配置好的Bean
拿來用,完成屬性、方法的組裝,它可以對類成員變數、方法及建構函式進行標註,完成自動裝配的工作。當加上(required=false
)時,就算找不到bean
也不報錯。
20、@Qualifier
:當有多個同一型別的Bean
時,可以用@Qualifier(“name”)
來指定。與@Autowired
配合使用。@Qualifier
限定描述符除了能根據名字進行注入,但能進行更細粒度的控制如何選擇候選者,具體使用方式如下:
@Autowired @Qualifier(value = “demoInfoService”) private DemoInfoService demoInfoService;
21、@Resource(name=”name”,type=”type”)
:沒有括號內內容的話,預設byName
。與@Autowired
幹類似的事。
三、JPA註解
1、@Entity
:@Table(name=”“)
:表明這是一個實體類。一般用於jpa
這兩個註解一般一塊使用,但是如果表名和實體類名相同的話,@Table
可以省略。
2、@MappedSuperClass
:用在確定是父類的entity
上。父類的屬性子類可以繼承。
3、@NoRepositoryBean
:一般用作父類的repository
,有這個註解,Spring
不會去例項化該repository
。
4、@Column
:如果欄位名與列名相同,則可以省略。
5、@Id
:表示該屬性為主鍵。
6、@GeneratedValue(strategy=GenerationType.SEQUENCE,generator= “repair_seq”)
:表示主鍵生成策略是sequence
(可以為Auto
、IDENTITY
、native
等,Auto
表示可在多個數據庫間切換),指定sequence
的名字是repair_seq
。
7、@SequenceGeneretor(name = “repair_seq”, sequenceName = “seq_repair”, allocationSize = 1)
:name
為sequence
的名稱,以便使用,sequenceName
為資料庫的sequence
名稱,兩個名稱可以一致。
8、@Transient
:表示該屬性並非一個到資料庫表的欄位的對映,ORM
框架將忽略該屬性。
如果一個屬性並非資料庫表的欄位對映,就務必將其標示為@Transient
,否則,ORM
框架預設其註解為@Basic
。
9、@Basic(fetch=FetchType.LAZY)
:標記可以指定實體屬性的載入方式。
10、@JsonIgnore
:作用是json
序列化時將Java bean
中的一些屬性忽略掉,序列化和反序列化都受影響。
11、@JoinColumn(name=”loginId”)
:一對一:本表中指向另一個表的外來鍵。一對多:另一個表指向本表的外來鍵。
12、@OneToOne、@OneToMany、@ManyToOne
:對應hibernate
配置檔案中的一對一,一對多,多對一。
四、SpringMVC相關注解
1、@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
)型別中包含該指定型別才返回。
2、@RequestParam
:用在方法的引數前面。
3、@PathVariable
:路徑變數。如:
RequestMapping(“user/get/{macAddress}”) public String getByMacAddress(@PathVariable String macAddress){ //do something; }
五、全域性異常處理
@ControllerAdvice
:包含@Component
。可以被掃描到。統一處理異常。
@ExceptionHandler(Exception.class)
:用在方法上面表示遇到這個異常就執行以下方法。