Java工程师知识树

Java基础-高级特性-注解

2021-01-19  本文已影响0人  HughJin

Java工程师知识树 / Java基础


注解介绍

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

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

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

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

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

注解语法

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

public @interface MyAnnotation {
}

注解分类

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

内置注解
元注解

@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接口。


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

基于注解的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")
上一篇 下一篇

猜你喜欢

热点阅读