spring boot 的常用注解使用 总结

@RestController和@RequestMapper注解

spring4.0重要的一个改进是@RestController注解 它继承@Controller注解 4.0之前的版本 springmvc的组件都使用@Controller来标识当前类是一个控制器Servlet 使用这个特性 我们可以开发REST服务的时候不需要使用@Controller而专门的@RestController 当你实现一个Restful web services的时候  response将一直通过ResponseBody发送 为了简化开发 spring4.0提供了一个专门版本Controller 下面我们来看看@RestController实现的定义

1. @Target(value=TYPE)    
2.  @Retention(value=RUNTIME)    
3.  @Documented    
4.  @Controller    
5.  @ResponseBody    
6. public @interface RestController 

@RequestMapper和@RestController直接是Springmvc的注解 （他们不是springboot特定的注解）

@EnableAutoConfiguration注解

第二个类级别的注解是@EnableAutoConfiguration  这个注解告诉springboot根据添加的jar依赖猜想你如何配置spring 由于spring-boot-start-web添加了tomcat和springmvc 所以autoconfiguration将假定你正在开发一个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

@SpringBootApplication

很多Spring Boot开发者总是使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 注解他们的main类。由于这些注解被如此频繁地一块使用（特别是你遵循以上最佳实践时），Spring Boot提供一个方便的 @SpringBootApplication 选择。
该 @SpringBootApplication 注解等价于以默认属性使用 @Configuration ， @EnableAutoConfiguration 和 @ComponentScan 。

[java]  view plain  copy

 print ?

1. package com.example.myproject;  
2. import org.springframework.boot.SpringApplication;  
3. import org.springframework.boot.autoconfigure.SpringBootApplication;  
4. @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan  
5. public class Application {  
6.     public static void main(String[] args) {  
7.         SpringApplication.run(Application.class, args);  
8.     }  
9. }  

Spring Boot将尝试校验外部的配置，默认使用JSR-303（如果在classpath路径中）。你可以轻松的为你的@ConfigurationProperties类添加JSR-303 javax.validation约束注解：

@ResponseBody

表示该方法的返回结果直接写入HTTP response body中

一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上
@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如
异步获取json数据，加上@responsebody后，会直接返回json数据。

@Component：

泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。一般公共的方法我会用上这个注解

@AutoWired

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构
造函数进行标注，完成自动装配的工作。
当加上（required=false）时，就算找不到bean也不报错。

@RequestParam：
用在方法的参数前面。

[java]  view plain  copy

 print ?

1. @RequestParam String a =request.getParameter("a")。  

@PathVariable:
路径变量。

[java]  view plain  copy

 print ?

1. RequestMapping("user/get/mac/{macAddress}")  
2. public String getByMacAddress(@PathVariable String macAddress){  
3. //do something;  
4. }  

全局处理异常的：

@ControllerAdvice：

包含@Component。可以被扫描到。
统一处理异常。

@ExceptionHandler（Exception.class）：
用在方法上面表示遇到这个异常就执行以下方法。

[java]  view plain  copy

 print ?

1. /** 
2.  * 全局异常处理 
3.  */  
4. @ControllerAdvice  
5. class GlobalDefaultExceptionHandler {  
6.     public static final String DEFAULT_ERROR_VIEW = "error";  
7.   
8.     @ExceptionHandler({TypeMismatchException.class,NumberFormatException.class})  
9.     public ModelAndView formatErrorHandler(HttpServletRequest req, Exception e) throws Exception {  
10.         ModelAndView mav = new ModelAndView();  
11.         mav.addObject("error","参数类型错误");  
12.         mav.addObject("exception", e);  
13.         mav.addObject("url", RequestUtils.getCompleteRequestUrl(req));  
14.         mav.addObject("timestamp", new Date());  
15.         mav.setViewName(DEFAULT_ERROR_VIEW);  
16.         return mav;  
17.     }}  

通过@value注解来读取application.properties里面的配置

[java]  view plain  copy

 print ?

1. # face++ key  
2. face_api_key = R9Z3Vxc7ZcxfewgVrjOyrvu1d-qR****  
3. face_api_secret =D9WUQGCYLvOCIdsbX35uTH********  

[java]  view plain  copy

 print ?

1. @Value("${face_api_key}")  
2.    private String API_KEY;  
3.   
4.    @Value("${face_api_secret}")  
5.    private String API_SECRET;  

注意使用這個注解的时候 使用@Value的类如果被其他类作为对象引用，必须要使用注入的方式，而不能new。这个很重要，我就是被这个坑了

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