详解Java注解的实现与使用方法

详解java注解的实现与使用方法

java注解是java5版本发布的，其作用就是节省配置文件，增强代码可读性。在如今各种框架及开发中非常常见，特此说明一下。

如何创建一个注解

每一个自定义的注解都由四个元注解组成，这四个元注解由java本身提供：

@target(elementtype.**)

这是一个枚举，它置顶是该自定义的注解使用的地方，像类、变量、方法等

@retention(retentionpolicy.**)作用是标明注解保存在什么级别，像在编译时、class文件中，vm运行中

@documented 将此注解包含在 javadoc 中 ，它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同

@inherited : 在您定义注解后并使用于程序代码上时，预设上父类别中的注解并不会被继承至子类别中，您可以在定义注解时加上java.lang.annotation.inherited 限定的annotation，这让您定义的annotation型别被继承下来。

介绍完理论，开始代码(talk is cheap,show your code)

package com.yasin.javalearn;

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;

/**
 * 这是一个类级别的注释，这个注释中有一个name字段，默认值是 yasin
 * @author yasin
 *
 */

@target(elementtype.type)
@retention(retentionpolicy.runtime)
@documented
public @interface learn {
  string name() default "yasin";
}

package com.yasin.javalearn;

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;

/**
 * 这是一个变量级别的注解，注解中有一个字段name，默认值是field
 * @author yasin
 *
 */

@target(elementtype.field)
@retention(retentionpolicy.runtime)
@documented
public @interface filedlearn {
  string name() default "field";


}

package com.yasin.javalearn;

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;

/**
 * 这是一个方法级别的注解
 * @author yasin
 *
 */

@target(elementtype.method)
@retention(retentionpolicy.runtime)
@documented
public @interface methodlearn {
  string name() default "method";

}

上面了我定义了三个注解，分别是常用的类、变量、方法三个级别的注解。

下面我定义一个类，使用这三个注解

package com.yasin.javalearn;

@learn
public class yasin {

  @filedlearn
  public int level;

  @filedlearn(name="xq")
  public string xq;

  public string a;


  @methodlearn(name="test")
  public void setmain(){

  }

  public void seta(){

  }

}

下面就是如何使用这个注解了，注解的提取，都是通过class反射得到相应的变量和方法，在从变量和方法中获得注解。

package com.yasin.javalearn;

import java.lang.reflect.field;
import java.lang.reflect.method;
import java.text.parseexception;
import java.text.simpledateformat;
import java.util.arraylist;
import java.util.date;
import java.util.hashmap;
import java.util.iterator;
import java.util.list;
import java.util.map;

import org.apache.commons.logging.log;
import org.apache.commons.logging.logfactory;
import org.apache.log4j.logger;
import org.apache.log4j.propertyconfigurator;
import org.apache.log4j.xml.domconfigurator;

/**
 * hello world!
 *
 */
public class app {

  public static void main(string[] args) {

    learn learn = yasin.class.getannotation(learn.class);
    system.out.println(learn.name());


    field[] fields = yasin.class.getfields();//获取该类所有的字段

    for(field filed:fields){
      if(filed.isannotationpresent(filedlearn.class)){//校验该字段是否添加这个注解
        system.out.println(filed.getname());
        filedlearn filedlearn = filed.getannotation(filedlearn.class);
        system.out.println(filedlearn.name());
      }
    }

    method[] methods = yasin.class.getmethods();
    for(method method:methods){
      if(method.isannotationpresent(methodlearn.class)){//校验该方法是否有这个注解
        system.out.println(method.getname());
        methodlearn methodlearn = method.getannotation(methodlearn.class);
        system.out.println(methodlearn.name());
      }

    }


  }
}

如有疑问请留言或者到本站社区交流讨论，感谢阅读，希望能帮助到大家，谢谢大家对本站的支持！