博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
java 自定义注解
阅读量:6493 次
发布时间:2019-06-24

本文共 5299 字,大约阅读时间需要 17 分钟。

 java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。 注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

1、元注解

元注解是指注解的注解。包括  @Retention @Target @Document @Inherited四种。

1.1、@Retention: 定义注解的保留策略

@Retention(RetentionPolicy.
SOURCE)  
//注解仅存在于源码中,在class字节码文件中不包含
@Retention(RetentionPolicy.
CLASS)
   
// 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME) 
// 注解会在class字节码文件中存在,在运行时可以通过反射获取到
 
1.2、@Target:定义注解的作用目标
其定义的源码为:
[java]
  1. @Documented 
  2. @Retention(RetentionPolicy.RUNTIME) 
  3. @Target(ElementType.ANNOTATION_TYPE) 
  4. public@interface Target { 
  5.     ElementType[] value(); 
@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.ANNOTATION_TYPE)public @interface Target {    ElementType[] value();}
@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) /
//
   
由以上的源码可以知道,他的elementType 可以有多个,一个注解可以为类的,方法的,字段的等等
1.3、@Document:说明该注解将被包含在javadoc中
 
1.4、@Inherited:说明子类可以继承父类中的该注解
 
2、java 注解的自定义
      下面是自定义注解的一个例子
[java]
  1. @Documented 
  2. @Target({ElementType.TYPE,ElementType.METHOD}) 
  3. @Retention(RetentionPolicy.RUNTIME) 
  4. public@interface Yts { 
  5.    publicenum YtsType{util,entity,service,model} 
  6.     
  7.    public YtsType classType() default YtsType.util; 
  8.   
@Documented@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)public @interface Yts {   public enum YtsType{util,entity,service,model}      public YtsType classType() default YtsType.util;}
[java]
  1. @Documented 
  2. @Retention(RetentionPolicy.RUNTIME) 
  3. @Target(ElementType.METHOD) 
  4. @Inherited 
  5. public@interface HelloWorld { 
  6.     public String name()default""
@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)@Inheritedpublic @interface HelloWorld {    public String name()default "";}

@Retention(RetentionPolicy.RUNTIME)

定义的这个注解是注解会在class字节码文件中存在,在运行时可以通过反射获取到。

@Target({ElementType.TYPE,ElementType.METHOD})

因此这个注解可以是类注解,也可以是方法的注解

这样一个注解就自定义好了,当然注解里面的成员可以为基本的数据类型,也可以为数据,Object等等

 

3 注解是定义好了,那么怎么来得到,解析注解呢?

java的反射机制可以帮助,得到注解,代码如下:

[java]
  1. publicclass ParseAnnotation { 
  2.  
  3.      publicvoid parseMethod(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException{ 
  4.   Object obj = clazz.getConstructor(new Class[]{}).newInstance(new Object[]{}); 
  5.     for(Method method : clazz.getDeclaredMethods()){ 
  6.         HelloWorld say = method.getAnnotation(HelloWorld.class); 
  7.         String name = ""
  8.         if(say != null){ 
  9.            name = say.name(); 
  10.            method.invoke(obj, name); 
  11.         } 
  12.        Yts yts = (Yts)method.getAnnotation(Yts.class); 
  13.        if(yts != null){ 
  14.           if(YtsType.util.equals(yts.classType())){ 
  15.           System.out.println("this is a util method"); 
  16.         }else
  17.             System.out.println("this is a other method"); 
  18.             } 
  19.         } 
  20.       } 
  21.     } 
  22.     @SuppressWarnings("unchecked"
  23.     publicvoid parseType(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException{ 
  24.         Yts yts = (Yts) clazz.getAnnotation(Yts.class); 
  25.         if(yts != null){ 
  26.             if(YtsType.util.equals(yts.classType())){ 
  27.                 System.out.println("this is a util class"); 
  28.             }else
  29.                 System.out.println("this is a other class"); 
  30.             } 
  31.         } 
  32.     } 
  33.      
public class ParseAnnotation {	 public void parseMethod(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException{  Object obj = clazz.getConstructor(new Class[]{}).newInstance(new Object[]{});    for(Method method : clazz.getDeclaredMethods()){        HelloWorld say = method.getAnnotation(HelloWorld.class);        String name = "";        if(say != null){           name = say.name();           method.invoke(obj, name);        }       Yts yts = (Yts)method.getAnnotation(Yts.class);       if(yts != null){          if(YtsType.util.equals(yts.classType())){          System.out.println("this is a util method");        }else{            System.out.println("this is a other method");            }        }      }    }	@SuppressWarnings("unchecked")	public void parseType(Class clazz) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException{		Yts yts = (Yts) clazz.getAnnotation(Yts.class);		if(yts != null){			if(YtsType.util.equals(yts.classType())){				System.out.println("this is a util class");			}else{				System.out.println("this is a other class");			}		}	}	}

前一个方法是解析得到方法注解的,后一个方法是得到类注解的

以下是测试方法类

[java]
  1. @Yts(classType =YtsType.util) 
  2. publicclass SayHell { 
  3.  
  4.     @HelloWorld(name = " 小明 "
  5.     @Yts 
  6.     publicvoid sayHello(String name){ 
  7.         if(name == null || name.equals("")){ 
  8.             System.out.println("hello world!"); 
  9.         }else
  10.             System.out.println(name + "say hello world!"); 
  11.         } 
  12.     } 
@Yts(classType =YtsType.util)public class SayHell {	@HelloWorld(name = " 小明 ")	@Yts	public void sayHello(String name){		if(name == null || name.equals("")){			System.out.println("hello world!");		}else{			System.out.println(name + "say hello world!");		}	}}
[html]
  1. public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException, InstantiationException { 
  2.         ParseAnnotation parse = new ParseAnnotation(); 
  3.         parse.parseMethod(SayHell.class); 
  4.         parse.parseType(SayHell.class); 
  5.     } 

转载地址:http://wvkyo.baihongyu.com/

你可能感兴趣的文章
3.2 用户组管理
查看>>
awk
查看>>
AliOS Things SMP系统及其在esp32上实现示例
查看>>
postgresql 聚合函数 的编写
查看>>
循环遍历二叉树
查看>>
while循环 和 运算符
查看>>
MySQL压缩包安装
查看>>
SpringMVC参数绑定
查看>>
阿里云MVP:开发者的超能力,用技术创造更好世界
查看>>
云计算教学实践40:open***架构实施方案(一)跨机房异地灾备
查看>>
Vue和React的对比
查看>>
MyBatis 源码解析 —— SqlSessionFactory
查看>>
如何解决CentOS 7.*无法使用tab补全功能
查看>>
ORA-00119: invalid specification for system par...
查看>>
rpc.rstatd-4.0.1.tar.gz安装问题
查看>>
【虚拟化实战】VM设计之三内存资源控制
查看>>
Mysql 时间操作(当天,昨天,7天,30天,半年,全年,季度)
查看>>
Linux+Nginx+MySql+Php既LNMP源码安装
查看>>
BACKUP DATABASE 失败的处理方法
查看>>
NTP服务
查看>>