0
点赞
收藏
分享

微信扫一扫

Java基础:注解

前行的跋涉者 2022-02-22 阅读 67

目录

注解概述

1.什么是注解?

2.内置注解

 3.元注解(meta-annotation)

 4.自定义注解


注解概述

1.什么是注解?

定义︰注解(Annotation ) ,也叫元数据。一种代码级别的说明。它是5.0版本引入的新技术,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。

Annotation的作用:

不是程序本身,可以对程序做出解释(这一点和注释(comment)没什么区别)

可以被其他程序(比如:编译器)读取

Annotation的格式:

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

Annotation在哪里使用?

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

2.内置注解

@Override:定义在java.lang.Override中,此注释只适用于修辞方法,表示一个方法声明打算重写超类中的另一个方法声明

@Deprecated:定义在java.lang.Deprecated中,此注释可以用于修辞方法,属性,类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或者存在更好地选择。

@SuppressWarnings:定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。与前两个注释不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的,我们选择性的使用就好了。  它不仅可以作用在方法上,还可以作用在类上。

@SuppressWarnings(“all”)

@SuppressWarnings(“unchecked”)

@SuppressWarnings(value={“unchecked”,“deprecation”})等等

(深色表示警告)

(加上注解后无警告产生)

package com.annotation;

import java.util.ArrayList;
import java.util.List;

//什么是注解
@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();
    }

}

 3.元注解(meta-annotation)

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

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

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

@Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期

(SOURCE>CLASS>RUNTIME

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

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

package com.annotation;

import java.lang.annotation.*;

//测试元注解
@MyAnnotation
public class Test02 {
    @MyAnnotation
    public void test(){

    }
}
//定义一个注解
//Target 表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//设置该注解可以作用在方法和类上
//Retention 表示我们的注解在什么地方才有效
//runtime > class >source
@Retention(value = RetentionPolicy.RUNTIME)
//Documented 表示是否将我们的注解生成在JAVAdoc中
@Documented
//Inherited 表示子类可以继承父类的注解
@Inherited
@interface MyAnnotation{
}

通过这4个元注解定义一个自定义注解@MyAnnotation

package com.annotation;

import java.lang.annotation.*;

//测试元注解
@MyAnnotation
public class Test02 {
    @MyAnnotation
    public void test(){

    }
}
//定义一个注解
//Target 表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//设置该注解可以作用在方法和类上
//Retention 表示我们的注解在什么地方才有效
//runtime > class >source
@Retention(value = RetentionPolicy.RUNTIME)    
//Documented 表示是否将我们的注解生成在JAVAdoc中
@Documented
//Inherited 表示子类可以继承父类的注解
@Inherited
@interface MyAnnotation{
}

ElementType表示可以作用在类,字段或方法等等上

@Override源码简单解析,它的运行时级别在源码级别时有效,只有在源码时这个注解才是有用的,但作用范围只在方法(method)上

 

同理,@Deprecated表示在运行时(Runtime)有效

 @SuppressWarnings镇压警告表示在源码时(SOURCE)有效,同时需要一个值value 

 

 源码:

 4.自定义注解

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

分析:

@interface用来声明一个注解,格式:public@interface注解名{定义内容}

其中的每一个方法实际上是声明了一个配置参数

方法的名称就是参数的名称

返回值类型就是参数的类型(返回值只能是基本类型,Class,String,enum)

可以通过fefault来声明参数的默认值

如果只有一个参数成员,一般参数名为value

注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值

package com.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//自定义注解
public class Test03 {
    //注解可以显示赋值,有默认值后可以不用写注解参数
    //如果没有默认值,我们就必须给注解赋值
    @MyAnnotation2(name = "秦疆",schools = "西北大学") 
    //注解赋值没有顺序要求
    public void test(){}
    
    @MyAnnotation3("秦疆") //只有一个值使用value命名,可以省略value
    public void test2(){}
}
//下列代码就是自定义的注解
@Target({ElementType.TYPE,ElementType.METHOD})//目标作用域
@Retention(RetentionPolicy.RUNTIME)//在哪个地方有效
@interface MyAnnotation2{
//注解的参数:参数类型 + 参数名()
    String name()default "";   //设置一个默认值为空 ""
    int age() default 0;
    int id() default -1;//如果默认值为-1,代表不存在
    //indexof如果找不到就返回-1
    String[] schools()default {"西部开源"};
}
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
    //如果注解只有一个值,可以使用value命名
    //只有value才可以省略,其他不行
}

 

举报

相关推荐

0 条评论