首页手记 SpringBoot的常用注解

SpringBoot的常用注解

标签：

Java SpringBoot 源码

一、自定义注解

1. 注解的定义：

Java文件叫做Annotation，用@interface表示。注解的本质就是一个继承了 Annotation 接口的接口。

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。

Java注解：Java提供了一种原程序中的元素关联任何信息和任何元数据的途径和方法。

注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

Java自定义注解和运行时靠反射获取注解。

2. Annotation原理：

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

JDK5.0中提供了注解的功能，允许开发者定义和使用自己的注解类型。该功能由一个定义注解类型的语法和描述一个注解声明的语法，读取注解的API，一个使用注解修饰的class文件和一个注解处理工具组成。

Annotation并不直接影响代码的语义，但是他可以被看做是程序的工具或者类库。它会反过来对正在运行的程序语义有所影响。

3. 注解的分类：

(1)按照运行机制分：源码注解、编译时注解、运行时注解；

源码注解：只在源文件存在，class文件就不存了。

编译时注解：在class文件中存在。在源码中也存在，jdk自带注解都是。只在编译的时候起作用。

运行注解：在运行阶段还起作用，甚至会影响运行逻辑。

(2)按照来源分：来自JDK的注解、来自第三方的注解、我们自定义的注解；

JDK自带注解:@Override,@Deprecated,@Suppvisewarnings

@Override,表示当前的方法定义将覆盖超类中的方法。如果你不小心拼写错误,或者方法签名对不上被覆盖的方法,编译器就会发出错误提示。

@Deprecated,修饰过时的方法。如果程序员不小心使用了它的元素,那么编译器会发出警告信息。

@Suppvisewarnings，关闭不当的编译器警告信息。

(3)来自第三方的注解：比如Spring框架自带的注解、SpringBoot框架自带的注解都属于第三方。

4. 元注解：

使用@interface关键字定义注解。注解的注解叫元注解，元注解用于创建新的注解，在Java中有四个元注解，如下：

（1）@Target：注解的作用目标，表示该注解可以用于什么地方，可能的ElementType参数有：

@Target(ElementType.TYPE) // 接口、类、枚举, 表示允许被修饰的注解作用在类、接口和枚举上

@Target(ElementType.FIELD) // 字段、枚举的常量，表示允许作用在属性字段上

@Target(ElementType.METHOD) // 方法，表示允许作用在方法上

@Target(ElementType.PARAMETER) // 方法参数，表示允许作用在方法参数上

@Target(ElementType.CONSTRUCTOR) // 构造函数，表示允许作用在构造器上

@Target(ElementType.LOCAL_VARIABLE) // 局部变量，表示允许作用在本地局部变量上

@Target(ElementType.ANNOTATION_TYPE) // 注解，表示允许作用在注解上

@Target(ElementType.PACKAGE) // 包，表示允许作用在包上

@Target(ElementType.TYPE_PARAMETER) //类型参数，表示允许作用在类型参数上(jdk1.8新增)

@Target(ElementType.TYPE_USE) //任何类型，表示允许作用在任何类型上(jdk1.8新增)

源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

(2) @Retention：注解的生命周期，用于指明当前注解的生命周期，可能的RetentionPolicy参数有：

@Retention(RetentionPolicy.SOURCE) // 注解仅存在于源码中，在class字节码文件中不包含；

@Retention(RetentionPolicy.CLASS) // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，在类加载阶段丢弃；

@Retention(RetentionPolicy.RUNTIME) // 永久保存，注解会在class字节码文件中存在，在运行时可以通过反射获取到；

@Retention 注解指定了被修饰的注解的生命周期，一种是只能在编译期可见，编译后会被丢弃，另一种会被编译器编译进 class 文件中，无论是类、方法或字段，它们都是有属性表的，而 JAVA 虚拟机也定义了几种注解属性表用于存储注解信息，但是这种可见性不能带到方法区，类加载时会予以丢弃，最后一种则是永久存在的可见性。

源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}

(3) @Documented：注解包含在 JavaDoc 文档中

源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

(4) @Inherited：允许子类继承该注解，也就是注解可以被继承

源码：

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}

5. 使用@interface关键字定义注解：

（1）成员以无参数无异常的的方式声明

（2）可以用default为成员制定一个默认值

（3）成员类型是受限制的，合法的类型包含原始基本类型及String、Class、Annotation、Enumeration

（4）如果注解只有一个成员，则成员名必须取为value();在使用时可以忽略成员名和赋值号（=）

（5）注解类可以没有成员，没有成员的注解成为标识注解

（6）默认情况下注解并不会被继承到子类中，可以在自定义注解时加上java.lang.annotation.Inherited注解声明使用继承。

（7）使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

（8）当注解中使用的属性名为value时，对其赋值时可以不指定属性的名称而直接写上属性值接口；除了value以外的变量名都需要使用name=value的方式赋值。

（9）要想在制作JavaDoc文件的同时将注解信息加入到API文件中，可以使用java.lang.annotation.Documented。

6. 解析注解：

通过反射获取类、函数或成员上的运行时注解信息，从而实现动态控制程序运行的逻辑。

对于一个类或者接口来说，Class 类中提供了以下一些方法用于反射注解：

getAnnotation：返回指定的注解；

isAnnotationPresent：判定当前元素是否被指定注解修饰；

getAnnotations：返回所有的注解；

getDeclaredAnnotation：返回本元素的指定注解；

getDeclaredAnnotations：返回本元素的所有注解，不包含父类继承而来的；

通常情况下，注解都是作用在一个类、方法或属性上：

当注解作用于类上时，可以使用如下代码获取反射的类信息：

Class<类名> userClass = 类名.class;

通过userClass对象获取注解类对象信息：

注解类名 description = userClass.getAnnotation(注解类名.class);

进一步获取注解的属性内容；

当注解作用于方法上时，可以使用如下代码获取所有的方法信息：

Method[] methods = 类名.class.getMethods();

遍历methods，然后获取注解信息：

注解类名 anno = method.getAnnotation(注解类名.class);

进一步获取注解的信息；

当注解作用于属性上时，可以使用如下代码来获取字段信息：

Class<?> studentClass = 类变量名.getClass();

Field[] fields = studentClass.getDeclaredFields();

遍历fields，然后获取注解中的属性信息：

注解类名 column = field.getAnnotation(注解类名.class);

进一步获取对象的属性信息；

实例代码1：

@Target({ElementType.FIELD})  //作用域
@Retention(RetentionPolicy.RUNTIME)  //生命周期
@Documented
@Inherited
public @interface Column {

    String value();
}

实例代码2：

@Target({ElementType.METHOD,ElementType.TYPE})  //作用域
@Retention(RetentionPolicy.RUNTIME)  //声明周期
@Documented
@Inherited
public @interface Description {
    //1.类型受限制，包括基本类型及String、Class、Annotation、Enumeration
    //2.若只有一个成员，则名称必须为value(),使用时可以忽略成员名和赋值号(=)
    //3.注解类可以没有成员，称为标识注解
    //4.成员无参且无异常声明
    //5.可以指定默认值

    String desc();  //描述

    String author();  //作者

    int age() default 18;  //年龄
}

实例代码3：

@Target({ElementType.FIELD, ElementType.METHOD})  //作用域
@Retention(RetentionPolicy.RUNTIME)  //声明周期
@Documented
@Inherited
public @interface Validate {

    public int min() default 3;

    public int max() default 20;

    public boolean isNotNull() default true;
}

实例代码4：

@Target({ElementType.FIELD, ElementType.METHOD})  //作用域
@Retention(RetentionPolicy.RUNTIME)  //生命周期
@Documented
@Inherited
public @interface Init {

    public String value() default "";
}

二、SpringBoot的常用注解

(1)@SpringBootApplication: SpringBoot的重要注解，作用在入口启动类上，它是组合注解，由@Configuration、@EnableAutoConfiguration、@ComponentScan组成，通常用在主类上；

其中@ComponentScan让Spring Boot扫描到Configuration类并把它加入到程序上下文。

(2)@Configuration：等同于Spring的XML配置文件，一般加在主类上；使用java代码可以检查类型安全。

(3)@EnableAutoConfiguration：完成自动配置,让 Spring Boot 根据应用所声明的依赖来对 Spring 框架进行自动配置，一般加在主类上；

(4)@ComponentScan: 组件扫描，可自动发现和装配一些Bean。扫描到有@Component、@Controller、@Service等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。

(5)@Value : 注入Spring boot application.properties配置的属性的值。，比如：

@Vale("${book.name}")

private String name;

@Value(value = “#{message}”)

private String message;

(6)@Repository: 用于标注数据访问组件，即DAO组件；使用@Repository注解可以确保DAO或者repositories提供异常转译，这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置，同时也不需要为它们提供XML配置项。

(7)@Service: 用于标注业务层组件(服务层)；

(8)@RestController: 用于标注控制层组件，包含@Controller和@ResponseBody；表示这是个控制器bean,并且是将函数的返回值直接填入HTTP响应体中,是REST风格的控制器。

(9)@Controller: 用于标注是控制层组件，需要返回页面时请用@Controller而不是@RestController；用于定义控制器类，在spring 项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping。

(10)@Component: 泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注；

(11)@ResponseBody:表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，在使用@RequestMapping后，返回值通常解析为跳转路径，

加上@responsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中；比如异步获取json数据，加上@responsebody后，会直接返回json数据；

(12)@RequestBody:参数前加上这个注解之后，认为该参数必填。表示接受json字符串转为对象 List等；

(13)@Autowired：自动导入。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作；

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

(14)@Bean:相当于XML中的,放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理；

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

(16)@Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired作用类似；

(17)@RequestMapping: 提供路由信息，负责URL到Controller中的具体函数的映射。

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径；

该注解有六个属性: