当前位置:  编程技术>java/j2ee

基于Java注解(Annotation)的自定义注解入门介绍

    来源: 互联网  发布时间:2014-10-23

    本文导语:    要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。 -------------------------------------------------------------------------------- 元...

  要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。

--------------------------------------------------------------------------------

元注解:

  元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
    1.@Target,
    2.@Retention,
    3.@Documented,
    4.@Inherited
  这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

--------------------------------------------------------------------------------

  @Target:

   @Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

  作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

  取值(ElementType)有:

    1.CONSTRUCTOR:用于描述构造器
    2.FIELD:用于描述域
    3.LOCAL_VARIABLE:用于描述局部变量
    4.METHOD:用于描述方法
    5.PACKAGE:用于描述包
    6.PARAMETER:用于描述参数
    7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

  使用实例:  

代码如下:

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解,默认值为类名称
     * @return
     */
    public String tableName() default "className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}


  注解Table 可以用于注解类、接口(包括注解类型) 或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

--------------------------------------------------------------------------------

  @Retention:

  @Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

  作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

  取值(RetentionPoicy)有:

    1.SOURCE:在源文件中有效(即源文件保留)
    2.CLASS:在class文件中有效(即class保留)
    3.RUNTIME:在运行时有效(即运行时保留)

  Retention meta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下:

代码如下:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField";
    public boolean defaultDBValue() default false;
}

   Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理

--------------------------------------------------------------------------------

  @Documented:

  @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。

代码如下:

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField";
    public boolean defaultDBValue() default false;
}

  @Inherited:

  @Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

  注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

  当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。

  实例代码:

代码如下:

/**
 *
 * @author peida
 *
 */
@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}


--------------------------------------------------------------------------------

自定义注解:

  使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

  定义注解格式:
  public @interface 注解名 {定义体}

  注解参数的可支持数据类型:

    1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
    2.String类型
    3.Class类型
    4.enum类型
    5.Annotation类型
    6.以上所有类型的数组

  Annotation类型里面的参数该怎么设定:
  第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;   
  第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;  
  第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

  简单的自定义注解和使用注解实例:

代码如下:

package 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;

/**
 * 水果名称注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}


代码如下:

package 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;

/**
 * 水果颜色注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 颜色枚举
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};

    /**
     * 颜色属性
     * @return
     */
    Color fruitColor() default Color.GREEN;

}


代码如下:

package annotation;

import annotation.FruitColor.Color;

public class Apple {

    @FruitName("Apple")
    private String appleName;

    @FruitColor(fruitColor=Color.RED)
    private String appleColor;

   

   
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }

   
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }

    public void displayName(){
        System.out.println("水果的名字是:苹果");
    }
}


  定义了注解,并在需要的时候给相关类,类属性加上注解信息,如果没有响应的注解信息处理流程,注解可以说是没有实用价值。如何让注解真真的发挥作用,主要就在于注解处理方法,下一步我们将通过注解实现一个简单的ORM,来深入学习注解,来利用注解!

    
 
 

您可能感兴趣的文章:

  • Java的UIMA注解类 uimaFIT
  • Java8新特性之重复注解(repeating annotations)浅析
  • java自定义注解接口实现方案
  • java扩展Hibernate注解支持java8新时间类型
  • Java注解之Retention、Documented、Inherited介绍
  • Java注解详细介绍
  • Java8中的类型注解浅析
  • java教程之java注解annotation使用方法
  • JAVA annotation入门基础 iis7站长之家
  • 基于Java 注解(Annotation)的基本概念详解
  • Java Annotation(Java 注解)的实现代码
  • java命名空间java.lang.annotation接口annotation的类成员方法: annotationtype定义及介绍
  • Java Annotation Overview详解
  • java命名空间java.text类annotation的类成员方法: annotation定义及介绍
  • JAVA annotation入门基础
  • java命名空间java.lang.annotation枚举elementtype的类成员方法: annotation_type定义及介绍
  • java命名空间java.lang.annotation接口annotation的类成员方法: tostring定义及介绍
  • java命名空间java.lang.annotation接口annotation的类成员方法: hashcode定义及介绍
  • java命名空间java.lang.annotation接口annotation的类成员方法: equals定义及介绍
  • java命名空间javax.tools枚举standardlocation的类成员方法: annotation_processor_path定义及介绍
  • java命名空间javax.lang.model.element枚举elementkind的类成员方法: annotation_type定义及介绍
  • java命名空间java.text类annotation的类成员方法: tostring定义及介绍
  • java命名空间javax.annotation注释类型resource的类成员方法: authenticationtype定义及介绍
  • java命名空间javax.xml.bind.annotation注释类型xmlaccessororder的类成员方法: value定义及介绍
  • java命名空间javax.xml.bind.annotation注释类型xmlelement的类成员方法: type定义及介绍
  • java命名空间java.lang.annotation类incompleteannotationexception的类成员方法: incompleteannotationexception定义及介绍
  • java命名空间javax.xml.bind.annotation注释类型xmlschematype的类成员方法: type定义及介绍
  • java命名空间javax.xml.bind.annotation注释类型xmlschema的类成员方法: attributeformdefault定义及介绍
  • java命名空间javax.xml.bind.annotation注释类型xmlschema的类成员方法: elementformdefault定义及介绍
  • java命名空间java.lang.annotation枚举elementtype的类成员方法: field定义及介绍
  • java命名空间java.lang.annotation枚举elementtype的类成员方法: method定义及介绍
  •  
    本站(WWW.)旨在分享和传播互联网科技相关的资讯和技术,将尽最大努力为读者提供更好的信息聚合和浏览方式。
    本站(WWW.)站内文章除注明原创外,均为转载、整理或搜集自网络。欢迎任何形式的转载,转载请注明出处。












  • 相关文章推荐
  • 请问:java 入门以及学好Java要看哪些书籍阿????
  • 谢谢推荐几本关于JAVA入门好书?
  • JAVA 怎么入门?
  • 请推荐几本java的入门和提高书籍.
  • 大家觉得java.sun.com上的Java Tutorial写的如何?我觉得是最好的入门教材
  • 请大家介绍一下java BEAN的入门读物吧
  • 谁能告诉我JAVA怎样快速的入门?
  • 请问JAVA怎么入门?
  • 介绍一本真正好的java入门到提高的书吧!!!
  • JAVA入门者问题!
  • 哪位仁兄能给小弟推荐基本java的入门好书
  • 那里有Java的入门书下栽?
  • Java入门
  • 最入门级的java问题,如何运行HelloWorld.java
  • 请帮忙介绍一本java入门的书, 给分啦!
  • 请问大家入门JAVA比较好的书是?谢了
  • 给哥们介绍一个JAVA入门的好教材吧:)
  • 各位老兄,我刚入门怎么样才能学好JAVA呢?
  • 小弟想转学java 希望大家推荐基本入门的书籍,最好是可以下载的,谢谢!
  • 请大家介绍一本Java入门的好书
  • java命名空间java.sql类types的类成员方法: java_object定义及介绍
  • 我想学JAVA ,是买THINK IN JAVA 还是JAVA2核心技术:卷1 好???
  • java命名空间java.awt.datatransfer类dataflavor的类成员方法: imageflavor定义及介绍
  • 请问Java高手,Java的优势在那里??,Java主要适合于开发哪类应用程序
  • java命名空间java.lang.management类managementfactory的类成员方法: getcompilationmxbean定义及介绍
  • 如何将java.util.Date转化为java.sql.Date?数据库中Date类型对应于java的哪个Date呢
  • java命名空间java.lang.management接口runtimemxbean的类成员方法: getlibrarypath定义及介绍
  • 谁有电子版的《Java编程思想第二版(Thinking in java second)》和《Java2编程详解(special edition java2)》?得到给分
  • java命名空间java.lang.management接口runtimemxbean的类成员方法: getstarttime定义及介绍
  • 本人想学java,请问java程序员的待遇如何,和java主要有几个比较强的方向
  • java命名空间java.awt.datatransfer类dataflavor的类成员方法: stringflavor定义及介绍


  • 站内导航:


    特别声明:169IT网站部分信息来自互联网,如果侵犯您的权利,请及时告知,本站将立即删除!

    ©2012-2021,,E-mail:www_#163.com(请将#改为@)

    浙ICP备11055608号-3