什么是注解？
注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。
如何创建并使用自定义注解？
引入依赖
在pom文件中引入AOP的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
</dependency>
定义注解
元注解
java.lang.annotation 提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：
@Documented – 注解是否将包含在JavaDoc中
@Retention – 什么时候使用该注解
@Target – 注解用于什么地方
@Inherited – 是否允许子类继承该注解
1.）@Retention – 定义该注解的生命周期
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
2.）Target – 表示该注解用于什么地方。默认值为任何元素，表示该注解用于什么地方。可用的ElementType 参数包括
● ElementType.CONSTRUCTOR: 用于描述构造器
● ElementType.FIELD: 成员变量、对象、属性（包括enum实例）
● ElementType.LOCAL_VARIABLE: 用于描述局部变量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述参数
● ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明
3.)@Documented – 一个简单的Annotations 标记注解，表示是否将注解信息添加在java文档中。
4.)@Inherited – 定义该注释和子类的关系
@Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的annotation 类型被用于一个class，则这个annotation 将被用于该class 的子类。
自定义注解类编写的一些规则
- Annotation 型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
- 参数成员只能用public 或默认(default) 这两个访问权修饰
- 参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型，以及这一些类型的数组.
- 要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation 对象，因为你除此之外没有别的获取注解对象的方法
- 注解也可以没有定义成员,，不过这样注解就没啥用了
PS:自定义注解需要使用到元注解
package com.example.demo.annotation;
import java.lang.annotation.*;
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface WyLog {
String value() default "";
}
实现类
package com.example.demo.aspect;
import com.example.demo.annotation.WyLog;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.aspectj.lang.annotation.Aspect;
import java.util.Arrays;
@Component
@Aspect
public class WyLogAspect {
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
/**
* 其中@Pointcut声明了切点（这里的切点是我们自定义的注解类），
* @Before声明了通知内容，在具体的通知中，我们通过@annotation(logger)拿到了自定义的注解对象，
* 所以就能够获取我们在使用注解时赋予的值了。
*/
@Pointcut("@annotation(com.example.demo.annotation.WyLog)")
private void pointcut() {}
@Before("pointcut() && @annotation(logger)")
public void before(JoinPoint joinPoint, WyLog logger) {
//类名
String clsName=joinPoint.getSignature().getDeclaringType().getSimpleName();
//方法名
String modName= joinPoint.getSignature().getName();
//参数
Object[] args = joinPoint.getArgs();
StringBuffer result = new StringBuffer();
System.out.println(logger.value());
result.append("["+clsName+"]");
result.append("["+modName+"]");
Arrays.stream(args).forEach(arg->{
try {
result.append("["+OBJECT_MAPPER.writeValueAsString(arg)+"]");
} catch (JsonProcessingException e) {
}
});
System.out.println(result.toString());
}
}
使用注解
package com.example.demo.controller;
import com.example.demo.annotation.WyLog;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@RequestMapping("user/{id}")
@WyLog(value="hello this is log")
public String showUserId(@PathVariable("id") Integer id) {
System.out.println("user'id is "+id);
return "user'id is "+id;
}
}
执行
