注解

1、注解

1.1、什么是注解

什么是注解？注解是annotation，是一种应用于类、方法、参数、变量、构造器及包括声明中的特殊修饰符。是一种工具。comment仅仅是一种注释。

Annotation的作用：

不是程序本身，可以对程序作出解释。
可以被其他程序（比如编译器等）读取。

Annotation的格式

注释是以"@注释名"在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value="unchecked").

Annotation在哪里使用：

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

1.2、常见的内置注解

@Oveeride
- @Override 用在方法上，表示这个方法重写了父类的方法，如toString()。如果父类没有这个方法，那么就无法编译通过，可以用来控制代码或检查正确性
@Deprecated
- @Deprecated 表示这个方法已经过期，不建议开发者使用。(暗示在将来某个不确定的版本，就有可能会取消掉)，jdk9以上的版本被取消了
@SuppressWarnings
- @SuppressWarnings Suppress英文的意思是抑制的意思，这个注解的用处是忽略警告信息。
  
  1.deprecation：使用了不赞成使用的类或方法时的警告(使用@Deprecated使得编译器产生的警告)； 2.unchecked：执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型; 关闭编译器警告； 3.fallthrough：当 Switch 程序块直接通往下一种情况而没有 Break 时的警告; 4.path：在类路径、源文件路径等中有不存在的路径时的警告; 5.serial：当在可序列化的类上缺少 serialVersionUID 定义时的警告; 6.finally：任何 finally 子句不能正常完成时的警告; 7.rawtypes 泛型类型未指明 8.unused 引用定义了，但是没有被使用 9.all：关于以上所有情况的警告。
@SafeVarargs
- @SafeVarargs 这是1.7 之后新加入的基本注解. 如例所示，当使用可变数量的参数的时候，而参数的类型又是泛型T的话，就会出现警告。这个时候，就使用@SafeVarargs来去掉这个警告。
  
  @SafeVarargs注解只能用在参数长度可变的方法或构造方法上，且方法必须声明为static或final，否则会出现编译错误。
@FunctionalInterface
- @FunctionalInterface这是Java1.8 新增的注解，用于约定函数式接口。函数式接口概念：如果接口中只有一个抽象方法（可以包含多个默认方法或多个static方法），该接口称为函数式接口。函数式接口其存在的意义，主要是配合Lambda 表达式来使用。

测试代码

test01类

//什么是注解
@SuppressWarnings("all")
public class Test01 extends Object {

    //@Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    //Deprecated 不推荐程序员使用，但是可以使用，或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }


    public void test02(){
        List list = new ArrayList();
    }

    public static void main(String[] args) {
        test();
    }

}

1.3、元注解

元注解的作用就是负责注解其他注解，Java定义4个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明。

这些类型和他们所支持的类在java.lang.annotation包中可以找到(@Target,@Retention,@Documented,@Inherited)

@Target:用于描述注解的使用范围(即：被描述的注解可以用在什么地方)
@Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期(SOURCE<CLASS<RUNTIME)
@Documented:说明该注解被包含在javadoc中
@Inherited说明子类可以继承父类中的该注解

测试

//测试元注解
@MyAnnotation
public class Test02 {

    @MyAnnotation
    public 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.4、自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口

分析：

@interface用来声明一个注解，格式：public @interface 注解名 {定义内容}
其中的每一个方法实际上时声明了一个配置参数，
方法的名称就是参数的名称
返回值类型就是参数的类型（返回值只能是基本类型，Class，String，，enum）
可以通过default来声明参数的默认值
如果只有一个参数成员，一般参数名为value
注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值。

测试

//自定义注解
public class Test03 {
    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation2(age = 18,name = "汉字")
    public void test(){}
    
    @MyAnnotation3("汉字")
    public void test2(){}
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数 ： 参数类型 + 参数名 ();
    String name() default "";
    int age();
    int id() default -1; //如果默认值为-1，代表不存在 ， indexof，如果找不到就返回-1
    
    String[] schools() default {"清华大学","西南大学"};
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    //默认值value才能省略
    String value();
}

posted @ 2022-06-06 11:34 Resign～as 阅读(64) 评论(0) 收藏举报

刷新页面返回顶部

注解

1、注解

1.1、什么是注解

1.2、常见的内置注解

1.3、元注解

1.4、自定义注解

公告