Java自定义注解实现过程

最新推荐文章于 2024-10-12 11:06:22 发布
原创 最新推荐文章于 2024-10-12 11:06:22 发布 · 6.6k 阅读 · 7 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #自定义 #注解

本文介绍了一种使用自定义注解进行参数校验的方法，包括注解的创建、解析及校验流程，并通过示例展示了如何在Java项目中应用自定义注解。

步骤
1、创建自定义注解类，并添加校验规则
2、解析自定义注解类并实现校验方法
3、创建测试类并声明自定义注解
4、编写Junit测试类测试结果

自定义注解类

package com.swk.common.annotation;

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

/**
 * 自定义注解类
 * @author fuyuwei
 * @Retention: 定义注解的保留策略
 * @Retention(RetentionPolicy.SOURCE)  注解仅存在于源码中，在class字节码文件中不包含
   @Retention(RetentionPolicy.CLASS)   默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
   @Retention(RetentionPolicy.RUNTIME) 注解会在class字节码文件中存在，在运行时可以通过反射获取到

   @Target 注释类型声明
   CONSTRUCTOR 构造方法声明
   FIELD 字段声明（包括枚举常量）
   LOCAL_VARIABLE 局部变量声明
   METHOD 方法声明
   PACKAGE 包声明
   PARAMETER 参数声明
   TYPE 类、接口（包括注释类型）或枚举声明
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.PARAMETER})
public @interface CustomAnnotation {

    /**
     * 是否为空
     * @return
     */
    boolean isNull() default false;

    /**
     * 最大长度
     * @return
     */
    int maxLength() default 8;

    /**
     * 字段描述
     * @return
     */
    String description() default "";

}

实现自定义注解类规则读取与校验

package com.swk.common.annotation;

import java.lang.reflect.Field;
import java.util.concurrent.ConcurrentHashMap;

import org.springframework.util.StringUtils;

import com.swk.common.enums.CommonPostCode;
import com.swk.common.exception.PostingException;


/**
 * 解析自定义注解，并完成校验
 * @author fuyuwei
 */
public class AnnotationChecker {

    private final static ConcurrentHashMap<String,Field[]> fieldsMap = new ConcurrentHashMap<String, Field[]>();

    public AnnotationChecker(){
        super();
    }

    public static void checkParam(Object object) throws PostingException{
        Class<? extends Object> clazz = object.getClass();
        Field[] fields = null;
        if(fieldsMap.containsKey(clazz.getName())){
            fields = fieldsMap.get(clazz.getName());
        }
        // getFields:获得某个类的所有的公共（public）的字段，包括父类;getDeclaredFields获得某个类的所有申明的字段，即包括public、private和proteced，但是不包括父类的申明字段
        else{
            fields = clazz.getDeclaredFields();
            fieldsMap.put(clazz.getName(), fields);
        }
        for(Field field:fields){
            synchronized(field){
                field.setAccessible(true);
                check(field, object);
                field.setAccessible(false);
            }
        }
    }

    private static void check(Field field,Object object) throws PostingException{
        String description;
        Object value = null;
        CustomAnnotation ca = field.getAnnotation(CustomAnnotation.class);
        try {
            value = field.get(object);
        } catch (IllegalArgumentException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
        if (ca == null) return;
        // 如果没有标注description默认展示字段名称
        description = ca.description().equals("")?field.getName():ca.description();
        if(!ca.isNull()){
            if(value == null || StringUtils.isEmpty(value.toString().trim())){
                throw new PostingException(CommonPostCode.PARAM_LENGTH.getErrorCode(),description+" "+CommonPostCode.PARAM_NULL.getErrorMesage());
            }
        }
        if(value.toString().length() > ca.maxLength()){
            throw new PostingException(CommonPostCode.PARAM_LENGTH.getErrorCode(),description+" "+CommonPostCode.PARAM_LENGTH.getErrorCode());
        }
    }
}

创建依赖的其他类

枚举类

package com.swk.common.enums;

public enum CommonPostCode {

    PARAM_NULL(-1,"param required"),
    PARAM_LENGTH(-2,"param too long");

    private int errorCode;

    private String errorMesage;


    private CommonPostCode(int errorCode, String errorMesage) {
        this.errorCode = errorCode;
        this.errorMesage = errorMesage;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMesage() {
        return errorMesage;
    }

    public void setErrorMesage(String errorMesage) {
        this.errorMesage = errorMesage;
    }


}

自定义异常类

package com.swk.common.exception;

public class PostingException extends RuntimeException {

    private static final long serialVersionUID = 5969404579580331293L;

    private int errorCode;

    private String errorMessage;

    public PostingException(int errorCode, String errorMessage) {
        super();
        this.errorCode = errorCode;
        this.errorMessage = errorMessage;
    }

    public int getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(int errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMessage() {
        return errorMessage;
    }

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }



}

创建声明自定义注解的测试类

package com.swk.request;

import com.swk.common.annotation.CustomAnnotation;

public class UserInfoRequest {

    @CustomAnnotation(isNull=false,maxLength=4,description="姓名")
    private String name;

    @CustomAnnotation(isNull=false,maxLength=11,description="手机号")
    private String mobile;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getMobile() {
        return mobile;
    }

    public void setMobile(String mobile) {
        this.mobile = mobile;
    }


}

编写Junit测试类

package com.swk.test.annotation;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import com.sun.istack.internal.logging.Logger;
import com.swk.common.annotation.AnnotationChecker;
import com.swk.common.exception.PostingException;
import com.swk.request.UserInfoRequest;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:spring-mybatis.xml"})
public class AnnotationTest {

    private Logger logger = Logger.getLogger(AnnotationTest.class);

    @Test
    public void testAnnotation(){
        UserInfoRequest request = new UserInfoRequest();
        try {
            AnnotationChecker.checkParam(request);
        } catch (PostingException e) {
            logger.info(e.getErrorCode()+":"+e.getErrorMessage());
        }
    }
}

运行结果
这里写图片描述

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:spring-mybatis.xml"})
public class AnnotationTest {

    private Logger logger = Logger.getLogger(AnnotationTest.class);

    @Test
    public void testAnnotation(){
        UserInfoRequest request = new UserInfoRequest();
        request.setName("齐天大圣孙悟空");
        try {
            AnnotationChecker.checkParam(request);
        } catch (PostingException e) {
            logger.info(e.getErrorCode()+":"+e.getErrorMessage());
        }
    }
}

运行结果
这里写图片描述

自定义Java注解的实现步骤
qq_52897257的博客
07-24 496
如何编写一个自定义注解？在上述代码中，我们定义了一个名为`CustomAnnotation`的注解，它有两个成员变量：`value`和`count`。`value`成员变量是一个字符串类型的，默认值为空字符串；`count`成员变量是一个整数类型的，默认值为0。我们使用`@Retention`注解指定了注解的保留策略为`RUNTIME`，即在运行时仍然可用；使用`@Target`注解指定了注解的目标为`METHOD`，即只能应用于方法上。// 方法体。
java 自定义注解的实例详解
08-29
在本文中，我们将详细介绍 Java 自定义注解的实例详解，包括如何创建自定义注解、如何使用反射来获取注解信息 oraz 如何使用自定义注解来实现特定的功能。 一、Java 注解的基本概念 Java 注解是一种特殊的标记，它...
Java实现自定义注解
热门推荐
全力奔跑，梦在彼岸
08-25 10万+
前言      上一篇文章介绍了注解的一些基本知识，这次来介绍下如何实现自定义注解及注解如何使用。 正文      注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。...
JAVA实现自定义注解
weixin_46155048的博客
10-12 1万+
该注解功能最为强大，其所标注的方法用于编写包裹业务模块执行的代码，通知的第一个参数必须是 ProceedingJoinPoint 类型。，@Pointcut切点表达式非常丰富，可以将 方法(method)、类(class)、接口(interface)、包(package) 等作为切入点，非常灵活，常用的有@annotation、@within、execution等方式，上面的示例使用的是@annotation方式，意思就是说被Spring扫描到方法上带有@annotation中的注解 就会执行切面通知。
java注解-自定义注解的实现
胡云峰的博客
10-07 4642
注解浅解
注解
qq_33068253的博客
04-02 198
JDK自带的注解 @Override 重写方法 @Deprecated 过期启用 @SuppressWarnings("all") 压制警告 自定义注解 格式： 元注解 public @interface 注解名称{ } 本质：public @interface myAnno{ }-------->本质上就是一个接口，默认继承Annotation public interf...
java自定义注解接口实现方案
09-05
Java自定义注解是一种强大的工具，允许开发者在代码中添加元信息，这些信息可以在编译时或运行时被解析和利用。本文将深入探讨如何在Java中实现自定义注解以及如何解析和利用这些注解。 首先，了解Java中的元注解是...
Java自定义注解实现Redis自动缓存的方法
08-30
"Java自定义注解实现Redis自动缓存的方法" Java自定义注解实现Redis自动缓存的方法是指在Java应用程序中使用自定义注解来实现Redis自动缓存的功能。该方法可以在实际开发中节省重复劳动，提高开发效率。 首先，...
自定义注解实现伪动态传参的小demo
09-13
在这个“自定义注解实现伪动态传参的小demo”中，我们将探讨如何创建一个自定义注解，以允许在注解中传递类似于动态参数的数据。 首先，自定义注解的定义通常以`@interface`关键字开始，我们可以定义一些元素（也...
自定义注解实现拦截sql.rar
10-08
本示例中，“自定义注解实现拦截SQL”是关于如何通过注解来动态修改执行的SQL语句，以在其中增加特定的条件。这个功能在数据库操作中特别有用，比如在MyBatisPlus框架中，可以用来实现灵活的数据过滤或者权限控制。 ...
自定义注解实现
09-21
看到别的博主写的几篇接绍注解相关的东西，觉得挺好的，mark一下 概述及JDK自带注解：http://blog.youkuaiyun.com/zen99t/article/details/49506919 自定义注解：http://blog.youkuaiyun.com/zen99t/article/details/49508447 解析注解：http://blog.youkuaiyun.com/zen99t/article/details/49512411 注解反射生成SQL语句：http://blog.youkuaiyun.com/zen99t/article/details/50351575 后面的文件是自己上传的对着博主实现加了注释的代码。主要就是自定义了注解，使用了自定义注解，然后利用java的反射机制根据注解生成不同的sql语句
java 创建自定义注解_Java自定义注解实现过程
weixin_31681589的博客
02-28 762
步骤1、创建自定义注解类，并添加校验规则2、解析自定义注解类并实现校验方法3、创建测试类并声明自定义注解4、编写Junit测试类测试结果自定义注解类package com.swk.common.annotation;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.la...
Java自定义注解
duoerbasilu
03-03 191
Java注解目前广泛被应用。spring中的基于注解的依赖注入、Spring Web MVC中的Route、PlayFramework中的基于注解的Validation等。 使用注解，可以在适当地方替代XML的繁琐。 现在来看看，如何自定义注解。 目标：通过注解方式，定义属性的默认值。例如： public class DefaultUse { @Default(value = ...
java自定义注解的实现
羽枫760的博客
07-31 650
        今天研究了一下注解这个玩意，其实我们一直都在使用注解，一般我们都是用的第三方提供的注解或者是java内置的注解，我们从来没有关注过这些注解是怎么来的。像我们最开始接触java时，会碰到@Override注解，@SuppressWarnings注解，这些注解是java内置的注解，还有平时我们使用框架，接触...
使用Java实现自定义注解的方法与技巧
技术研究中心
07-05 1847
自定义注解是Java编程中强大的工具，可以用于代码的元数据描述、简化配置、实现AOP等。通过定义注解、使用注解和处理注解，我们可以实现许多有用的功能，提升代码的可读性和可维护性。在Java开发中，注解是一种强大的工具，广泛用于框架开发和代码的元数据描述。通过自定义注解，我们可以实现很多有用的功能，比如自动生成代码、简化配置、实现AOP等。注解（Annotation）是Java提供的一种元数据形式，可以在代码中添加额外的信息。关键字，注解可以包含元素，就像接口中的方法一样。注解的方法，记录方法的执行时间。
Java自定义注解的实现
呼呼的小窝
07-21 483
注解是Java开发中比较常用的一项技能，本篇文章将结合注解与反射这2块知识点进行讲解，为后续的自定义实现ORM框架做铺垫。关于Java反射的文章可以见本篇文章：Java反射 注解的定义 JDK5引入的新特性；在引入这个新特性之后，就被大量的框架所采用，在Spring中应用的及其广泛 注解可以大大提升编码效率以及代码的精简 比如：@Override @Deprecated @SuppressWar...
简单实现自定义注解
weixin_33691817的博客
03-27 263
在Java中创建自定义注解 创建自定义注解与编写接口很相似，除了它的接口关键字前有个@符号。 注意以下几点： ·注解方法不能有参数。 ·注解方法的返回类型局限于原始类型，字符串，枚举，注解，或以上类型构成的数组。 ·注解方法可以包含默认值。 ·注解可以包含与其绑定的元注解，元注解为注解提供信息，有四种元注解类型： @Documented – 表示使用该注解的元素应被javadoc或类似工具文档...
java 自定义注解 实现
最新发布
04-09
### Java 自定义注解的实现方法与示例 #### 创建自定义注解 在 Java 中，可以通过 `@interface` 关键字来声明一个新的注解。以下是创建自定义注解的关键要素： 1. **定义注解名称** 使用 `@interface` 定义新的注解类型。 2. **设置属性（可选）** 可以为注解添加属性，这些属性类似于方法签名，但不带具体实现。 3. **指定目标和保留策略** 需要通过元注解 `@Target` 和 `@Retention` 来限定注解的作用范围以及生命周期。 下面是一个简单的自定义注解示例[^4]： ```java 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 MyAnnotation { String value() default ""; // 默认值为空字符串 int count() default 0; // 默认计数值为0 } ``` --- #### 使用自定义注解 一旦定义好注解，就可以将其应用到类、方法或其他允许的地方。以下是如何使用上述 `@MyAnnotation` 的例子[^1]： ```java class MyClass { @MyAnnotation(value = "This is a sample method", count = 5) public void myMethod() { System.out.println("Method executed"); } } ``` 在这里，`myMethod()` 被标记了一个带有参数的 `@MyAnnotation` 注解。 --- #### 获取注解并读取其值 为了利用注解中的信息，通常会结合反射机制动态解析它们。以下是从类中提取注解信息的一个完整示例[^2]： ```java import java.lang.reflect.Method; public class AnnotationMain { public static void main(String[] args) throws Exception { MyClass obj = new MyClass(); // 获取当前对象的Class实例 Class<?> cls = obj.getClass(); // 查找所有的Declared Methods Method[] methods = cls.getDeclaredMethods(); for (Method method : methods) { // 判断该方法是否有特定注解 if (method.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation annotation = method.getAnnotation(MyAnnotation.class); // 输出注解中的value和count字段 String value = annotation.value(); int count = annotation.count(); System.out.println("Value: " + value + ", Count: " + count); } } } } ``` 当执行此代码时，它将打印出如下内容： ``` Value: This is a sample method, Count: 5 ``` --- #### 总结 以上展示了完整的流程：从定义自定义注解到实际运用再到通过反射获取其中的信息。这种技术非常适用于框架设计或自动化处理场景下，能够显著减少重复劳动并提升灵活性[^3]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值