注解是什么?
Java注解又称Java标注,是Java语言5.0版本开始支持加入源代码的特殊语法元数据。
有什么用?
为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便的使用这些数据。
Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同,Java标注可以通过反射获取注解内容。在编译器生成类文件时,注解可以被嵌入到字节码中。Java虚拟机可以保留注解内容,在运行时可以获取到注解内容。
内置注解
Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。
1、作用在代码的注解是
@Override
-
@Deprecated
-
@SuppressWarnings
2、作用在其他注解的注解(或者说元注解)是:
-
@Retention
- 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
RetentionPolicy.SOURCE - 标记的注释仅保留在源级别中,并由编译器忽略。
RetentionPolicy.CLASS - 标记的注释在编译时由编译器保留,但Java虚拟机(JVM)会忽略。
RetentionPolicy.RUNTIME - 标记的注释由JVM保留,因此运行时环境可以使用它。(常用)
@Documented
-
@Target
- 标记这个注解应该是哪种 Java 成员。
ElementType.TYPE 可以应用于类的任何元素。
ElementType.FIELD 可以应用于字段或属性。
ElementType.METHOD 可以应用于方法级注释。
ElementType.PARAMETER 可以应用于方法的参数。
ElementType.CONSTRUCTOR 可以应用于构造函数。
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
ElementType.ANNOTATION_TYPE 可以应用于注释类型。
ElementType.PACKAGE 可以应用于包声明。
ElementType.TYPE_PARAMETER
ElementType.TYPE_USE
-
@Inherited
3、从 Java 7 开始,额外添加了 3 个注解:
-
@SafeVarargs
- Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。 -
@FunctionalInterface
@Repeatable
自定义注释
Java中自定义注解和创建一个接口相似,自定义注解的格式是以@interface为标志的
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface SPI {
/**
* default extension name
*/
String value() default "";
}
定义了之后在方法上面使用注释,之后在同一个地方利用反射处理即可。这里根据实际情况来写。
以下是切片实现中使用的反射
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface OperationLog {
/**方法描述*/
String methodDesc() default "";
}
@Aspect
@Component
public class SysLogAspect {
//定义切点 @Pointcut
//在注解的位置切入代码
@Pointcut("@annotation(com.test.OperationLog)")
public void logPoinCut() {
}
Logger log = LoggerFactory.getLogger(SysLogAspect.class);
//返回数据后,记录操作日志
@AfterReturning(returning = "result",value = "logPoinCut()")
public void afterReturning(JoinPoint joinPoint,String result){
//获取请求IP和URI
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
//获取切点方法描述
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
//自定义注解OperationLog
OperationLog operationLog = method.getAnnotation(OperationLog.class);
String methodDesc = operationLog.methodDesc();
System.out.println(methodDesc);
}
}