@RestController和@RequestMappinghtml
@RestController
被稱爲一個構造型(stereotype
)註解。它爲閱讀代碼的開發人員提供建議。對於Spring,該類扮演了一個特殊角色。它繼承自@Controller註解。4.0以前的版本,spring MVC的組件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性,咱們能夠開發REST服務的時候不須要使用@Controller而專門的@RestController
。java
實例:在本實例中,Example
的類是一個web @Controller
,因此當處理進來的web
請求時,Spring
會詢問它。web
import org.springframework.boot.*; import org.springframework.boot.autoconfigure.*; import org.springframework.stereotype.*; import org.springframework.web.bind.annotation.*; @RestController @EnableAutoConfiguration public class Example { @RequestMapping("/") String home() { return "Hello World!"; } public static void main(String[] args) throws Exception { SpringApplication.run(Example.class, args); } }
@RequestMapping:註解提供路由信息。它告訴Spring任何來自"/"路徑的HTTP請求都應該被映射到home方法。@RestController
註解告訴Spring以字符串的形式渲染結果,並直接返回給調用者。該註解有六個屬性: spring
params:指定request中必須包含某些參數值是,才讓該方法處理。json
headers:指定request中必須包含某些指定的header值,才能讓該方法處理請求。api
value:指定請求的實際地址,指定的地址能夠是URI Template 模式app
method:指定請求的method類型, GET、POST、PUT、DELETE等異步
consumes:指定處理請求的提交內容類型(Content-Type
),如application/json
,text/html
函數
produces:指定返回的內容類型,僅當request
請求頭中的(Accept
)類型中包含該指定類型才返回spring-boot
實例:
@RequestMapping(「/test」) @ResponseBody public String test(){ return」ok」; }
注意:@RestController
和@RequestMapping註解是Spring MVC註解(它們不是Spring Boot
的特定部分)
@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
將仍舊盡最大努力去自動配置你的應用。
你能夠經過將@EnableAutoConfiguration
或@SpringBootApplication
註解添加到一個@Configuration
類上來選擇自動配置。
注意:只須要添加一個@EnableAutoConfiguration
註解。建議將它添加到主@Configuration
類上,若是發現應用不想要的特定自動配置類,可使用@EnableAutoConfiguration註解的排除屬性來禁用它們。
import org.springframework.boot.autoconfigure.*; import org.springframework.boot.autoconfigure.jdbc.*; import org.springframework.context.annotation.*; @Configuration @EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class}) public class MyConfiguration { // ... }
@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(basePackages = "com.yoodb.blog",includeFilters = {@ComponentScan.Filter(Aspect.class)})
@ComponentScan:表示將該類自動發現掃描組件。若是掃描到有@Component、@Controller、@Service等這些註解的類,並註冊爲Bean,能夠自動收集全部的Spring組件,包括@Configuration類。使用@ComponentScan註解搜索beans,並結合@Autowired註解導入。能夠自動收集全部的Spring組件,包括@Configuration類。若是沒有配置,Spring Boot
會掃描啓動類所在包下以及子包下的使用了@Service,@Repository等註解的類。
@SpringBootApplication
不少Spring Boot
開發者老是使用@Configuration,@EnableAutoConfiguration和@ComponentScan註解他們的main類。因爲這些註解被如此頻繁地一塊使用(特別是你遵循以上最佳實踐時),Spring Boot
提供一個方便的@SpringBootApplication選擇。該@SpringBootApplication註解等價於以默認屬性使用@Configuration,@EnableAutoConfiguration和@ComponentScan。
import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication // 等同於@Configuration @EnableAutoConfiguration @ComponentScan public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }
Spring Boot
將嘗試校驗外部的配置,默認使用JSR-303(若是在classpath路徑中)。能夠輕鬆的爲@ConfigurationProperties類添加JSR-303 javax.validation約束註解:
@Component @ConfigurationProperties(prefix="connection") public class ConnectionSettings { @NotNull private InetAddress remoteAddress; // ... getters and setters }
@Profiles
Spring Profiles提供了一種隔離應用程序配置的方式,並讓這些配置只能在特定的環境下生效。任何@Component或@Configuration都能被@Profile標記,從而限制加載它的時機。
@Configuration @Profile("production") public class ProductionConfiguration { // ... }
全局異常處理
@ControllerAdvice:包含@Component。能夠被掃描到。統一處理異常。
@ExceptionHandler(Exception.class):用在方法上面表示遇到這個異常就執行如下方法。
/** * 全局異常處理 */ @ControllerAdvice public 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註解來讀取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;
注意:
使用@Value註解的時其使用的類若是被其餘類做爲對象引用,必需要使用注入的方式而不能new,通常經常使用的配置在application.properties文件。
其餘註解
@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相似。