Java 自定义注解

JDK 内置注解

• @Override, 重载

• @SuppressWarnings, 抑制警告信息

• @Deprecated, 标注方法已过时，那么在编译的时候，编译器会发出相关警告

• @SafeVarargs

• @FunctionInterface

@Retention 策略设置为:

• SOURCE，那么在 javac 阶段注解会有效，编译之后注解将会被抛弃
• CLASS，那么注解将会被编译到 class 文件中，但它不能在运行时通过反射获取
• RUNTIME，那么注解将会被编译到 class 文件中，并能在运行时通过反射获取

@Documented

表示是否允许 javadoc 或相关工具为这个注解生成文档

@Inherited

表示注解是否可以被子类继承。

@Target

目标。

表示这个注解可以放到哪些元素上面。如果不设定，那么注解可以放置到任何元素上。

可以有很多选项，比如:

• ElementType.TYPE，可以放到类、接口、枚举类上面
• ElementType.METHOD，可以放到方法上面
• ElementType.PARAMETER，可以放到参数上面

在这里我以 maven项目 演示

配置pom.xml文件

 完整的pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.oukele.annotationDemo</groupId>
  <artifactId>AnnotationDemo</artifactId>
  <version>1.0-SNAPSHOT</version>

  <name>AnnotationDemo</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>

  <!--依赖-->
  <dependencies>

  <!--单元测试-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!--reflections 依赖-->
    <dependency>
      <groupId>org.reflections</groupId>
      <artifactId>reflections</artifactId>
      <version>0.9.10</version>
    </dependency>

  </dependencies>

  <build>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.0.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.7.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.20.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-jar-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

</project>

项目结构：

IAnimal为自定义的注解类

代码：

package com.oukele.annotationDemo.animal;


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

@Target({ElementType.TYPE,ElementType.METHOD})// TYPE --> @IAnimal注解可以放在类上， METHOD --> @IAnimal注解也可以放在方法上
@Retention(RetentionPolicy.RUNTIME)//项目运行时 启用注解
public @interface IAnimal {
    //vaule 默认为空
    String value() default "";

}

在animal包中 创建一个Cat类

 在test文件夹中的AppTest测试类的代码

package com.oukele.annotationDemo;


import com.oukele.annotationDemo.animal.IAnimal;
import org.junit.Test;
import org.reflections.Reflections;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Set;


public class AppTest {

    @Test
    public void Test1() {

        //使用reflections 快速读取注解
        //创建reflections对象 并 扫描 前缀为 com.oukele.annotationDemo的文件下所有类
        Reflections reflections = new Reflections("com.oukele.annotationDemo");
        //读取 IAnimal 注解
        Set<Class<?>> clazzs = reflections.getTypesAnnotatedWith(IAnimal.class);

        //遍历所有使用 @IAnimal注解 的类
        for (Class<?> aClass : clazzs) {
            //获取当前使用注解的类
            IAnimal annotation = aClass.getAnnotation(IAnimal.class);
            System.out.println("类名："+aClass.getSimpleName()+" 注解值： "+ annotation.value() );
            //遍历所有使用 @IAnimal注解 的方法
            for (Method method : aClass.getMethods()) {
                IAnimal annotation1 = method.getAnnotation(IAnimal.class);
                //如果方法 没使用 注解 则跳过 
                if(annotation1 != null){
                    System.out.println("方法名："+method.getName()+" 注解值： "+annotation1.value());
                }

            }
        }


    }

}

 结果：

另一种实现方法：

package com.oukele.annotationDemo;


import com.oukele.annotationDemo.animal.Cat;
import com.oukele.annotationDemo.animal.IAnimal;
import org.junit.Test;
import org.reflections.Reflections;

import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Set;


public class AppTest {




    @Test
    public void Test2(){
        getAnnotation(Cat.class);

    }

    public  void getAnnotation(Class<?> clazz ){
        //获取一个类的注解
        //加载类
       //  Class<?> clazz  ==  Class<Cat> catClass = Cat.class;
        //判断这个类是否有注解,有则返回true
        if(clazz.isAnnotationPresent(IAnimal.class)){
            //获取注解
            IAnimal annotation = clazz.getAnnotation(IAnimal.class);
            System.out.println("类名:"+clazz.getSimpleName()+" 注解值: "+annotation.value() );

            for (Method method : clazz.getMethods()) {
                //获取方法上的注解
                IAnimal annotation1 = method.getAnnotation(IAnimal.class);
                //判断这个方法是否有注解 如果此方法没有注解 那么它的annotation1值是null
                if(annotation1 != null ){
                    System.out.println(
                            "方法:"+ Modifier.toString(method.getModifiers())+" "
                             +method.getReturnType()+" "+method.getName()+"(){} 注解值: "+annotation1.value()
                    );
                }
            }
        }
    }

}

结果：