自定义注解

冰冰酱哈

已于 2022-11-03 16:14:25 修改

阅读量839

点赞数

于 2022-11-03 16:13:36 首次发布

本文链接：https://blog.csdn.net/m0_68211831/article/details/127669648

版权

1.java注解简介

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解相关类都包含在java.lang.annotation包中。

1.1.java注解分类

JDK基本注解
JDK元注解
自定义注解

1.2.JDK基本注解

@Override
重写

@SuppressWarnings(value = "unchecked")
压制编辑器警告

1.3.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工具提取成文档.

1.4.自定义注解

注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:

标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息

元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;

1.5.如何自定义注解？

使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值；

2.自定义注解

 @interface注解修饰符

如果属性是value的话可以不写，如果是其他就必须要写。

MyAnnotation

package com.xbb.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author冰冰
 * @create  2022-11-03 14:38
 */
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    //指的是注解里面的属性
    public String desc() default "desc可以修饰符、方法、属性";
    public String value() default "value可以修饰符、方法、属性";


}

MyAnnotation2

package com.xbb.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author冰冰
 * @create  2022-11-03 15:18
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation2 {

    //    指的是注解中的属性
    public String desc() default "desc可以修饰符、方法、属性";
    public String value() default "value可以修饰符、方法、属性";

}

StudentController

package com.xbb.annotation;

/**
 * @author冰冰
 * @create  2022-11-03 14:44
 */
@MyAnnotation(desc = "标记在类上面")
public class StudentController {
    @MyAnnotation("标记在属性id上面")
    private String id;
    @MyAnnotation("标记在属性name上面")
    private String name;
    @MyAnnotation
    public void test1(@MyAnnotation2("用来修饰id参数") String id,@MyAnnotation2("用来修饰name参数") String name){
        System.out.println("测试...");
    }

}

Demo1

package com.xbb.demo;

import com.xbb.annotation.MyAnnotation;
import com.xbb.annotation.MyAnnotation2;
import com.xbb.annotation.StudentController;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * @author冰冰
 * @create  2022-11-03 15:11
 *
 * 目标：
 * 1.获取studentController 类上自定义注解 中的内容
 * 2.获取studentController 方法上自定义注解 中的内容
 * 3.获取studentController 属性上自定义注解 中的内容
 * 4.获取studentController 参数上自定义注解 中的内容
 **/
public class Demo1 {
    public static void main(String[] args) throws Exception {
//        拿到类、拿注解
        MyAnnotation annotation = StudentController.class.getAnnotation(MyAnnotation.class);
        System.out.println(annotation.value());
        System.out.println(annotation.desc());

//        获取属性上的
        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());

//        获取到方法上的
        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());


    }
}

3.aop应用自定义注解

在我们做的系统中，有时需要记录操作日志，方便找到某个操作是谁进行的，这个可以用spring的aop来实现，本篇博客记录用自定义注解+aop应用于springboot项目中实现操作日志的记录

1、aop相关术语介绍

连接点（Joinpoint)：程序执行的某个特定位置，如某个方法调用前，调用后，方法抛出异常后，这些代码中的特定点称为连接点；简单来说，就是在哪加入你的逻辑增强，连接点表示具体要拦截的方法，切点是定义一个范围，而连接点是具体到某个方法
切点（PointCut）：每个程序的连接点有多个，如何定位到某个感兴趣的连接点，就需要通过切点来定位。比如，连接点是数据库的记录，切点是查询条件；切点用于来限定Spring-AOP启动的范围，通常我们采用表达式的方式来设置，所以关键词是范围
增强（Advice）：增强是织入到目标类连接点上的一段程序代码；在Spring中，像BeforeAdvice等还带有方位信息；通知是直译过来的结果，我个人感觉叫做“业务增强”更合适，对照代码就是拦截器定义的相关方法，通知分为如下几种：
前置通知（before）：在执行业务代码前做些操作，比如获取连接对象
后置通知（after）：在执行业务代码后做些操作，无论是否发生异常，它都会执行，比如关闭连接对象
异常通知（afterThrowing）：在执行业务代码后出现异常，需要做的操作，比如回滚事务
返回通知（afterReturning）：在执行业务代码后无异常，会执行的操作
环绕通知（around）：环绕通知可以在方法调用前后完成自定义的行为，它也会选择是否继续执行连接点或直接返回它们自己的返回值或抛出异常来结束执行

目标对象（Target）：需要被加强的业务对象
织入（Weaving）：织入就是将增强添加到对目标类具体连接点上的过程；织入是一个形象的说法，具体来说，就是生成代理对象并将切面内容融入到业务流程的过程。
代理类（Proxy）：一个类被AOP织入增强后，就产生了一个代理类
切面（Aspect）：切面由切点和增强组成，它既包括了横切逻辑的定义，也包括了连接点的定义，SpringAOP就是将切面所定义的横切逻辑织入到切面所制定的连接点中。SpringAOP将切面定义的内容织入到我们的代码中，从而实现前后的控制逻辑。比如我们常写的拦截器Interceptor，就是一个切面类

3.1.自定义注解日志的使用

DeomController

package com.xbb.aop;

import org.springframework.stereotype.Controller;

/**
 * @author冰冰
 * @create  2022-11-03 15:49
 */
@Controller
public class DeomController {
    @MyLog(desc = "测试类的方法")
    public void  test(){
        System.out.println("测试方法");

    }
}

MyLog

package com.xbb.aop;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author冰冰
 * @create  2022-11-03 15:48
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String desc();
}

MyLogAspect

package com.xbb.aop;

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.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

/**
 * @author冰冰
 * @create  2022-11-03 15:52
 */
@Component
@Aspect
public class MyLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);

    /**
     * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
     */
    @Pointcut("@annotation(com.xbb.aop.MyLog)")
    private void MyValid() {
    }

    @Before("MyValid()")
    public void before(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());
    }
}

测试类：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class AnnotationTest {
    @Autowired
    private DemoController demoController;
 
    @Test
    public void test1(){
        demoController.test();
    }
}

3.2自定义注解数据字典的使用

学习网址：

http://47.100.191.44/index

冰冰酱哈

关注

0
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
自定义注解

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解相关类都包含在java.lang.annotation包中。没有成员变量的Annotation;这种Annotation仅利用自身的存在与否来提供信息包含成员变量的Annotation;它们可以接受(和提供)更多的元数据;
复制链接

扫一扫