Java小白一文带你回顾复习Java注解相关知识

Kerwin要坚持日更

于 2024-08-16 20:54:55 发布

阅读量992

点赞数 42

分类专栏： JavaSE 文章标签： java 开发语言 intellij-idea

本文链接：https://blog.csdn.net/Kerwin_D/article/details/141269450

版权

JavaSE 专栏收录该内容

25 篇文章 0 订阅

订阅专栏

注解Annotation

说明：

注解Annotation也被称为元数据，用于修饰解释包、类、方法、属性、构造器、局部变量等数据信息
和注释一样，注解不影响程序逻辑，但注解可以被编译或运行，相当于嵌入在代码中的补充信息
在JavaSE中，注解的使用目的比较简单，例如标记过的功能，忽略警告等。在JavaEE中注解占据了更重要的角色，例如用来配置引用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等

基本介绍

使用Annotation时要在前面加@，并把该Annotation当成一个修饰符使用，用于修饰它支持的程序元素

三个基本的Annotation：

@Override：限定某个方法，是重写父类方法，该注解只能用于方法
@Deprecated: 用于表示某个程序元素（类、方法等）已过时
@SuppressWarnings: 抑制编译器警告

@Override

class Dad{
    public void smile(){
        System.out.println("Dad smile~~~~");
    }
}
class Son extends Dad{
    /**
    	1.@Override注解放在smile方法上，表示子类的smile方法是重写了父类的smile
    	2.这里如果没有写@Override注解，还是重写了父类的smile
    	3.如果你写了@Override注解，编译器就会去检查该方法是否真的重写了父类的方法，
    	  如果的确重写了，则编译通过，如果没有构成重写，则编译错误
    	4.看看@Override的定义
    	  解读： 如果发现了@interface ，其表示一个注解类
    	  
    	  	 @Target(ElementType.METHOD)
			@Retention(RetentionPolicy.SOURCE)         
			public @interface Override {
			}
    */
    @Override
    public void smile() {
        System.out.println("Son smile~~~~wuhu");
    }
}

使用说明

@Override表示指定重写父类的方法,如果父类没有smile方法，则会报错
如果不写@Override注解，而父类仍有public void smile(){},仍然构成重写
@Override只能修饰方法，不能修饰其他的类、包、属性等
查看@Override注解源码为@Target(ElementType.METHOD)，说明只能修饰方法
@Target是修饰注解的注解，称为元注解，记住这个概念

@Deprecated

public class Journey {
    public static void main(String[] args) {
        //此中的Dad都已经过时了
        Dad dad = new Dad();
        dad.smile();//这也是已经过期了

    }
}

/**
 * @Deprecated 修饰某个元素，表示该元素已经过时
 * 虽然不推荐使用，但是仍然可以使用
 */
@Deprecated
class Dad{

    public int age = 50;
    @Deprecated
    public void smile(){
        System.out.println("Dad smile~~~~");
    }
}

使用说明

用于表示某个程序元素（类、方法等）已过时
可以修饰方法、类、字段、包、参数等等
@Target(value={CONSTRUCTOR**,** FIELD**,** LOCAL_VARIABLE**,** METHOD**,** PACKAGE**,** PARAMETER**,** TYPE})
@Deprecated的作用可以做到新旧版本的兼容和过渡

@SuppressWarnings

@SuppressWarnings({"rawtypes","unchecked","unused"})
public static void main(String[] args){
	List list = new ArrayList();
	list.add("jack");
	list.add("tom");
	list.add("mary");
	int i;
	System.out.println(list.get(1));
}

使用说明

SuppressWarnings 作用范围是和你放置的位置相关，倘若放在main方法，那么抑制警告的范围就是main方法
unchecked是忽略没有检查的警告
rawtypes是忽略没有指定泛型的警告（传参时没有指定泛型的警告错误）
unused是忽略没有使用某个变量的警告错误
@SuppressWarnings可以修饰的程序元素为，查看@Target

//@SuppressWarnings源码展示及解读
/**
	1.可放置的位置就是TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE
	2.该注解类有数组 String[] values() 设置一个数组比如	{"rawtypes","unchecked","unused"}
	
*/
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
...
    String[] value();
}

生成@SuppressWarinings时，不用背，直接点击左侧的黄色提示，就可以选择（注意可以指定生成的位置）

元注解

说明：JDK的元注解用于修饰其他的Annotation

元注解：本身作用不大，主要是讲这个原因希望同学们，看源码时，可以知道它是干什么的就行

元注解种类：

Retention（保留）----指定注解的作用范围，三种SOURCE,CLASS,RUNTIME
Target----指定注解可以在哪些地方使用
Document----指定该注解是否会在Javadoc体现
Inherited----子类会继承父类注解

@Retention注解

说明：只能用于修饰一个Annotation定义，用于指定该Annotation可以保留多长时间，

@Retention包含一个RetentionPolicy类型的成员变量，使用@Retention时必须为该value成员变量指定值

@Retention的三个值

RetentionPolicy.RUNTIME ：编译器将把注释记录在class文件中，当运行Java程序时，JVM会保留注解，程序可以通过反射获取该注释； ---->也是作用在Java的字节码文件中，但是比.CLASS停留时间更久，三个之中停留时间最长
RetentionPolicy.SOURCE ：编译器使用后，直接丢弃这种策略的注释---->作用在Java源文件，停留时间最短

//这是Override的源码，可以看到其作用域在SOURCE，当编译器编译时不会生效，
//不会写入到字节码.class文件,也不会在runtime运行时生效
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

RetentionPolicy.CLASS : 编译器将把注释记录在class文件中，当运行Java程序时，JVM不会保留注解，这是默认值；

----->作用在Java的字节码文件

@Target注解

说明：用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些程序元素，

@Target也包含一个名为value的成员变量

//@Target源码
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
....
    ElementType[] value();
}
//再深挖下Element[]
public enum ElementType {
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE
}

@Documented注解

说明：用于指定被该元Annotation修饰的Annotation类将被javadoc工具提取成文档，即在生成文档时，可以看到该注解

定义为Documented的注解必须设置Retention值为RUNTIME

@Documented     //此中有@Documented注解，其表明此时你在某个方法上写了@Deprecated，再生成javadoc的时候，此时的@Deprecated
			  //会保留在你的javadoc文档上
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

在这里插入图片描述