【springMvc】自定义注解的使用方式

2023-09-15 16:46:24

                                                🎬 艳艳耶✌️:个人主页

                                                🔥 个人专栏 :《Spring与Mybatis集成整合》

                                                ⛺️  生活的理想,为了不断更新自己 !

1.前言

1.1.什么是注解

Annontation是Java5开始引入的新特征,中文名称叫注解。

它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)程序元素(类、方法、成员变量等)进行关联。为程序的元素(类、方法、成员变量)加上更直观、更明了的说明,这些说明信息是与程序的业务逻辑无关,并且供指定的工具或框架使用。Annontation像一种修饰符一样,应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。

1.2.注解的用处

  1.  生成文档。这是最常见的,也是java 最早提供的注解。常用的有@param @return 等
  2. 跟踪代码依赖性,实现替代配置文件功能。比如Dagger 2 依赖注入,未来java 开发,将大量注解配置,具有很大用处;
  3. 在编译时进行格式检查。如@override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

 1.3.注解的原理

注解本质是一个继承了Annotation 的特殊接口,其具体实现类是Java 运行时生成的动态代理类。而我们通过反射获取注解时,返回的是Java 运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解(接口)的方法,会最终调用AnnotationInvocationHandler 的invoke 方法。该方法会从memberValues 这个Map 中索引出对应的值。而memberValues 的来源是Java 常量池。

2.注解的案列:

  2.1 案例一(获取类与方法上的注解值)

                定义一个类:

package com.sy.annotation.pi;

public enum  TranscationModel {
    Read, Write, ReadWrite    //定义三个实例,可以将它看作类

}

               写三个注解:

package com.sy.annotation;

import java.lang.annotation.*;

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

import java.lang.annotation.*;

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

import java.lang.annotation.*;

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

创建几个方法使用这些注解

package com.sy.annotation.Demo1;

import com.sy.annotation.MyAnnotation1;
import com.sy.annotation.MyAnnotation2;
import com.sy.annotation.MyAnnotation3;
import com.sy.annotation.TranscationModel;

/**
 * @author shenyan
 *
 * 获取类与方法上的注解值
 */
@MyAnnotation1(name = "艳艳耶")
public class Demo1 {

    @MyAnnotation1(name = "csdn")
    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");
    }
}

最后,进行测试

 2.2  案例二(获取类属性上的注解属性值,默认值的赋予)

        自定义一个注解,并赋予默认值:

package com.sy.annotation.Demo2;

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

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

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

  建立类测试:

                有些两个值都赋予了,有些只赋予了一个

package com.sy.annotation.Demo2;

/**
 * @author shenyan
 *
 * 获取类属性上的注解属性值
 */
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;
}

   测试结果:

   2.3  案例三(获取参数修饰注解对应的属性值,非空注解)

                同样,先建立一个非空注解

package com.sy.annotation;

import java.lang.annotation.*;

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

 建立方法,进行测试:

package com.sy.annotation.Demo3;

import com.sy.annotation.IsNotNull;

/**
 * @author shenyan
 *
 * 获取参数修饰注解对应的属性值
 */
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:

方法2:

方法3:

3.AOP结合自定义注解案例

        配置相关AOP  pom文件

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

       applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!--1. 注解式开发 -->
    <!-- 注解驱动 -->
    <context:annotation-config/>
    <!-- 用注解方式注入bean,并指定查找范围:com.javaxl.ssh2及子子孙孙包-->
    <context:component-scan base-package="com.zking"/>
    <!--开启动态代理-->
    <aop:aspectj-autoproxy />
 
</beans>

 定义一个标志日志的注解

package com.sy.annotation;

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

/**
 * @author shenyan
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String desc();
}

再创建一个切面类 LogAspect,用于实现日志记录的逻辑。

package com.sy.annotation.aop;

import com.sy.annotation.MyLog;
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 shenyan
 */
@Component
@Aspect
public class MyLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);

    /**
     * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的,就是目标类
     */
    @Pointcut("@annotation(com.sy.annotation.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());
    }


}

在方法上运用日志注解

package com.sy.annotation.aop;

import com.sy.annotation.MyLog;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author shenyan
 */
@Controller
public class LogController {

    @RequestMapping("/myLog")
    @MyLog(desc = "这是结合spring aop知识,讲解自定义注解应用的一个案例")
    public void testLogAspect(){
        System.out.println("这里随便来点啥");
    }
}

运行结果: 

                                                           今日分享结束!

更多推荐

CAN一致性测试

目录CAN一致性测试概述物理层一致性测试数据链路层一致性测试应用层一致性测试CAN一致性测试概述什么是一致性测试?一致性测试是用来检验一个半导体、零部件(ECU)以及软件是否符合规范的测试流程。通过执行“一致性测试”,可以验证被测件是否符合通讯协议规范,从而排除不同工程师的理解差异。为什么要进行一致性测试?为了保证产品

面试题四:请解释一下watch,computed和filter之间的区别

watch与computed、filter:watch:监控已有属性,一旦属性发生了改变就去自动调用对应的方法computed:监控已有的属性,一旦属性的依赖发生了改变,就去自动调用对应的方法.computed有详细的介绍,移步computed的使用filter:js中为我们提供的一个方法,用来帮助我们对数据进行筛选,

容器内也能运行图形化应用?Distrobox 为容器注入生命 | 开源日报 No.35

JetBrains/compose-multiplatformStars:13.3kLicense:Apache-2.0ComposeMultiplatform是一个使用Kotlin在多个平台上共享UI的声明性框架。它基于JetpackCompose,由JetBrains和开源贡献者开发。您可以选择使用ComposeM

django和celery的项目,nginx和uwsgi协议,在通过api端口进行deeplearning任务的训练和排队

问题汇总redis安装django和celery的安装nginx和uwsgi的安装一.Django的项目,有个runserver直接起了一个webserver,为什么还要Nginx包一层,起一个webserver呢?Nginx的性能比Django自带的Webserver的性能要好,python写的程序,deeplab想

怎样提高redis的命中率

要提高Redis缓存命中率,可以考虑以下几个方面:合理设置缓存过期时间:根据业务需求和数据更新频率,设置适当的缓存过期时间。过长的过期时间可能导致数据不及时更新,而过短的过期时间则可能导致频繁的缓存失效。选择合适的数据结构:根据具体业务场景选择合适的Redis数据结构。例如,使用Hash类型来存储对象,使用Sorted

DEM格式转换:转换NSDTF-DEM国标数据格式为通用格式,使用ArcGIS工具转换NSDTF-DEM国标.dem文件为通用.tif格式。

DEM格式转换:转换NSDTF-DEM国标数据格式为通用格式,使用ArcGIS工具转换NSDTF-DEM国标.dem文件为通用.tif格式。*.dem是一种比较常见的DEM数据格式,其有两种文件组织方式,即NSDTF-DEM和USGS-DEM。(1)NSDTF-DEM是一种明码的中国国家标准空间数据的交换格式,遵从国家

浅谈消防设备电源监控系统在高层民用建筑内的应用

【摘要】:当高层民用建筑内火灾发生时,各类消防设备能否正常运行、能否发挥作用是初期火灾扑救是否成功的重要条件之一,而稳定可靠的消防设备电源则是消防设备正常工作的保障。因此针对高层民用建筑内消防设备电源的监测系统至关重要。【关键词】:消防设备电源;AFPM100/B1;电压/电流传感器;高层民用建筑0前言为扎实推进高层民

【全志V3s】SPI NAND Flash 驱动开发

文章目录一、硬件介绍V3s的启动顺序二、驱动支持U-Boot驱动主线Linux驱动已经支持三、烧录工具xfel四、构建U-Boot(官方的Uboot)先编译一下开始spinandflash代码层面的适配修改menuconfig配置ARMarchitecture配置SupportforSPINandFlashonAllw

MySQL远程登录提示Access denied的场景

厂商给的某个MySQL库,通过客户端远程登录,提示这个错误,Accessdeniedforuser'用户名'@'IP'(usingpassword:YES)确认输入的账号密码都是正确的,出现这个错误说明端口是通的。此时可以检索mysql.user,如果待登录账号的记录host字段是localhost,说明仅允许本地登录

Hbuilder本地调试微信H5项目(一)

摘要通过内网穿透,访问本地Hbuilder创建的Vue项目前置准备下载并安装【HBuilder】,本文用的是HBuilder3.8.12版本,下载地址下载并安装【微信开发者工具】,本文用的是1.06版本,下载地址下载并安装【natapp】,下载地址实现逻辑本地使用Hbuilder进行开发并运行起来(配置为80端口)使用

【golang】深入理解GMP调度模型

GoroutineGo中,协程被称为goroutine,它非常轻量,一个goroutine只占几KB,并且这几KB就足够goroutine运行完,这就能在有限的内存空间内支持大量goroutine,支持了更多的并发,虽然一个goroutine的栈只占几KB(Go语言官方说明为4~5KB),但实际是可伸缩的,如果需要更多

热文推荐