Java—自定义注解的实现

一、关于注解

注解是Java中的一个常见特性,如果当前类继承自某个父类或者实现了某个接口,那么继承(实现)的方法上会包含一个@override注解,表示当前这个方法重写了父类或者接口的方法。@override注解的功能比较简单,只是让开发人员意识到当前方法是重写的,该注解在编译时就会被丢弃。而平时我们所使用的一些框架内的注解都是需要在运行时获得其注解的类或对象的,因此级别与override注解不同。

二、 元注解

自定义注解时,需要使用元注解对自定义注解进行修饰,因此元注解就是修饰注解的注解。Java提供的4种元注解如下:

注解 作用 属性 取值
@Target 标识注解所使用的范围 ElementType CONSTRUCTOR:构造器的声明
FIELD:域声明(包括enum实例)
LOCAL_VARIABLE:局部变量声明
METHOD:方法声明
PACKAGE:包声明
PARAMETER:参数声明
TYPE:类、接口(包括注解类型)或enum声明
@Retention 表示需要在什么级别保存该注解信息 RetentionPolicy SOURCE:注解将被编译器丢弃
CLASS:注解在class文件中可用,但会被虚拟机丢弃
RUNTIME:虚拟机将在运行期间保留注解,因此可以通过反射机制读取注解的信息
@Document 在javadoc中包含注解
@Inherited 允许子类继承该注解

三、注解的实现与应用

自定义注解一般为运行时注解,通过反射找到添加该注解的类、方法或属性,然后根据注解中的字段取值判断该类或方法是否符合标准。
注解中的参数支持以下类型及其数组,注解的参数必须有确定的默认值,要么在定义时给定,要么在使用注解时给定。

1. 基本类型:byte, short, char, int, long, float, double
2. String
3. Class
4. enum
5. Annotation

通过反射获取注解上的类、方法和属性时,主要使用以下方法。

1. 判断该元素是否被annotationClass注解修饰
boolean is AnnotationPresent(Class<?extends Annotation> annotationClass)
2. 获取 该元素上annotationClass类型的注解,如果没有返回null
<T extends Annotation> T getAnnotation(Class<T> annotationClass)
3. 返回该元素上所有的注解
Annotation[] getAnnotations()
4. 返回该元素上指定类型所有的注解
<T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)
5. 返回直接修饰该元素的所有注解
Annotation[] getDeclaredAnnotations()
6. 返回直接修饰该元素的所有注解
<T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)

3.1 实例:通过注解表示任务

这是一个经典的例子,在某个方法上添加注解,标注该方法的优先级和完成度,随后可以通过反射获取到这些方法的优先级信息。
注解定义如下,这是一个添加在方法上的注解,属性包括作者、优先级和状态,并为每个属性定义了一个默认值。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
    public enum Priority {LOW, MEDIUM, HIGH}
    public enum Status {STARTED, NOT_STARTED}    
    String author() default "Author";
    Priority priority() default Priority.LOW;
    Status status() default Status.NOT_STARTED;
}

随后为工作类中的方法添加注解,标明其优先级和进度。

public class BusinessLogic {
    public BusinessLogic() {
        super();
    }
    
    @Todo(priority = Todo.Priority.HIGH)
    public void notYetStartedMethod() {
    }
    
    @Todo(priority = Todo.Priority.MEDIUM, author = "Uday", status = Todo.Status.STARTED)
    public void incompleteMethod1() {
    }

    @Todo(priority = Todo.Priority.LOW, status = Todo.Status.STARTED )
    public void incompleteMethod2() {
    }
}

通过反射取出某个类中所有带有该注解的方法。

Class businessLogicClass = BusinessLogic.class;
for(Method method : businessLogicClass.getMethods()) {
Todo todoAnnotation = (Todo)method.getAnnotation(Todo.class);
    if(todoAnnotation != null) {
        System.out.println(" Method Name : " + method.getName());
        System.out.println(" Author : " + todoAnnotation.author());
        System.out.println(" Priority : " + todoAnnotation.priority());
        System.out.println(" Status : " + todoAnnotation.status());
    }
}

3.2 实例:通过注解判断属性是否符合要求

上面介绍了注解在方法上的应用,这里介绍一个注解在类和属性上的结合应用。主要通过注解来判断当前实体类中String的长度是否符合标准。
首先需要定义在类和属性上的2个注解。
实体类注解:

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface EntityCheck {
    
    String entityName();
    
}

属性注解:

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldCheck {
    
    int min() default 0;
    int max() default 0;
    String error();
    
}

使用注解时分别在实体类以及实体类中需要进行长度限制的String字段上进行注解。当字段的长度与期望不符时,通过error进行提示。

@EntityCheck(entityName = "Entity")
public class Entity {
    
    @FieldCheck(min = 4, max = 10, error = "f1 not in range")
    private String field1;
    
    @FieldCheck(min = 8, max = 12, error = "f2 not in range")
    private String field2;
    
    public Entity(String f1, String f2) {
        field1 = f1;
        field2 = f2;
    }
    
}

注解的解析如下,方法传入Object,得到Class对象后判断其是否被EntityCheck所注解,如果注解则认为该类是实体类,并对其被FieldCheck注解的字段进行判断,如果不符合,则输出error信息。

public class EntityTestUtils {
    
    public void check(Object o) throws Exception {
        Class c = o.getClass();
        // 如果当前的类被 @Entity 注解
        if (c.isAnnotationPresent(EntityCheck.class)) {
            Field[] fields = c.getDeclaredFields();
            for (Field field : fields) {
                // 如果当前 field 被 @FieldCheck 注解
                if (field.isAnnotationPresent(FieldCheck.class)) {
                    field.setAccessible(true);
                    FieldCheck fieldCheck = field.getAnnotation(FieldCheck.class);
                    if (field.getGenericType().toString().equals("class java.lang.String")) {
                        String s = (String) field.get(o);
                        if (s != null && 
                                (s.length() < fieldCheck.min() || s.length() > fieldCheck.max())) {
                            System.out.println(fieldCheck.error());
                        }
                    }
                }
            }
        }
    }
    
    public static void main(String[] args) {
        EntityTestUtils entityTestUtils = new EntityTestUtils();
        Entity entity = new Entity("12", "12");
        try {
            entityTestUtils.check(entity);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

结果如下:

f1 not in range
f2 not in range

这里进行测试时传入了Entity对象,其实任何注解了EntityCheck的类的对象都可以作为输入,注解的松耦合性给编程带来了极大的便利。
有些数据库框架通过注解来生成SQL语句,感兴趣的同学可以实践一下。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,470评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,393评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,577评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,176评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,189评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,155评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,041评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,903评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,319评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,539评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,703评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,417评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,013评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,664评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,818评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,711评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,601评论 2 353

推荐阅读更多精彩内容