java注解

概述:

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。

Java 语言中的类、方法、变量、参数和包等都可以被标注。Java 标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中, Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容 , 它也支持自定义 Java 标注.

内置注解:

Java 语言中已经定义好的注解

@Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。

@Deprecated - 标记过时方法。如果使用该方法，会报编译警告。

@SuppressWarnings - 指示编译器去忽略注解中声明的警告。

@FunctionalInterface 用于指示被修饰的接口是函数式接口。

元注解

元注解是 java API 提供的，是用于修饰注解的注解，通常用在注解的定义上：

@Retention - 标识这个注解怎么保存，是只在代码中，还是编入 class 文件中，或者是在运行时可以通过反射访问。

@Documented - 标记这些注解是否包含在用户文档中。

@Target - 标记这个注解应该是哪种 Java 成员。

@Inherited - 标记这个注解是继承于哪个注解类(默认注解并没有继承于任何子类)

@Repeatable - 标识某注解可以在同一个声明上使用多次Java 语言中已经定义好的注解

常见的元注解

@Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方.

ElementType.TYPE 可以应用于类的任何元素。

ElementType.CONSTRUCTOR 可以应用于构造函数。

ElementType.FIELD 可以应用于字段或属性。

ElementType.LOCAL_VARIABLE 可以应用于局部变量。

ElementType.METHOD 可以应用于方法级注释。

ElementType.PACKAGE 可以应用于包声明。

ElementType.PARAMETER 可以应用于方法的参数。

@Retention：@Retention 定义了该注解被保留的时间长短：某些注解仅出现在源代码中，而被编译器丢弃；而另一些却被编译在 class 文件中；编译在 class文件中的注解可能会被虚拟机忽略，而另一些在 class 被装载时将被读取（请注意并不影响 class 的执行，因为注解与 class 在使用上是被分离的）。用于描述

注解的生命周期（即：被描述的注解在什么范围内有效）取值有：

1.SOURCE:在源文件中有效（即源文件保留）

2.CLASS:在 class 文件中有效（即 class 保留）

3.RUNTIME:在运行时有效（即运行时保留）

自定义注解

1.自己定义一个注解,其中有三个属性.

@Target(ElementType.FIELD)//作用在类的属性上
@Retention(RetentionPolicy.RUNTIME)//运行时生效
public @interface NotNull {

    String message() default "";
    
    int length() default 0;
    
    String lengthmessage() default "";
}

2.定义一个User类

public class User {
    
    private int num;

    @NotNull(message="姓名不能为空",length=3,lengthmessage="长度不能小于3")
    private String name;

    public String getName() {
        return name;
    }

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

    public int getNum() {
        return num;
    }

    public void setNum(int num) {
        this.num = num;
    }
}

3.定义一个Test类,详细解析如下:

public class Test {

      public static void main(String[] args) throws NoSuchMethodException, SecurityException, Exception {

          User user = new User();//创建一个空对象,num为0,name为null
              //user.setName("");

          //反射解析注解
          Field[] fields = user.getClass().getDeclaredFields();//获取User类所有的属性

          for (Field field : fields) {//遍历属性
                      //获取属性的注解,num上没有注解,所以拿到的是name的注解
                NotNull notNull = field.getAnnotation(NotNull.class);
                if (notNull != null) { //如果没有拿到对应属性的注解什么也不做
                    Method m = user.getClass().getMethod("get" + getMethodName(field.getName()));//这里通过User的class对象获取getName方法,getMethodName(field.getName())就是调用下面定义的方法将拿到的属性名字首字母大写
                    Object value=m.invoke(user);//调用get方法 获取属性值
                    if (value==null) {//拿到name的值后如果为空, 抛出一个异常
                        System.err.println(field.getName() +notNull.message());
                        throw new NullPointerException(notNull.message());
                    }else{//不为空就打印出自己定义的信息和规则
                        if(String.valueOf(value).length()<(notNull.length())){
                             System.err.println(field.getName() +notNull.lengthmessage());
                        }
                    }
                }
            }
       }

        /**
         * 把一个字符串的第一个字母大写
         */
        private static String getMethodName(String fildeName) throws Exception {
            byte[] items = fildeName.getBytes();
            items[0] = (byte) ((char) items[0] - 'a' + 'A');
            return new String(items);
        }
}