JAVA自定义注解

最新推荐文章于 2024-05-27 14:20:22 发布

稚子候门

最新推荐文章于 2024-05-27 14:20:22 发布

阅读量183

点赞数

分类专栏： java

本文链接：https://blog.csdn.net/weixin_42074377/article/details/82995491

版权

java 专栏收录该内容

22 篇文章 0 订阅

订阅专栏

这只是我的笔记，看大神请移步：https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html

什么是注解？

对于很多初次接触的开发者来说应该都有这个疑问？Annontation是Java5开始引入的新特征，中文名称叫注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

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

简单理解，注解就是把元信息加在当前执行的代码上，删了注解之后，代码还能正常运行。

注解有什么用处？

1.生成文档。这是最常见的，也是java 最早提供的注解。常用的有@param @return 等。

2.跟踪代码依赖性，实现替代配置文件功能。比如Dagger 2依赖注入，未来java开发，将大量注解配置，具有很大用处。

3.在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

注解的原理：

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

元注解：

元注解，就是最基本的注解，可以为其他注解进行注解。

java.lang.annotation提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）：

@Documented –注解是否将包含在JavaDoc中
@Retention –什么时候使用该注解
@Target –注解用于什么地方
@Inherited – 是否允许子类继承该注解

具体如下：

1.@Retention -------- 什么时候使用该注解

RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。
RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

2.@Target -------- 注解用于什么地方（默认值为任何元素，表示该注解用于什么地方。可用的ElementType参数包括）

ElementType.CONSTRUCTOR:用于描述构造器
ElementType.FIELD:成员变量、对象、属性（包括enum实例）
ElementType.LOCAL_VARIABLE:用于描述局部变量
ElementType.METHOD:用于描述方法
ElementType.PACKAGE:用于描述包
ElementType.PARAMETER:用于描述参数
ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明

3. @Documented–一个简单的Annotations标记注解，表示是否将注解信息添加在java文档中。

4.@Inherited – 定义该注释和子类的关系

@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

常见标准的Annotation：

1.）@Override

java.lang.Override是一个标记类型注解，它被用作标注方法。它说明了被标注的方法重载了父类的方法，起到了断言的作用。如果我们使用了这种注解在一个没有覆盖父类方法的方法时，java编译器将以一个编译错误来警示。

2.）@Deprecated

@Deprecated也是一种标记类型注解。当一个类型或者类型成员使用@Deprecated修饰的话，编译器将不鼓励使用这个被标注的程序元素。所以使用这种修饰具有一定的“延续性”：如果我们在代码中通过继承或者覆盖的方式使用了这个过时的类型或者成员，虽然继承或者覆盖后的类型或者成员并不是被声明为@Deprecated，但编译器仍然要报警。

3.）@SuppressWarnings

@SuppressWarning不是一个标记类型注解。它有一个类型为String[ ]的成员，这个成员的值为被禁止的警告名。对于javac编译器来讲，被-Xlint选项有效的警告名也同样对@SuppressWarings有效，同时编译器忽略掉无法识别的警告名。

@SuppressWarnings("unchecked")

自定义注解：

自定义注解需要遵从一些规则：

Annotation型定义为@interface, 所有的Annotation会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
参数成员只能用public或默认(default)这两个访问权修饰
参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String、Enum、Class、annotations等数据类型,以及这一些类型的数组.
要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation对象,因为你除此之外没有别的获取注解对象的方法
注解也可以没有定义成员, 不过这样注解就没啥用了

自定义注解实例：

照着大神的代码写了一个demo。

UserName 字符串类型的注解。

import java.lang.annotation.*;

/**
 * @Author: ykbian
 * @Date: 2018/10/10 9:06
 * @Todo:  用户名注解
 */

@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface UserName {

    String value() default "";
}

UserGender 枚举类型的注解。

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @Author: ykbian
 * @Date: 2018/10/10 9:09
 * @Todo:  用户性别
 */


@Target(FIELD)   //意思是这个注释可以用在成员变量，对象，属性（包括enum实例）
@Retention(RUNTIME) //始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
@Documented
public @interface UserGender {



    /**
     *  性别枚举
     */
    public enum Gender{ MAN,WOMEN};

    /**
     *  性别属性====如果不输入的话默认为 MAN
     */
    Gender userGender() default Gender.MAN;


}

UserSchool 多项信息的注解。

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @Author: ykbian
 * @Date: 2018/10/10 9:23
 * @Todo:  用户学籍信息注解
 */
@Target(FIELD)
@Retention(RUNTIME)
@Documented
public @interface UserSchool {

    /**
     *  学号
     */
     public int id() default -1;


     /**
      *  班级信息
      */
     public String grade() default "";

     /**
      *   学校地址
      */
     public String address() default "";
}

UserInfoUtil 注解处理器。

import com.byk.annontation.UserGender;
import com.byk.annontation.UserName;
import com.byk.annontation.UserSchool;

import java.lang.reflect.Field;
/**
 * @Author: ykbian
 * @Date: 2018/10/10 9:27
 * @Todo:   注解处理器
 */

public class UserInfoUtil {

    public static void getUserInfo(Class<?> clazz){

        String userNameString=" 学生姓名：";
        String userGenderString=" 学生性别：";
        String userSchoolString=" 学校信息：";

        // 通过反射 拿到具体的java对象
        Field[] fields = clazz.getDeclaredFields();

        for(Field field :fields){
            // 如果这个@UserName注解没有被使用，则不执行这段代码，以下类同。
            if(field.isAnnotationPresent(UserName.class)){
                UserName userName = field.getAnnotation(UserName.class);
                userNameString=userNameString+userName.value();
                System.out.println(userNameString);
            }
            else if(field.isAnnotationPresent(UserGender.class)){
                UserGender userGender= field.getAnnotation(UserGender.class);
                userGenderString=userGenderString+userGender.userGender();
                System.out.println(userGenderString);
            }
            else if(field.isAnnotationPresent(UserSchool.class)){
                UserSchool school= field.getAnnotation(UserSchool.class);
                userSchoolString=userSchoolString+" 学号："+school.id()+" 班级："+school.grade()+" 学校地址："+school.address();
                System.out.println(userSchoolString);
            }
        }
    }
}

User 实体类中使用注解。

import com.byk.annontation.UserGender;
import com.byk.annontation.UserName;
import com.byk.annontation.UserSchool;


/**
 * @Author: ykbian
 * @Date: 2018/10/10 9:36
 * @Todo:  用户实体类
 */

public class User {

    /**
     *  注入字符串
     */
    @UserName("江德华")
    public String userName;

    /**
     *  枚举类型选择
     */
    @UserGender(userGender= UserGender.Gender.WOMEN)
    public String userGender;

    /**
     *  多条信息注入
     */
    @UserSchool(id = 10086,grade = "三年级一班",address = "北京市海淀区中关村北大街清华大学附属中学  邮编：100084")
    public String userSchool;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getUserGender() {
        return userGender;
    }

    public void setUserGender(String userGender) {
        this.userGender = userGender;
    }

    public String getUserSchool() {
        return userSchool;
    }

    public void setUserSchool(String userSchool) {
        this.userSchool = userSchool;
    }

   

}

UserRun 测试

/**
 * @Author: ykbian
 * @Date: 2018/10/10 9:47
 * @Todo:  测试
 */

public class UserRun {

    public static void main(String[] arg){
        UserInfoUtil.getUserInfo(User.class);
    }
}

测试结果如下：

如果实体类里面注释掉@UserSchool 注解，则输出的结果中没有学校信息。

鸣谢

这个只是我的学习笔记，再次感谢大神： https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html

源码在这里：

https://github.com/bian1234/myAnnontation.git

稚子候门

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
JAVA自定义注解

这只是我的笔记，看大神请移步：https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html什么是注解？对于很多初次接触的开发者来说应该都有这个疑问？Annontation是Java5开始引入的新特征，中文名称叫注解。它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为...
复制链接

扫一扫