注解的定义和使用

package com.bjpowernode.javase.annotation;
/*
自定义注解
 */
public @interface MyAnnotation {
    
    

}

package com.bjpowernode.javase.annotation;

/*
1、注解，或者叫做注释，英文单词是：Annotation

2、注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。

3、怎么自定义注解呢？语法格式？
    [修饰符列表] @interface 注解类型名{

    }

4、注解怎么使用，用在什么地方？

    第一：注解使用时的语法格式是：
        @注解类型名
    第二：注解可以出现在类上、属性上、方法上、变量上等...
        注解还可以出现再注解类型上。

    默认情况下，注解可出现在任意位置。
 */

@MyAnnotation
public class AnnotationTest01 {
    
    

    @MyAnnotation
    private int no;

    @MyAnnotation
    public AnnotationTest01(){
    
    }

    @MyAnnotation
    public static void m1(@MyAnnotation String name,
                          @MyAnnotation int k){
    
    
        @MyAnnotation
        int a = 100;
    }

    @MyAnnotation
    public void m2(){
    
    

    }

}

@MyAnnotation
interface MyInterface{
    
    

}

@MyAnnotation
enum Seasion{
    
    
    SPRING, SUMMER, AUTUMN, WINTER;
}

package com.bjpowernode.javase.annotation;

// 注解修饰注解。
@MyAnnotation
public @interface OthreAnnotation {
    
    
}

JDK内置注解

/*
JDK内置了哪些注解呢？
    java.lang包下的注解类型：
        掌握：
        Deprecated用@Deprecated注释的程序元素。
        掌握：
        Override表示一个方法声明打算重写超类中的另一个方法声明。
        不用掌握：
        SuppressWarnings指示应该在注释元素（以及包含在该注释元素中的
        所有程序元素）中取消显示指定的编译器警告。
*/

Override注解

/*
关于JDK lang包下的Override注解
源代码：
    public @interface Override {
    }
标识性注解，给编译器做参考的。
编译器看到这个注解是给编译器参考的，和运行阶段没有关系。
凡是java中的方法带有这个注解的，编译器都会进行编译检查，如果这个方法不是重写父类的方法，编译器报错。
 */


// @Override这个注解只能注解方法
// @Override这个注解是给编译器参考的，和运行阶段没有关系。
// @Override凡是java中的方法带有这个注解的，编译器都会进行编译检查，如果这个不是重写父类的方法，编译器报错。

// @Override
public class AnnotationTest02 {
    
    
    @Override
    public String toString() {
    
    
        return "toString";
    }
}

元注解

/*
元注解：
    什么是元注解？
        用来标注“注解类型”的“注解”，称为元注解。

    常见的元注解有哪些？
        Target
        Retention

    关于Target注解：
        这是一个元注解，用来标注“注解类型”的“注解”。
        这个Target注解用来标注“被标注的注解”可以出现在哪个位置上。
        @Target(ElementType.METHOD)：表示"被标注的注解"只能出现在方法上。

    关于Retention注解：
        这是一个元注解，用来标注"注解类型"的"注解"。
        这个Retention注解用来标注"被标注的注解"最终保存在哪里。

        @Retention(RetentionPolicy.SOURCE)：表示"被标注的注解"只能被保留在java源文件中。
        @Retention(RetentionPolicy.CLASS)：表示"被标注的注解"只能被保留在class文件中。
        @Retention(RetentionPolicy.RUNTIME)：表示"被标注的注解"只能被保留在class文件中，并且可以被反射机制所读取。
 */

Deprecated注解

package com.bjpowernode.javase.annotation;

// 表示这个类已经过时
//@Deprecated
public class AnnotationTest03 {
    
    
    public static void main(String[] args) {
    
    
        AnnotationTest03 at = new AnnotationTest03();
        at.doSome();
    }

    // Deprecated这个注解标注的元素已过时。
    // 这个注解主要是向其他程序员传达一个信息，告知已过时，有更好的解决方法存在。
    @Deprecated
    public void doSome(){
    
    
        System.out.println("do Some...");
    }

    @Deprecated
    public static void doOther(){
    
    
        System.out.println("do Other...");
    }
}

class T{
    
    
    public static void main(String[] args) {
    
    
        AnnotationTest03 at = new AnnotationTest03();
        at.doSome();
        AnnotationTest03.doOther();
    }
}

在这里插入图片描述

注解中定义属性

package com.bjpowernode.javase.annotation2;

public @interface MyAnnotation {
    
    

    /**
     * 我们通常在注解当中可以定义属性，以下这个是MyAnnotaion的name属性
     * 看着像1个方法，但实际上我们称之为属性name。
     */
    String name();

    // 颜色属性
    String color();

    // 年龄属性
    int age() default 25; // 属性指定默认值，实参就不是必须的
}

package com.bjpowernode.javase.annotation2;

public class MyAnnotaionTest {
    
    

    // 报错的原因：如果一个注解当中有属性，必须给属性赋值。（除非该属性使用default指定了默认值）
    /*@MyAnnotation()
    public void doSome(){

    }*/

    //@MyAnnotation(属性名=属性值,属性名=属性值,属性名=属性值)
    //指定name属性的值就好了
    @MyAnnotation(name="zhangsan", color="red")
    public void doSome(){
    
    

    }
}

属性是value时，可省略

package com.bjpowernode.javase.annotation3;

public @interface MyAnnotation {
    
    

    // 指定一个value属性
    String value();

    //String email();
}

package com.bjpowernode.javase.annotation3;

/*
如果一个注解的属性的名字是value的话，并且只有一个属性的话，在使用的时候，该属性名可以省略。
 */
public class MyAnnotaionTest {
    
    

    @MyAnnotation(value="hehe")
    public void doSome(){
    
    

    }

    @MyAnnotation("haha")
    public void doOther(){
    
    

    }
}

package com.bjpowernode.javase.annotation3;

public @interface OtherAnnotation {
    
    
    String name();
}

package com.bjpowernode.javase.annotation3;

public class OtherAnnotationTest {
    
    

    // 因为属性名是name，不能省略
    //@OtherAnnotation("test")
    @OtherAnnotation(name = "test")
    public void doSome(){
    
    

    }
}

属性是一个数组

package com.bjpowernode.javase.annotation4;


public @interface MyAnnotaion {
    
    
    /*
    注解当中的属性可以是哪一种类型?
        属性的类型可以是：
            byte short int long float double boolean char String Class 枚举类型
            以及以上每一种的数组形式。
     */
    int value1();

    String value2();

    int[] value3();

    String[] value4();

    Season value5();

    Season[] value6();

    Class parameterType();

    Class[] parameterTypes();
}

public enum Season {
    
    
    SPING,SUMMER,AUTUMN,WINTER
}

package com.bjpowernode.javase.annotation4;

public @interface OtherAnnotation {
    
    
    /*
    年龄属性
     */
    int age();
    String[] email();

    // 季节数组
    // 枚举类型
    Season[] seasonArray();
}

package com.bjpowernode.javase.annotation4;

import java.lang.annotation.RetentionPolicy;

/*

 */
public class OtherAnnotationTest {
    
    

    // 数组是{}
    @OtherAnnotation(age=25, email={
    
    "[email protected]", "lisi@souhu"}, seasonArray = Season.AUTUMN)
    public void doSome(){
    
    }

    // 如果数组中只有一个元素，{}可以省略
    @OtherAnnotation(age=25,email="[email protected]", seasonArray = {
    
    Season.SPING, Season.AUTUMN})
    public void doOther(){
    
    }
}

/*
Retention的源代码：
    //元注解
    public @interface Retention {
        //属性
       RetentionPolicy value();
    }

    RetentionPolicy的源代码：
        public enum RetentionPolicy {
            SOURCE,
            CLASS,
            RUNTIME
        }

    //@Retention(value=RetentionPolicy.RUNTIME)
    // value属性，可以省略value
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotaion{

    }

 */

反射注解

package com.bjpowernode.javase.annotation5;

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})
// 希望这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
// 改为RetentionPolicy.CLASS，后面就无法反射，和得到反射内容。
public @interface MyAnnotation {
    
    
    // value属性
    String value() default "北京大兴区";
}

package com.bjpowernode.javase.annotation5;

import com.bjpowernode.javase.annotation5.MyAnnotation;

@MyAnnotation("上海浦东区")
public class MyAnnotationTest {
    
    

    /*@MyAnnotation()
    int i;*/

    @MyAnnotation
    public void doSome(){
    
    
        /*@MyAnnotation
        int i;*/
    }

    /*@MyAnnotation
    public MyAnnotationTest(){

    }*/
}

package com.bjpowernode.javase.annotation5;

public class ReflectAnnotationTest {
    
    
    public static void main(String[] args) throws Exception{
    
    

        // 获取类
        Class c = Class.forName("com.bjpowernode.javase.annotation5.MyAnnotationTest");
        // 判断类上面是否有MyAnnotation
        System.out.println(c.isAnnotationPresent(MyAnnotation.class)); // true
        if(c.isAnnotationPresent(MyAnnotation.class)){
    
    
            // 获取该注解对象
            MyAnnotation myAnnotation = (MyAnnotation)c.getAnnotation(MyAnnotation.class);
            System.out.println("类上面的注解对象: " + myAnnotation);
            // 获取注解对象的属性怎么办？和调接口没区别。
            String value = myAnnotation.value();
            System.out.println(value);

        }

        // 判断String类上面是否有这个注解
        Class stringClass = Class.forName("java.lang.String");
        System.out.println(stringClass.isAnnotationPresent(MyAnnotation.class)); // false
    }
}

通过反射获取注解对象属性的值

package com.bjpowernode.javase.annotation6;

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 username();
    String password();
}

package com.bjpowernode.javase.annotation6;

import java.lang.reflect.Method;

public class MyAnnotationTest {
    
    
    @MyAnnotation(username = "admin", password = "123")
    public void doSome(){
    
    

    }

    public static void main(String[] args) throws Exception{
    
    
        // 获取MyAnnotationTest的doSome方法上的注解信息。
        // MyAnnotationTest获取类
        Class c = Class.forName("com.bjpowernode.javase.annotation6.MyAnnotationTest");
        // 获取doSome()方法
        Method doSomeMethod = c.getDeclaredMethod("doSome");
        // 判断该方法是否存在这个注解
        if(doSomeMethod.isAnnotationPresent(MyAnnotation.class)){
    
    
            // 如果存在这个注解，就获取注解
            MyAnnotation myAnnotation = doSomeMethod.getAnnotation(MyAnnotation.class);
            System.out.println(myAnnotation.username());
            System.out.println(myAnnotation.password());
        }
    }
}

注解的应用实例

package com.bjpowernode.javase.annotation7;

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

// 表示该注解只能出现在类上面
@Target(ElementType.TYPE)
// 该注解可以被反射机制读取到
@Retention(RetentionPolicy.RUNTIME)
public @interface Id {
    
    
}

/*
    这个注解Id用来标注类，被标注的类必须有一个int类型的id属性，
    没有就报异常。
 */

package com.bjpowernode.javase.annotation7;

@Id
public class User {
    
    
    //int id;
    String name;
    String password;
}

package com.bjpowernode.javase.annotation7;

import java.lang.reflect.Field;

public class Test {
    
    
    public static void main(String[] args) throws Exception{
    
    
        // 获取类
        Class userClass = Class.forName("com.bjpowernode.javase.annotation7.User");
        // 判断类上是否存在Id注解
        if(userClass.isAnnotationPresent(Id.class)){
    
    
            // 当一个类上面有Id注解的时候，要求类中必须存在int类型的id属性
            // 如果没有int类型的id属性则报异常。
            // 获取类的属性
            Field[] fields = userClass.getDeclaredFields();
            boolean isOk = false;// 给一个默认的标记
            for(Field field : fields){
    
    
                if("id".equals(field.getName()) && "int".equals(field.getType().getSimpleName())){
    
    
                    // 表示这个类是合法的类。有@Id注解，则这个类中必须有int类型的id
                    isOk = true; // 表示合法
                }
            }
            // 判断是否合法
            if(!isOk){
    
    
                throw new HasNotIdPropertyException("被@Id注解标注的类中必须要有一个int类型的id属性！");
            }
        }
    }
}

package com.bjpowernode.javase.annotation7;

// 自定义异常
public class HasNotIdPropertyException extends RuntimeException{
    
    
    public HasNotIdPropertyException(){
    
    

    }
    public HasNotIdPropertyException(String s){
    
    
        super(s);
    }
}

JavaSE进阶31 - 注解

注解的定义和使用

JDK内置注解

Override注解

元注解

Deprecated注解

注解中定义属性

属性是value时，可省略

属性是一个数组

反射注解

通过反射获取注解对象属性的值

注解的应用实例

猜你喜欢