Java注解定义及用法（*）

Posted 2022-08-05 Firm陈

一、什么是注解

Annotation是从 JDK5.0 开始引入的技术
Annotation的作用 :
不是程序本身，可以对程序作出解释。这一点和注释(comment)没什么区别
可以被其他程序读取

Annotation的格式:
注解是以 @注释名 在代码中存在的， 还可以添加一些参数值，例如：@SuppressWarnings(value=“unchecked”)

Annotation在哪里使用?
可以附加在package , class , method , field等上面，相当于给他们添加了额外的辅助信息，可以通过反射机制编程实现对这些元数据的访问。

二、内置注解

1、@Override

定义在java.lang.Override中，此注解只适用于修饰方法，表示子类重写父类的方法

2、@Deprecated

定义在java.lang.Deprecated中，表示废弃；此注解可以用于修饰方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择

3、@SuppressWarnings

定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息，与前两个注解有所不同，需要添加一个参数才能正确使用，这些参数都是已经定义好了的，选择性的使用就好了

@SuppressWarnings(“all”)
@SuppressWarnings(“unchecked”)
@SuppressWarnings(value=“unchecked”,“deprecation”)

public class Demo01 extends Object
    @Override//重写方法
    public String toString() 
        return super.toString();
    
    @Deprecated//表示弃用方法
    public static void test()
    
    @SuppressWarnings("all")//抑制警告
    public static void test01()
        int age;
    
    public static void main(String[] args) 
        test();
        test01();
    

三、元注解

1、元注解的作用

就是负责注解其他注解
Java定义了4个标准的meta -annotation类型，他们被用来提供对其他annotation类型作说明，这些类型和它们所支持的类在java.lang.annotation包中可以找到
@ Target , @Retention，@Documented , @Inherited

2、@Target

用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

3、@Retention

表示需要在什么级别保存该注释信息，用于描述注解的生命周期 (SOURCE < CLASS < RUNTIME)

4、@Documented

说明该注解将被包含在javadoc中

5、@Inherited

说明子类可以继承父类中的该注解

import java.lang.annotation.*;
@MyAnnotation
public class Demo02 
    void test()
    

//定义一个注解
//Target 表示我们的注解可以用在哪些地方.
@Target(value = ElementType.METHOD, ElementType.TYPE)
//Retention表示我们的注解在什么地方还有效。
// runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)
//Documented表示是否将我们的注解生成在Javadoc中
@Documented
//Inherited子类可以继承父类的注解
@Inherited
@interface MyAnnotation 

四、自定义注解

1、使用 @interface 自定义注解时，自动继承了java.lang .annotation.Annotation接口
2、分析：
（1）@interface 用来声明一个注解，格式： public @interface 注解名定义内容
（2）其中的每一个方法实际上是声明了一个配置参数
（3）方法的名称就是参数的名称
（4）返回值类型就是参数的类型(返回值只能是基本类型，Class , String , enum )
（5）可以通过default来声明参数的默认值；没有默认值时，需要在注解中赋值
（6）如果只有一个参数成员，一般参数名为value，可以省略value，名字不是value时，不能省略
（7）注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值

import java.lang.annotation.*;
public class Demo03 
    public static void main(String[] args) 
        
    
    //注解可以显式赋值，如果没有默认值 ，我们就必须给注解赋值
    @MyAnnotation2(name = "赵大宝",age = 12)
    public void test()
    @MyAnnotation3("baobao")//参数只有一个，且参数名为value
    public void test1()


@Target(ElementType.METHOD,ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2
    //注解的参数:参数类型+参数名();
    String name() default "";
    int age() default 0;
    int id() default -1;// 如果默认值为-1,代表不存在。
    String[] schools() default "清华大学，辽宁大学"


@Target(ElementType.TYPE,ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3
    //只有一个参数，参数名为value时，使用时可省略参数名
    String value();