【SpringMVC】自定义注解

2023-09-15 19:49:35

【SpringMVC】自定义注解

自定义注解及其应用

前言

在Java编程中，注解（Annotation）是一种用来向程序中添加元数据的方式，它可以在不改变代码逻辑的情况下对程序进行补充说明和配置。本文将介绍注解的定义、分类以及在实际开发中的应用。

1. 什么是注解？

注解是一种特殊的接口类型，它以@符号开头，可以附加在类、方法、字段等程序元素上，为这些元素添加额外的信息和属性。通过使用注解，我们可以在编译时或运行时对程序进行检查、配置和生成相应的代码。

2. 注解的用处

注解具有以下几个主要用途：

提供给编译器和工具进行代码分析和处理。
在运行时动态地获取和处理注解信息。
生成文档、代码和其他资源文件。
注解的使用可以减少冗余的配置代码，提高代码的可读性和维护性，同时还能够增强程序的灵活性和可扩展性。

3. 注解的原理

注解的原理主要基于Java的反射机制。在程序运行时，可以通过反射API获取被注解元素的相关信息，并根据注解定义的规则进行相应的处理。这使得开发者可以在运行时对程序进行动态配置和扩展。

注解的分类
Java中的注解可以分为三类：JDK基本注解、JDK元注解和自定义注解。接下来分别介绍它们的特点和用途。

  1. JDK基本注解

1.1. @Override

@Override注解用于标识方法覆盖父类或实现接口中的方法，可以帮助我们检查方法是否正确地覆盖了父类或接口中的方法。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

1.2. @SuppressWarnings

@SuppressWarnings注解用于抑制编译器警告信息，可以指定忽略某些特定类型的警告。

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
 
    String[] value();
}

2. JDK元注解

JDK元注解是用来注解其他注解的注解，它们主要用于控制注解的行为和作用范围。

2.1. @Retention

@Retention注解用于指定注解的生命周期，即注解在什么时候丢弃。常用的值包括SOURCE（编译时丢弃）、CLASS（编译时保留，运行时丢弃）和RUNTIME（运行时保留）。

@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.SOURCE)
@java.lang.annotation.Target({java.lang.annotation.ElementType.TYPE})
public @interface Slf4j {
    java.lang.String topic() default "";
}

2.2. @Target

@Target注解用于指定注解可以应用的目标元素类型，例如类、方法、字段等。
@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) //包

2.3. @Inherited

@Inherited注解用于指示某个注解是否可以被继承，默认情况下注解是不可继承的。

2.4. @Documented

@Documented注解用于指定注解是否会出现在生成的Java文档中。

3. 自定义注解

3.1. 自定义注解的分类

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

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

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

注解类

MyAnnotation1

package com.niyin.annotation.demo1;

import java.lang.annotation.*;

/**
 * MyAnnotation1注解可以用在类、接口、属性、方法上
 * 注解运行期也保留
 * 不可继承
 */
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation1 {
    String name();
}

MyAnnotation2

package com.niyin.annotation.demo1;

import com.niyin.annotation.TranscationModel;

import java.lang.annotation.*;

/**
 *  MyAnnotation2注解可以用在方法上
 *  注解运行期也保留
 *  不可继承
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {
    TranscationModel model() default TranscationModel.ReadWrite;
}
MyAnnotation3

package com.niyin.annotation.demo1;

import com.niyin.annotation.TranscationModel;

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation3 {
    TranscationModel[] models() default  TranscationModel.ReadWrite;
}

TestAnnotation

package com.niyin.annotation.demo2;

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

 
//@Retention(RetentionPolicy.SOURCE)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface   TestAnnotation {
    String value() default "默认value值";

    String what() default "这里是默认的what属性对应的值";
}

IsNotNull

package com.niyin.annotation.demo3;

import java.lang.annotation.*;


 
 //非空注解：使用在方法的参数上，false表示此参数可以为空，true不能为空
 
@Documented
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface IsNotNull {
    boolean value() default false;
}

demo1

package com.niyin.annotation.demo1;

import com.niyin.annotation.TranscationModel;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 *
 * 获取类与方法上的注解值
 */
@MyAnnotation1(name = "abc")
public class Demo1 {

    @MyAnnotation1(name = "xyz")
    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.niyin.annotation.demo1;

import com.niyin.annotation.TranscationModel;
import org.junit.Test;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 */
public class Demo1Test {
    @Test
    public void list() throws Exception {
//        获取类上的注解
        MyAnnotation1 annotation1 = Demo1.class.getAnnotation(MyAnnotation1.class);
        System.out.println(annotation1.name());//abc

//        获取方法上的注解
        MyAnnotation2 myAnnotation2 = Demo1.class.getMethod("list").getAnnotation(MyAnnotation2.class);
        System.out.println(myAnnotation2.model());//Read

//        获取属性上的注解
        MyAnnotation1 myAnnotation1 = Demo1.class.getDeclaredField("age").getAnnotation(MyAnnotation1.class);
        System.out.println(myAnnotation1.name());// xyz
    }

    @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
        }
    }
}

在这里插入图片描述
demo2

package com.niyin.annotation.demo2;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 *
 * 获取类属性上的注解属性值
 */
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.niyin.annotation.demo2;

import org.junit.Test;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 */
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());
    }
}

在这里插入图片描述
总结：如果我们注解上没有指定是value还是what默认就是value,如果只想转递一个参数又不想默认是value那就需要指定what=""即可。
demo3

package com.niyin.annotation.demo3;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 *
 * 获取参数修饰注解对应的属性值
 */
public class Demo3 {

    public void hello1(@IsNotNull(true) String name) {
        System.out.println("hello:" + name);
    }

    public void hello2(@IsNotNull String name) {
        System.out.println("hello:" + name);
    }
}

在这里插入图片描述

四、自定义注解案例
1.MyLogAspect切面类

package com.niyin.aspect;

import com.niyin.annotation.aop.MyLog;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
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;

import java.nio.channels.Pipe;
import java.util.Arrays;


@Component
@Aspect
public class MyLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);

    /**
     * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
     */
    @Pointcut("@annotation(com.niyin.annotation.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());
//    }
@Around("MyValid()")
public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    long startTime = System.currentTimeMillis();
    System.out.println(pjp.getTarget());
    System.out.println(pjp.getThis());
    Object[] args = pjp.getArgs();
    System.out.println(Arrays.toString(args));


    Object ob = pjp.proceed();// ob 为方法的返回值
    System.out.println(ob);
    logger.info("耗时 : " + (System.currentTimeMillis() - startTime));
    return ob;
}
}

LogController

package com.niyin.web;

import com.niyin.annotation.aop.MyLog;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 */

@Controller
public class LogController {
@RequestMapping("/mylog")
    @MyLog(desc = "这是结合spring aop知识，讲解自定义注解应用的一个案例")
    public void testLogAspect(HttpServletRequest request){
    request.getRemoteAddr();
    request.getRemotePort();


    System.out.println("这里随便来点啥");
    }
}

mylog

package com.niyin.annotation.aop;

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

/**
 * @author 小李飞刀
 * @site www.javaxl.com
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String desc();
}

在这里插入图片描述

结语

本文介绍了注解
的定义、分类以及在实际开发中的应用。通过学习和使用注解，我们可以提高代码的可读性和维护性，减少冗余的配置代码，并增强程序的灵活性和可扩展性。希望本文能对大家理解和运用注解有所帮助。如有疑问或错误之处，欢迎指正。

更多推荐

SIEM：网络攻击检测

如果您正在寻找一种能够检测环境中的网络威胁、发送实时警报并自动执行事件响应的网络攻击检测平台，Log360SIEM解决方案可以完成所有这些以及更多，能够准确检测安全威胁并遏制网络攻击。网络攻击检测能力基于规则的攻击检测MITREATT&CK实现来检测APTS基于ML的行为分析基于规则的攻击检测使用从Log360强大的关

Spring Cloud Alibaba Nacos注册中心（单机）

文章目录SpringCloudAlibabaNacos注册中心（单机）1.docker安装nacos（先别着急）2.配置nacos持久化到mysql、2.1properties文件3.java注册3.1POM文件3.2properties文件3.3测试配置中心4.注册中心4.1配置文件4.2测试类4.3补充演示Spri

Vivado初体验LED工程

文章目录前言一、PL和PS二、LED硬件介绍三、创建Vivado工程四、创建VerilogHDL文件五、添加管脚约束六、添加时序约束七、生成BIT文件八、仿真测试九、下载测试前言本节我们要做的是熟练使用Vivado创建工程并实现对LED灯控制，每秒钟控制开发板上的LED灯翻转一次，实现亮、灭、亮、灭的控制。会控制LED

中国这么多 Java 开发者，应该诞生出生态级应用开发框架

1、必须要有，不然就永远不会有应用开发框架，虽然没有芯片、操作系统、数据库、编程语言这些重要。但是最终呈现在用户面前的，总是有软件部分。而软件系统开发，一般都需要应用开发框架，它是软件系统的基础性部件之一。很多很多软件系统都会有Java开发的部分，尤其是政府部门的软件系统大量的使用了Java。市场非常的大，我们有很多的

【国产32位mcu】电动车控制芯片CS32F031C8T6的应用

近年来，随着“新国标”的落地，双轮电动车在智能化、强性能、安全性等方面不断演进，带动了新一轮的换车高峰。电动车控制器作为双轮电动车的核心部件，迎来新的增长。芯海科技32位MCUCS32F031C8T6，作为电动车控制器的主控MCU芯片，很好地满足了双轮电动车在户外工作中的高温宽、高耐潮的工作环境，以及PWM、ADC等高

《DevOps实践指南》- 读书笔记（八）

DevOps实践指南Part6集成信息安全、变更管理和合规性的技术实践22.将信息安全融入每个人的日常工作22.1将安全集成到开发迭代的演示中22.2将安全集成到缺陷跟踪和事后分析会议中22.3将预防性安全控制集成到共享源代码库及共享服务中22.4将安全集成到部署流水线中22.5保证应用程序的安全性22.6确保软件供应

BD就业复习第三天

1.连续活跃区间表的实现思路实现连续活跃区间表是数据仓库中常见的需求，通常用于分析用户或实体在一段时间内的活跃情况。以下是一种可能的实现思路：1.数据模型设计：首先，您需要设计一个数据模型来存储连续活跃区间。通常，这个表包含以下字段：用户/实体ID：标识活跃实体的唯一标识符。开始日期：活跃区间的开始日期或时间戳。结束日

【DevOps系列】Docker数据卷（volume）详解

【DevOps系列】Docker数据卷（volume）详解文章目录【DevOps系列】Docker数据卷（volume）详解一、概述二、数据卷三、为什么使用数据卷volume数据卷的作用：数据卷的特点：四、数据卷volume基本操作4.1创建数据卷4.2查看数据卷4.3查看数据卷详细信息4.4数据卷删除五、数据卷的使用

Python发布订阅模式

Python发布订阅模式1、broadcast-service模块2、基本使用3、使用装饰器4、发布Topic带参数1、broadcast-service模块Python发布订阅模式可以实现程序间的松耦合broadcast-service是一个轻量级的Python发布订阅者框架，且支持同步、异步、多主题订阅等不同场景下

【Python基础】S01E02 列表

S01E02列表列表是什么列表的操作修改、添加和删除元素列表排序列表倒序列表长度遍历整个列表数值列表创建数值列表数值列表简单统计计算列表推导式列表切片复制列表列表是什么在Python中，用方括号（[]）表示列表，用逗号分隔其中的元素。bicycles=['trek','cannon','redline','specia

华为OD机试 - 构成正方形的数量 - 数据结构map（Java 2023 B卷 100分）

目录专栏导读一、题目描述二、输入描述三、输出描述四、Java算法源码五、效果展示1、输入2、输出3、说明华为OD机试2023B卷题库疯狂收录中，刷题点这里专栏导读本专栏收录于《华为OD机试（JAVA）真题（A卷+B卷）》。刷的越多，抽中的概率越大，每一题都有详细的答题思路、详细的代码注释、样例测试，发现新题目，随时更新

热文推荐
  1. Map＜K,V＞的使用和List学习

    MapMap是一种专门用来进行搜索的容器或者数据结构，其搜索的效率与其具体的实例化子类有关。对于静态类型的查找来说，一般直接遍历或者用二分查找【不会对区间进行插入和删除操作】而在现实生活中的查找比如：根据姓名查询考试成绩通讯录，即根据姓名查询联系方式不重复集合，即需要先搜索关键字是否已经在集合中注：Map最重要的特性就

  2. 【Redis】深入探索 Redis 的数据类型 —— 列表 List

    文章目录一、List类型介绍二、List类型相关命令2.1LPUSH和RPUSH、LPUSHX和RPUSHX2.2LPOP和RPOP、BLPOP和BRPOP2.3LRANGE、LINDEX、LINSERT、LLEN2.4列表相关命令总结三、List类型内部编码3.1压缩列表（ziplist）3.2链表（linkedli

  3. ceph分布式存储

    目录一、概述二、组件三、架构图四、搭建一、概述ceph是一个统一的分布式存储系统，设计初衷是提供较好的性能、可靠性和可扩展性。特点：1.统一存储虽然ceph底层是一个分布式文件系统，但由于在上层开发了支持对象和块的接口。所以在开源存储软件中，能够一统江湖。至于能不能千秋万代，就不知了。2.高扩展性扩容方便、容量大。能够

  4. 前端Vue3+element-plus表单输入框实现Cron表达式校验

    页面如下：本来想手写正则表达式校验，结果发现很麻烦，cron表达式组成如下：开发使用框架为vue3+element-plus，于是选择cron-validator依赖。使用步骤如下：1、通过npminstallcron-validator命令安装：2、可以通过package.json文件中看到，已安装成功。3、在你需要

  5. 自动化测试的生命周期是什么？

    软件测试发展到今日，已经逐渐标准化且能力更强，其流程每天都在发展。测试人员的技术熟练程度对于整个测试阶段的成功来说至关重要。测试不再意味着仅仅发现错误；它的范围已经扩大，从任何开发项目开始就可以看出它的重要性。当谈论起自动化测试生命周期（AutomationTestingLifeCycle）时，大多数人认为这只是SDL

  6. 【vue】vue 中插槽的三种类型：

    文章目录一、匿名插槽：``二、具名插槽：``三、作用域插槽一、匿名插槽：<slot></slot>1.没有为插槽指定名称2.通过slot标签可以添加匿名插槽3.在使用组件的时候，组件中的内容会填充到所有匿名插槽的位置，所以在封装组件的时候，匿名插槽一般只有一个4.匿名插槽可以设置默认的内容，如果没有传入内容就使用默认内

  7. ceph分布式存储部署

    一、概述是一个统一的分布式存储系统，设计初衷是提供较好的性能、可靠性和可扩展性。特点1、统一存储虽然ceph底层是一个分布式文件系统，但由于在上层开发了支持对象和块的接口。所以在开源存储软件中，能够一统江湖。至于能不能千秋万代，就不知了。2、高扩展性扩容方便、容量大。能够管理上千台服务器、EB级的容量。3、可靠性高支持

  8. c++ 模版元编程 基于条件的编译

    基于条件的编译是指根据不同的条件选择是否编译某段代码或选择不同的代码路径。在C++的模板元编程中，我们可以利用模板特化和std::enable_if技术来实现基于条件的编译。通过基于条件的编译，我们可以在编译期间根据类型特征或其他条件，决定采取不同的代码路径。这种能力使得我们可以针对不同类型或条件编写更加灵活和通用的代

  9. 死锁详细解读

    目录死锁（1）一、死锁的定义二、产生死锁的原因三、产生死锁的四个必要条件四、解决死锁的方法死锁（2）第三节死锁避免一、死锁避免的概念二、安全状态与安全序列三、银行家算法第四节、死锁的检测与解除一、死锁的检测和解除二、死锁检测的算法三、解除死锁的方法死锁（3）第五节资源分配图一、资源分配图二、死锁定理第六节哲学家就餐问题