Java注解

最新推荐文章于 2024-04-13 16:15:52 发布

Mike-H

最新推荐文章于 2024-04-13 16:15:52 发布

阅读量665

点赞数

分类专栏： Java_基础

本文链接：https://blog.csdn.net/QLBFA/article/details/109628861

版权

Java_基础专栏收录该内容

29 篇文章 1 订阅

订阅专栏

一、概念

注释：是用文字描述程序的。给程序员看的
注解：说明程序的。给计算机看的
注解定义：注解（Annotation）， 也叫元数据。 一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

概念描述： 1. JDK1.5之后的新特性 2. 说明程序的 3.使用注解：@注解名称 *

作用分类：

①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
②代码分析：通过代码里标识的注解对代码进行分析【使用反射】
③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查 eg：【Override】如果你没重写就编译错误。

上面编写文档eg：
先写个Annotation_test .java把它复制到一个文件夹（任意在电脑创建）中，打开cmd输入：javadoc Annotation_test.java生成index.html打开就行，经常乱码。。。

/**
 * @author QLBF
 * @version 1.0
 * @date 2020/11/11 19:29
 */
public class Annotation_test {
    
    public int add(int a,int b){
        /** 
         * @description: 加法 
         * @param: * @param: a
         * @param: b 
         * @return: int 
         * @author QLBF
         * @date: 2020/11/11 19:30
         */ 
        return a+b;
    }
}

二、JDK中预定义的一些注解

@Override ：检测被该注解标注的方法是否是继承自父类(接口)的（就防止你没重写而已，如果去掉也没错，就是会变为一个普通方法而已）
@Deprecated：该注解标注的内容，表示已过时（画一条横线，不建议你用，你用也行），（一般用于你方法升级了，但是你不能删了它，就建议别人不用就行，适应低版本嘛）
@SuppressWarnings：压制警告，一般传递参数all ，@SuppressWarnings(“all”)，就可以压制所有的错误（比如定义这个方法没调用），一般写在Class上面

/**
 * @author QLBF
 * @version 1.0
 * @date 2020/11/11 20:19
 */

@SuppressWarnings("all")
public class AnnoDemo2 {
    String name;
    @Override
    public String toString() {
        return "AnnoDemo2{" +
                "name='" + name + '\'' +
                '}';
    }
    @Deprecated
    public void show1(){
        //有缺陷
    }
    public void show2(){
        //替代show1方法
    }
    public static void main(String[] args) {
        AnnoDemo2 a=new AnnoDemo2();
        System.out.println(a);
        a.show1();
        a.show2();
    }
}

三、自定义注解

3.1 格式：

元注解（见下）
public @interface 注解名称{
属性列表（见下属性）;
}

3.2 本质：

注解本质上就是一个接口，该接口默认继承Annotation接口
public interface MyAnno extends java.lang.annotation.Annotation {}

java反汇编：

把Myanno.java复制到一个文件夹（在文件夹中按住shift右键鼠标打开powershell窗口）：输入:javac Myanno.java，编译生成字节码文件，再输入反汇编p命令：javap Myanno.class就输出结果了。在这里插入图片描述

3.3 属性

（属性这里其实是方法，要用方法名=“你想的值”，所以定义方法名尽量想属性名一点）：接口中的抽象方法（常量也是属性，但一般没用）

要求：属性的返回值类型有下列取值(void和类不能定义为属性的返回值)
1. 基本数据类型 String
2. 枚举类public enum Person { P1,P2; }
3. 注解
4. 以上类型的数组

定义了属性，在使用时需要给属性赋值 (都需要给方法（属性）赋值，除了以下特殊)
1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。
2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。（上面的SuppressWarnings(“all”)就是使用了value，但如果有多个属性，还是得写value）
3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略

@interface Myanno {
    public int show();
    String name();
    Person per();
    mynano2 anno2();//mynano2是我第一的一个注解
    String [] strs();
}


@Myanno(show = 1, name ="22" , per =Person.P1, anno2 =@mynano2, strs ={"abc"} )
public class Anno_test{
}

3.4 元注解：

用于描述注解的注解（在自定义的注解上面写）

@Target：描述注解能够作用的位置 ElementType取值：

TYPE：可以作用于类上 (指定你的自定义注解只能注解在类上)
METHOD：可以作用于方法上
FIELD：可以作用于成员变量上（上面3个可以一起用）

@Retention：描述注解被保留的阶段（有Sourse,runtime,class）@Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
@Documented：描述注解是否被抽取到api文档中
@Inherited：描述注解是否被子类继承

import java.lang.annotation.*;
@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface Myanno {
}

@Myanno
class S{
    String name;
    public void show(){
        System.out.println("123");
    }
}

3.5 在程序使用(解析)注解：获取注解中定义的属性值

（可以简化我们之前反射时要改配置文件，这里只需要改注解的属性就行,之前配置文件的方式看我之前的博客：看反射的魅力）
步骤：

获取注解定义的位置的对象（Class，Method,Field）
获取指定的注解 getAnnotation(Class) //其实就是在内存中生成了一个该注解接口的子类实现对象

public class ProImpl implements Pro{ 
	public String className(){
		return "cn.itcast.annotation.Demo1";
	 }
	public String methodName(){
 		return "show"; 
 	} 
 }

调用注解中的抽象方法获取配置的属性值

先定义myanno3 注解

/**
 * @author QLBF
 * @version 1.0
 * @date 2020/11/12 14:07
 */

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 myanno3 {
    String className();
    String methodName();
}

import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Properties;

/**
 * @author QLBF
 * @version 1.0
 * @date 2020/11/12 14:30
 */
class Student{
    String name;


    public String getName() {
        return name;
    }

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

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                '}';
    }

    public void eat(){
        System.out.println("eat..");
    }
}
class Person{
    public void sleep(){
        System.out.println("sleep...");
    }
}

//这里要写Person的全类名，只不过我这里是没包名，所以直接写Person了
@myanno3(className = "Student",methodName = "eat")
public class zhujiemeili {

    public static void main(String[] args) throws Exception {
         /*
            前提：不能改变该类的任何代码。可以创建任意类的对象，可以执行任意方法
         */
      /*  Person1 p = new Person1();
        p.eat();*/
/*
        Student stu = new Student();
        stu.sleep();*/

       //这里不用配置，而是使用注解
        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<zhujiemeili> zhujiemeiliClass = zhujiemeili.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现对象,不然不能直接调用方法
         /*

            public class ProImpl implements Pro{
                public String className(){
                    return "cn.itcast.annotation.Demo1";
                }
                public String methodName(){
                    return "show";
                }
            }
        */
         //这里得写这个类上面自定义注解.class哦
        myanno3 an = zhujiemeiliClass.getAnnotation(myanno3.class);
        //3.调用注解对象中定义的抽象方法，获取返回值
        String classname = an.className();
        String methodname = an.methodName();
        //System.out.println(classname);
        //System.out.println(methodname);
        //3.加载该类进内存，看上面的博客方法
        Class cls = Class.forName(classname);
        //4.创建对象,因为不知道是什么对象，所以创建一个obj的
        Object obj = cls.newInstance();
        //5.获取方法对象
        Method method = cls.getMethod(methodname);
        //6.执行方法
        method.invoke(obj);//eat..

    }
}

然后要想调用Person的sleep方法只需要在@myanno3(className = "Student",methodName = "eat") public class zhujiemeili {
这里改对应类和方法名就行，那个注解里面的内容不用改

Mike-H

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Java注解

一、概念注释：是用文字描述程序的。给程序员看的注解：说明程序的。给计算机看的注解定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。概念描述： 1. JDK1.5之后的新特性 2. 说明程序的 3.使用注解：@注解名称 *作用分类：①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】②代码分析
复制链接

扫一扫

专栏目录