【JAVA】java注解的自定义和使用

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

java注解概念

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

java注解介绍

常用注解

@Override：表示方法是重写的方法

@Deprecated：过时的方法

@SuppressWarnings：抑制警告

注解分类

按照运行机制分

1、源码注解：注解只在源码中存在，编译成.class文件就不存在了

2、编译时注解：注解在源码和.class文件中都存在，如@Override

3、运行时注解：在运行阶段起作用，甚至会影响运行逻辑，如@Autowired

按照来源分

1、JDK自带注解

2、第三方注解

3、自定义注解

自定义注解和使用

1、使用@interface关键定义注解（Description.java），如下：

package com.hd; import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target; /**
* 注解的注解：元注解
*
* 注解作用域
ElementType.TYPE：允许被修饰的注解作用在类、接口和枚举上
ElementType.FIELD：允许作用在属性字段上
ElementType.METHOD：允许作用在方法上
ElementType.PARAMETER：允许作用在方法参数上
ElementType.CONSTRUCTOR：允许作用在构造器上
ElementType.LOCAL_VARIABLE：允许作用在本地局部变量上
ElementType.ANNOTATION_TYPE：允许作用在注解上
ElementType.PACKAGE：允许作用在包上注解的生命周期
RetentionPolicy.SOURCE：当前注解编译期可见，不会写入 class 文件
RetentionPolicy.CLASS：类加载阶段丢弃，会写入 class 文件
RetentionPolicy.RUNTIME：永久保存，可以反射获取
*
*/
// 注解的作用域
@Target({ElementType.METHOD, ElementType.TYPE})
// 注解的生命周期
@Retention(RetentionPolicy.RUNTIME)
// 允许子类继承
@Inherited
// 生成javadoc的时候生成注解的信息
@Documented
// @interface：使用@interface关键定义注解
public @interface Description { // 注解的成员
// 成员类型所限的，合法的类型包括原始数据类型及String、Class、Annotation、Enumeration
String desc(); String author(); // 成员以无参无异常方式生命，可以用default为成员指定一个默认值
int age() default 18; // 如果注解成员只有一个时，成员名必须取名未value(),在使用时可以忽略成员名和赋值号(=)
// 注解可以没有成员，没有成员的注解成为标识注解
}

2、在普通类上使用注解，使用方法

注解使用： @<注解名>(<成员名1>=<成员值1>, <成员名2>=<成员值2>, ...)

如下：

package com.hd; /**
* 注解使用：
* @<注解名>(<成员名1>=<成员值1>, <成员名2>=<成员值2>, ...)
* @author H__D
* @date 2019-07-09 22:49:32
*
*/
@Description(desc="I am class annotation", author="hd")
public class TestDescription { @Description(desc="I am method annotation", author="hd")
public String test(){ return "red";
} }

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

package com.hd; import java.lang.annotation.Annotation;
import java.lang.reflect.Method; /**
* 解析注解
* 通过反射获取类，函数或成员上的运行时注解信息，从而实现动态控制程序运行的逻辑
*
* 对于一个类或者接口来说，Class 类中提供了以下一些方法用于反射注解。
getAnnotation：返回指定的注解
isAnnotationPresent：判定当前元素是否被指定注解修饰
getAnnotations：返回所有的注解
getDeclaredAnnotation：返回本元素的指定注解
getDeclaredAnnotations：返回本元素的所有注解，不包含父类继承而来的
*
* @author H__D
* @date 2019-07-09 22:52:42
*
*/
public class ParseDecription { public static void main(String[] args) {
// TODO Auto-generated method stub
// 1、使用类加载器加载类
try {
Class c = Class.forName("com.hd.TestDescription");
System.out.println(c); // 2、找到类上面的注解
boolean isExist = c.isAnnotationPresent(Description.class); if(isExist) {
// 3、拿到注解实例
Description d = (Description) c.getAnnotation(Description.class);
System.out.println("========parse class annotation=========");
System.out.println("desc = " + d.desc());
System.out.println("author = " + d.author());
System.out.println("age = " + d.age());
} // 4、找到方法上的注解
Method[] ms = c.getMethods();
for (Method m : ms) {
boolean isMExist = m.isAnnotationPresent(Description.class);
if(isMExist) {
Description d = m.getAnnotation(Description.class);
System.out.println("========parse method annotation=========");
System.out.println("desc = " + d.desc());
System.out.println("author = " + d.author());
System.out.println("age = " + d.age());
}
} // 另外一种解析方法
for (Method m : ms) {
Annotation[] annotations = m.getAnnotations();
for (Annotation annotation : annotations) {
if(annotation instanceof Description) {
System.out.println("========parse method annotation other way=========");
Description d = (Description) annotation;
System.out.println("desc = " + d.desc());
System.out.println("author = " + d.author());
System.out.println("age = " + d.age());
}
}
} } catch (ClassNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}