附:Spring Boot 官方文檔學習(一)入門及使用 見http://www.rzrgm.cn/larryzeal/p/5799195.html
@RestController和@RequestMapping注解
4.0重要的一個新的改進是@RestController注解,它繼承自@Controller注解。4.0之前的版本,Spring MVC的組件都使用@Controller來標識當前類是一個控制器servlet。使用這個特性,我們可以開發REST服務的時候不需要使用@Controller而專門的@RestController。
當你實現一個RESTful web services的時候,response將一直通過response body發送。為了簡化開發,Spring 4.0提供了一個專門版本的controller。下面我們來看看@RestController實現的定義:
- @Target(value=TYPE)
- @Retention(value=RUNTIME)
- @Documented
- @Controller
- @ResponseBody
- public @interface RestController
@RequestMapping 注解提供路由信息。它告訴Spring任何來自"/"路徑的HTTP請求都應該被映射到 home 方法。 @RestController 注解告訴Spring以字符串的形式渲染結果,并直接返回給調用者。
注: @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 注解的排除屬性來禁用它們。
- <pre name="code" class="java">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.hyxt",includeFilters = {@ComponentScan.Filter(Aspect.class)})
@SpringBootApplication
很多Spring Boot開發者總是使用 @Configuration , @EnableAutoConfiguration 和 @ComponentScan 注解他們的main類。由于這些注解被如此頻繁地一塊使用(特別是你遵循以上最佳實踐時),Spring Boot提供一個方便的 @SpringBootApplication 選擇。
該 @SpringBootApplication 注解等價于以默認屬性使用 @Configuration , @EnableAutoConfiguration 和 @ComponentScan 。
- package com.example.myproject;
- 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);
- }
- }
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 {
- // ...
- }
表示該方法的返回結果直接寫入HTTP response body中
一般在異步獲取數據時使用,在使用@RequestMapping后,返回值通常解析為跳轉路徑,加上
@responsebody后返回結果不會被解析為跳轉路徑,而是直接寫入HTTP response body中。比如
異步獲取json數據,加上@responsebody后,會直接返回json數據。
造函數進行標注,完成自動裝配的工作。
當加上(required=false)時,就算找不到bean也不報錯。
用在方法的參數前面。
- @RequestParam String a =request.getParameter("a")。
@PathVariable:
路徑變量。
- RequestMapping("user/get/mac/{macAddress}")
- public String getByMacAddress(@PathVariable String macAddress){
- //do something;
- }
- /**
- * 用戶進行評論及對評論進行管理的 Controller 類;
- */
- @Controller
- @RequestMapping("/msgCenter")
- public class MyCommentController extends BaseController {
- @Autowired
- CommentService commentService;
- @Autowired
- OperatorService operatorService;
- /**
- * 添加活動評論;
- *
- * @param applyId 活動 ID;
- * @param content 評論內容;
- * @return
- */
- @ResponseBody
- @RequestMapping("/addComment")
- public Map<String, Object> addComment(@RequestParam("applyId") Integer applyId, @RequestParam("content") String content) {
- ....
- return result;
- }
- }
- @RequestMapping("/list/{applyId}")
- public String list(@PathVariable Long applyId, HttpServletRequest request, ModelMap modelMap) {
- }
統一處理異常。
@ExceptionHandler(Exception.class):
用在方法上面表示遇到這個異常就執行以下方法。
- /**
- * 全局異常處理
- */
- @ControllerAdvice
- 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里面的配置
- # face++ key
- face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****
- face_api_secret =D9WUQGCYLvOCIdsbX35uTH********
- @Value("${face_api_key}")
- private String API_KEY;
- @Value("${face_api_secret}")
- private String API_SECRET;
注意使用這個注解的時候 使用@Value的類如果被其他類作為對象引用,必須要使用注入的方式,而不能new。這個很重要,我就是被這個坑了
所以一般常用的配置都是配置在application.properties文件的