首頁  >  文章  >  Java  >  SpringBoot註解的知識點有哪些

SpringBoot註解的知識點有哪些

WBOY
WBOY轉載
2023-05-15 16:40:06862瀏覽

一、註解(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 三個配置。

import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication; 

@SpringBootApplication // same as 

o

#@EnableAutoConfiguration 

@ComponentScanpublic 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”)@ResponseBodypublic String test(){  return”ok”;}

@Controller:用於定義控制器類,在spring 專案中由控制器負責將用戶發送的URL請求轉送到對應的服務介面(service層),一般這個註解在類別中,通常方法需要配合註解@RequestMapping。範例程式碼:

@Controller@RequestMapping(“/demoInfo”)publicclass DemoController {  

@Autowired  private DemoInfoService demoInfoService;   

@RequestMapping("/hello")  hello(Map map){    System.out.println("DemoController.hello()");   

## map.put("hello","from TemplateController.helloHtml"# map.put("hello","from TemplateController.helloHtml"# map. ##);    

//會使用hello.html或hello.ftl範本進行渲染顯示.    

return"/hello";  

}

##return"/hello";  

}

}

@RestController:用於標註控制層元件(如struts中的action),@ResponseBody和@Controller的集合。範例程式碼:

import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController; @RestController@RequestMapping(“/demoInfo2”)publicclass DemoController#2 {   

#@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:用在方法的參數前面。 @RequestParamString a =request.getParameter(“a”)。

@PathVariable:路徑變數。如

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

#參數與括號裡的名字一樣要相同。

五、全域例外處理

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

@ExceptionHandler(Exception.class):用在方法上面表示遇到這個例外就執行以下方法。

以上是SpringBoot註解的知識點有哪些的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:yisu.com。如有侵權,請聯絡admin@php.cn刪除