一、自定义注解须知
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。
Java5.0定义的元注解:
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
@Target:说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
@Retention: 定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)
@Documented: 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
@Inherited: 是指定某个自定义注解如果写在了父类的声明部分,那么子类的声明部分也能自动拥有该注解。@Inherited注解只对那些@Target被定义为ElementType.TYPE的自定义注解起作用。
二、使用aop实现注解进行日志打印
注解类
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {
/**
* 描述
* @return {String}
*/
String value();
}
aop实现
@Slf4j
@Aspect
@AllArgsConstructor
public class SysLogAspect {
@SneakyThrows
@Around("@annotation(sysLog)")
public Object around(ProceedingJoinPoint point, SysLog sysLog) {
String strClassName = point.getTarget().getClass().getName();
String strMethodName = point.getSignature().getName();
log.debug("[类名]:{},[方法]:{}", strClassName, strMethodName);
//注解值
sysLog.value();
Long startTime = System.currentTimeMillis();
Object obj = point.proceed();
Long endTime = System.currentTimeMillis();
return obj;
}
}
//提一嘴HttpServletRequest懂的都懂 request 都来了做点日志记录 ip 等等
HttpServletRequest request = ((ServletRequestAttributes) Objects
.requireNonNull(RequestContextHolder.getRequestAttributes())).getRequest();
三、反射使用注解
自定义注解
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {ElementType.METHOD})
@Documented
public @interface MyAnnotation {
String name();
int age() default 18;
int[] score();
}
使用注解的方法
public class Student{
//记得加注解测试
// @MyAnnotation(....)
public void study(int times){
for(int i = 0; i < times; i++){
System.out.println("Good Good Study, Day Day Up!");
}
}
}
反射使用注解 用户可以结合aop进行使用做事情
public static void main(String[] args) {
try{
//获取Student的Class对象
Class stuClass = Class.forName("com.hong.example.Student");
//这里的形参不能写成Integer.class,应该写int.class //参数类型.class
Method stuMethod = stuClass.getMethod("study",int.class);
if (stuMethod.isAnnotationPresent(MyAnnotation.class)){
System.out.println("Student类上配置了MyAnnotation注解!");
//获取该元素上指定类型的注解
MyAnnotation myAnnotation = stuMethod.getAnnotation(MyAnnotation.class);
System.out.print("name: "+myAnnotation.name()+", age: "+myAnnotation.age()+", score:");
for (int i = 0 ;i < myAnnotation.score().length;i++){
System.out.print(myAnnotation.score()[i]+" ");
}
}else{
System.out.println("Student类上没有配置MyAnnotation注解");
}
System.out.println();
}catch (ClassNotFoundException | NoSuchMethodException e){
e.printStackTrace();
}
}