目录
一、注释简介
Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。 注解相关类都包含在java.lang.annotation包中。
Java注解分类
JDK基本注解
JDK元注解
自定义注解
JDK基本注解
@Override
重写@SuppressWarnings(value = "unchecked")
压制编辑器警告
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是否包含成员变量,可以把Annotation分为两类）:
标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;
如何自定义注解？
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值；
二、自定义注解
MyAnnotation注解
package com.cdl.ssm.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:21
*
* MyAnnotation注解可以用在类、接口、属性、方法上
* 注解运行期也保留
* 不可继承
*/
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation {
String name();//注解中的属性
}
StudentController
package com.cdl.ssm.annotation;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:27
*/
@MyAnnotation(name = "注解中的属性标记在类上")
public class StudentController {
@MyAnnotation(name="注解中的属性标记在属性上")
private int age;
@MyAnnotation(name="注解中的属性标记在方法上")
public void edit(){
}
}
获取注释内标记类的内容
MyAnnotation
package com.cdl.ssm.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:21
*
* MyAnnotation注解可以用在类、接口、属性、方法上
* 注解运行期也保留
* 不可继承
*/
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation {
public String value() default "value修饰类、方法、属性";
public String des() default "desc修饰类、方法、属性";//注解中的属性
}
MyAnnotation2
package com.cdl.ssm.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:21
*
* MyAnnotation注解可以用在类、接口、属性、方法上
* 注解运行期也保留
* 不可继承
*/
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation2 {
public String value() default "value修饰类、方法、属性";
public String des() default "desc修饰类、方法、属性";//注解中的属性
}
StudentController
package com.cdl.ssm.annotation;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:27
*/
@MyAnnotation(value = "注解中的属性标记在类上")
public class StudentController {
@MyAnnotation(value="注解中的属性标记在属性上")
private int age;
@MyAnnotation(value="注解中的属性标记在方法上")
public void test1(@MyAnnotation2("用来修饰id参数")String id,@MyAnnotation2("用来修饰name参数")String name){
}
}
Demo1
获取类上的内容
package com.cdl.ssm.annotation.demo;
import com.cdl.ssm.annotation.MyAnnotation;
import com.cdl.ssm.annotation.StudentController;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:43
*
* 目标：
* 1.拿到类自定义注释的内容
* 2.拿到方法自定义注释的内容
* 3.拿到属性自定义注释的内容
*/
public class Demo1 {
public static void main(String[] args) {
//获取到注释类
MyAnnotation myAnnotation = StudentController.class.getAnnotation(MyAnnotation.class);
System.out.println(myAnnotation.value());
System.out.println(myAnnotation.des());
}
}
结果：
修改注解的代码 表示只有在运行时才能够拿到类中的注解
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)效果：
获取注释内标记属性的内容
StudentController
package com.cdl.ssm.annotation;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:27
*/
@MyAnnotation(value = "注解中的属性标记在类上")
public class StudentController {
@MyAnnotation(value="注解中的属性id标记在属性上")
private String id;
@MyAnnotation(value="注解中的属性name标记在属性上")
private String name;
@MyAnnotation(value="注解中的属性标记在方法上")
public void test1(@MyAnnotation2("用来修饰id参数")String id,@MyAnnotation2("用来修饰name参数")String name){
}
}
Demo1
package com.cdl.ssm.annotation.demo;
import com.cdl.ssm.annotation.MyAnnotation;
import com.cdl.ssm.annotation.StudentController;
import java.lang.reflect.Field;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 11:43
*
* 目标：
* 1.拿到类自定义注释的内容
* 2.拿到方法自定义注释的内容
* 3.拿到属性自定义注释的内容
*/
public class Demo1 {
public static void main(String[] args) throws Exception{
//获取到注释类
MyAnnotation myAnnotation = StudentController.class.getAnnotation(MyAnnotation.class);
// System.out.println(myAnnotation.value());
// System.out.println(myAnnotation.des());
//获取属性上的
Field id = StudentController.class.getDeclaredField("id");
Field name = StudentController.class.getDeclaredField("name");
System.out.println(id.getAnnotation(MyAnnotation.class).value());
System.out.println(name.getAnnotation(MyAnnotation.class).value());
//使用场景
// // MyAnnotation2 annotation2 = id.getAnnotation(MyAnnotation2.class);
// Field[] declaredFields = StudentController.class.getDeclaredFields();
// for (Field f : declaredFields) {
// Annotation annotation1 = f.getAnnotation(myAnnotation.getClass());
// if(annotation1 !=null){
//
// }
// }
}
}
效果：
获取注释内标记方法的内容
Demo1
//获取方法上的
Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
System.out.println(m1.getAnnotation(MyAnnotation.class).value());
获取注释内标记参数的内容
Demo1
//获取方法上的
Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
// System.out.println(m1.getAnnotation(MyAnnotation.class).value());
//获取参数上的
for (Parameter p : m1.getParameters()) {
System.out.println(p.getAnnotation(MyAnnotation2.class).value());
}
三、自定义注解日志的使用
MyLog
package com.cdl.ssm.annotation.aop;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 15:47
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
String desc();
}
MyLogAspect
package com.cdl.ssm.annotation.aop;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 15:50
*/
public class MyLogAspect {
private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);
/**
* 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
*/
@Pointcut("@annotation(com.cdl.ssm.annotation.aop.MyLog)")
private void MyValid() {
}
@Before("MyValid()")
public void before(JoinPoint joinPoint) {
//joinPoint 可以拿到目标对象 目标方法 传递参数
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
logger.debug("[" + signature.getName() + " : start.....]");
System.out.println("[" + signature.getName() + " : start.....]");
MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
logger.debug("【目标对象方法被调用时候产生的日志，记录到日志表中】："+myLog.desc());
System.out.println("【目标对象方法被调用时候产生的日志，记录到日志表中】：" + myLog.desc());
}
}
DemoController
package com.cdl.ssm.annotation.aop;
import org.springframework.stereotype.Controller;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-27 15:48
*/
@Controller
public class DemoController {
@MyLog(desc="这是一个测试类的方法")
public void test(){
System.out.println("测试方法");
}
}
AnnotationTest
package com.cdl.shiro;
import com.cdl.ssm.annotation.aop.DemoController;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* @author cdl
* @site www.cdl.com
* @create 2022-10-26 19:34
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class AnnotationTest {
@Autowired
private DemoController demoController;
@Test
public void test(){
demoController.test();
}
}
若在AnnotationTest 和MyLogAspect 中各打一个断点 则会先进入MyLogAspect，其中有前置通知
4602
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
