目录
- Java注解(Annotation)简介
- Java注解分类
- 提取Annotation信息+案例
- 注解处理器+案例
Java注解(Annotation)简介
一、Java注解
Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。
注意：注解相关类都包含在java.lang.annotation包中。
二、Java注解分类
1、JDK基本注解
1 @Override
重写
2 @Deprecated
已过时
3 @SuppressWarnings(value = "unchecked")
压制编辑器警告
2、JDK元注解
元注解用于修饰其他的注解(纪委：管干部的干部)
@Retention：定义注解的保留策略
@Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中，在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS) //默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
@Retention(RetentionPolicy.RUNTIME) //注解会在class字节码文件中存在，在运行时可以通过反射获取到
@Target：指定被修饰的Annotation可以放置的位置(被修饰的目标)
@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.METHOD, ElementType.TYPE})，也就是此注解可以在方法和类上面使用
@Inherited：指定被修饰的Annotation将具有继承性
@Documented：指定被修饰的该Annotation可以被javadoc工具提取成文档.
注解分类（分类依据：Annotation是否包含成员变量）
1 标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息
2元数据Annotation: 包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;
3、自定义注解开发
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:Annotation的成员变量在Annotation定义中是以无参的方法形式来
声明的, 其方法名和返回值类型定义了该成员变量的名字和类型, 而且我们还可以使用default关键字为这个成员变量设定默认值，例如：
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Tag {
String name() default "该叫啥才好呢?";
String description() default "这家伙很懒, 啥也没留下...";
}
注1：只有名字为“value”属性，赋值时可以省略属性名
三、提取Annotation信息
使用AnnotatedElement接口中的方法提取注解中的数据，像Class/Constructor/Field/Method/Package
这些类都实现了AnnotatedElement接口
注：只有当定义Annotation时使用了@Retention(RetentionPolicy.RUNTIME)修饰,JVM才会在装载class文件时
提取保存在class文件中的Annotation,该Annotation才会在运行时可见,这样我们才能够解析
案例一：获取类和方法上的注解值
MyAnnotation1
package com.ssm.annotation;
import java.lang.annotation.*;
/**
*
* MyAnnotation1注解可以用在类、接口、属性、方法上
* 注解运行期也保留
* 不可继承
*/
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation1 {
String name();
}
Demo1
package com.ssm.annotation;
/**
*
* 获取类与方法上的注解值
*/
@MyAnnotation1(name = "abcdef")
public class Demo1 {
MyAnnotation1(name = "xyzxyz")
private Integer age;
@MyAnnotation2(model = TranscationModel.Read)
public void list() {
System.out.println("list");
}
@MyAnnotation3(models = {TranscationModel.Read, TranscationModel.Write})
public void edit() {
System.out.println("edit");
}
}
Demo1Test
package com.ssm.annotation;
import org.junit.Test;
/**
*demo1测试类：获取类和方法上的注解值
*/
public class Demo1Test {
@Test
public void list() throws Exception {
// 获取类上的注解
MyAnnotation1 annotation1 = Demo1.class.getAnnotation(MyAnnotation1.class);
System.out.println(annotation1.name());//abcdef
// 获取方法上的注解
MyAnnotation2 myAnnotation2 = Demo1.class.getMethod("list").getAnnotation(MyAnnotation2.class);
System.out.println(myAnnotation2.model());//Read
}
@Test
public void edit() throws Exception {
MyAnnotation3 myAnnotation3 = Demo1.class.getMethod("edit").getAnnotation(MyAnnotation3.class);
for (TranscationModel model : myAnnotation3.models()) {
System.out.println(model);//Read,Write
}
}
}
案例二：获取属性上的注解
MyAnnotation2
package com.ssm.annotation;
import java.lang.annotation.*;
/**
* MyAnnotation2注解可以用在方法上
*
* 不可继承注解运行期也保留
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {
TranscationModel model() default TranscationModel.ReadWrite;
}
Demo2
package com.ssm.annotation;
/**
* 获取属性上的注解
*/
public class Demo2 {
@TestAnnotation(value = "这就是value对应的值_msg1", what = "这就是what对应的值_msg1")
private static String msg1;
@TestAnnotation("这就是value对应的值1")
private static String msg2;
@TestAnnotation(value = "这就是value对应的值2")
private static String msg3;
@TestAnnotation(what = "这就是what对应的值")
private static String msg4;
}
Demo2Test
package com.ssm.annotation;
import org.junit.Test;
/**
*demo2测试类：获取属性上的注解
*/
public class Demo2Test {
@Test
public void test1() throws Exception {
TestAnnotation msg1 = Demo2.class.getDeclaredField("msg1").getAnnotation(TestAnnotation.class);
System.out.println(msg1.value());
System.out.println(msg1.what());
}
@Test
public void test2() throws Exception{
TestAnnotation msg2 = Demo2.class.getDeclaredField("msg2").getAnnotation(TestAnnotation.class);
System.out.println(msg2.value());
System.out.println(msg2.what());
}
@Test
public void test3() throws Exception{
TestAnnotation msg3 = Demo2.class.getDeclaredField("msg3").getAnnotation(TestAnnotation.class);
System.out.println(msg3.value());
System.out.println(msg3.what());
}
@Test
public void test4() throws Exception{
TestAnnotation msg4 = Demo2.class.getDeclaredField("msg4").getAnnotation(TestAnnotation.class);
System.out.println(msg4.value());
System.out.println(msg4.what());
}
}
四、注解处理器
使用Annotation修饰了类/方法/成员变量等之后,这些Annotation不会自己生效,为了让程序中的这些注解起作用,
必须由这些注解的开发者为这些注解提供一个注解处理器(Annotation Processor)。另外，在编译期间，JVM会自
动运行注解处理器（当然，我们需要将其注册）
注解处理器的分类：
静态处理器，非AOP处理
动态注解处理器(spring aop方式)
动态注册注解处理器案例
首先我们先定义一个切面MyLogAspect
package com.zking.ssm.annotation;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import java.util.Arrays;
@Component
@Aspect
@Slf4j
public class MyLogAspect {
private boolean off = false;
@Pointcut("@annotation(com.zking.ssm.annotation.MyLog)")
private void MyValid() {
}
@Before("MyValid()")
public void before(JoinPoint joinPoint) {
Object target = joinPoint.getTarget();
String name = joinPoint.getSignature().getName();
Object[] args = joinPoint.getArgs();
if (!off) {
log.info(target.getClass().getName() + "." + name + "将执行，参数为：" + Arrays.toString(args));
}
// log.debug(myLog.desc() + "[" + joinPoint.getSignature().getName() + " : start.....]");
}
}
MyLog元注解
package com.zking.ssm.annotation;
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyLog {
String desc();
}
ICalService
package com.zking.ssm.service;
public interface ICalService {
Integer add(Integer a, Integer b);
}
CalServiceImpl
package com.zking.ssm.service;
import com.zking.ssm.annotation.MyLog;
import org.springframework.stereotype.Service;
@Service
public class CalServiceImpl implements ICalService {
@MyLog(desc = "xyzxyz")
@Override
public Integer add(Integer a, Integer b) {
return a + b;
}
}
ICalServiceTest
package com.zking.ssm.service;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import static org.junit.Assert.*;
public class ICalServiceTest extends BaseTest {
@Autowired
private ICalService calService;
@Before
public void before() {
}
@Test
public void add() throws Exception {
Integer a = 10;
Integer b = 20;
Integer c = calService.add(a, b);
System.out.println(c);
}
}
注意：log4j2
<!--过滤掉spring和mybatis的一些无用的DEBUG信息 -->
<logger name="org.springframework" level="ERROR"></logger>
<logger name="org.mybatis" level="ERROR"></logger>
217
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
