1. 程式人生 > >Springboot 常用註解

Springboot 常用註解

RF head rest服務 請求 false val bean api time

@SpringBootApplication:

包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主類上。

很多SpringBoot開發者總是使用@Configuration,@EnableAutoConfiguration和 @ComponentScan註解他們的main類。由於這些註解被如此頻繁地一塊使用,SpringBoot提供一個方便的@SpringBootApplication選擇。該@SpringBootApplication註解等價於以默認屬性使用@Configuration, @EnableAutoConfiguration和 @ComponentScan。

針對性的了解@SpringBootApplication註解可以參考 點擊打開鏈接

@Repository:

用於標註數據訪問組件,即DAO組件。

@Service:

用於標註業務層組件。

@RestController:

用於標註控制層組件(如struts中的action),包含@Controller和@ResponseBody。

4.0重要的一個新的改進是@RestController註解,它繼承自@Controller註解。4.0之前的版本,spring MVC的組件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性,我們可以開發REST服務的時候不需要使用@Controller而專門的@RestController。

當你實現一個RESTful webservices的時候,response將一直通過response body發送。為了簡化開發,Spring 4.0提供了一個專門版本的controller。

@RequestMapping 註解提供路由信息。它告訴Spring任何來自"/"路徑的HTTP請求都應該被映射到 home 方法。 @RestController註解告訴Spring以字符串的形式渲染結果,並直接返回給調用者。

@ResponseBody:

表示該方法的返回結果直接寫入HTTP response body中
一般在異步獲取數據時使用,在使用@RequestMapping後,返回值通常解析為跳轉路徑,加上@responsebody後返回結果不會被解析為跳轉路徑,而是直接寫入HTTP response body中。比如異步獲取json數據,加上@responsebody後,會直接返回json數據。

@Component:

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

@ComponentScan:

組件掃描。個人理解相當於<context:component-scan>,如果掃描到有@Component @Controller @Service等這些註解的類,則把這些類註冊為bean。

@Configuration:

指出該類是 Bean配置的信息源,相當於XML中的<beans></beans>,一般加在主類上。

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(basePackages= "com.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)})

@Bean:

相當於XML中的<bean></bean>,放在方法的上面,而不是類,意思是產生一個bean,並交給spring管理。

@EnableAutoConfiguration:

讓 Spring Boot根據應用所聲明的依賴來對 Spring框架進行自動配置,一般加在主類上。

這個註解告訴Spring Boot根據添加的jar依賴猜測你想如何配置Spring。由於 spring-boot-starter-web 添加了Tomcat和Spring MVC,所以auto-configuration將假定你正在開發一個web應用並相應地對Spring進行設置。Starter POMs和Auto-Configuration:設計auto-configuration的目的是更好的使用"StarterPOMs",但這兩個概念沒有直接的聯系。你可以自由地挑選starter POMs以外的jar依賴,並且Spring Boot將仍舊盡最大努力去自動配置你的應用。

你可以通過將@EnableAutoConfiguration或@SpringBootApplication註解添加到一個 @Configuration類上來選擇自動配置。
註:你只需要添加一個 @EnableAutoConfiguration註解。我們建議你將它添加到主 @Configuration類上。

如果發現應用了你不想要的特定自動配置類,你可以使用 @EnableAutoConfiguration註解的排除屬性來禁用它們。

@AutoWired:

byType方式。把配置好的Bean拿來用,完成屬性、方法的組裝,它可以對類成員變量、方法及構造函數進行標註,完成自動裝配的工作。當加上(required=false)時,就算找不到bean也不報錯。

@Qualifier:

當有多個同一類型的Bean時,可以用@Qualifier("name")來指定。與@Autowired配合使用

@Resource(name="name",type="type"):

沒有括號內內容的話,默認byName。與@Autowired幹類似的事。

@RequestMapping:

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 Stringa=request.getParameter("a")。

@PathVariable:

路徑變量。參數與大括號裏的名字一樣要相同。

RequestMapping("user/get/mac/{macAddress}")

public String getByMacAddress(@PathVariable StringmacAddress){

  //do something;

}

@Profiles

Spring Profiles提供了一種隔離應用程序配置的方式,並讓這些配置只能在特定的環境下生效。

任何@Component或@Configuration都能被@Profile標記,從而限制加載它的時機。

@Configuration

@Profile("prod")

publicclass ProductionConfiguration {

// ...

}

@ConfigurationProperties

Spring Boot將嘗試校驗外部的配置,默認使用JSR-303(如果在classpath路徑中)。
你可以輕松的為你的@ConfigurationProperties類添加JSR-303javax.validation約束註解:

全局異常處理

@ControllerAdvice:

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

@ExceptionHandler(Exception.class):

用在方法上面表示遇到這個異常就執行以下方法。

@ControllerAdvice:

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

@ExceptionHandler(Exception.class):

用在方法上面表示遇到這個異常就執行以下方法。

/**

*全局異常處理

*/

@ControllerAdvice

classGlobalDefaultExceptionHandler {

public static final StringDEFAULT_ERROR_VIEW = "error";

@ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})

publicModelAndView 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",newDate());

mav.setViewName(DEFAULT_ERROR_VIEW);

returnmav;

}}

通過@value註解來讀取application.properties裏面的配置

# face++ key

face_api_key =R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****

face_api_secret=D9WUQGCYLvOCIdsbX35uTH********

@Value("${face_api_key}")

privateString API_KEY;

@Value("${face_api_secret}")

privateString API_SECRET;

所以一般常用的配置都是配置在application.properties文件的

Springboot 常用註解