Spring Boot 二十个注解

Spring Boot 二十个注解

占据无力拥有的东西是一种悲哀。

　　Cold on the outside passionate on the inside.

背景：Spring Boot 注解的强大毋庸置疑，使用其注解可以大量减少XML 等复杂的配置文件，令Java 代码更纯，开发更简单高效，记下一些常用的Spring Boot Annotations，不包括那些在Spring Boot 使用的JPA 和MyBatis 注解。

一、@SpringBootApplication

@SpringBootApplication 注解用于声明自动配置，即让Spring Boot 自动为程序进行必要的配置；@SpringBootApplication 注解配置等同于@Configuration、@EnableAutoConfiguration 和@ComponentScan 三个注解的配置。

 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;

 @SpringBootApplication
 /*@Configuration  三者只和等同于 @SpringBootApplication 注解进行自动配置
 @EnableAutoConfiguration
 @ComponentScan*/
 public class JzxyApplication {

     public static void main(String[] args) {
         SpringApplication.run(JzxyApplication.class, args);

     }

 }

二、@Contronller

@Contronller 注解用于定义该类属于控制器类，因为在Sping Boot 项目中是由控制器负责将用户请求的URL 转发到对应的服务接口（Service 服务层），So使用其是必不可少。

 /**
  * 定义控制器类 @Controller
  */
 @Controller
 @RequestMapping("/demon/linux")
 public class LinuxUsersController {

     @RequestMapping("/add/host")
     public Map getLinuxConn(@RequestBody List<LinuxConnEntity> list) {
         Map resultMap = null;
         return list == null
                 ? setResult(resultMap, Constant.ZERO, Constant.REQUEST_NULL_MSG)
                 : linuxUsersServiceImpl.createLinuxConn(list);

     }

三、@ResponseBody

@ResponseBody 注解表示该方法的返回结果直接写入HTTP 的Response Body 中，该注解一般在异步获取数据时使用，用于构建RESTful 的API；另外，在使用@RequestMapping 注解后返回值通常会解析为路径跳转，而在加上了@ResponseBody 注解后，返回结果则不会被解析为路径而是直接写入HTTP Response Body 中。

 /**
      * 异步获取json 数据，加上@responsebody 注解后，会直接返回json 数据
      */
     @ResponseBody
     @RequestMapping("/responsebody")
     public LinuxUserEntity testOne(LinuxUserEntity linuxUserEntity) {
         return linuxUsersServiceImpl.test();
              }

四、@RestController

@RestController 注解用于标注控制层组件，其是@ResponseBody 和@Contronller 两个注解的集合。

 /**
  * @RestController 等价于@Controller 和 @ResponseBody 两个注解的集合
  */
 @RestController
 @RequestMapping("/responsebody/linux")
 public class LinuxUsersController {

     @RequestMapping("/responsebody")
     public LinuxUserEntity testOne(LinuxUserEntity linuxUserEntity) {
         return linuxUsersServiceImpl.test();
              }

五、@RequestMapping

@RequestMapping 是提供路由信息的注解，其是负责URL 到Controller 中的具体函数的映射；此外，该注解后的括号内经常会使用如下六个属性：

1. param：指定请求request 中必须包含某些参数，否则不处理该方法；

2. header：指定请求request 中必须包含某些指定的header 值，否则不处理该方法；

3. value：指定请求的实际地址；

4. method：指定请求的方法method 类型，通常设计为RESTful 风格的GET、POST、PUT 和DELETE；

5. consumes：指定处理请求提交内容的具体类型（即Content-Type），如applicatin/json 和text/html 等类型格式；

6: produces：指定返回的内容类型，设置该属性后仅当request 请求头中的Accept 类型中包含该制定类型时才会返回，需谨慎。

 /**
      * @RequestMapping 提供路由信息的注解
      */
     @RequestMapping("/responsebody")
     public LinuxUserEntity testOne(LinuxUserEntity linuxUserEntity) {
         return linuxUsersServiceImpl.test();
     }

六、@EnableAutoConfiguration

@EnableAutoConfiguration 是Spring Boot 自动配置注解，其会根据项目中添加的依赖自动配置Spring 应用；比如Spring Boot 自动配置内嵌tomcat 的端口为8080；还有自动载入应用程序所需的所有Bean，这依赖于Spring Boot 在类路径中的查找结果，就比如你在classpath 下存在HSQLDB，并且没有手动配置任何数据库连接Bean，那么@EnableAutoConfiguration 注解就会自动配置一个内存模型（in-memory）数据库。

七、@ComponentScan

@ComponentScan 注解表示该类会自动发现扫描组件，若扫描到包含@Component、@Controller 和@Service 等注解的类，则会将其注册为Bean，并且可以自动收集所有的Spring 组件，包括有@Configuration 注解标注的类；开发中经常使用@ComponentScan 注解搜索Beans，并结合@Autowired 注解将Beans 注入，若没有进行配置，则Spring Boot 只会扫描SpringBootApplication 启动类所在包下及其子包下的使用了@Service、@Repository 等注解的类。

八、@Configuration

@Configuration 注解作用类似于传统的xml 配置文件；例如，有第三方库需要用到xml 文件，则可以通过添加@Configuration 注解表示该类作为项目的配置主类，然后使用@ImportResource 注解加载xml 配置文件内容。

九、@Import

@Import 注解作用是导入其它配置类。

十、@ImportResource

@ImportResource 注解作用是加载xml 配置文件。

十一、@Autowired

@Autowired 注解的作用是自动导入依赖的Bean；即把配置好的Bean 拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作；并且当加上标签（required=false）时，就算找不到bean 也不报错，允许注入为空。

十二、@Service

@Service 注解的作用是标志某类为Service 层，是Service 服务层组件注解。

十三、@Repository

@Repository 注解作用是标志某类为数据层，其可用于确保DAO 层或者Repositories 能正常转译；当@Repository 注解修饰DAO 或者repositories 类时会被ComponentScan 发现并配置。

十四、@Bean

@Bean 注解相当于XML 配置文件中使用的<bean>标签，初始化的时候创建对象，并交由IOC 容器管理；需要注意的是@Bean 注解是放在方法的上面，而不是类，意思是产生一个bean，并交给spring 管理。

十五、@Value

@Value 注解作用是注入Spring Boot 配置文件application.properties，即获取application.properties 配置文件中属性的值。

 @Value(value = "#{VEHIVLE_TOPIC}")
     private String VEHIVLE_TOPIC;

十六、@inject

@inject 注解作用与@Autowired 相同，不同的是其没有require 属性，强制要求注入不能为空。

十七、@Component

@Component 注解泛指组件，即当组件不方便归类时，可以使用该注解进行标注归类。

十八、@Qualifier

@Qualifier 注解用于当有多个同一类型的Bean 时，通过@Qualifier(“name”) 根据名字来指定注入的Bean；其需要配合@Autowired 使用，根据名字进行注入，进行更细粒度的控制如何选择要注入的Bean。

十九、@Resouce

@Resouce 注解的作用与@Autowired 相似，都是自动注入依赖的Bean；不同的是@Resource(name=”name”,type=”type”) 多了括号内的属性，当没有括号内内容的话，默认byName。

二十、@PathVariable

@PathVariable 注解的作用是获取路径变量。

 /**
      * @RequestMapping 获取路径变量
      */
     @RequestMapping("/ioc/get/{address}")
     public String testOne(@PathVariable String address ) {
         /**
          * 获取得到路径中address 的值
          */
         return address;
     }

占据无力拥有的东西是一种悲哀。

　　Cold on the outside passionate on the insede.