Java高级特性-注解:Spring的注解是怎么回事?

在 Spring 中,大家会经常用到各种注解。在加上这些注解后,我们的代码就有了很多神奇的功能。

比如,下面这个类只用了两个注解:@Controller@RequestMapping,你就能在浏览器上访问 index() 方法。

@Controller
@RequestMapping("/")
public class IndexController {

    @RequestMapping(value = "index")
    public String index() {
        return "index";
    }

就这么简单的功能,你如果用 Java 自带的 Servlet,要写的代码最少也会翻倍。

这就是注解的威力。

什么是注解?

注解相当于给代码贴标签,你可以写代码来读取这些标签信息,做特殊的处理,从而实现更丰富的功能。

比如,下面这个例子,方法加上了@Override注解,Java 就会做出处理,覆盖父类toString()方法。

public class User {
    // 覆盖父类的toString() 方法
    @Override
    public String toString() {
        return "这是一个用户对象";
    }
}

注解大致分成三类:JDK内置注解、第三方注解、自定义注解。

JDK内置注解,就是JDK自带的注解。比如,@Override表示用子类的方法覆盖父类的方法。

public class UserOrderNoGen extends OrderNoGen {
    // 这个注解表示:覆盖父类的 genOrderNo() 方法
    @Override
    public String genOrderNo() {
        // 省略无数代码
    }
}

第三方注解,就是第三方框架提供的注解。比如,Spring 框架提供的@Controller@RequestMapping,我重新贴下文章开头的例子。

@Controller
@RequestMapping("/")
public class IndexController {

    @RequestMapping(value = "index")
    public String index() {
        return "index";
    }
}

自定义注解,就是我们自己写的注解。比如,我创建了一个注解@ExcelField,可以放在类上,表示这个类是 Excel 导出模板。

// Excel导出模板
public @interface ExcelField {
    // 省略无数代码
}

// 用户信息表
@ExcelField
public class UserInfoField {
    // 省略无数代码
}

此外,注解的级别非常高,和类、接口、枚举是同一级别的,有自己的一套写法。我们先看看注解怎么写吧~

写注解-加上元注解

所谓元注解,就是加在注解上的注解。

如果你要自定义注解,有两个元注解非常重要,几乎是必须加上的,分别是:@Target@Retention

@Target是限制注解的使用范围,表示这个注解能用在什么地方,它的取值范围在枚举 ElementType 里。 如果用@Target来限制注解的使用范围,那么超出这个范围,代码就会报错。

只能放在方法上面,不然就会报错

当然,你也可以不加@Target注解,这代表不限制注解的使用范围,你可以随便放,不会报错。

不限制使用范围,你可以随便放

@Retention是注解的保留策略,它的取值范围在枚举 RetentionPolicy 里。 注解的保留策略有 3 种,分别是:SOURCE、CLASS、RUNTIME。

SOURCE:注解只在源码中出现,在经过编译后,注解会被丢弃,不会出现在 class 文件中;
CLASS:经过编译后,注解会保留在 class 文件中,但在 JVM 加载时会忽略注解;
RUNTIME:在 JVM 加载时,注解会被加载到 JVM 内存,所以使用反射来读取注解;

但说实话,在这三种保留策略中,SOURCE 策略还不如多写两行注释;CLASS 策略就是让你看看,没太大作用;只有 RUNTIME 模式,才能真正发挥注解的作用。

注解的结构-成员变量

注解支持成员变量,成员变量可以用这些类型:

  1. 基本数据类型
  2. String
  3. 枚举类型
  4. 注解类型
  5. Class类型
  6. 以上类型的一维数组

这块我们没必要花太多时间,在用到的时候,再回来瞄一下就好。

最后,我们来看下注解是怎么起作用的。

注解是怎么起作用的?

注解想发挥作用,有三个要素:定义、使用、读取。

如果你用的是JDK内置注解,或者是第三方注解,那么只要使用就行,不用管定义和执行。

比如,Spring 框架会把注解类、读取注解的代码藏起来,我们只要会用就行,不用管太多。你可以看下面这个例子。

// 使用 Spring 的注解,把这个类交给 Spring 容器管理
@Service
public class UserService {

}

相比起来,自定义注解会更加复杂。自定义注解想发挥作用,我们需要自己定义注解,自己使用注解,最后再写代码读取。

有时候,我们要用自定义注解,才能实现一些功能。

比方说,这是一个 Excel 导出的功能,你得先创建注解@ExcelField,然后把@ExcelField加到模板类的成员变量上,最后用工具类ExcelExporter来导出 excel 表格。

Excel导出-注解开发流程

在注解的三要素中,定义注解是比较容易的,但使用、读取注解跟业务绑定很深,一两句话很难讲清楚,我们以后会结合实际案例来看。

写在最后

注解相当于给代码贴标签,你可以写代码来读取这些标签信息,做特殊的处理,从而实现更丰富的功能。

不过,注解想发挥作用,有三个要素:定义、使用、读取。但我们很少试过自定义注解,没有经历过定义—>使用—>读取的过程,就搞不清楚注解是怎么回事,更别提用好注解了。

换句话说,想要用好注解,你得看更多的实际案例,写更多的代码。

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

推荐阅读更多精彩内容