Java自定义注解

要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。

package annotation;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 
 * @author Minzhe Xu    2017年4月27日下午3:22:52
 * 
 *@Target 表示该注解用于什么地方,可能的值在枚举类 ElemenetType 中,包括:  
 *ElemenetType.CONSTRUCTOR:构造器声明 
 *ElemenetType.FIELD :域声明(包括 enum 实例) 
 *ElemenetType.LOCAL_VARIABLE:局部变量声明 
 *ElemenetType.METHOD :方法声明 
 *ElemenetType.PACKAGE :包声明 
 *ElemenetType.PARAMETER :参数声明 
 *ElemenetType.TYPE:类,接口(包括注解类型)或enum声明 
 *
 *@Retention 表示在什么级别保存该注解信息。可选的参数值在枚举类型 RetentionPolicy 中,包括: 
 *RetentionPolicy.SOURCE :注解将被编译器丢弃 
 *RetentionPolicy.CLASS :注解在class文件中可用,但会被VM丢弃 
 *RetentionPolicy.RUNTIME VM:将在运行期也保留注释,因此可以通过反射机制读取注解的信息。 
 *
 *@Documented 将此注解包含在 javadoc 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@see,@param 等。
 *
 *@Inherited 允许子类继承父类中的注解。
 */

@Target({ElementType.TYPE,ElementType.CONSTRUCTOR,ElementType.METHOD,ElementType.PARAMETER,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {

    /**
     * @interface用来声明一个注解,
     * 其中的每一个方法实际上是声明了一个配置参数。
     * 方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。
     * 可以通过default来声明参数的默认值。
     */
    String name();
    int id() default 0;
    Class gid();

}

测试类

package annotation;

import java.util.HashMap;
import java.util.Map;

/**
 * 
 * @author Minzhe Xu    2017年4月27日下午3:09:20
 *
 */
@TestA(gid = Long.class, name = "type")
public class UserAnotation {
    @TestA(gid = Long.class, name = "param",id=1)
    private Integer age;

    @TestA(gid = Long.class, name = "constract",id=2)
    public UserAnotation(){

    }
    @TestA(gid = Long.class, name = "method",id=3)
    public void test1(){
        @SuppressWarnings("rawtypes")
        Map m=new HashMap(0);
    }

    @TestA(gid = Long.class, name = "method3",id=5)
    public void test2(@TestA(gid = Long.class, name = "inner_param",id=4) Integer a){

    }


}

通过反射的方式 使用注解

package annotation;

import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;

/**
 * 
 * @author Minzhe Xu    2017年4月27日下午3:39:17
 *
 */
public class ParseAnotation {

    public static void parseTypeAnnotation() throws ClassNotFoundException{
        Class clazz=Class.forName("annotation.UserAnotation");
        Annotation[] annotations = clazz.getAnnotations();
        for(Annotation annotation:annotations){
            TestA testA=(TestA) annotation;
            System.out.println("id="+testA.id()+";name="+testA.name()+";gid="+testA.gid());
        }
    }
    public static void parseMethodAnnotation(){
        Method[] methods = UserAnotation.class.getDeclaredMethods();
        for(Method method:methods){
            boolean hasAnnotation=method.isAnnotationPresent(TestA.class);
            if(hasAnnotation){
                TestA testA=method.getAnnotation(TestA.class);
                System.out.println("id="+testA.id()+";name="+testA.name()+";gid="+testA.gid());
            }
        }
    }

    @SuppressWarnings("unchecked")
    public static void parseConstractAnnotation(){
        Constructor[] constructors = UserAnotation.class.getConstructors();
        for(Constructor contructor:constructors){
            boolean annotationPresent = contructor.isAnnotationPresent(TestA.class);//isAnnotationPresent方法来判断是否使用了某个注解
            if(annotationPresent){
                TestA testA = (TestA) contructor.getAnnotation(TestA.class);
                System.out.println("id="+testA.id()+";name="+testA.name()+";gid="+testA.gid());
            }
        }
    }
    public static void main(String[] args) throws ClassNotFoundException {
        parseTypeAnnotation();
        parseMethodAnnotation();
        parseConstractAnnotation();
    }

}

这里写图片描述

注解的使用是基于java反射的机理,同时一般在开发的时候 不建议使用注解,除非是在搭建项目,对框架进行开发时,采用注解,形成统一的风格

参考链接:
http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html

http://blog.sina.com.cn/s/blog_93dc666c0101gzn5.html

<think>好的,用户想了解如何在Java中创建和使用自定义注解,并需要示例。首先,我需要回忆Java注解的基础知识。自定义注解是通过@interface关键字定义的,这类似于接口,但多了@符号。然后,元注解如@Target和@Retention是必须的,它们指定了注解的使用范围和生命周期。 用户提供的引用内容中提到,@Retention(RetentionPolicy.RUNTIME)让注解在运行时可见,这样可以通过反射读取。@Target指定注解可以应用的位置,比如方法或字段。接下来,自定义注解可以包含元素,这些元素可以有默认值。 在示例部分,我需要展示如何定义注解类,然后如何应用到方法上。使用反射来获取注解信息是关键步骤,用户可能需要看到如何通过Method对象获取注解实例,并读取其属性。 然后,关于使用场景,引用[2]提到结合拦截器或AOP,这部分需要简要说明,但用户的问题主要是创建和使用示例,可能不需要深入框架细节,但可以提及这些高级应用作为扩展。 需要检查语法是否正确,比如注解定义是否正确,反射代码是否恰当。例如,确保使用method.getAnnotation(MyAnnotation.class)来获取注解实例。同时,代码示例需要正确格式化,避免语法错误。 可能还需要考虑用户是否了解反射机制,因此在解释代码时,要提到反射的作用,即运行时处理注解。另外,要提到默认值的作用,当用户不指定值时使用的默认设置。 最后,生成相关问题时要围绕自定义注解的深入应用、注解元素类型和高级用法,确保问题有助于用户进一步学习。例如,处理参数或类的注解,或者结合Spring AOP的使用。 总结回答结构:定义注解类,使用元注解,添加元素,应用注解到方法,通过反射读取,示例代码,使用场景,相关问题。确保每个步骤清晰,代码正确,并且解释到位。</think>### Java自定义注解的创建与使用示例 #### 一、自定义注解的创建 1. **定义注解类** 使用 `@interface` 关键字定义注解,并添加元注解(如 `@Target` 和 `@Retention`): ```java import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) // 注解在运行时可通过反射读取 @Target(ElementType.METHOD) // 注解仅用于方法 public @interface MyAnnotation { String value() default ""; // 注解属性,默认值为空字符串 int count() default 1; // 注解属性,默认值为1 } ``` 2. **元注解说明** - `@Retention`:定义注解的生命周期 - `RetentionPolicy.SOURCE`:仅源码可见(如 `@Override`) - `RetentionPolicy.CLASS`:编译时可见(默认值) - `RetentionPolicy.RUNTIME`:运行时可见(需反射读取)[^1] - `@Target`:定义注解的适用范围(方法、字段、类等)[^2] --- #### 二、自定义注解的使用 1. **在方法上添加注解** ```java public class ExampleClass { @MyAnnotation(value = "测试方法", count = 3) public void testMethod() { System.out.println("执行测试方法"); } } ``` 2. **通过反射读取注解** ```java import java.lang.reflect.Method; public class AnnotationProcessor { public static void main(String[] args) throws Exception { Method method = ExampleClass.class.getMethod("testMethod"); if (method.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation annotation = method.getAnnotation(MyAnnotation.class); System.out.println("注解值: " + annotation.value()); // 输出 "测试方法" System.out.println("执行次数: " + annotation.count()); // 输出 3 } } } ``` --- #### 三、核心应用场景 1. **框架设计** 结合拦截器或AOP(面向切面编程),实现日志记录、权限校验等功能。 ```java // 示例:通过AOP拦截带有@MyAnnotation的方法 @Aspect public class MyAnnotationAspect { @Around("@annotation(com.example.MyAnnotation)") public Object process(ProceedingJoinPoint joinPoint) throws Throwable { System.out.println("方法执行前处理"); Object result = joinPoint.proceed(); System.out.println("方法执行后处理"); return result; } } ``` 2. **配置化编程** 通过注解替代XML配置,提升代码可读性(如Spring框架的 `@Autowired`)。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值