Java自定义注解

news2024/11/28 17:45:33

目录

一、什么是自定义注解

1）Java注解简介

2）Java注解分类

JDK基本注解

JDK元注解

自定义注解

如何自定义注解？

二、自定义注解

1）获取类上注解值

2）获取类属性上的注解属性值

3）获取方法上的注解值 

4）获取参数修饰注解对应的属性值

三、aop应用自定义注解

自定义注解日志的使用

一、什么是自定义注解

1）Java注解简介

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

2）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关键字为这个成员变量设定默认值；

二、自定义注解

常见的自定义注解有四种：注解用在类上面、注解用在方法上面、注解用在属性上面、注解用在参数上面

 @Target

 

 @Target里面标记的属性，决定了你自定义注解能放在哪里使用，将METHOD改为TEPY或者使用逗号分隔在后面添加也行，这样方法，类，属性都可以使用这个注解类了

  

如果不知道该注解是干嘛用的，可以点进去查看，Ctrl+鼠标键 

@Retention一共有三种：source、class、runtime 

如果属性是value的话，可以省略value= 

1）获取类上注解值

使用自定义注解就是为了拿这上面的数据的 

MyAnnotation1.java 

package com.xiaokun.ssm.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * @author 小坤
 * @create  2022-10-28 20:09
 */
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation1 {
 
//    指的是注解中的属性
    public String desc() default "desc可以修饰符、方法、属性";
    public String value() default "value可以修饰符、方法、属性";
}

 MyAnnotation2.java 

package com.xiaokun.ssm.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * @author 小坤
 * @create  2022-10-28 20:09
 */
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation2 {
 
//    指的是注解中的属性
    public String desc() default "desc可以修饰符、方法、属性";
    public String value() default "value可以修饰符、方法、属性";
}

Studentcontroller.java

package com.xiaokun.ssm.annotation;
 
/**
 * @author 小坤
 * @create  2022-10-28 20:11
 */
@MyAnnotation1(desc = "标记在类上面")
public class Studentcontroller {
 
    @MyAnnotation1("标记在属性id上面")
    private String id;
    @MyAnnotation1("标记在属性name上面")
    private String name;
    @MyAnnotation1
    public void test1(@MyAnnotation2("用来修饰id参数") String id,@MyAnnotation2("用来修饰name参数") String name){
        System.out.println("测试...");
    }
 
 
 
}

Demo1.java

package com.jwj.ssm.annotation.demo;
 
import com.xiaokun.ssm.annotation.MyAnnotation1;
import com.xiaokun.ssm.annotation.Studentcontroller;
 
/**
 * @author 小坤
 * @create  2022-10-28 22:10
 *
 * 目标：
 * 1.获取studentController 类上自定义注解 中的内容
 * 2.获取studentController 方法上自定义注解 中的内容
 * 3.获取studentController 属性上自定义注解 中的内容
 * 4.获取studentController 参数上自定义注解 中的内容
 * * *..*Service.*pager(..)
 * com.zking.service.BookService.queryPager(..);
 * com.zking.service.OrderService.queryPager(..);
 */
public class Demo1 {
    public static void main(String[] args) {
//        拿到类、拿注解
        MyAnnotation1 annotation = Studentcontroller.class.getAnnotation(MyAnnotation1.class);
        System.out.println(annotation.value());
        System.out.println(annotation.desc());
    }
}

这个时候我们运行main方法时，程序会报错，图中详讲，看图😜 

2）获取类属性上的注解属性值

Demo1.java  

package com.xiaokun.ssm.annotation.demo;
 
import com.xiaokun.ssm.annotation.MyAnnotation1;
import com.xiaokun.ssm.annotation.MyAnnotation2;
import com.xiaokun.ssm.annotation.Studentcontroller;
 
import java.lang.reflect.Field;
 
/**
 * @author 小坤
 * @create  2022-10-28 22:10
 *
 * 目标：
 * 1.获取studentController 类上自定义注解 中的内容
 * 2.获取studentController 方法上自定义注解 中的内容
 * 3.获取studentController 属性上自定义注解 中的内容
 * 4.获取studentController 参数上自定义注解 中的内容
 * * *..*Service.*pager(..)
 * com.zking.service.BookService.queryPager(..);
 * com.zking.service.OrderService.queryPager(..);
 */
public class Demo1 {
    public static void main(String[] args) throws NoSuchFieldException {
//        拿到类、拿注解
        MyAnnotation1 annotation = Studentcontroller.class.getAnnotation(MyAnnotation1.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(MyAnnotation1.class).value());
        System.out.println(name.getAnnotation(MyAnnotation1.class).value());
 


    }
}

运行结果如图：

3）获取方法上的注解值 

//        获取到方法上的
        Method m1 = Studentcontroller.class.getDeclaredMethod("test1", String.class, String.class);
        System.out.println(m1.getAnnotation(MyAnnotation1.class).value());

4）获取参数修饰注解对应的属性值

//        获取参数上的标识
        for (Parameter p : m1.getParameters()) {
            System.out.println(p.getAnnotation(MyAnnotation2.class).value());
 
        }

三、aop应用自定义注解

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

aop相关术语介绍

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

目标对象（Target）：需要被加强的业务对象

织入（Weaving）：织入就是将增强添加到对目标类具体连接点上的过程；织入是一个形象的说法，具体来说，就是生成代理对象并将切面内容融入到业务流程的过程。

代理类（Proxy）：一个类被AOP织入增强后，就产生了一个代理类

切面（Aspect）：切面由切点和增强组成，它既包括了横切逻辑的定义，也包括了连接点的定义，SpringAOP就是将切面所定义的横切逻辑织入到切面所制定的连接点中。SpringAOP将切面定义的内容织入到我们的代码中，从而实现前后的控制逻辑。 比如我们常写的拦截器Interceptor，就是一个切面类

自定义注解日志的使用

DemoController.java

package com.xiaokun.ssm.annotation.aop;
 
import org.springframework.stereotype.Controller;
 
/**
 * @author 小坤
 * @create  2022-10-29 14:19
 */
@Controller
public class DemoController {
    @MyLog(desc = "这是一个测试类的方法")
    public void test(){
        System.out.println("测试方法");
    }
}

MyLog.java

package com.xiaokun.ssm.annotation.aop;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String desc();
}

MyLogAspect .java

package com.xiaokun.ssm.annotation.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;
 
@Component
@Aspect
public class MyLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);
 
    /**
     * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
     */
    @Pointcut("@annotation(com.jwj.ssm.annotation.aop.MyLog)")
//    这是以前的写法 @Around("execution"(* *..*Service.*Pager(..))")
//   上面这个已经把这个替代掉了 @Pointcut("@execution(* *.*Controller.add())")
    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());
    }
}

 添加测试方法

AnnotationTest.java

package com.xiaokun.shiro;
 
import com.xiaokun.ssm.annotation.aop.DemoController;
import com.xiaokun.ssm.biz.ClazzBiz;
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 小坤
 * @create  2022-10-27 22:21
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class AnnotationTest {
    @Autowired
    private DemoController demoController;
 
    @Test
    public void test1(){
        demoController.test();
    }
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/3608.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

WireShark 常用协议分析

WireShark 常用协议分析

WireShark 常用协议分析 1.3 实战：使用 WireShark 对常用协议抓包并分析原理 协议分析的时候 我们 关闭混淆模式， 避免一些干扰的数据包存在。 1.3.1 常用协议分析 - ARP 协议 地址解析协议 （英语：Address Resolution Protocol&…
阅读更多...
从内核角度看网络包发送流程

从内核角度看网络包发送流程

一、前置知识 1、RingBuffer结构详解 关于RingBuffer网上有很多说法，有的人说RingBuffer是系统启动时就预先申请好的一个环形数组，有的人说RingBuffer是在接收或发送数据时才动态申请的一个环形数组，那么到底RingBuffer的结构是怎么样的呢&…
阅读更多...
《吉师作业》(2)之迟来的答案

《吉师作业》(2)之迟来的答案

前言 🍀作者简介：吉师散养学生，为挣钱努力拼搏的一名小学生。 🍁个人主页：吉师职业混子的博客_CSDN博客-python学习,HTML学习,清览题库--C语言程序设计第五版编程题解析领域博主 🫒文章目的：我不…
阅读更多...
初识C++（二）

初识C++（二）

简述 ：本篇就缺省参数 和 函数重载 方面进行初步学习 ，对比C语言学习C这两个语法，从而感受C在此方面对C语言进行的补充。 目录 缺省参数 什么是缺省参数 缺省参数的分类 缺省参数的应用 函数重载 什么是函数重载 函数重载的三种情况 支…
阅读更多...
【JavaSE】函数or方法？方法的重载讲解

【JavaSE】函数or方法？方法的重载讲解

文章目录什么是方法如何定义方法方法的调用过程形参与实参的关系方法的重载为什么要重载重载的概念方法签名递归什么是方法 在C语言的学习中我们学习到了一个概念叫做函数，那么在Java的语法中有没有类似函数的东西的，答案是有的，但是在Java的…
阅读更多...
strimzi实战之一：简介和准备

strimzi实战之一：简介和准备

欢迎访问我的GitHub 这里分类和汇总了欣宸的全部原创(含配套源码)：https://github.com/zq2599/blog_demos 关于strimzi strimzi是一个开源项目，已加入了CNCF，官网地址：https://strimzi.io/借助strimzi，既能快速部署ka…
阅读更多...
【生日快乐】搜索技术【深度优先搜索】 - 回溯法

【生日快乐】搜索技术【深度优先搜索】 - 回溯法

搜索技术【深度优先搜索】 - 回溯法 回溯法是一种选优搜索法，按照选优条件深度优先搜索，以达到目标。当搜索到某一步时，发现原先的选择并不是最优或达不到目标，就退回一步重新选择，这种走不通就退回再走的技术被称为回…
阅读更多...
如何用 Elasticsearch 实现 Word、PDF，TXT 文件的全文内容检索？

如何用 Elasticsearch 实现 Word、PDF，TXT 文件的全文内容检索？

简单介绍一下需求 能支持文件的上传，下载 要能根据关键字，搜索出文件，要求要能搜索到文件里的文字，文件类型要支持 word，pdf，txt 文件上传，下载比较简单，要能检索到文件里的文字&am…
阅读更多...
2022-ISCTF-部分MISC和PWN

2022-ISCTF-部分MISC和PWN

misc 两层编码 第一层 sha256掩码爆破 第二层 base64解码找到key import string,sys from hashlib import sha256 from multiprocessing import Process from Crypto.Util.number import * from pwn import * import base64 from primefac import * context(log_leveldebug)…
阅读更多...
【STL】容器 - set和map的使用

【STL】容器 - set和map的使用

目录 前言 一.键值对 1.在SGI - STL中对键值对的定义: 2.make_pair 二.set 1.set的概念与注意事项 2.set的使用(常用接口) <1>.构造函数 <2>.迭代器与范围for <3>.插入和查找 <4>.删除erase <5>.计数count 三.map 1.map的概念与注…
阅读更多...
洛谷千题详解 | P1012 [NOIP1998 提高组] 拼数【C++、Java语言】

洛谷千题详解 | P1012 [NOIP1998 提高组] 拼数【C++、Java语言】

博主主页&#xff1a;Yu仙笙 专栏地址&#xff1a;洛谷千题详解 目录 题目描述 输入格式 输出格式 输入输出样例 解析&#xff1a; C源码&#xff1a; C源码2&#xff1a; C源码3&#xff1a; Java源码&#xff1a; ---------------------------------------------------------…
阅读更多...
element-ui upload图片上传组件使用

element-ui upload图片上传组件使用

图片上传前端收集 数据 再调用接口发送到后端 组件标签内的参数&#xff1a; 参数说明类型可选值默认值action必选参数&#xff0c;上传的地址string——headers设置上传的请求头部object——multiple是否支持多选文件boolean——data上传时附带的额外参数object——name上传…
阅读更多...
【数据结构】链表OJ第一篇 —— 移除链表元素 反转链表 合并两个有序链表

【数据结构】链表OJ第一篇 —— 移除链表元素 反转链表 合并两个有序链表

文章目录0. 前言1. 移除链表元素2. 反转链表3. 合并两个有序链表4. 结语0. 前言 上篇博客中&#xff0c;我们学习了实现了单链表。但是仅仅实现并不算掌握&#xff0c;所以我们需要做些题目来练习巩固。而从今天开始的几期&#xff0c;anduin 都会为大家带来链表OJ题&#xff…
阅读更多...
在Linux环境下VScode中配置ROS、PCL和OpenCV开发环境记录

在Linux环境下VScode中配置ROS、PCL和OpenCV开发环境记录

一.安装必要的插件 打开VScode&#xff0c;在开展中安装CMake、CMake Tools&#xff0c;ROS和catkin-tools插件&#xff0c;截图如下&#xff0c;安装后重新打开VScode插件生效。 二.创建ROS工作空间 在选择的路径下&#xff0c;打开终端创建工作空间&#xff0c;具体命令如下…
阅读更多...
【概率论笔记】正态分布专题

【概率论笔记】正态分布专题

文章目录一维正态分布多维正态分布n维正态分布二维正态分布一维正态分布 设X~N(μ,σ2)X\text{\large\textasciitilde}N(\mu,\sigma^2)X~N(μ,σ2)&#xff0c;则XXX的概率密度为f(x)12πσe−(x−μ)22σ2f(x)\frac{1}{\sqrt{2\pi}\sigma}e^{-\frac{(x-\mu)^2}{2\sigma^2}}f(…
阅读更多...
WXML模板语法

WXML模板语法

文章目录1、数据绑定1.1 数据绑定的基本原则1.2在data中定义页面的数据1.3 Mustache语法的格式1.4 Mustache语法的应用场景1.5 算数运算2、事件绑定2.1 小程序常用的事件2.2事件对象的属性列表2.3 target和currentTarget的区别2.4 <font colorred>bindtap的语法格式2.5 在…
阅读更多...
狗厂员工来面试本想难为一下，结果被虐得连console.log也不敢写了

狗厂员工来面试本想难为一下，结果被虐得连console.log也不敢写了

这次说到的面试题是关于node服务端内存溢出的问题&#xff0c;狗厂员工来面试本想难为一下&#xff0c;现在我连console.log也不敢写了 关于这道node内存溢出的问题&#xff0c;大哥从以下几个方面讲的&#xff0c;讲完我觉得自己得到了升华&#xff0c;现在搞得连代码也快不敢…
阅读更多...
2.24 OrCAD Cadence16.6怎么更改原理图中做好的库文件？

2.24 OrCAD Cadence16.6怎么更改原理图中做好的库文件？

笔者电子信息专业硕士毕业&#xff0c;获得过多次电子设计大赛、大学生智能车、数学建模国奖&#xff0c;现就职于南京某半导体芯片公司&#xff0c;从事硬件研发&#xff0c;电路设计研究。对于学电子的小伙伴&#xff0c;深知入门的不易&#xff0c;特开次博客交流分享经验&a…
阅读更多...
FPGA代码设计规范一些探讨

FPGA代码设计规范一些探讨

代码设计规范的重要性 经过一段的工作积累已经慢慢进入了提高和进阶的阶段&#xff0c;在这篇博客里多聊一聊在现实工作中的话题&#xff0c;比如代码规范以及如何尽快接手前人代码&#xff0c;快速定位项目问题。 显然每个FPGA工程师的设计理念和代码风格很多情况下有一些差别…
阅读更多...
python 基于PHP+MySQL的学生成绩管理系统

python 基于PHP+MySQL的学生成绩管理系统

学生成绩管理是每一个学校都会面临的一个问题,传统的管理模式已经明显到和时代不同步。通过我对当前学校成绩管理的需求和自己的实习经验整理出了一个能够满足大多数学校的学生成绩管理系统。本系统分为管理人员,教师和学生三种用户,每种用户各负责其一部分功能然后通过他们的整…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023