SpringBoot注解詳解，建議收藏！
一、簡介
基于 SpringBoot 平臺開發的項目數不勝數，與常規的基于Spring開發的項目最大的不同之處，SpringBoot 里面提供了大量的注解用于快速開發，而且非常簡單，基本可以做到開箱即用!
那 SpringBoot 為開發者提供了多少注解呢?我們該如何使用?
針對此問題，小編特意對其進行了一番整理，內容如下，個人感覺還是比較清晰的，今天我們就一起來整一整每個注解的含義和用法，以免踩坑!
二、注解總結
2.1. SpringMVC 相關注解
- @Controller
通常用于修飾controller層的組件，由控制器負責將用戶發來的URL請求轉發到對應的服務接口，通常還需要配合注解@RequestMapping使用。
- @RequestMapping
提供路由信息，負責URL到Controller中具體函數的映射，當用于方法上時，可以指定請求協議，比如GET、POST、PUT、DELETE等等。
- @RequestBody
表示請求體的Content-Type必須為application/json格式的數據，接收到數據之后會自動將數據綁定到Java對象上去
- @ResponseBody
表示該方法的返回結果直接寫入HTTP response body中，返回數據的格式為application/json。
比如，請求參數為json格式，返回參數也為json格式，示例代碼如下：
/**
* 登錄服務
*/
@Controller
@RequestMapping("api")
public class LoginController {
/**
* 登錄請求，post請求協議，請求參數數據格式為json
* @param request
*/
@RequestMapping(value = "login", method = RequestMethod.POST)
@ResponseBody
public ResponseEntity login(@RequestBody UserLoginDTO request){
//...業務處理
return new ResponseEntity(HttpStatus.OK);
}
}
- @RestController
和@Controller一樣，用于標注控制層組件，不同的地方在于：它是@ResponseBody和@Controller的合集，也就是說，在當@RestController用在類上時，表示當前類里面所有對外暴露的接口方法，返回數據的格式都為application/json，示范代碼如下：
@RestController
@RequestMapping("api")
public class LoginController {
/**
* 登錄請求，post請求協議，請求參數數據格式為json
* @param request
*/
@RequestMapping(value = "login", method = RequestMethod.POST)
public ResponseEntity login(@RequestBody UserLoginDTO request){
//...業務處理
return new ResponseEntity(HttpStatus.OK);
}
}
- @RequestParam
用于接收請求參數為表單類型的數據，通常用在方法的參數前面，示范代碼如下：
/**
* 登錄請求，post請求協議，請求參數數據格式為表單
*/
@RequestMapping(value = "login", method = RequestMethod.POST)
@ResponseBody
public ResponseEntity login(@RequestParam(value = "userName",required = true) String userName,
@RequestParam(value = "userPwd",required = true) String userPwd){
//...業務處理
return new ResponseEntity(HttpStatus.OK);
}
- @PathVariable
用于獲取請求路徑中的參數，通常用于restful風格的api上，示范代碼如下：
/**
* restful風格的參數請求
* @param id
*/
@RequestMapping(value = "queryProduct/{id}", method = RequestMethod.POST)
@ResponseBody
public ResponseEntity queryProduct(@PathVariable("id") String id){
//...業務處理
return new ResponseEntity(HttpStatus.OK);
}
- @GetMapping
除了@RequestMapping可以指定請求方式之外，還有一些其他的注解，可以用于標注接口路徑請求，比如GetMapping用在方法上時，表示只支持get請求方法，等價于@RequestMapping(value="/get",method=RequestMethod.GET)。
@GetMapping("get")
public ResponseEntity get(){
return new ResponseEntity(HttpStatus.OK);
}
- @PostMapping
用在方法上，表示只支持post方式的請求。
@PostMapping("post")
public ResponseEntity post(){
return new ResponseEntity(HttpStatus.OK);
}
- @PutMapping
用在方法上，表示只支持put方式的請求，通常表示更新某些資源的意思。
@PutMapping("put")
public ResponseEntity put(){
return new ResponseEntity(HttpStatus.OK);
}
- @DeleteMapping
用在方法上，表示只支持delete方式的請求，通常表示刪除某些資源的意思。
@DeleteMapping("delete")
public ResponseEntity delete(){
return new ResponseEntity(HttpStatus.OK);
}
2.2. bean 相關注解
- @Service
通常用于修飾service層的組件，聲明一個對象，會將類對象實例化并注入到bean容器里面。
@Service
public class DeptService {
//具體的方法
}
- @Component
泛指組件，當組件不好歸類的時候，可以使用這個注解進行標注，功能類似于于@Service。
@Component
public class DeptService {
//具體的方法
}
- @Repository
通常用于修飾dao層的組件，@Repository注解屬于Spring里面最先引入的一批注解，它用于將數據訪問層 (DAO層 ) 的類標識為Spring Bean，具體只需將該注解標注在 DAO類上即可，示例代碼如下：
@Repository
public interface RoleRepository extends JpaRepository<Role,Long> {
//具體的方法
}
為什么現在使用的很少呢?
主要是因為當我們配置服務啟動自動掃描dao層包時，Spring會自動幫我們創建一個實現類，然后注入到bean容器里面。當某些類無法被掃描到時，我們可以顯式的在數據持久類上標注@Repository注解，Spring會自動幫我們聲明對象。
- @Bean
相當于 xml 中配置 Bean，意思是產生一個 bean 對象，并交給spring管理，示例代碼如下：
@Configuration
public class AppConfig {
//相當于 xml 中配置 Bean
@Bean
public Uploader initFileUploader() {
return new FileUploader();
}
}
- @Autowired
自動導入依賴的bean對象，默認時按照byType方式導入對象，而且導入的對象必須存在，當需要導入的對象并不存在時，我們可以通過配置required = false來關閉強制驗證。
@Autowired
private DeptService deptService;
- @Resource
也是自動導入依賴的bean對象，由JDK提供，默認是按照byName方式導入依賴的對象;而@Autowired默認時按照byType方式導入對象，當然@Resource還可以配置成通過byType方式導入對象。
/**
* 通過名稱導入（默認通過名稱導入依賴對象）
*/
@Resource(name = "deptService")
private DeptService deptService;
/**
* 通過類型導入
*/
@Resource(type = RoleRepository.class)
private DeptService deptService;
- @Qualifier
當有多個同一類型的bean時，使用@Autowired導入會報錯，提示當前對象并不是唯一，Spring不知道導入哪個依賴，這個時候，我們可以使用@Qualifier進行更細粒度的控制，選擇其中一個候選者，一般于@Autowired搭配使用，示例如下：
@Autowired
@Qualifier("deptService")
private DeptService deptService;
- @Scope
用于生命一個spring bean的作用域，作用的范圍一共有以下幾種：
- singleton：唯一 bean 實例，Spring 中的 bean 默認都是單例的。
- prototype：每次請求都會創建一個新的 bean 實例，對象多例。
- request：每一次 HTTP 請求都會產生一個新的 bean，該 bean 僅在當前 HTTP request 內有效。
- session：每一次 HTTP 請求都會產生一個新的 bean，該 bean 僅在當前 HTTP session 內有效。
/**
* 單例對象
*/
@RestController
@Scope("singleton")
public class HelloController {
}
2.3. JPA 相關注解
- @Entity和@Table
表明這是一個實體類，這兩個注解一般一塊使用，但是如果表名和實體類名相同的話，@Table可以省略。
- @Id
表示該屬性字段對應數據庫表中的主鍵字段。
- @Column
表示該屬性字段對應的數據庫表中的列名，如果字段名與列名相同，則可以省略。
- @GeneratedValue
表示主鍵的生成策略，有四個選項，分別如下：
- AUTO：表示由程序控制，是默認選項 ，不設置就是這個
- IDENTITY：表示由數據庫生成，采用數據庫自增長，Oracle 不支持這種方式
- SEQUENCE：表示通過數據庫的序列生成主鍵ID，MYSQL 不支持
- Table：表示由特定的數據庫產生主鍵，該方式有利于數據庫的移植
- @SequenceGeneretor
用來定義一個生成主鍵的序列，它需要與@GeneratedValue聯合使用才有效，以TB_ROLE表為例，對應的注解配置如下：
@Entity
@Table(name = "TB_ROLE")
@SequenceGenerator(name = "id_seq", sequenceName = "seq_repair",allocationSize = 1)
public class Role implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 主鍵ID，采用【id_seq】序列函數自增長
*/
@Id
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator = "id_seq")
private Long id;
/* 角色名稱
*/
@Column(nullable = false)
private String roleName;
/**
* 角色類型
*/
@Column(nullable = false)
private String roleType;
}
- @Transient
表示該屬性并非與數據庫表的字段進行映射，ORM 框架會將忽略該屬性。
/**
* 忽略該屬性
*/
@Column(nullable = false)
@Transient
private String lastTime;
- @Basic(fetch=FetchType.LAZY)
用在某些屬性上，可以實現懶加載的效果，也就是當用到這個字段的時候，才會裝載這個屬性，如果配置成fetch=FetchType.EAGER，表示即時加載，也是默認的加載方式!
/**
* 延遲加載該屬性
*/
@Column(nullable = false)
@Basic(fetch = FetchType.LAZY)
private String roleType;
- @JoinColumn
用于標注表與表之間關系的字段，通常與@OneToOne、@OneToMany搭配使用，例如如下：
@Entity
@Table(name = "tb_login_log")
public class LoginLog implements Serializable {
/**
* 查詢登錄的用戶信息
*/
@OneToOne
@JoinColumn(name = "user_id")
private User user;
//...get、set
}
- @OneToOne、@OneToMany和@ManyToOne
這三個注解，相當于hibernate配置文件中的一對一，一對多，多對一配置，比如下面的客戶地址表，通過客戶 ID，實現客戶信息的查詢。
@Entity
@Table(name="address")
public class AddressEO implements java.io.Serializable {
@ManyToOne(cascade = { CascadeType.ALL })
@JoinColumn(name="customer_id")
private CustomerEO customer;
//...get、set
}
2.4. 配置相關注解
- @Configuration
表示聲明一個 Java 形式的配置類，Spring Boot 提倡基于 Java 的配置，相當于你之前在 xml 中配置 bean，比如聲明一個配置類AppConfig，然后初始化一個Uploader對象。
@Configuration
public class AppConfig {
@Bean
public Uploader initOSSUploader() {
return new OSSUploader();
}
}
- @EnableAutoConfiguration
@EnableAutoConfiguration可以幫助SpringBoot應用將所有符合條件的@Configuration配置類，全部都加載到當前SpringBoot里，并創建對應配置類的Bean，并把該Bean實體交給IoC容器進行管理。
某些場景下，如果我們想要避開某些配置類的掃描(包括避開一些第三方jar包下面的配置，可以這樣處理。
@Configuration
@EnableAutoConfiguration(exclude = { org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration.class})
public class AppConfig {
//具有業務方法
}
- @ComponentScan
標注哪些路徑下的類需要被Spring掃描，用于自動發現和裝配一些Bean對象，默認配置是掃描當前文件夾下和子目錄下的所有類，如果我們想指定掃描某些包路徑，可以這樣處理。
@ComponentScan(basePackages = {"com.xxx.a", "com.xxx.b", "com.xxx.c"})
- @SpringBootApplication
等價于使用@Configuration、@EnableAutoConfiguration、@ComponentScan這三個注解，通常用于全局啟動類上，示例如下：
@SpringBootApplication
public class PropertyApplication {
public static void main(String[] args) {
SpringApplication.run(PropertyApplication.class, args);
}
}
把@SpringBootApplication換成@Configuration、@EnableAutoConfiguration、@ComponentScan這三個注解，一樣可以啟動成功，@SpringBootApplication只是將這三個注解進行了簡化!
- @EnableTransactionManagement
表示開啟事務支持，等同于 xml 配置方式的：
@SpringBootApplication
@EnableTransactionManagement`
public class PropertyApplication {
public static void main(String[] args) {
SpringApplication.run(PropertyApplication.class, args);
}
}
- @Conditional
從 Spring4 開始，可以通過@Conditional注解實現按條件裝載bean對象，目前 Spring Boot 源碼中大量擴展了@Condition注解，用于實現智能的自動化配置，滿足各種使用場景。下面我給大家列舉幾個常用的注解：
- @ConditionalOnBean：當某個特定的Bean存在時，配置生效
- @ConditionalOnMissingBean：當某個特定的Bean不存在時，配置生效
- @ConditionalOnClass：當Classpath里存在指定的類，配置生效
- @ConditionalOnMissingClass：當Classpath里不存在指定的類，配置生效
- @ConditionalOnExpression：當給定的SpEL表達式計算結果為true，配置生效
- @ConditionalOnProperty：當指定的配置屬性有一個明確的值并匹配，配置生效
具體的應用案例如下：
@Configuration
public class ConditionalConfig {
/**
* 當AppConfig對象存在時，創建一個A對象
* @return
*/
@ConditionalOnBean(AppConfig.class)
@Bean
public A createA(){
return new A();
}
/**
* 當AppConfig對象不存在時，創建一個B對象
* @return
*/
@ConditionalOnMissingBean(AppConfig.class)
@Bean
public B createB(){
return new B();
}
/**
* 當KafkaTemplate類存在時，創建一個C對象
* @return
*/
@ConditionalOnClass(KafkaTemplate.class)
@Bean
public C createC(){
return new C();
}
/**
* 當KafkaTemplate類不存在時，創建一個D對象
* @return
*/
@ConditionalOnMissingClass(KafkaTemplate.class)
@Bean
public D createD(){
return new D();
}
/**
* 當enableConfig的配置為true，創建一個E對象
* @return
*/
@ConditionalOnExpression("${enableConfig:false}")
@Bean
public E createE(){
return new E();
}
/**
* 當filter.loginFilter的配置為true，創建一個F對象
* @return
*/
@ConditionalOnProperty(prefix = "filter",name = "loginFilter",havingValue = "true")
@Bean
public F createF(){
return new F();
}
}
- @value
可以在任意 Spring 管理的 Bean 中通過這個注解獲取任何來源配置的屬性值，比如你在application.properties文件里，定義了一個參數變量!
config.name=zhangsan
在任意的bean容器里面，可以通過@Value注解注入參數，獲取參數變量值。
@RestController
public class HelloController {
@Value("${config.name}")
private String config;
@GetMapping("config")
public String config(){
return JSON.toJSONString(config);
}
}
- @ConfigurationProperties
上面@Value在每個類中獲取屬性配置值的做法，其實是不推薦的。
一般在企業項目開發中，不會使用那么雜亂無章的寫法而且維護也麻煩，通常會一次性讀取一個 Java 配置類，然后在需要使用的地方直接引用這個類就可以多次訪問了，方便維護，示例如下：
首先，在application.properties文件里定義好參數變量。
config.name=demo_1
config.value=demo_value_1
然后，創建一個 Java 配置類，將參數變量注入即可!
@Component
@ConfigurationProperties(prefix = "config")
public class Config {
public String name;
public String value;
//...get、set
}
最后，在需要使用的地方，通過ioc注入Config對象即可!
- @PropertySource
這個注解是用來讀取我們自定義的配置文件的，比如導入test.properties和bussiness.properties兩個配置文件，用法如下：
@SpringBootApplication
@PropertySource(value = {"test.properties","bussiness.properties"})
public class PropertyApplication {
public static void main(String[] args) {
SpringApplication.run(PropertyApplication.class, args);
}
}
- @ImportResource
用來加載 xml 配置文件，比如導入自定義的aaa.xml文件，用法如下：
@ImportResource(locations = "classpath:aaa.xml")
@SpringBootApplication
public class PropertyApplication {
public static void main(String[] args) {
SpringApplication.run(PropertyApplication.class, args);
}
}
2.5. 異常處理相關注解
- @ControllerAdvice和@ExceptionHandler
通常組合使用，用于處理全局異常，示例代碼如下：
@ControllerAdvice
@Configuration
@Slf4j
public class GlobalExceptionConfig {
private static final Integer GLOBAL_ERROR_CODE = 500;
@ExceptionHandler(value = Exception.class)
@ResponseBody
public void exceptionHandler(HttpServletRequest request, HttpServletResponse response, Exception e) throws Exception {
log.error("【統一異常處理器】", e);
ResultMsg<Object> resultMsg = new ResultMsg<>();
resultMsg.setCode(GLOBAL_ERROR_CODE);
if (e instanceof CommonException) {
CommonException ex = (CommonException) e;
if(ex.getErrCode() != 0) {
resultMsg.setCode(ex.getErrCode());
}
resultMsg.setMsg(ex.getErrMsg());
}else {
resultMsg.setMsg(CommonErrorMsg.SYSTEM_ERROR.getMessage());
}
WebUtil.buildPrintWriter(response, resultMsg);
}
}
2.6. 測試相關注解
- @ActiveProfiles
一般作用于測試類上， 用于聲明生效的 Spring 配置文件，比如指定application-dev.properties配置文件。
- @RunWith和@SpringBootTest
一般作用于測試類上， 用于單元測試用，示例如下：
@ActiveProfiles("dev")
@RunWith(SpringRunner.class)
@SpringBootTest
public class TestJunit {
@Test
public void executeTask() {
//測試...
}
}
三、小結
整個篇幅內容比較多，比較干，大家在看的過程中，也沒有必要去記住，可以先收藏起來，等到需要用到的時候，再把它拿出來看看!
