@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any
*/
String value() default "";
}
@Target({ElementType.TYPE}) 注解
ElementType 这个枚举类型的常量提供了一个简单的分类:注释可能出现在Java程序中的语法位置(这些常量与元注释类型(@Target)一起指定在何处写入注释的合法位置)
package java.lang.annotation;
/**
* The constants of this enumerated type provide a simple classification of the
* syntactic locations where annotations may appear in a Java program. These
* constants are used in {@link Target java.lang.annotation.Target}
* meta-annotations to specify where it is legal to write annotations of a
* given type.
* @author Joshua Bloch
* @since 1.5
* @jls 9.6.4.1 @Target
* @jls 4.1 The Kinds of Types and Values
*/
public enum ElementType {
/** 类, 接口 (包括注释类型), 或 枚举 声明 */
TYPE,
/** 字段声明(包括枚举常量) */
FIELD,
/** 方法声明(Method declaration) */
METHOD,
/** 正式的参数声明 */
PARAMETER,
/** 构造函数声明 */
CONSTRUCTOR,
/** 局部变量声明 */
LOCAL_VARIABLE,
/** 注释类型声明 */
ANNOTATION_TYPE,
/** 包声明 */
PACKAGE,
/**
* 类型参数声明
*
* @since 1.8
*/
TYPE_PARAMETER,
/**
* 使用的类型
*
* @since 1.8
*/
TYPE_USE
}
@Retention({RetentionPolicy.Runtime}) 注解
RetentionPolicy这个枚举类型的常量描述保留注释的各种策略,它们与元注释(@Retention)一起指定注释要保留多长时间
package java.lang.annotation;
/**
* Annotation retention policy. The constants of this enumerated type
* describe the various policies for retaining annotations. They are used
* in conjunction with the {@link Retention} meta-annotation type to specify
* how long annotations are to be retained.
*
* @author Joshua Bloch
* @since 1.5
*/
public enum RetentionPolicy {
/**
* 注释只在源代码级别保留,编译时被忽略
*/
SOURCE,
/**
* 注释将被编译器在类文件中记录
* 但在运行时不需要JVM保留。这是默认的
* 行为.
*/
CLASS,
/**
*注释将被编译器记录在类文件中
*在运行时保留VM,因此可以反读。
* @see java.lang.reflect.AnnotatedElement
*/
RUNTIME
}
@Documented注解
Documented注解表明这个注释是由 javadoc记录的,在默认情况下也有类似的记录工具。 如果一个类型声明被注释了文档化,它的注释成为公共API的一部分。
@Target
用于描述注解的使用范围(即:被描述的注解可以用在什么地方),其取值有:
取值 | 描述 |
---|---|
CONSTRUCTOR | 用于描述构造器(领盒饭)。 |
FIELD | 用于描述域(领盒饭)。 |
LOCAL_VARIABLE | 用于描述局部变量(领盒饭)。 |
METHOD | 用于描述方法。 |
PACKAGE | 用于描述包(领盒饭)。 |
PARAMETER | 用于描述参数。 |
TYPE | 用于描述类或接口(甚至 enum )。 |
@Retention
用于描述注解的生命周期(即:被描述的注解在什么范围内有效),其取值有:
取值 | 描述 |
---|---|
SOURCE | 在源文件中有效(即源文件保留,领盒饭)。 |
CLASS | 在 class 文件中有效(即 class 保留,领盒饭)。 |
RUNTIME | 在运行时有效(即运行时保留)。 |
@Documented 在默认的情况下javadoc命令不会将我们的annotation生成再doc中去的,所以使用该标记就是告诉jdk让它也将annotation生成到doc中去
@Inherited 比如有一个类A,在他上面有一个标记annotation,那么A的子类B是否不用再次标记annotation就可以继承得到呢,答案是肯定的
Annotation属性值
Annotation属性值 有以下三种: 基本类型、数组类型、枚举类型
1:基本串类型
public @interface UserdefinedAnnotation {
intvalue();
String name();
String address();
}
使用:
@UserdefinedAnnotation(value=123,name="wangwenjun",address="火星")
public static void main(String[] args) {
System.out.println("hello");
}
}
如果一个annotation中只有一个属性名字叫value,我没在使用的时候可以给出属性名也可以省略。
public @interface UserdefinedAnnotation {
int value();
}
也可以写成如下的形式
Java代码
@UserdefinedAnnotation(123) 等同于@UserdefinedAnnotation(value=123)
public static void main(String[] args) {
System.out.println("hello");
}
2:数组类型 我们在自定义annotation中定义一个数组类型的属性,代码如下:
public @interface UserdefinedAnnotation {
int[] value();
}
使用:
public class UseAnnotation {
@UserdefinedAnnotation({123})
public static void main(String[] args) {
System.out.println("hello");
}
}
注意1:其中123外面的大括号是可以被省略的,因为只有一个元素,如果里面有一个以上的元素的话,花括号是不能被省略的哦。比如
{123,234}
。注意2:其中属性名value我们在使用的时候进行了省略,那是因为他叫value,如果是其他名字我们就不可以进行省略了必须是
@UserdefinedAnnotation
(属性名={123,234}
)这样的格式。3:枚举类型
public enum DateEnum {
Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
}
然后在定义一个annotation
package com.wangwenjun.annatation.userdefined;
public @interface UserdefinedAnnotation {
DateEnum week();
}
使用:
public class UseAnnotation {
@UserdefinedAnnotation(week=DateEnum.Sunday)
public static void main(String[] args) {
System.out.println("hello");
}
}
4:默认值
public @interface UserdefinedAnnotation {
String name() default "zhangsan";
}
使用:
public class UseAnnotation {
@UserdefinedAnnotation()
public static void main(String[] args) {
System.out.println("hello");
}
}
5:注意
Annotation是不可以继承其他接口的,这一点是需要进行注意,这也是annotation的一个规定吧。 Annotation也是存在包结构的,在使用的时候直接进行导入即可。 Annotation类型的类型只支持原声数据类型,枚举类型和Class类型的一维数组,其他的类型或者用户自定义的类都是不可以作为annotation的类型,我查看过文档并且进行过测试。