SpringBoot常用註解

一、註解(annotations)列表 

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

@Controller用於標註控制層組件,@Service用於標註業務層組件,@Repository用於標註數據訪問組件,即DAO組件,而@Component泛指組件,當組件不好歸類的時候,我們可以使用這個註解進行標註。

在一個稍大的項目中,通常會有上百個組件,如果這些組件採用xml的bean定義來配置,顯然會增加配置文件的體積,查找以及維護起來也不太方便。 Spring2.5爲我們引入了組件自動掃描機制,他可以在類路徑底下尋找標註了@Component,@Service,@Controller,@Repository註解的類,並把這些類納入進spring容器中管理。它的作用和在xml文件中使用bean節點配置組件時一樣的。

@Autowired自動導入。

@PathVariable獲取參數。

@JsonBackReference解決嵌套外鏈問題。

@RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。

二、註解(annotations)詳解

1.Application類

@SpringBootApplication:申明讓spring boot自動給程序進行必要的配置,這個配置等同於:@Configuration ,@EnableAutoConfiguration 和 @ComponentScan 三個配置。

(1)@Configuration是Spring框架提供的一個註解,它能替代傳統的xml配置文件,將Spring框架中的xml文件以Java類的形式替代,去XML是SpringBoot的一個重要思想;

(2)@EnableAutoConfiguration是SpringBoot提供的一個註解,它的作用是啓動SpringBoot的自動配置機制;

(3)@ComponentScan是Spring框架提供的一個註解,它能掃描項目中所有的組件(@Component, @Service, @Repository, @Controller等進行標註的類)並將其註冊到Spring容器;

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); 
    } 
}

 

 

2.Configuration類

@Configuration:相當於傳統的xml配置文件,如果有些第三方庫需要用到xml文件,建議仍然通過@Configuration類作爲項目的配置主類

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

@Bean:用@Bean標註方法等價於XML中配置的bean,意思是產生一個bean,並交給spring管理。@Bean是一個方法級別上的註解,主要用在@Configuration註解的類裏,也可以用在@Component註解的類裏。添加的bean的id爲方法名。你能夠使用@Scope註解來指定使用@Bean定義的bean。

@Configuration
public class AppConfig {

    @Bean
    public TransferService transferService() {
        return new TransferServiceImpl();
    }

}

 

3.Component類

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

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

 

4.Controller類

@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中的具體函數的映射。

@ResponseBody:表示該方法的返回結果直接寫入HTTP response body中,一般在異步獲取數據時使用,用於構建RESTful的api。在使用 @RequestMapping後,返回值通常解析爲跳轉路徑,加上@responsebody後返回結果不會被解析爲跳轉路徑,而是直接寫入HTTP response body中。比如異步獲取json數據,加上@responsebody後,會直接返回json數據。該註解一般會配合@RequestMapping一起使用。示例代碼:

@RequestMapping(“/test”) 
@ResponseBody 
public String test(){ 
return”ok”; 
}

 

5.Service類

@Service:在SpringBoot中一般用於修飾service層的組件

@Service是標記實現類上的。因爲@Service是把spring容器中的bean進行實例化,也就是等同於new操作,只有實現類是可以進行new實例化的,而接口則不能,所以是加在實現類上的。

相當於 xml配置中得bean  id = service ,也可以不指定,不指定相當於 bean id =  com. service.service 就是這個類的全限定名,@Service("myMath")表示給當前類命名一個別名,方便注入到其他需要用到的類中;不加的話,默認別名就是當前類名,但是首字母小寫。

getBean的默認名稱是類名(頭字母小寫),如果想自定義,可以@Service(“aaaaa”)這樣來指定,這種bean默認是單例的,如果想改變,可以使用@Service(“beanName”)@Scope(“prototype”)來改變。

 

6.Repository類

@Repository:在SpringBoot中用於標註數據訪問組件,使用@Repository註解可以確保DAO或者repositories提供異常轉譯,這個註解修飾的DAO或者repositories類會被ComponetScan發現並配置,同時也不需要爲它們提供XML配置項。

 

7.Autowired類

@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幹類似的事。

@Inject:等價於默認的@Autowired,只是沒有required屬性;

 

Spring中@Autowired註解、@Resource註解,@Inject註解的區別

Spring不但支持自己定義的@Autowired註解,還支持幾個由JSR-250規範定義的註解,它們分別是@Resource、@PostConstruct以及@PreDestroy。

@Resource的作用相當於@Autowired,只不過@Autowired按byType自動注入,而@Resource默認按 byName自動注入罷了。@Resource有兩個屬性是比較重要的,分是name和type,Spring將@Resource註解的name屬性解析爲bean的名字,而type屬性則解析爲bean的類型。所以如果使用name屬性,則使用byName的自動注入策略,而使用type屬性時則使用byType自動注入策略。如果既不指定name也不指定type屬性,這時將通過反射機制使用byName自動注入策略。

 

1、@Autowired是spring自帶的,@Inject是JSR330規範實現的,@Resource是JSR250規範實現的,需要導入不同的包

2、@Autowired、@Inject用法基本一樣,不同的是@Autowired有一個request屬性

3、@Autowired、@Inject是默認按照類型匹配的,@Resource是按照名稱匹配的

4、@Autowired如果需要按照名稱匹配需要和@Qualifier一起使用,@Inject和@Name一起使用

 

 

8.Value類

@Value:注入Spring boot application.properties配置的屬性的值。示例代碼:

@Value(value = “#{message}”) private String message;

 

9.Import類

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

@ImportResource:用來加載xml配置文件。

 

三、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):用在方法上面表示遇到這個異常就執行以下方法。

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章