Springboot 經常使用註解

@SpringBootApplication:

包含@Configuration、@EnableAutoConfiguration、@ComponentScan一般用在主類上。html

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

針對性的瞭解@SpringBootApplication註解能夠參考 點擊打開連接web

@Repository:

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

@Service:

用於標註業務層組件。json

@RestController:

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

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

 當你實現一個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文件的

@Slf4j

使用註解須要引入

<!--若是不想每次都寫private  final Logger logger = LoggerFactory.getLogger(XXX.class); 能夠用註解@Slf4j--><dependency>   <groupId>org.projectlombok</groupId>   <artifactId>lombok</artifactId></dependency>
相關文章
相關標籤/搜索