JAVA注解篇

本文涉及的产品
云解析 DNS,旗舰版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
全局流量管理 GTM,标准版 1个月
简介: JAVA注解篇


目录

一、基本概念

注解概念:

注解定义:

概念描述:

作用分类:

Java将注解抽取到doc文件中:

JDK中预定义的一些注解

自定义注解

       格式:

       本质:

       属性:

3.元注解

4.在程序中使用(解析)注解:

一、基本概念

注解概念:

应用于说明程序,给计算机看的。

注解定义:

注解也叫做元数据,一种代码级别的说明。他是JDK1.5之后版本引入的一个特性,与类,接口,枚举是在同一个层次。它可以声明在包,类,字段,方法,局部变量,方法参数等的前面,用来对这些数据进行说明。

概念描述:

1.JDK1.5之后新特性

2.说明程序的

3.使用注解:@注解名称

作用分类:

1.编写文档:通过代码里标识的元数据(注解)生成文档【生成文档doc文档】

2.代码分析:通过代码里标识的元数据(注解)对代码进行分析【使用反射】

3.编译检查:通过代码里标识的元数据(注解)让编译器能够实现基本的编译检查【Override(如toString方法的重写)】

Java将注解抽取到doc文件中:

先定义一个类,在类中定义方法  并且在类中写入注解(快捷键:/**enter)

package cn.annotation;
/*
* 注解javadoc演示
*
* @author tangxiaocong
* @since 1.5
* */
public class AnnoDemo1 {
    /*
    * 注解
    * 注解来描述一些信息
    * 这些注解可以被抽取但Java doc文档中
    *
    *
    *
    * */
    /**
     * 计算两数之和
     * @param a 整数
     * @param b 整数
     * @return 返回两数之和
     */
    public  int add(int a,int b)
{
    return a+b;
}
}

类中注解会被抽取到doc文件中

先新建一个文件夹,把java文件粘贴进入此文件

为了方便后边的抽取,把包给注释删除

打开命令行窗口

打开当前当前文件夹输入javadoc AnnoDemo1.java

打开之后会在“新建文件夹”下边生成大量html文件

JDK中预定义的一些注解

1.@override       :检测被该注解标注的方法是否是继承自父类(接口)的

2.@Deprecated   :该注解标注的内容,表示已经过时(已经有新方法替代它)

3.@SuppressWarnings  :压制警告(需要传递参数一般为all)

eg:@SuppressWarnings("all")

package cn.annotation;
@SuppressWarnings("all")
public class AnnoDemo2 {
    @Override
    public String toString() {
        return super.toString();
    }
    @Deprecated
    public void show1()
    {
        //有缺陷
    }
    public void show2()
    {
        //替代show1
    }
}

自定义注解

       格式:

元注解

public @interface 注解名称{

}

       本质:

先编译(javac)生成字节码文件  再反编译(javap)生成一下:

public interface cn.annotation.MyAnno extends java.lang.annotation.Annotation {

}

注解本质上就是一个接口,该接口默认继承Annotation接口

       属性:

接口中可以定义的成员方法(接口中的抽象方法)

               要求:

1.属性的返回值类型:

       基本数据类型

       String

       枚举(enum)

       注解

       以上类型的数组

(不允许void)

2.定义了属性,在使用时需要给属性赋值

(1)如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。

(2)如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。

(3)数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}省略

3.元注解

用于描述注解的注解

eg:

 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.SOURCE)
 public @interface Override {
 }

@Target:表示注解能够作用的位置 @Target(ElementType.METHOD)

    ElementType取值:(ElementType是数组)

   METHOD:表示可以作用在方法上

   TYPE:表示可以作用在类上

   FIELD:表示可以作用于成员变量上

package cn.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
//表示该注解MyAnno3只能作用于类上
@Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
  public @interface MyAnno3 {
}

 

@Retention: 描述注解被保留的阶段, @Retention(RetentionPolicy.SOURCE)

RUNTIME:表示当前被描述的注解,会保留到class字节码文件中,并被JVM读取到

CLASS:表示当前被描述的注解,会保留到class字节码文件中,但是不会被读取到

SOURCE:表示当前被描述的注解,只会在源码中出现,不会保留到class文件中

package cn.annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
//表示该注解MyAnno3只能作用于类上
//@Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno3 {
}

@Documented:描述注解是否被抽取到api文档中

表示当前被描述的注解会被抽取到Javadoc的文档中

       在不加@Documented的情况下生成的API文档:

@Inherited:描述注解是否被子类继承

4.在程序中使用(解析)注解:

获取注解中定义的属性值

       1.获取注解定义的位置的对象(Class,Method,Field)

       2.获取指定的注解

getAnnotation(Class)

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

             前提:

不能改变该类的任何代码,可以创建任意类的对象,可以执行任意方法

步骤:

1.解析注解


       1.1 获取该类的字节码文件对象

Class<ReflectTest> reflectTestClass = ReflectTest.class;

2 .获取上边注解对象(其实就是在内存中生成一个该注解接口的子类实现对象)

pro annotation = reflectTestClass.getAnnotation(pro.class);

相当于重写注解接口中的方法     因为返回值为String    重写后会return 回来

3.调用注解对象中定义的抽象方法,获取返回值

String s = annotation.className();

String s1 = annotation.methodName();

package cn.annotation;
@pro(className = "cn.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) {
            //1.解析注解
        //1.1 获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //2 获取上边注解对象
        //其实就是在内存中生成一个该注解接口的子类实现对象
        pro annotation = reflectTestClass.getAnnotation(pro.class);//
        //3.调用注解对象中定义的抽象方法,获取返回值
        String s = annotation.className();
        String s1 = annotation.methodName();
        System.out.println(s);
        System.out.println(s1);
    }
}



相关文章
|
15天前
|
XML Java 编译器
Java注解的底层源码剖析与技术认识
Java注解(Annotation)是Java 5引入的一种新特性,它提供了一种在代码中添加元数据(Metadata)的方式。注解本身并不是代码的一部分,它们不会直接影响代码的执行,但可以在编译、类加载和运行时被读取和处理。注解为开发者提供了一种以非侵入性的方式为代码提供额外信息的手段,这些信息可以用于生成文档、编译时检查、运行时处理等。
51 7
|
2月前
|
XML Java 编译器
Java学习十六—掌握注解:让编程更简单
Java 注解(Annotation)是一种特殊的语法结构,可以在代码中嵌入元数据。它们不直接影响代码的运行,但可以通过工具和框架提供额外的信息,帮助在编译、部署或运行时进行处理。
98 43
Java学习十六—掌握注解:让编程更简单
|
21天前
|
Java 编译器 数据库
Java 中的注解(Annotations):代码中的 “元数据” 魔法
Java注解是代码中的“元数据”标签,不直接参与业务逻辑,但在编译或运行时提供重要信息。本文介绍了注解的基础语法、内置注解的应用场景,以及如何自定义注解和结合AOP技术实现方法执行日志记录,展示了注解在提升代码质量、简化开发流程和增强程序功能方面的强大作用。
58 5
|
1月前
|
Java 开发者 Spring
[Java]自定义注解
本文介绍了Java中的四个元注解(@Target、@Retention、@Documented、@Inherited)及其使用方法,并详细讲解了自定义注解的定义和使用细节。文章还提到了Spring框架中的@AliasFor注解,通过示例帮助读者更好地理解和应用这些注解。文中强调了注解的生命周期、继承性和文档化特性,适合初学者和进阶开发者参考。
57 14
|
1月前
|
前端开发 Java
[Java]讲解@CallerSensitive注解
本文介绍了 `@CallerSensitive` 注解及其作用,通过 `Reflection.getCallerClass()` 方法返回调用方的 Class 对象。文章还详细解释了如何通过配置 VM Options 使自定义类被启动类加载器加载,以识别该注解。涉及的 VM Options 包括 `-Xbootclasspath`、`-Xbootclasspath/a` 和 `-Xbootclasspath/p`。最后,推荐了几篇关于 ClassLoader 的详细文章,供读者进一步学习。
36 12
|
1月前
|
Java 编译器
Java进阶之标准注解
Java进阶之标准注解
32 0
|
2月前
|
JSON Java 数据库
java 常用注解大全、注解笔记
关于Java常用注解的大全和笔记,涵盖了实体类、JSON处理、HTTP请求映射等多个方面的注解使用。
43 0
java 常用注解大全、注解笔记
|
3月前
|
Arthas Java 测试技术
Java字节码文件、组成,jclasslib插件、阿里arthas工具,Java注解
Java字节码文件、组成、详解、分析;常用工具,jclasslib插件、阿里arthas工具;如何定位线上问题;Java注解
Java字节码文件、组成,jclasslib插件、阿里arthas工具,Java注解
|
2月前
|
IDE Java 编译器
java的反射与注解
java的反射与注解
19 0
|
3月前
|
Java 编译器 程序员
Java注解,元注解,自定义注解的使用
本文讲解了Java中注解的概念和作用,包括基本注解的用法(@Override, @Deprecated, @SuppressWarnings, @SafeVarargs, @FunctionalInterface),Java提供的元注解(@Retention, @Target, @Documented, @Inherited),以及如何自定义注解并通过反射获取注解信息。
Java注解,元注解,自定义注解的使用
下一篇
DataWorks