Java自定义注解和元注解

简介: <div class="markdown_views"><h1 id="自定义annotation">自定义annotation</h1><p>先看一个注解实例:</p><pre class="prettyprint"><code class="language-java hljs "><span class="hljs-keyword">import</span

自定义annotation

先看一个注解实例:

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/*-----------------定义注解--------------------*/
@Retention(RetentionPolicy.SOURCE)//声明注释保留时长
@Target(ElementType.METHOD)//声明可以使用此注解的元素级别类型(如类、方法变量等)
@Documented//表示当标注了NeedRecord注解的对象在被javadoc生成文档时,NeedRecord注解将会被API文档记录
public @interface NeedRecord {//定义注解
    String userName() default "anonymous";//定义注解成员,同时用default声明默认值,如果不想声明默认值,去掉default部分即可
    String value() ;
}
/*------------------使用注解实例1-----------------*/
@NeedRecord("login")
public void login(){
    System.out.println("I'm zenghao ,I'm logining");
}
/*------------------使用注解实例2-----------------*/
@NeedRecord(userName = "zenghao",value = "login")
public void login(){
    System.out.println("I'm zenghao ,I'm logining");
}

除了程序中注释提到的细节外,还有几点是需要注意的:
1. 使用注解的格式为@注解名(key1 = value1,key2 = value2 …..),当以@注解名(thisValue)来标注注解时,thisValue默认对应与注解内的value属性,如果注解内未定义value属性,则会编译出错。
2. 注解属性不能有入参(如value(name)),也不能声明异常(如value() throws Exception)
3. 属性的类型只能为原始类型及其包装类或相应的数组类型,不能是自定义类型,如声明MyClass myClass();则会出现编译错误Invalid type MyClass for the annotation attribute NeedRecord.myClass; only primitive type, String, Class, annotation, enumeration are permitted or 1-dimensional arrays thereof

元注解

上面实例中我们用到的@Retention,@Target,@Documented都是Java预定义的元注解,他们只能在我们自定义注解的时候使用,下面来分析分析这些注解的用法。

1. @Retention

用于声明我们自定义的注解的存活时间,它的属性value有三个对应的值
1. RetentionPolicy.SOURCE:在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
2. RetentionPolicy.CLASS:默认值,编译器仅把注解保存在class文件中,在运行java程序时,JVM不会保留注释,即不能用反射(在运行期)来获取注释
3. RetentionPolicy.RUNTIME:编译器不仅把注解保存在class文件中,同时在运行java程序时,JVM也会保留注释,即可以通过反射来获取注释


2. @Target

用于指定自定义的注解能够修饰哪些元素,其value属性指明了注解对象,有如下几个值供选择:
- ElementType.TYPE:修饰类、接口或枚举(enum)
- ElementType.FIELD:注解成员变量
- ElementType.METHOD:注解方法
- ElementType.PARAMETER:注解方法参数
- ElementType.CONSTRUCTOR:注解构造函数
- ElementType.LOCAL_VARIABLE :注解局部变量
- ElementType.ANNOTATION_TYPE 注解另一个自定义注解
- ElementType.PACKAGE 注解包

3. @Documented

比如注解A被标注@Documented,B被A标注,则用javadoc对B类生成API文档时,在类声明上会出现注解A记录。

目录
相关文章
|
1月前
|
Java Spring 容器
【Java】Spring如何扫描自定义的注解?
【Java】Spring如何扫描自定义的注解?
35 0
|
1月前
|
Java 数据库连接
hibernate注解实体类(Dept.java)
hibernate注解实体类(Dept.java)
13 1
|
1月前
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(Dept.java)
Hibernate中使用Criteria查询及注解——(Dept.java)
14 1
|
28天前
|
存储 SQL Java
【Java技术指南】「JPA编程专题」让你不再对JPA技术中的“持久化型注解”感到陌生了(二)
【Java技术指南】「JPA编程专题」让你不再对JPA技术中的“持久化型注解”感到陌生了
44 1
|
3天前
|
Java 测试技术 编译器
JAVA注解
JAVA注解
9 0
|
14天前
|
Java
Java配置大揭秘:读取自定义配置文件的绝佳指南
Java配置大揭秘:读取自定义配置文件的绝佳指南
16 0
Java配置大揭秘:读取自定义配置文件的绝佳指南
|
18天前
|
NoSQL Java Redis
Java自定义线程池的使用
Java自定义线程池的使用
|
1月前
|
Java 数据库连接
hibernate注解实体类(Emp.java)
hibernate注解实体类(Emp.java)
14 1
|
1月前
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(DeptTest.java)
Hibernate中使用Criteria查询及注解——(DeptTest.java)
8 1
|
1月前
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(Emp.java)
Hibernate中使用Criteria查询及注解——(Emp.java)
9 0