Java基础-高级特性-注解

Java工程师知识树 / Java基础


注解介绍

Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制

Java 语言中的类、方法、变量、参数和包等都可以被注解。

在编译器生成类文件时,注解可以被嵌入到字节码中。Java 虚拟机可以保留注解内容,在运行时可以获取到注解内容 。

Java 注解支持自定义 Java 注解。

注解(Annotation)与注释(Comments)是有区别的。注解(Annotation)与注释(Comments)不同在于Java注解可以通过反射获取注解内容

注解语法

注解通过 @interface 关键字进行定义:

public @interface MyAnnotation {
}

注解分类

注解可以分为内置注解、元注解、自定义注解

内置注解
  • @Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
  • @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。不推荐使用,可以使用或者有更好的方式。
  • @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
  • @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
  • @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
  • @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
元注解
  • @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。控制注解的作用时间范围。
  • @Documented - 标记这些注解是否包含在用户文档中。
  • @Target - 标记这个注解应该是哪种 Java 成员。控制注解的作用区域范围。
  • @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

@Retention属性介绍

@Retention(RetentionPolicy.SOURCE) 只在编译时有效
@Retention(RetentionPolicy.CLASS) 会写到class字节码文件里,不可以通过反射读取
@Retention(RetentionPolicy.RUNTIME), 注解会在class字节码文件中存在,在运行时可以通过反射获取到。一般自定义注解都是使用该元注解

@Target属性介绍

@Target(ElementType.TYPE) 作用接口、类、枚举、注解
@Target(ElementType.FIELD) 作用属性字段、枚举的常量
@Target(ElementType.METHOD) 作用方法
@Target(ElementType.PARAMETER) 作用方法参数
@Target(ElementType.CONSTRUCTOR) 作用构造函数
@Target(ElementType.LOCAL_VARIABLE)作用局部变量
@Target(ElementType.ANNOTATION_TYPE)作用于注解
@Target(ElementType.PACKAGE) 作用于包
@Target(ElementType.TYPE_PARAMETER) 作用于类型泛型,即泛型方法、泛型类、泛型接口 (jdk1.8加入)
@Target(ElementType.TYPE_USE) 类型使用.可以用于标注任意类型除了 class (jdk1.8加入)

自定义注解

使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口。

  • @interface用来声明一个注解,格式:public @interface 注解名称{定义注解属性}。
  • 注解的默认属性为 String value();只有一个value()属性时,可以忽略。
  • 注解内的每个方法实际上都声明了一个配置参数,方法名称为参数名称,方法返回值为参数类型(返回值类型可以是1.基本数据类型;2.String;3.枚举类型4.注解类型;5.Class类型;6.以上类型的一维数组类型
    eg:

  • 可以使用default来声明参数的默认值。有默认值的属性,使用注解时可以不将该属性指定值。属性没有默认值时,使用注解时必须赋值

使用自定义注解实现记录操作日志

基于注解的Aop日志记录的实现方案:

  1. 自定义日志注解。
  2. 定义切面。
  3. 切面方法中通过Java反射机制获取注解内的属性值。
  4. 在操作方法(增删改重要表)时,添加注解,eg:@OperationLog(operationType = "1", operationDesc = "后台管理系统添加用户", operator = "admin", moduleId = "User")

自定义日志注解类

package com.hmio.study.annotion;

import java.lang.annotation.*;

@Target({ ElementType.PARAMETER, ElementType.METHOD })//作用方法、作用方法参数
@Retention(RetentionPolicy.RUNTIME)//运行时有效
@Documented//标注注解在生成javadoc时是否显示
public @interface OperationLog {
    /** 要执行的操作类型比如:增删改导入导出等操作 可以使用枚举类型**/
    public String operationType();// 没有默认值,在使用时必须赋值

    /** 要执行的具体操作比如:操作具体描述 **/
    public String operationDesc();// 没有默认值,在使用时必须赋值

    /** 操作人:操作的操作人 任务操作可能没有操作人**/
    public String operator() default "";// 有默认值,在使用时可以不赋值

    /** 操作类型所属模块 仅用于特定场景日志采集使用,非要求请使用默认值 可以使用枚举类型     */
    public String moduleId() default "";// 有默认值,在使用时可以不赋值

}

使用示例:

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

推荐阅读更多精彩内容