当前位置: 代码网 > it编程>编程语言>Java > java自定注解完整示例代码

java自定注解完整示例代码

2026年01月14日 Java 我要评论
1 理解java注解实际上java注解与普通修饰符(public、static、void等)的使用方式并没有多大区别,下面的例子是常见的注解:public class annotationdemo {

1 理解java注解

实际上java注解与普通修饰符(public、static、void等)的使用方式并没有多大区别,下面的例子是常见的注解:

public class annotationdemo {
    //@test注解修饰方法a
    @test
    public static void a(){
        system.out.println("test.....");
    }

    //一个方法上可以拥有多个不同的注解
    @deprecated
    @suppresswarnings("uncheck")
    public static void b(){

    }
}

@test实际上是一种标记注解,起标记作用,运行时告诉测试框架该方法为测试方法。
而对于@deprecated和@suppresswarnings(“uncheck”),则是java本身内置的注解,在代码中,可以经常看见它们。

2 java内置标准注解

javase中内置三个标准注解,定义在java.lang中:

  • @override:用于修饰此方法覆盖了父类的方法;
  • @deprecated:用于修饰已经过时的方法;
  • @suppresswarnnings:用于通知java编译器禁止特定的编译警告。

2.1@override

用于标明此方法覆盖了父类的方法。

2.2@deprecated

用于标明已经过时的方法或类。用 @deprecated 注释的程序元素,不鼓励程序员使用这样的元素,通常是因为它很危险或存在更好的选择。在使用不被赞成的程序元素或在不被赞成的代码中执行重写时,编译器会发出警告。

2.3@suppresswarnnings

用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告。suppresswarnings annotation类型只定义了一个单一的成员,所以只有一个简单的value={…}作为name=value对。又由于成员值是一个数组,故使用大括号来声明数组值。

其数组的值可以为下来枚举:

  • deprecation:使用了不赞成使用的类或方法时的警告;
  • unchecked:执行了未检查的转换时的警告,例如当使用集合时没有用泛型 (generics) 来指定集合保存的类型;
  • fallthrough:当 switch 程序块直接通往下一种情况而没有 break 时的警告;
  • path:在类路径、源文件路径等中有不存在的路径时的警告;
  • serial:当在可序列化的类上缺少 serialversionuid 定义时的警告;
  • finally:任何 finally 子句不能正常完成时的警告;
  • all:关于以上所有情况的警告。

注意:我们可以在下面的情况中缩写annotation:当annotation只有单一成员,并成员命名为"value=“。这时可以省去"value=”。如:

    @suppresswarnings({"unchecked","deprecation"})
    public void test1() {
    }

3 注解基础

3.1 注解分类

根据注解参数的个数,注解分为标记注解、单值注解、完整注解三类。

(1)标记注解:一个没有成员定义的annotation类型被称为标记注解。如:@test@inherited@documented

(2)单值注解:只有一个值

(3)完整注解:拥有多个值。

根据注解使用方法和用途:

(1)jdk内置系统注解

(2)元注解

(3)自定义注解

3.2 元注解

所谓元注解就是标记其他注解的注解。

java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。

3.2.1 @target

表示该注解用于什么地方,可能的值在枚举类elemenettype

类型枚举说明
elemenettype.constructor标明注解可以用于构造函数声明
elemenettype.field标明该注解可以用于字段(域)声明,包括enum实例
elemenettype.local_variable标明注解可以用于局部变量声明
elemenettype.method标明该注解可以用于方法声明
elemenettype.package标明注解可以用于包声明
elemenettype.parameter标明该注解可以用于参数声明
elemenettype.type标明该注解可以用于类、接口(包括注解类型)或enum声明
elemenettype.annotation_type标明注解可以用于注解声明(应用于另一个注解上)
elemenettype.type_parameter标明注解可以用于类型参数声明(1.8新加入)
elemenettype.type_use类型使用声明(1.8新加入)

示例1:

@target(elementtype.type)
public @interface table {
    /**
     * 数据表名称注解,默认值为类名称
     * @return
     */
    public string tablename() default "classname";
}

@target(elementtype.field)
public @interface nodbcolumn {
}

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

3.2.2 @retention

用来约束注解的生命周期。可选的参数值在枚举类型retentionpolicy中,分别有三个值,源码级别(source),类文件级别(class)或者运行时级别(runtime)。

类型枚举说明
retentionpolicy.source注解将被编译器丢弃(该类型的注解信息只会保留在源码里,源码经过编译后,注解信息会被丢弃,不会保留在编译好的class文件里,如@override
retentionpolicy.class注解在class文件中可用,但会被vm丢弃(该类型的注解信息会保留在源码里和class文件里,在执行的时候,不会加载到虚拟机中),请注意,当注解未定义retention值时,默认值是class
retentionpolicy.runtime注解信息将在运行期(jvm)也保留,因此可以通过反射机制读取注解的信息(源码、class文件和执行的时候都有注解的信息),如springmvc中的@controller、@autowired、@requestmapping等。这也是我们常用的。

示例1:

@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,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理。

3.2.3 @documented

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

3.2.4 @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类型被发现,或者到达类继承结构的顶层。

3.3 注解支持的数据类型

注解支持的元素数据有:

  • 所有基本类型(int,float,boolean,byte,double,char,long,short)
  • string
  • class
  • enum
  • annotation
  • 上述类型的数组

注意:倘若使用了其他数据类型,编译器将会丢出一个编译错误,注意,声明注解元素时可以使用基本类型但不允许使用任何包装类型,同时还应该注意到注解也可以作为元素的类型,也就是嵌套注解(springboot中多为嵌套注解)。

示例1

@target(elementtype.type)
@retention(retentionpolicy.runtime)
@interface reference{
    boolean next() default false;
}

public @interface annotationelementdemo {
    //枚举类型
    enum status {fixed,normal};

    //声明枚举
    status status() default status.fixed;

    //布尔类型
    boolean showsupport() default false;

    //string类型
    string name()default "";

    //class类型
    class<?> testcase() default void.class;

    //注解嵌套
    reference reference() default @reference(next=true);

    //数组类型
    long[] value();
}

3.4 编译器对默认值的限制

编译器对元素的默认值有些过分挑剔。首先,元素不能有不确定的值。也就是说,元素必须要么具有默认值,要么在使用注解时提供元素的值。其次,对于非基本类型的元素,无论是在源代码中声明,还是在注解接口中定义默认值,都不能以null作为值,这就是限制,没有什么利用可言,但造成一个元素的存在或缺失状态,因为每个注解的声明中,所有的元素都存在,并且都具有相应的值,为了绕开这个限制,只能定义一些特殊的值,例如空字符串或负数,表示某个元素不存在。
如:@test

@retention(retentionpolicy.runtime)
@target({elementtype.method})
public @interface test {

    /**
     * default empty exception
     */
    static class none extends throwable {
        private static final long serialversionuid = 1l;

        private none() {
        }
    }

    class<? extends throwable> expected() default none.class;

    long timeout() default 0l;
}

3.5 注解不支持继承

注解是不支持继承的,因此不能使用关键字extends来继承某个@interface,但注解在编译后,编译器会自动继承java.lang.annotation.annotation接口。

3.6 快捷方式

所谓的快捷方式就是注解中定义了名为value的元素,并且在使用该注解时,如果该元素是唯一需要赋值的一个元素,那么此时无需使用key=value的语法,而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素,记住,这限制了元素名必须为value。

如:2.3节的示例中。

4 自定义注解

使用@interface自定义注解时,自动继承了java.lang.annotation.annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。

4.1 注解示例

先看一个java的注解类@deprecated的源码:

import java.lang.annotation.*;
import static java.lang.annotation.elementtype.*;

@documented
@retention(retentionpolicy.runtime)
@target(value={constructor, field, local_variable, method, package, parameter, type})
public @interface deprecated {
}

(1)首先,使用@interface声明了deprecated注解

(2)其次,使用@target注解传入{constructor, field, local_variable, method, package, parameter, type}参数,来标明@deprecated可以用在构造器,字段,局部变量,方法,包,参数,类或接口上。

(3)再者,使用@retention(retentionpolicy.runtime)则用来表示该注解生存期是运行时。

(4)最后,使用@documented则用来表明,当前注解在生成javadoc时需要展示,否则不予显示。

从代码上看注解的定义很像接口的定义,确实如此,毕竟在编译后也会生成deprecated.class文件。对于@target@retention,@documented是由java提供的元注解。

4.2 定义注解格式

@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、class、string、enum)。可以通过default来声明参数的默认值。
public @interface 注解名{定义体s}

4.3 注解参数(即方法)

注解里面的每一个方法实际上就是声明了一个配置参数,其规则如下:

①修饰符

只能用public或默认(default)这两个访问权修饰 ,默认为default

②类型

注解参数只支持以下数据类型:

  • 基本数据类型(int,float,boolean,byte,double,char,long,short);
  • string类型;
  • class类型;
  • enum类型;
  • annotation类型;
  • 以上所有类型的数组

③命名

对取名没有要求,如果只有一个参数成员,最好把参数名称设为"value",后加小括号。

④参数

注解中的方法不能存在参数

⑤默认值

可以包含默认值,使用default来声明默认值。

4.4 示例

以下举两个例子:

logtreadannotation 使用log4j2时,控制多线程中线程日志数据的注解。

/**
 * @author pangzi
 * @version v1.0
 * @description log4j多线程日志输出注解
 *    使用该注解的方法,其运行日志除了在正常的log文件中输出外。
 *    还会在 thread目录下 job:uuid-yyyymmdd.log 文件中输出。
 * @date 2019-11-02 16:34
 */
@documented
@retention(retentionpolicy.runtime)
@target(elementtype.method)
public @interface logtreadannotation {
}

datasource 多数据源切换注解

/**
 * @author pangzi
 * @version v1.0
 * @description 用于aop类中当作切入点来选择数据源
 * @date 2019-06-03 14:43
 */
@target({elementtype.method})
@retention(retentionpolicy.runtime)
@documented
public @interface datasource {
    datasourceenum value() default datasourceenum.mysql;
}

5 注解处理器

如果没有用来读取注解的方法和工作,那么注解也就不会比注释更有用处了。使用注解的过程中,很重要的一部分就是创建于使用注解处理器。

5.1 反射机制

retention.runtime时,java使用annotation接口来代表程序元素前面的注解,该接口是所有annotation类型的父接口。除此之外,java在java.lang.reflect 包下新增了annotatedelement接口,该接口代表程序中可以接受注解的程序元素,该接口主要有如下几个实现类:

  • class:类定义
  • constructor:构造器定义
  • field:类的成员变量定义
  • method:类的方法定义
  • package:类的包定义

java.lang.reflect 包下主要包含一些实现反射功能的工具类,实际上,java.lang.reflect 包所有提供的反射api扩充了读取运行时annotation信息的能力。当一个annotation类型被定义为运行时的annotation后,该注解才能是运行时可见,当class文件被装载时被保存在class文件中的annotation才会被虚拟机读取。

annotatedelement 接口是所有程序元素(class、method和constructor)的父接口,所以程序通过反射获取了某个类的annotatedelement对象之后,程序就可以调用该对象的如下四个个方法来访问annotation信息(以上5个类都实现以下的方法):

返回值方法名称说明
getannotation(class annotationclass)该元素如果存在指定类型的注解,则返回这些注解,否则返回 null。
annotation[]getannotations()返回此元素上存在的所有注解,包括从父类继承的
booleanisannotationpresent(class<? extends annotation> annotationclass)如果指定类型的注解存在于此元素上,则返回 true,否则返回 false。
annotation[]getdeclaredannotations()返回直接存在于此元素上的所有注解,注意,不包括父类的注解,调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响,没有则返回长度为0的数组
annotation[]getannotationsbytype(class annotationclass)jdk1.8新增
annotation[]getdeclaredannotationsbytype(class annotationclass)jdk1.8新增

示例:

/***********注解声明***************/
/**
 * 水果名称注解
 * @author peida
 *
 */
@target(elementtype.field)
@retention(retentionpolicy.runtime)
@documented
public @interface fruitname {
    string value() default "";
}
/**
 * 水果颜色注解
 * @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;
}

/**
 * 水果供应者注解
 * @author peida
 *
 */
@target(elementtype.field)
@retention(retentionpolicy.runtime)
@documented
public @interface fruitprovider {
    /**
     * 供应商编号
     * @return
     */
    public int id() default -1;
    /**
     * 供应商名称
     * @return
     */
    public string name() default "";
    /**
     * 供应商地址
     * @return
     */
    public string address() default "";
}
/***********注解使用***************/
public class apple {
    @fruitname("apple")
    private string applename;
    @fruitcolor(fruitcolor=color.red)
    private string applecolor;
    @fruitprovider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
    private string appleprovider;
}
/***********注解处理器***************/
public class fruitinfoutil {
    public static void getfruitinfo(class</> clazz){

        string strfruitname=" 水果名称:";
        string strfruitcolor=" 水果颜色:";
        string strfruitprovicer="供应商信息:";

        field[] fields = clazz.getdeclaredfields();

        for(field field :fields){
            if(field.isannotationpresent(fruitname.class)){
                fruitname fruitname = (fruitname) field.getannotation(fruitname.class);
                strfruitname=strfruitname+fruitname.value();
                system.out.println(strfruitname);
            }
            else if(field.isannotationpresent(fruitcolor.class)){
                fruitcolor fruitcolor= (fruitcolor) field.getannotation(fruitcolor.class);
                strfruitcolor=strfruitcolor+fruitcolor.fruitcolor().tostring();
                system.out.println(strfruitcolor);
            }
            else if(field.isannotationpresent(fruitprovider.class)){
                fruitprovider fruitprovider= (fruitprovider) field.getannotation(fruitprovider.class);
                strfruitprovicer=" 供应商编号:"+fruitprovider.id()+" 供应商名称:"+fruitprovider.name()+" 供应商地址:"+fruitprovider.address();
                system.out.println(strfruitprovicer);
            }
        }
    }
}
/***********输出结果***************/
public class fruitrun {
    /**
     * @param args
     */
    public static void main(string[] args) {
        fruitinfoutil.getfruitinfo(apple.class);
    }
}

5.2 springaop

除了通过反射工具自定义注解解释器外,在日常开发中用的最多的就是注解与spring aop结合完成特定的工作。

示例

下面以4.4节中的日志注解为例介绍。

logtreadannotation主要的通途就是,当标注@logtreadannotation方法执行时,会根据方法参数判断,如果参数不一致,则整个方法及后续方法的日志都输出在一个log文件中,即每次标注@logtreadannotation方法的日志都会在不同的日志文件中。

/**
 * @author pangzi
 * @version v1.0
 * @description log4j多线程日志输出注解
 *    使用该注解的方法,其运行日志除了在正常的log文件中输出外。
 *    还会在 thread目录下 job:uuid-yyyymmdd.log 文件中输出。
 * @date 2019-11-02 16:34
 */
@documented
@retention(retentionpolicy.runtime)
@target(elementtype.method)
public @interface logtreadannotation {
}

/**
 * @author pangzi
 * @version v1.0
 * @description log4j多线程日志控制切面
 * @date 2019-11-02 16:30
 */
@component      //声明组件
@aspect         //声明切面
@componentscan  //组件自动扫描
@enableaspectjautoproxy //spring自动切换jdk动态代理和cglib
public class logtreadrecordaspect {

    @pointcut("@annotation(com.zznode.gum.task.core.aop.logtreadannotation)")
    public void addlogtread(){}

    @before("addlogtread()")
    public void beforeadvide(){
        //todo 操作日志@before 方法执行前
    }

    @after("addlogtread()")
    public void afteradvide() {
        //todo 操作日志@after 方法执行后
    }

    @around("addlogtread()")
    public void aroundavide(proceedingjoinpoint pjp) throws throwable {
        //操作日志@around 方法执行前
        object[] args = pjp.getargs();
        if(args != null && args.length >1) {
           string jobid = args[0].tostring();
           string uuid = args[1].tostring();
           logutils.logthreadbegin(jobid+":"+uuid);
        }
        //方法执行
        pjp.proceed();

        //操作日志@around 方法执行后
        logutils.logtreadend();
    }
}

/**
 * @author pangzi
 * @version v1.0
 * @description log4j2多线程输出日志工具类
 * @date 2019-11-02 15:07
 */
public class logutils {

    /**
     * 开始日志输出到指定线程
     * @param key
     */
    public static void logthreadbegin(string key) {
        threadcontext.put("jobuuid",key);
    }

    /**
     * 结束日志输出
     */
    public static void logtreadend() {
        threadcontext.remove("jobuuid");
    }
}

使用

/**
 * @author pangzi
 * @version v1.0
 * @description 数据汇聚计算controller
 * @date 2019-09-16 14:20
 */
@slf4j
@restcontroller
@requestmapping("/dataconverge")
@api(value = "数据计算任务restful")
public class dataconvergecontroller {

    @autowired
    private dataconvergeservice dataconvergeservice;

    @apioperation(value = "报表指标天汇聚计算任务", notes = "报表指标天汇聚计算任务")
    @getmapping("/rptindexdayconverge")
    @apiimplicitparams({
            @apiimplicitparam(name = "jobid", value = "任务编号", required = true, datatype = "string", paramtype = "query"),
            @apiimplicitparam(name = "uuid", value = "任务实例编号", required = true, datatype = "string", paramtype = "query")
    })
    @responsebody
    @logtreadannotation
    protected result<string> rptindexdayconverge(@requestparam(name="jobid") string  jobid,
                                                 @requestparam(name="uuid") string  uuid) {
        dataconvergeserviceah.rptindexdayconverge(jobid,uuid);
        //返回处理中
        return new result<>(enumresult.executing.getindex(), enumresult.executing.getname());
    }

另附 log4j2.xml配置

<?xml version="1.0" encoding="utf-8"?>
<configuration status="warn" monitorinterval="60">
    <properties>
        <property name="pattern">%d{default} [%t] %-5p %c{1.}.%m %l - %msg%xex%n</property>
    </properties>
    <appenders>
        <console name="console" target="system_out">
            <thresholdfilter level="info" onmatch="accept" onmismatch="deny" />
            <patternlayout pattern="${pattern}" />
        </console>

        <rollingfile name="trace" filename="${sys:app.log.home}/task-all.log" filepattern="${sys:app.log.home}/$${date:yyyy-mm}/task-all-%d{mm-dd-yyyy}-%i.log.gz">
            <thresholdfilter level="trace" onmatch="accept" onmismatch="deny" />
            <patternlayout pattern="${pattern}" />
            <sizebasedtriggeringpolicy size="20mb" />
        </rollingfile>

        <rollingfile name="debug" filename="${sys:app.log.home}/task-debug.log" filepattern="${sys:app.log.home}/$${date:yyyy-mm}/task-debug-%d{mm-dd-yyyy}-%i.log.gz">
            <thresholdfilter level="debug" onmatch="accept" onmismatch="deny" />
            <patternlayout pattern="${pattern}" />
            <sizebasedtriggeringpolicy size="20mb" />
        </rollingfile>

        <rollingfile name="info" filename="${sys:app.log.home}/task-info.log" filepattern="${sys:app.log.home}/$${date:yyyy-mm}/task-info-%d{mm-dd-yyyy}-%i.log.gz">
            <thresholdfilter level="info" onmatch="accept" onmismatch="deny" />
            <patternlayout pattern="${pattern}" />
            <sizebasedtriggeringpolicy size="20mb" />
        </rollingfile>

        <rollingfile name="error" filename="${sys:app.log.home}/task-error.log" filepattern="${sys:app.log.home}/$${date:yyyy-mm}/task-error-%d{mm-dd-yyyy}-%i.log.gz">
            <thresholdfilter level="error" onmatch="accept" onmismatch="deny" />
            <patternlayout pattern="${pattern}" />
            <sizebasedtriggeringpolicy size="20mb" />
        </rollingfile>

        <routing name="thread">
            <routes pattern="$${ctx:jobuuid}">
                <route>
                    <file name="file-${ctx:jobuuid}" filename="${sys:app.log.home}/threads/${ctx:jobuuid}.log">
                        <thresholdfilter level="debug" onmatch="accept" onmismatch="deny" />
                        <patternlayout pattern="${pattern}" />
                    </file>
                </route>
            </routes>
        </routing>
    </appenders>

    <!--然后定义logger,只有定义了logger并引入的appender,appender才会生效 -->
    <loggers>
        <!--过滤掉spring和mybatis的一些无用的debug信息 -->
        <logger name="org.springframework" level="info" />
        <logger name="org.mybatis" level="debug" />
        <logger name="springfox.documentation" level="error" />
        <logger name="io.netty" level="info" />
        <logger name="org.apache" level="info" />
        <logger name="reactor.util" level="info" />
        <logger name="org.flowable" level="info" />
        <logger name="com.test" level="debug" />
        <logger name="io.lettuce" level="info" />
        <logger name="org.quartz" level="info" />
        <logger name="org.hibernate.validator" level="info" />

        <root level="trace">
            <appender-ref ref="console" />
            <appender-ref ref="trace" />
            <appender-ref ref="debug" />
            <appender-ref ref="info" />
            <appender-ref ref="error" />
            <appender-ref ref="thread" />
        </root>
    </loggers>
</configuration>

5.3 spring ioc

除了配置aop之外,其次就是结合ioc,直接从ioc容器中拿取标注了指定注解的bean。

5.3.1 注解

@target(elementtype.type)
@retention(retentionpolicy.runtime)
@documented
public @interface columncommandorder {
    /**
     * 默认值处理顺序
     * @return 序号
     */
    int valueorder() default 99;

    /**
     * 检查处理顺序
     * @return 序号
     */
    int checkorder() default 99;

    /**
     * 指定报文类型。
     * 只有指定的报文类型,才使用该command
     * @return 报文类型数组
     */
    string[] telextype() default {analyseconstants.telex_type_notamncr};
}

5.3.2 注解解析

通过ioc获取标注了该注解的类实例。

(1)applicationcontext的工具类

@component
public class analyseservicecontext implements applicationcontextaware {

    private static applicationcontext applicationcontext=null;

    @override
    public void setapplicationcontext(applicationcontext applicationcontext) throws beansexception {
        analyseservicecontext.applicationcontext = applicationcontext;
    }

    public static <t> t getbean(string beanname) {
        return (t)applicationcontext.getbean(beanname);
    }

    public static <t> t getbean(class<t> clazz) {
        return applicationcontext.getbean(clazz);
    }

    public static map<string,object> getbeanmap(class<? extends annotation> tclass) {
          return applicationcontext.getbeanswithannotation(tclass);
    }

    public static <t> map<string,t> getbeansoftype(class<t> clazz) {
        return applicationcontext.getbeansoftype(clazz);
    }
}

注解解析

public class telexbusinesscheckparserhandler implements itelexparserhandler{
    @override
    public void parsertelex(itelexbusinesshandler businesshandler) {
        if (businesshandler.iserrorout()) {
            return;
        }
        treemap<integer, itelexcolumnparsercommand> commandtreemap= maps.newtreemap();
        map<string,object> maps = analyseservicecontext.getbeanmap(columncommandorder.class);
        for (map.entry<string, object> bean: maps.entryset()) {
            object obj = bean.getvalue();
            columncommandorder annotation = obj.getclass().getannotation(columncommandorder.class);
            if (null!=annotation) {
                int order = annotation.checkorder();
                commandtreemap.put(order, (itelexcolumnparsercommand) obj);
            }
        }

        commandtreemap.foreach((k,v)->{
            v.setbusinesshandler(businesshandler);
            if (log.isdebugenabled()) {
                log.debug("业务规则判断{},处理类{}",k,v.getclass().getsimplename());
            }
            try {
                columncommandorder annotation = v.getclass().getannotation(columncommandorder.class);
                if (arrayutils.contains(annotation.telextype(),
                        businesshandler.getoutputtype().getapplicationcode())) {
                    v.columncheckhandler();
                }
            } catch (exception e) {
                log.error("业务规则判断{},处理类{},异常{}",k,v.getclass().getsimplename(),e);
            }
        });
    }
}

5.3.3 注解标注

@slf4j
@component
@columncommandorder(valueorder = 12,checkorder = 12)
public class itembparsercommand extends abstractcolunmparsercommand {
...
}

6 java 8中注解增强

对于元注解,java 8 主要有两点改进:类型注解和重复注解。

6.1 重复注解

元注解@repeatable是jdk1.8新加入的,它表示在同一个位置重复相同的注解。在没有该注解前,一般是无法在同一个类型上使用相同的注解的。

//java8前无法这样使用
@filterpath("/web/update")
@filterpath("/web/add")
public class a {}

java8前如果是想实现类似的功能,我们需要在定义@filterpath注解时定义一个数组元素接收多个值如下:

@target(elementtype.type)
@retention(retentionpolicy.runtime)
public @interface filterpath {
    string [] value();
}

//使用
@filterpath({"/update","/add"})
public class a { }

但在java8新增了@repeatable注解后就可以采用如下的方式定义并使用了

//使用java8新增@repeatable原注解
@target({elementtype.type,elementtype.field,elementtype.method})
@retention(retentionpolicy.runtime)
@repeatable(filterpaths.class)//参数指明接收的注解class
public @interface filterpath {
    string  value();
}

// 自定义一个包装类filterpaths注解用来放置一组具体的filterpath注解
@target(elementtype.type)
@retention(retentionpolicy.runtime)
@interface filterpaths {
    filterpath[] value();
}

// 使用案例新方法
@filterpath("/web/update")
@filterpath("/web/add")
class aa{ }

// 使用案例旧方法
@filterpaths ({@filterpath("/web/update"), @filterpath("/web/add")}) 
class aa{ }

见5.1节,为了处理上述的新增注解,java8还在annotatedelement接口新增了getdeclaredannotationsbytype() getannotationsbytype()两个方法并在接口给出了默认实现,在指定@repeatable的注解时,可以通过这两个方法获取到注解相关信息。

注意:

  • 旧版api中的getdeclaredannotation()getannotation()是不对@repeatable注解的处理的(除非该注解没有在同一个声明上重复出现)。
  • getdeclaredannotationsbytype方法获取到的注解不包括父类,其实当 getannotationsbytype()方法调用时,其内部先执行了getdeclaredannotationsbytype方法,只有当前类不存在指定注解时,getannotationsbytype()才会继续从其父类寻找,但请注意如果@filterpath@filterpaths没有使用了@inherited的话,仍然无法获取。

6.2 类型注解

6.2.1 注解使用的范围。

在java 8之前,注解只能是在声明的地方所使用,java8开始,注解可以应用在任何地方。

  • type_use则可以用于标注任意类型(不包括class)
// 用于构造函数,创建类实例
new@interned myobject();

// 用于强制类型转换和instanceof检查,注意这些注解中用于外部工具,它们不会对类型转换或者instanceof的检查行为带来任何影响。
mystring = (@nonnull string) str;
if(input instanceof @nonnull string)

// 用于父类或者接口
class image implements @rectangular shape { }

// 用于指定异常
void monitortemperature() throws @critical temperatureexception { ... }
  • type_parameter 标注在类型参数上
// 标注在类型参数上
class d<@parameter t> { }

注意:

  • 在java 8里面,当类型转化甚至分配新对象的时候,都可以在声明变量或者参数的时候使用注解。
  • java注解可以支持任意类型。
  • 类型注解只是语法而不是语义,并不会影响java的编译时间,加载时间,以及运行时间,也就是说,编译成class文件的时候并不包含类型注解。

由上面的注解使用范围的变更,引出elementtype新增的两个类型。

6.2.2 新增的两种elementtype

新增的两个注释的程序元素类型 elementtype.type_useelementtype.type_parameter用来描述注解的新场合 。

  • elementtype.type_parameter 表示该注解能写在类型变量的声明语句中。
  • elementtype.type_use 表示该注解能写在使用类型的任何语句中(eg:声明语句、泛型和强制转换语句中的类型)。
@target({elementtype.type_parameter, elementtype.type_use})
@interface myannotation {}

6.2.3 类型注解的作用

类型注解被用来支持在java的程序中做强类型检查。配合第三方插件工具checker framework,可以在编译的时候检测出runtime error(eg:unsupportedoperationexception; numberformatexception;nullpointerexception异常等都是runtime error),以提高代码质量。这就是类型注解的作用。

注意:

使用checker framework可以找到类型注解出现的地方并检查。

总结

到此这篇关于java自定注解的文章就介绍到这了,更多相关java自定注解内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!

(0)

相关文章:

版权声明:本文内容由互联网用户贡献,该文观点仅代表作者本人。本站仅提供信息存储服务,不拥有所有权,不承担相关法律责任。 如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 2386932994@qq.com 举报,一经查实将立刻删除。

发表评论

验证码:
Copyright © 2017-2026  代码网 保留所有权利. 粤ICP备2024248653号
站长QQ:2386932994 | 联系邮箱:2386932994@qq.com