springboot常用注解（包含spring及MVC）

说明：以下的注解为springboot，spring以及spinrgMVC中常见的部分注解，并不包含全部，我只是列出了常用的一些。

@Controller

这个无需多言，表明某类是一个controller，配合@RequestMapping注解即可实现跳转

@ResponseBody

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

一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，加上

@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如

异步获取json数据，加上@responsebody后，会直接返回json数据。

@RestController

官方文档：

@RestController is a stereotype annotation that combines @ResponseBody and @Controller.

该注解告诉Spring以字符串的形式渲染结果，并直接返回给调用者。相当于@ResponseBody ＋ @Controller合在一起的作用。

@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

该注解可点击链接查看

@PathVariable

路径变量。

如 RequestMapping(“user/get/mac/{macAddress}”)

public String getByMacAddress(@PathVariable String macAddress){

//do something;

}

参数与大括号里的名字一样要相同。

—-以下为springboot特有注解

@Configuration

@Configuration注解该类，等价 与XML中配置beans；如

<beans></beans>

Spring Boot提倡基于Java的配置。尽管你可以使用一个XML源来调用 SpringApplication.run() ，我们通常建议你使用 @Configuration 类作为主要源。一般定义 main 方法的类也是主要 @Configuration 的一个很好候选。你不需要将所有的 @Configuration 放进一个单独的类。 @Import 注解可以用来导入其他配置类。@Import(xxx.class) //在配置类中导入xxx类的配置

相当于之前在spring的xml配置文件中导入另一个配置文件的xml，

<import resource="classpath*:/spring/xxx.xml" />

另外，你也可以使用 @ComponentScan 注解自动收集所有的Spring组件，包括 @Configuration类。

如果你绝对需要使用基于XML的配置，我们建议你仍旧从一个 @Configuration 类开始。你可以使用附加的 @ImportResource 注解加载XML配置文件,类似于xml配置时的：

@Bean

标注方法等价于XML中配置bean,如

<bean></bean>

,

放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理。

@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 注解的排除属性来禁用它们。

如

@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})

public class MyConfiguration {

}

@ComponentScan

个人理解相当于之前在spring配置文件xml中的

<context:component-scan>

你可以自由地使用任何标准的Spring框架技术去定义beans和它们注入的依赖。简单起见，我们经常使用 @ComponentScan 注解搜索beans，并结合 @Autowired 构造器注入。

如果使用上面建议的结构组织代码（将应用类放到根包下），你可以添加 @ComponentScan 注解而不需要任何参数。你的所有应用程序组件（ @Component , @Service , @Repository , @Controller 等）将被自动注册为Spring Beans。

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan

该 @SpringBootApplication 注解等价于以默认属性使用 @Configuration ，@EnableAutoConfiguration和 @ComponentScan 。

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

@AutoWired

byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构

造函数进行标注，完成自动装配的工作。

当加上（required=false）时，就算找不到bean也不报错。

@Qualifier

当有多个同一类型的Bean时，可以用@Qualifier(“name”)来指定。与@Autowired配合使用

@Resource(name=”name”,type=”type”)：

没有括号内内容的话，默认byName。与@Autowired干类似的事。