java自定义注解（Annotation）及自定义注解结合Aop数据字典应用

最新推荐文章于 2024-07-05 10:13:40 发布
最新推荐文章于 2024-07-05 10:13:40 发布
阅读量695 收藏 4
点赞数 1
文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/men_ma/article/details/109749267
版权

转载请标明出处：https://blog.csdn.net/men_ma/article/details/106847165.
本文出自 不怕报错 就怕不报错的小猿猿 的博客

java自定义注解

背景

在平时开发过程中经常看到各种各样的注解，例如@Component、@Resource、@Override 等等，注解极大方便了我们开发，今天就了解下注解，看下我们如何自定义注解。自定义注解前 我们必须要了解元注解和相关定义注解的语法。

目标

1、Java注解简介
2、Java元注解（重点）
3、自定义注解
4、Aop自定义注解的应用（重点）

1.Java注解简介

1.1 Java注解(Annotation)

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

注解相关类都包含在java.lang.annotation包中。

1.2 Java注解分类

  1. JDK基本注解
  2. JDK元注解
  3. 自定义注解

1.3 JDK基本注解

  1. @Override 重写
  2. @Deprecated 已过时
  3. @SuppressWarnings(value = “unchecked”) 压制编辑器警告

2.注解的基本元素

声明一个注解要用到的东西

  • 修饰符
          访问修饰符必须为public,不写默认为pubic；
  • 关键字
          关键字为@interface；
  • 注解名称
          注解名称为自定义注解的名称，使用时还会用到；
  • 注解类型元素
          注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

3.Java元注解

作用：元注解用于修饰其他的注解

3.1 @Retention：定义注解的保留策略

定义注解含义
@Retention(RetentionPolicy.SOURCE)//注解仅存在于源码中，在class字节码文件中不包含 ,在*.java编译文件中生效，如果一运行，这个注解会在*.class文件中自动消失，不会带到*.class中去
@Retention(RetentionPolicy.CLASS)//默认的保留策略，注解会在class字节码文件中编译存在，但运行时无法通过反射获取
@Retention(RetentionPolicy.RUNTIME)//注解会在class字节码文件中存在，在运行时可以通过反射获取到

3.2 @Target：指定被修饰的Annotation可以放置的位置(被修饰的目标)

指定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})，也就是此注解可以在方法和类上面使用

3.3 @Inherited：指定被修饰的Annotation将具有继承性 （判断自定义注解是否能继承）

案例：
在这里插入图片描述

3.4 @Documented：指定被修饰的该Annotation可以被javadoc工具提取成文档.

4.自定义注解

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

  1. 标记Annotation（注解）: 没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息（例如：）
    @Override（重写注解）：不需要传递任何的参数的
    在这里插入图片描述

  2. 元数据Annotation（注解）:包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;(例如：)
    @RequestMapping("/preSave")（请求地址映射的注解）：可以接收很多的参数的
    在这里插入图片描述

4.2 如何自定义注解？

使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:

Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型, 而且我们还可以使用default关键字为这个成员变量设定默认值；

注意：只有名字为“value”属性，赋值时可以省略属性名

接下来开始上代码：

5. 案例（三个）

5.1 案例一（获取类与方法上的注解值）：

TranscationModel (定义枚举类):

package com.xiaoqing.ssm.P1;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:46
 *
 * 定义枚举类型
 */
public enum TranscationModel {
    Read, Write, ReadWrite
}

MyAnnotation1 ：

package com.xiaoqing.ssm.P1;

import java.lang.annotation.*;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:47
 *
 *
 * MyAnnotation1注解可以用在类、接口、属性、方法上
 *  * 注解运行期也保留
 *  * 不可继承
 */

@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation1 {

    String name();
}

MyAnnotation2 ：

package com.xiaoqing.ssm.P1;

import java.lang.annotation.*;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:49
 *
 *
 * MyAnnotation2注解可以用在方法上
 *  *  注解运行期也保留
 *  *  不可继承
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {

    TranscationModel model() default TranscationModel.ReadWrite;
}

MyAnnotation3 ：

package com.xiaoqing.ssm.P1;

import java.lang.annotation.*;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:50
 *
 * * MyAnnotation3注解可以用在方法上
 *  * 注解运行期也保留
 *  * 可继承
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation3 {

    TranscationModel[] models() default TranscationModel.ReadWrite;

}

Demo1 ：获取类与方法上的注解值

package com.xiaoqing.ssm.P1;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:54
 *
 *
 * 一切的反射都是从获取类对象开始：：
 *  1.getClass
 *  2.  .class
 *  3. class.forname
 *
 * 获取类与方法上的注解值
 */

@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 ：测试Demo1

package com.xiaoqing.ssm.P1;

import org.junit.Test;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:50
 *
 */
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



    }

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

list()方法：
在这里插入图片描述

edit()方法:
在这里插入图片描述

5.2 案例二（获取类属性上的注解属性值）：

TestAnnotation（定义注解）:

package com.xiaoqing.ssm.annotation.p2;

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

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 16:29
 */
//@Retention(RetentionPolicy.SOURCE)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TestAnnotation {

    String value() default "默认value值";

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

Demo2：

package com.xiaoqing.ssm.annotation.p2;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 16:30
 *
 * 获取类属性上的注解属性值
 */
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;
}

MyAnnotation2 ：

package com.xiaoqing.ssm.P1;

import java.lang.annotation.*;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:49
 *
 *
 * MyAnnotation2注解可以用在方法上
 *  *  注解运行期也保留
 *  *  不可继承
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {

    TranscationModel model() default TranscationModel.ReadWrite;
}

MyAnnotation3 ：

package com.xiaoqing.ssm.P1;

import java.lang.annotation.*;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 0:50
 *
 * * MyAnnotation3注解可以用在方法上
 *  * 注解运行期也保留
 *  * 可继承
 */

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation3 {

    TranscationModel[] models() default TranscationModel.ReadWrite;

}

测试结果：

Demo2Test：测试Demo2

package com.xiaoqing.ssm.annotation.p2;

import org.junit.Test;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 16:30
 */
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());
    }
}

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

5.3 案例三（获取参数修饰注解对应的属性值）：

IsNotNull（定义注解）:

package com.xiaoqing.ssm.annotation.p3;

import java.lang.annotation.*;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 16:36
 *
 * 非空注解：使用在方法的参数上，false表示此参数可以为空，true不能为空
 */

@Documented
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface IsNotNull {
    boolean value() default false;
}

Demo3：

package com.xiaoqing.ssm.annotation.p3;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 16:37
 *
 * 获取参数修饰注解对应的属性值
 */
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);
    }

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

测试结果：

Demo3Test：测试Demo3

package com.xiaoqing.ssm.annotation.p3;

import org.junit.Test;

import java.lang.reflect.Parameter;

/**
 * @author晴sister
 * @site https://blog.csdn.net/men_ma
 * @company xxx公司
 * @create  2020-11-25 16:38
 */
public class Demo3Test {

    @Test
    public void hello1() throws Exception {
        Demo3 demo3 = new Demo3();
        for (Parameter parameter : demo3.getClass().getMethod("hello1", String.class).getParameters()) {
            IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
            if(annotation != null){
                System.out.println(annotation.value());//true
            }
        }
    }

    @Test
    public void hello2() throws Exception {
        Demo3 demo3 = new Demo3();
        for (Parameter parameter : demo3.getClass().getMethod("hello2", String.class).getParameters()) {
            IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
            if(annotation != null){
                System.out.println(annotation.value());//false
            }
        }
    }

    @Test
    public void hello3() throws Exception {
        Demo3 demo3 = new Demo3();
        for (Parameter parameter : demo3.getClass().getMethod("hello3", String.class,String.class,String.class).getParameters()) {
            IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
            if(annotation != null){
                System.out.println(annotation.value());//true
            }
        }
    }
}

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述

6.自定义注解结合Aop数据字典应用

参考博客：
自定义注解结合Aop数据字典应用
自定义注解+拦截器+SSM应用于前端token校验

不怕报错 就怕不报错的小猿猿
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
自定义注解+AOP记录访问日志
软件老王
12-02 643
1、问题描述 AOP拦截请求，记录请求参数、返回参数及响应时间，以前已经介绍过了，但是发现有个小问题，就是有些心跳或者仅仅是查询字典下拉框的请求，本身不用记录，排除的话，需要一个一个排除，有点麻烦，就用自定义注解对aop记录请求与返回做了个下改进，简单记录下。 2、解决方案 简单说就是新建个自定义注解标签，然后对需要记录日志的的方法加上标签就可以了。 2.1 自定义标签 import java.lang.annotation.*; @Documented @Retention(RetentionPolic
spring-cloud-commons, 在不同的spring 云实现中，常用的类.zip
09-18
spring-cloud-commons, 在不同的spring 云实现中，常用的类 云原生插件是一种应用开发风格，它鼓励在持续交付和价值驱动开发领域轻松采用最佳实践。 有关开发 12-factor 应用程序的相关规程是，开发实践与交付和操作目标一致，例如使用声明性编程和管理和监视。 spring 云方便了这些类型的开
Spring Cloud Commons 普通抽象
qq_40354025的博客
10-16 554
诸如服务发现，负载平衡和断路器之类的模式适用于所有Spring Cloud客户端可以独立于实现（例如通过Eureka或Consul发现）的消耗的共同抽象层。
使用Java实现自定义注解的方法与技巧
最新发布
技术研究中心
07-05 1040
自定义注解是Java编程中强大的工具，可以用于代码的元数据描述、简化配置、实现AOP等。通过定义注解、使用注解和处理注解，我们可以实现许多有用的功能，提升代码的可读性和可维护性。在Java开发中，注解是一种强大的工具，广泛用于框架开发和代码的元数据描述。通过自定义注解，我们可以实现很多有用的功能，比如自动生成代码、简化配置、实现AOP等。注解（Annotation）是Java提供的一种元数据形式，可以在代码中添加额外的信息。关键字，注解可以包含元素，就像接口中的方法一样。注解的方法，记录方法的执行时间。
【秒懂·云原生】微服务篇 —— Spring Cloud Commons:公共抽象
热门推荐
03-29 4万+
学习Spring Cloud 必须要会的知识，Spring Cloud Commons：公共抽象
Spring Cloud Commons模块
前路无畏的博客
04-11 1860
只要在项目的pom文件中引入了spring-cloud-starter 依赖包 ，就可以保证 spring-cloud-commons 的 jar被引入。如下图： Spring Cloud Commons模块设计的目的，Spring Cloud Commons模块是为了对微服务中的服务注册与发现、负载均衡、熔断器等功能提供一个抽象层代码，这个抽象层与具体的实现无关。这样这些功能具体的实现上可以采用不同的技术去实现，并可以做到在使用时灵活的更换。 下面是一些常用的抽象点： 1. @EnableDis
自定义注解结合Aop数据字典应用
Better_Mei的博客
01-09 882
本篇博客主要聊聊自定义注解在项目中的应用，自定义注解用来做系统监控日志，这个用法已经烂大街了，无法让面试官眼前一亮的感觉。 项目开发中数据字典使用场景非常多，使用数据字典有一点非常的不方便，那就是数据库中存放的是数字，而实际页面上展示的却是汉字；那么这也就造成了，每次做页面展示的时候都需要给数字进行转义，将其转义成汉字内容展示到页面，而转换的过程过于繁琐； 咱们的自定义注解可以完美的解决这一问...
Java的自定义注解——Annotation的使用
javanofa的博客
03-16 352
Annotation——自定义注解 Java中提供了 Annotation 功能，该功能可用于类，构造方法，成员变量，方法。参数等的声明中。该功能不会影响程序的运行，但是会对编译器警告等辅助工具产生影响。 定义 Annotation 类型 在定义 Annotation 类型时，需要用到用来定义接口的 interface 关键字，但需要在 interface 关键字前面加一个 “ @ ” 符号，即定...
详解使用Spring Boot的AOP处理自定义注解
08-28
使用Spring Boot的AOP处理自定义注解 AOP（Aspect-Oriented Programming，面向切面编程）是一种程序设计范型，旨在解决横切关注点（crosscutting concern）的问题。Spring Boot提供了AOP的支持，使得开发者可以轻松...
自定义注解+AOP实现规范返回数据和数据过滤
qq_42190578的博客
08-31 1659
自定义注解+AOP实现规范返回数据和数据过滤 由于JsonView和我写的AOP冲突，所以自定义了数据过滤 XML <!--AOP--> <dependency> <groupId>org.assertj</groupId> <artifactId>assertj-core</artifactId> </dependency> <dependency> <groupId>
spring+ commons
09-19
最新spring jar包4.3.11, 官方所有 另外包含commons-logging-1.2 也是最新的 还把开发所用的jar另外弄了一个文件夹, 可以直接复制粘贴
spring-cloud-commons：在不同的Spring Cloud实现中使用的通用类
01-30
spring-cloud-commons：在不同的Spring Cloud实现中使用的通用类
spring-data-commons-1.6.2.RELEASE-javadoc.jar
10-22
spring-data-commons-1.6.2.RELEASE-javadoc.jar
SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码
05-07
SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 SpringCloud分布式微服务项目Common通用依赖模块抽离示例代码 Spring
使用自定义注解翻译字典项
leomoon
11-20 1094
使用自定义注解翻译字典项 使用拦截器/aop
spring cloud commons-分布式程序概述
ssehs的博客
08-03 1450
前言 Cloud Native是一种应用程序开发风格，它鼓励在持续交付和价值驱动开发领域轻松采用最佳实践。一个相关的规程是构建12因素应用程序，其中开发实践与交付和操作目标保持一致——例如，通过使用声明式编程、管理和监视。Spring Cloud以许多特定的方式促进了这些风格的开发。起点是一组特性，分布式系统中的所有组件都需要方便地访问这些特性。 Spring Boot包含了其中的许多特性，Spring Cloud构建在Spring Boot之上。Spring Cloud还提供了两个库:Spring Clo
Spring Cloud Commons
hbuzhuhaoju的博客
12-27 2894
诸如服务发现，负载平衡和断路器之类的模式适用于所有Spring Cloud客户端可以独立于实现（例如通过Eureka或Consul发现）的消耗的共同抽象层。@EnableDiscoveryClient Commons提供@EnableDiscoveryClient注释。这通过META-INF/spring.factories查找DiscoveryClient接口的实现。Discovery Clie
SpringCloud学习-SpringCloudCommons
NickWU博客
12-05 1973
@EnableDiscoveryClient Commons提供EnableDiscoveryClient注释，通过META-INF/spring.factories查找DiscoveryClient接口的实现。Discovery Client的实现将在org.springframework.cloud.client.discovery.EnableDiscoveryClient下面的spring...
自定义Java注解：元注解与范围理解
本文将着重介绍如何基于Java注解进行自定义注解的入门，以及如何利用Java内置的元注解来理解注解的工作原理。 首先，深入学习注解的关键在于掌握如何定义和使用自定义注解。在定义自定义注解前，需要了解Java提供的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值