首頁 > 軟體

SpringBoot各種註解詳解

2022-12-27 14:00:43

一、註解列表

@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使用。

二、註解詳解

@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 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的合集。

範例程式碼:

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

到此這篇關於SpringBoot各種註解詳解的文章就介紹到這了,更多相關SpringBoot註解內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!


IT145.com E-mail:sddin#qq.com