听说你只会用注解,不会自己写注解?

Profile

Java猿的命根子!

自Java EE框架步入Spring Boot时代之后,注解简直是Java程序员的命根子啊,面向注解编程成了日常操作!

换句话的意思就是说:如果没有注解,我们啥也干不了哇(滑稽)。

image

这岂不是很危险!

所以本文来唠一唠关于注解的相关操作,并自己动手来写一个注解感受一下原理。原理性的东西掌握了,心里自然就不慌了。


注解的基本原理

首先必须要说的是,注解它也不是什么高深的玩意儿,没必要畏惧它!

意如其名,其本来的意思就是用来做标注用:可以在字段变量方法接口等位置进行一个特殊的标记,为后续做一些诸如:代码生成数据校验资源整合等工作做铺垫。

对嘛,就做标记用的嘛!

注解一旦对代码标注完成,后续我们就可以结合Java强大的反射机制,在运行时动态地获取到注解的标注信息,从而可以执行很多其他逻辑,完成我们想要的自动化工作。

所以,反射必须要学好!


来!动手造一个注解

在我的前文《听说你还在手写复杂的参数校验?》里曾经讲过,Spring自身提供了非常多好用的注解可以用来方便地帮我们做数据校验的工作。

比如,在没有注解加持时,我们想要校验Student类:

public class Student {
    private Long id;        // 学号
    private String name;    // 姓名
    private String mobile;  // 手机号码(11位)
}

我们只能通过手写if判断来进行校验:

@PostMapping("/add")
public String addStudent( @RequestBody Student student ) {

    if( student == null )
        return "传入的Student对象为null,请传值";
    if( student.getName()==null || "".equals(student.getName()) )
        return "传入的学生姓名为空,请传值";
    if( student.getScore()==null )
        return "传入的学生成绩为null,请传值";
    if( (student.getScore()<0) || (student.getScore()>100) )
        return "传入的学生成绩有误,分数应该在0~100之间";
    if( student.getMobile()==null || "".equals(student.getMobile()) )
        return "传入的学生电话号码为空,请传值";
    if( student.getMobile().length()!=11 )
        return "传入的学生电话号码长度有误,应为11位";

    studentService.addStudent( student ); // 将student对象存入MySQL数据库
    return "SUCCESS";
}

这样非常繁琐!

但是借助于Spring提供的注解,数据校验工作可以变得非常优雅,就像这样:

public class Student {

    @NotNull(message = "传入的姓名为null,请传值")
    @NotEmpty(message = "传入的姓名为空字符串,请传值")
    private String name;    // 姓名

    @NotNull(message = "传入的分数为null,请传值")
    @Min(value = 0,message = "传入的学生成绩有误,分数应该在0~100之间")
    @Max(value = 100,message = "传入的学生成绩有误,分数应该在0~100之间")
    private Integer score;  // 分数

    @NotNull(message = "传入的电话为null,请传值")
    @NotEmpty(message = "传入的电话为空字符串,请传值")
    @Length(min = 11, max = 11, message = "传入的电话号码长度有误,必须为11位")
    private String mobile;  // 电话号码
}

于是很多人就表示疑问,这些注解到底如何实现功能的呢

今天本文则以上文的@Length注解为例,自己动手实现一遍,这个学会了,其他注解实现原理也是类似。

image

总共分三大步实现。

第一步:首先定义注解:@Length

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Length {
    
    int min();          // 允许字符串长度的最小值
    
    int max();          // 允许字符串长度的最大值
    
    String errorMsg();  // 自定义的错误提示信息
}

下面做几点说明:

1、注解的定义有点像定义接口interface,但唯一不同的是前面需要加一个@符号

2、注解的成员变量只能使用基本类型、String或者enum枚举,比如int可以,但Integer这种包装类型就不行,需注意

3、像上面@Target@Retention这种加在注解定义上面的注解,我们称为 “元注解”,元注解就是专门用于给注解添加注解的注解,哈哈,很拗口,简单理解,元注解就是天生就有的注解,可直接用于注解的定义上

4、@Target(xxx) 用来说明该自定义注解可以用在什么位置,比如:

  • ElementType.FIELD:说明自定义的注解可以用于类的变量
  • ElementType.METHOD:说明自定义的注解可以用于类的方法
  • ElementType.TYPE:说明自定义的注解可以用于类本身、接口或enum类型
  • 等等... 还有很多,如果记不住,建议现用现查

5、@Retention(xxx) 用来说明你自定义注解的生命周期,比如:

  • @Retention(RetentionPolicy.RUNTIME):表示注解可以一直保留到运行时,因此可以通过反射获取注解信息
  • @Retention(RetentionPolicy.CLASS):表示注解被编译器编译进class文件,但运行时会忽略
  • @Retention(RetentionPolicy.SOURCE):表示注解仅在源文件中有效,编译时就会被忽略

所以声明周期从长到短分别为:RUNTIME > CLASS > SOURCE ,一般来说,如果需要在运行时去动态获取注解的信息,还是得用RUNTIME,就像本文所用。

第二步:获取注解并对其进行验证

在运行时想获取注解所代包含的信息,该怎么办?那当然得用 Java的反射相关知识

下面写了一个验证函数validate(),代码中会逐行用注释去解释想要达到的目的,认真看一下每一行的注释:

public static String validate( Object object ) throws IllegalAccessException {

    // 首先通过反射获取object对象的类有哪些字段
    // 对本文来说就可以获取到Student类的id、name、mobile三个字段
    Field[] fields = object.getClass().getDeclaredFields();

    // for循环逐个字段校验,看哪个字段上标了注解
    for( Field field : fields ) {
        // if判断:检查该字段上有没有标注了@Length注解
        if( field.isAnnotationPresent(Length.class) ) {
            // 通过反射获取到该字段上标注的@Length注解的详细信息
            Length length = field.getAnnotation( Length.class );
            field.setAccessible( true ); // 让我们在反射时能访问到私有变量
            // 用过反射获取字段的实际值
            int value =( (String)field.get(object) ).length();
            // 将字段的实际值和注解上做标示的值进行比对
            if( value<length.min() || value>length.max() ) {
                return length.errorMsg();
            }
        }
    }
    return null;
}

可见,学好Java的反射知识是多么的重要!

第三步:使用注解

这一步比较轻松,使用注解的过程往往都是很愉悦的

public class Student {
    
    private Long id;        // 学号
    
    private String name;    // 姓名
    
    @Length(min = 11, max = 11, errorMsg = "电话号码的长度必须为11位")
    private String mobile;  // 手机号码(11位)
}

怎么样,一点也不复杂吧,主要就是反射相关的知识!

好了,关于如何动手自定义注解的相关内容就抛砖引玉到这里吧,每天进步一点点,Peace!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容

  • 什么是注解(Annotation):Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和...
    九尾喵的薛定谔阅读 3,161评论 0 2
  • 深入理解 Java 注解 本文内容基于 JDK8。注解是 JDK5 引入的,后续 JDK 版本扩展了一些内容,本文...
    静默虚空阅读 467评论 0 0
  • 关于注解首先引入官方文档的一句话:Java 注解用于为 Java 代码提供元数据。作为元数据,注解不直接影响你的代...
    编程小世界阅读 461评论 0 0
  • java自定义注解 Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配...
    尼尔君阅读 518评论 0 0
  • 摘要 Java Annotation是JDK5.0引入的一种注释机制。 网上很多关于Java Annotation...
    CarsonCao阅读 259评论 0 0