JavaSE—注解（1）

最新推荐文章于 2024-07-24 17:27:32 发布
最新推荐文章于 2024-07-24 17:27:32 发布
阅读量1k 收藏 19
点赞数 36
分类专栏： Java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Mr_Tang4/article/details/139512497
版权

1 注解的定义和作用

注解与注释：

注解：告诉编译器如何运行程序！

注释： 给程序员阅读，对编译、运行没有影响；

注解作用

  1. 告诉编译器如何运行程序；

  2. 简化(取代)配置文件

// 重写父类的方法
@Override
public String toString() {
    return super.toString();
}

// 抑制编译器警告 List不加泛型会出警告
@SuppressWarnings({"unused","unchecked"})
private void save() {
    List list = null;
}

// 标记方法以及过时
@Deprecated
private void save1() {
}

2 自定义注解

通过自定义注解，可以给类、字段、方法上添加描述信息！

2.1 元注解

元注解，表示注解的注解！

  1. 指定注解的可用范围：
@Target({
    TYPE,   	  类
    FIELD,    	  字段
    METHOD,  	  方法
    PARAMETER,    参数
    CONSTRUCTOR,  构造器
    LOCAL_VARIABLE  局部变量
})
  1. 指定注解的生命周期
@Retention(RetentionPolicy.SOURCE)    注解只在源码级别有效
@Retention(RetentionPolicy.CLASS)     注解在字节码级别有效  默认值
@Retention(RetentionPolicy.RUNTIME)   注解在运行时期有效

2.2 案例

//表示这个注解可以作用到方法、属性、类上
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Author {
    
    String name() default "";
    
    //带默认值的属性，使用时候不给这个属性赋值，也有一个默认值
    int age() default 20;

    //如果使用注解里面的value属性，使用的时候可以省略.
    //前提是：注解中只有这一个属性时候
    String[] value() default {};
}

//@Author("男")
//@Author(value = "男")
//@Author(value = {"男", "女"})
@Author(name = "zhao", age = 12, value = "男")
public class AuthorDemo {

    @Author
    private String str;

    @Author(name = "zhangsan", age = 23, value = {"男", "女"})
    //@Author(name = "zhangsan")
    public void add() {
    }

    @Test
    public void test1() throws NoSuchMethodException {
        Class<AuthorDemo> clazz = AuthorDemo.class;
        Author typeAuthor = clazz.getAnnotation(Author.class);
        System.out.println(typeAuthor.value()[0]);

        //1.先获得代表这个方法的Method
        Method method = clazz.getDeclaredMethod("add");
        //2.在Method上拿到指定注解
        Author methodAnnotation = method.getAnnotation(Author.class);
        System.out.println(methodAnnotation.name());//zhangsan
        System.out.println(methodAnnotation.age());//23
        System.out.println(Arrays.toString(methodAnnotation.value()));//[男, 女]
    }
}

3 解释一下

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Author {

    String[] value() default {};
}

这是一个 Java 注解的定义。注解是 Java 中的一种元数据，可以附加到代码中的类、方法、字段等元素上，用于提供额外的信息。让我们详细解释这个注解的各个部分。

注解定义

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Author {

    String[] value() default {};
}

详细解释

  1. @Target 注解(元注解)：

    • @Target 注解指定了这个自定义注解可以应用的目标。
    • 在这里，@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE}) 表示这个注解可以应用于方法、字段和类（类型）。
    • ElementType 的常见类型包括：
      • ElementType.METHOD：方法
      • ElementType.FIELD：字段
      • ElementType.TYPE：类、接口（包括注解类型）或枚举声明

  2. @Retention 注解(元注解)：

    • @Retention 注解指定了这个自定义注解的保留策略。
    • 在这里，@Retention(RetentionPolicy.RUNTIME) 表示这个注解在运行时可见。这意味着可以使用反射机制在运行时读取这个注解。
    • RetentionPolicy 的常见类型包括：
      • RetentionPolicy.SOURCE：注解只在源码中存在，编译时会被丢弃。
      • RetentionPolicy.CLASS：注解在编译时会被保留在类文件中，但在运行时不会被保留。
      • RetentionPolicy.RUNTIME：注解在运行时保留，可以通过反射机制读取。

  3. 注解的定义：

    • public @interface Author：这是定义一个名为 Author 的注解。
    • String[] value() default {};：定义了一个名为 value 的属性，它是一个 String 数组，默认值是一个空数组。
      • 在使用这个注解时，可以提供一个或多个字符串值。例如：@Author({"Alice", "Bob"}) 或 @Author("Alice")。

示例使用

应用在类上
@Author("Alice")
public class MyClass {
    // 类代码
}
应用在方法上
public class MyClass {
    @Author({"Alice", "Bob"})
    public void myMethod() {
        // 方法代码
    }
}
应用在字段上
public class MyClass {
    @Author("Charlie")
    private String myField;
}

读取注解

//如果指定类型的注解存在于此元素上,方法返回true，否则返回false。
A.isAnnotationPresent(B.class)
//B类型的注解是否存在于A元素(可以是类、字段(属性)、方法)上

通过反射可以读取这些注解的信息。例如：

import java.lang.reflect.Method;

public class AnnotationReader {
    public static void main(String[] args) throws Exception {
        // 获取类上的注解
        Class<MyClass> clazz = MyClass.class;
        if (clazz.isAnnotationPresent(Author.class)) {
            Author author = clazz.getAnnotation(Author.class);
            System.out.println("Class Author: " + String.join(", ", author.value()));
        }

        // 获取方法上的注解
        Method method = clazz.getMethod("myMethod");
        if (method.isAnnotationPresent(Author.class)) {
            Author author = method.getAnnotation(Author.class);
            System.out.println("Method Author: " + String.join(", ", author.value()));
        }

        // 获取字段上的注解
        Field field = clazz.getDeclaredField("myField");
        if (field.isAnnotationPresent(Author.class)) {
            Author author = field.getAnnotation(Author.class);
            System.out.println("Field Author: " + String.join(", ", author.value()));
        }
    }
}

总结

这个注解定义了一个名为 Author 的自定义注解，可以应用于类、方法和字段。通过 @Target 注解指定了可以应用的目标，通过 @Retention 注解指定了它的保留策略为运行时，并定义了一个 String 数组类型的 value 属性。这个注解可以在源码中提供作者信息，并在运行时通过反射机制读取。

4 如果使用时只用@Author会发生什么

如果在使用 @Author 注解时只写 @Author 而不提供任何参数，根据注解的定义，注解的 value 属性将使用默认值。因为 value 属性的默认值是一个空数组 default {}，所以这相当于没有指定任何作者信息。

注解的默认值

在注解的定义中，String[] value() default {}; 表示 value 属性有一个默认值，即一个空的 String 数组。如果使用注解时不提供任何参数，value 属性将使用这个默认值。

示例使用

仅使用 @Author 注解
@Author
public class MyClass {
    // 类代码
}
使用反射读取注解

通过反射读取注解时，如果没有提供任何参数，value 属性将是一个空数组。

import java.lang.reflect.Method;

public class AnnotationReader {
    public static void main(String[] args) throws Exception {
        // 获取类上的注解
        Class<MyClass> clazz = MyClass.class;
        if (clazz.isAnnotationPresent(Author.class)) {
            Author author = clazz.getAnnotation(Author.class);
            System.out.println("Class Author: " + String.join(", ", author.value()));
        }

        // 获取方法上的注解
        Method method = clazz.getMethod("myMethod");
        if (method.isAnnotationPresent(Author.class)) {
            Author author = method.getAnnotation(Author.class);
            System.out.println("Method Author: " + String.join(", ", author.value()));
        }

        // 获取字段上的注解
        Field field = clazz.getDeclaredField("myField");
        if (field.isAnnotationPresent(Author.class)) {
            Author author = field.getAnnotation(Author.class);
            System.out.println("Field Author: " + String.join(", ", author.value()));
        }
    }
}

输出结果

如果 @Author 注解没有提供任何参数，读取到的 value 属性将是一个空数组，因此输出将为空。

示例类
@Author
public class MyClass {
    @Author
    private String myField;

    @Author
    public void myMethod() {
        // 方法代码
    }
}
示例输出
Class Author: 
Method Author: 
Field Author:

总结

当你使用 @Author 注解而不提供任何参数时，注解的 value 属性将使用其默认值（即一个空数组）。读取这个注解时，会发现 value 属性是空的，表示没有指定任何作者信息。这是因为 String[] value() default {} 定义了 value 属性的默认值为一个空数组。

5 不提供参数的注解有啥用？

注解在 Java 中的作用取决于它们如何被设计和使用。虽然在某些情况下，不提供参数的注解（例如 @Author 没有参数）可能看起来没有明显的用途，但它们仍然可以在特定的上下文中有意义。以下是一些可能的用途和设计意图：

1. 标记用途

不带参数的注解可以用作简单的标记，用来标记某些元素（类、方法、字段等）具有特定的特性或需要特定的处理。

示例
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Important {
    // 这个注解没有参数，仅用于标记
}

在使用时：

@Important
public class MyClass {
    @Important
    private String importantField;

    @Important
    public void importantMethod() {
        // 重要的方法
    }
}

2. 反射处理

在运行时，通过反射来检查和处理这些标记注解。例如，可以在框架或库中使用这些注解来执行特定的逻辑。

示例：反射处理标记注解
import java.lang.reflect.Field;
import java.lang.reflect.Method;

public class AnnotationProcessor {
    public static void main(String[] args) throws Exception {
        Class<MyClass> clazz = MyClass.class;

        if (clazz.isAnnotationPresent(Important.class)) {
            System.out.println("Class " + clazz.getName() + " is important.");
        }

        for (Field field : clazz.getDeclaredFields()) {
            if (field.isAnnotationPresent(Important.class)) {
                System.out.println("Field " + field.getName() + " is important.");
            }
        }

        for (Method method : clazz.getDeclaredMethods()) {
            if (method.isAnnotationPresent(Important.class)) {
                System.out.println("Method " + method.getName() + " is important.");
            }
        }
    }
}

3. 兼容性和扩展性

设计注解时允许有参数和无参数两种形式，可以增强注解的灵活性和兼容性。在需要详细信息时可以传递参数，而在不需要详细信息时可以仅使用标记。

示例
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Author {
    String[] value() default {};
}

// 使用时可以只作为标记
@Author
public class MyClass {
    // 或者提供具体的值
    @Author({"Alice", "Bob"})
    private String importantField;

    @Author("Charlie")
    public void importantMethod() {
        // 重要的方法
    }
}

4. 默认值的意义

即使是默认值为空，注解仍可以提供关于代码结构的信息，并且允许将来扩展。例如，可以在后续开发中引入新的处理逻辑或使用策略，而不需要修改现有的代码。

总结

虽然不带参数的 @Author 注解在看起来可能没有直接的作用，但它仍可以用于标记、反射处理、提供兼容性和扩展性等用途。实际的用处取决于开发者如何设计和使用这些注解。在实际开发中，注解的使用往往是为了提供元数据，标记特定特性，并在运行时进行处理或执行特定的逻辑。

Mr_Tang4
关注
  • 36
    点赞
  • 踩
  • 19
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
javaSE代码及其注解
06-25
这个压缩包文件“javaSE代码及其注解”显然包含了一系列与JavaSE相关的编程示例，每个示例都配有详细的注释，旨在帮助学习者理解和掌握Java语言的基础以及进阶特性。 在JavaSE中，主要涵盖以下几个重要的知识点： ...
JavaSE进阶-09-注解1
08-03
【JavaSE进阶-09-注解1】章节主要介绍了Java中的注解（Annotation）概念及其使用，包括内置注释、自定义注释以及如何为注解添加变量和默认值。 1. **注解的作用**： - **编写文档**：通过元数据生成文档，如...
javase注解基础
m0_51654746的博客
03-27 124
参考这篇博文http://t.csdn.cn/OCILa 自定义注解 语法: public @interface test(){} 类似于一个接口，但是需要在接口的interface前面加上一个@符号 元注解 元注解一共有五个@Retention、@Documented、@Target、@Inherited、@Repeatable @Retention Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间 可以设置的属性有 Ret
JavaSE之注解
weixin_47543906的博客
11-17 685
默认是CLASS SOURCE：注解只作用在源码阶段，生成的字节码文件中不存在 CLASS：注解作用在源码阶段，字节码文件阶段，运行阶段不存在，默认值 RUNTIME：注解作用在源码阶段，字节码文件阶段，运行阶段
javaSE之注解
谨行的博客
07-06 311
文章目录注解：java Annotation1.什么是注解1.注解的作用2.注解的格式3.注解在哪里使用2.三类注解3.定义注解4.处理注解利用反射读取注解使用注解 注解：java Annotation 1.什么是注解 注解是从JDK5.0开始引入的新技术，注释会被编译器直接忽略，注解则可以被编译器打包进入class文件，因此，注解是一种用作标注的“元数据”。 1.注解的作用 1.不是程序本身，可以对程序做出解释（这一点个注释（comment）没什么区别） 2.可以被其他程序比如编译器等读取 2.注解的
JavaSE——注解
weixin_56341892的博客
01-01 96
注解 一、注解概述 注解，或者叫做注释类型，英文单词是：Annotation 注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。 注解的定义 [修饰符列表] @interface 注解类型名{ ​ } 注解的使用 （1）注解使用时的语法格式是： @注解类型名 （2）注解可以出现在类上、属性上、方法上、变量上等…注解还可以出现在注解类型上。 JDK内置的注解 java.lang包下的注释类型： ​ 掌握： ​ Deprecated 用 @Depr
【JavaSE】注解
知识输出、记录学习
09-22 813
尚硅谷JavaSE笔记——注解。个人实践总结，知识记忆架构不一定适合所有人，建议先阅读文章目录
JavaSE注解和反射
m0_67042480的博客
04-18 379
注解与反射，通过反射读取注解
JavaSE 注解
weixin_44717746的博客
06-25 147
一.JDK内置的三个注解 注解是jdk 5.0 新增功能 1.@Override 限定重写父类的方法，该注解只能用于方法 2.@Deprecated: 用于表示所修饰的元素(类，方法)已过时。希望开发者用新的JDK中的结构。 3.@SuppressWarnings 抑制编译警告。在编译器中定义一个变量，但未使用它，会出现一个警告。 当加上这个注解时候，这个警告变不会出现。 二.自定义注解： 1.注解申明为@interface 2.内部定义成员，使用value表示 3.可以指定成员的默认值，使用defa
JavaSE - 注解
r437664的博客
02-28 174
注解 @ 三大内置注解：准确覆写@Override、过期声明@Deprecated、压制警告@SuppressWarings 1.准确覆写 @Override 当子类覆写父类方法时，此注解检查覆写的方法是否正确声明，只有满足覆写方法要求才会编译通过，否则编译报错。 2.过期声明 @Deprecated 建议用户不使用原有的类或者方法时，可以在类或者方法上加 @Deprecated，表示在...
JavaSE基础学习——注解
weixin_44018911的博客
04-24 218
1. 注解概述 Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。 Java 语言中的类、构造器、方法、成员变量、参数等都可以被注解进行标注。 注解作用 对Java中类、方法、成员变量做标记，然后进行特殊处理，至于到底做何种处理由业务需求来决定。 2. 自定义注解 特殊属性 value属性，如果只有一个value属性的情况下，使用value属性的时候可以省略value名称不写 但是如果有多个属性，且多个属性没有默认值，那么value名称是不能省略的
JavaSE基础注解
叶之印的博客
09-10 149
什么是注解？ Annotation是从JDK5.0开始引入的新技术 Annotation的作用 不是程序本身，可以对程序做出解释(这一点和注释没有什么区别) 可以被其他程序读取 Annotation的格式 注解是以"@注释名"在代码中存在的，还可以添加一些参数值 eg：内置注解@SupperssWarnings(value=“unchecked”) Annotation在哪里使用？ 可以附加在...
JavaSE-注解与反射(框架底层实现机制)
12-21
JavaSE中的注解（Annotation）和反射（Reflection）是两种非常重要的编程特性，它们在现代Java框架和库的实现中起着至关重要的作用。自从JDK5.0引入注解以来，它已经成为编写更加优雅、可维护代码的一种手段。而反射...
JavaSE.xmind
05-08
Java基础语法，面向对象，API, 集合，IO流，泛型，异常，线程，枚举，网络编程，反射，注解，新特性
JavaSE_JavaSE学习资料_
10-02
除此之外，JavaSE还包含异常处理、多线程、反射、枚举、注解、包装类、日期时间API、正则表达式等诸多内容。异常处理能帮助我们编写健壮的代码，通过捕获和处理错误来避免程序意外终止。多线程则使得Java程序能够在...
12. Hibernate 模板设计模式
这是一个web全栈开发的博客，取其精华去其糟粕，争取让大家一看就懂，一学就会，一用就成~
07-22 1202
如何运用模板设计模式重构 Hibernate 操作流程；持久化对象与序列化接口；OOP中有一个编码原则 ：写仅写一次。翻译过来就是，不要重复，要重用。答案是：使用模板设计模式进一步封装Hibernate的操作。在真实项目中，Hibernate仅仅只是完成项目中的一部分工作，需要和其它，如Spring等框架联合工作，一起承担整体项目的开发。Spring框架中就提供的有Hibernate模板对象。一个常规的、频繁的操作代码中，大部分代码不需要变动，只有小部分代码需要根据需求变动。
Java-Lambda
lizhiwei21的博客
07-21 494
lambda表达式可以理解为对匿名内部类的一种简化 , 但是本质是有区别的面向对象思想 :强调的是用对象去完成某些功能函数式编程思想 :强调的是结果 , 而不是怎么去做。
Promise 详解（原理篇）
山重水复疑无路，柳暗花明又一村。
07-20 793
Promise 是一种异步编程的解决方案。在异步操作中，callback 会导致回调地狱的问题，Promise 解决了这个问题。一个 Promise对象有以下三种状态:pending：初始状态，既不是成功，也不是失败状态。：意味着操作成功完成。rejected：意味着操作失败。当 new Promise() 被实例化后，即表示 Promise 进入 pending 初始化状态，准备就绪，等待运行。
Java读取文件中多个JSON对象，并且16进制字符串和byte相互转换，将byte转为16进制字符串并写入json文件
最新发布
weixin_43561432的博客
07-24 270
【代码】Java读取文件中多个JSON对象，并且16进制字符串和byte相互转换，将byte转为16进制字符串并写入json文件。
JavaSE注解与反射详解
"这是一份关于JavaSE中注解和反射的文档，主要涵盖了注解的基本概念、内置注解的使用以及元注解的介绍。" 在Java编程中，注解（Annotation）是一种元数据，从JDK 5.0版本开始引入，用于向编译器、开发工具或者其他...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值