注解介绍
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日志记录的实现方案:
- 自定义日志注解。
- 定义切面。
- 切面方法中通过Java反射机制获取注解内的属性值。
- 在操作方法(增删改重要表)时,添加注解,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")