SpringBoot中常見註解含義總結
@RestController
@RestController被稱為一個構造型(stereotype)註解。它為閱讀代碼的開發人員提供建議。對於Spring,該類扮演了一個特殊角色。它繼承自@Controller註解。4.0之前的版本,spring MVC的組件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性,我們可以開發REST服務的時候不需要使用@Controller而專門的@RestController。
@RequestMapping
註解提供路由信息。它告訴Spring任何來自"/"路徑的HTTP請求都應該被映射到home方法。@RestController註解告訴Spring以字符串的形式渲染結果,並直接返回給調用者。該註解有六個屬性:
params:指定request中必須包含某些參數值是,才讓該方法處理。
headers:指定request中必須包含某些指定的header值,才能讓該方法處理請求。
value:指定請求的實際地址,指定的地址可以是URI Template 模式
method:指定請求的method類型, GET、POST、PUT、DELETE等
consumes:指定處理請求的提交內容類型(Content-Type),如application/json,text/html
produces:指定返回的內容類型,僅當request請求頭中的(Accept)類型中包含該指定類型才返回
@GetMapping是一個組合註解,是@RequestMapping(method =RequestMethod.GET)的縮寫。該註解將HTTP Get 映射到 特定的處理方法上。
@PostMapping
@EnableAutoConfiguration
@EnableAutoConfiguration。這個註解告訴Spring Boot根據添加的jar依賴猜測你想如何配置Spring。由於spring-boot-starter-web添加了Tomcat和Spring MVC,所以auto-configuration將假定正在開發一個web應用並相應地對Spring進行設置。Starter POMs和Auto-Configuration設計auto-configuration的目的是更好的使用"Starter POMs",但這兩個概念沒有直接的聯系。可以自由地挑選starter POMs以外的jar依賴,並且Spring Boot將仍舊盡最大努力去自動配置你的應用
@Configuration
Spring Boot提倡基於Java的配置。盡管可以使用一個XML源來調用SpringApplication.run(),但官方建議使用@Configuration類作為主要源。一般定義main方法的類也是主要@Configuration的一個很好候選。不需要將所有的@Configuration放進一個單獨的類。@Import註解可以用來導入其他配置類。另外也可以使用@ComponentScan註解自動收集所有的Spring組件,包括@Configuration類。
如果需要使用基於XML的配置,官方建議仍舊從一個@Configuration類開始。可以使用附加的@ImportResource註解加載XML配置文件。
@Configuration註解該類,等價與XML中配置beans;用@Bean標註方法等價於XML中配置bean。
@ComponentScan
表示將該類自動發現掃描組件。如果掃描到有@Component、@Controller、@Service等這些註解的類,並註冊為Bean,可以自動收集所有的Spring組件,包括@Configuration類。使用@ComponentScan註解搜索beans,並結合@Autowired註解導入。可以自動收集所有的Spring組件,包括@Configuration類。如果沒有配置,Spring Boot會掃描啟動類所在包下以及子包下的使用了@Service,@Repository等註解的類。
@SpringBootApplication
@SpringBootApplication // 等同於@Configuration @EnableAutoConfiguration @ComponentScan
@Profiles
Spring Profiles提供了一種隔離應用程序配置的方式,並讓這些配置只能在特定的環境下生效。任何@Component或@Configuration都能被@Profile標記,從而限制加載它的時機。
@ControllerAdvice
包含@Component。可以被掃描到。統一處理異常。
@ExceptionHandler
用在方法上面表示遇到這個異常就執行以下方法。
/**
* 全局異常處理*/@ControllerAdvicepublic class GlobalDefaultExceptionHandler {public static final String DEFAULT_ERROR_VIEW = "error";@ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {ModelAndView mav = new ModelAndView();
mav.addObject("error","參數類型錯誤");mav.addObject("exception", e);
mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));
mav.addObject("timestamp", new Date());mav.setViewName(DEFAULT_ERROR_VIEW);return mav;
}}
@value
通過@value註解來讀取application.properties裏面的配置,使用實例參考:
/************** application.properties *************/
qq_api_key=********1***********qq_api_secrt=******2***********/************* Java **************/
@Value("${qq_api_key}")
private String API_KEY;
@Value("${qq_api_secrt}")
private String API_SECRET;
@ResponseBody
表示該方法的返回結果直接寫入HTTP response body中一般在異步獲取數據時使用,在使用@RequestMapping後,返回值通常解析為跳轉路徑,加上@Responsebody後返回結果不會被解析為跳轉路徑,而是直接寫入HTTP response body中。如異步獲取json數據,加上@Responsebody後,會直接返回json數據。
@Component
泛指組件,當組件不好歸類時,可以使用這個註解進行標註。一般公共的方法會用上這個註解
@RequestParam
用在方法的參數前面,實例:
@RequestParam String a=request.getParameter("a");
@PathVariable
路徑變量註解,其參數與大括號裏的名字一樣要保持一致,實例:
RequestMapping("yoodb/detail/{id}")
public String getByMacAddress(@PathVariable String id){
//do something;
}
@Inject
等價於默認的@Autowired,只是沒有required屬性。
@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中常見註解含義總結