Java注解的基础入门和案例学习

╰+哭是因爲堅強的太久メ 2024-04-25 08:53 4阅读 0赞

> 【文章序言】：hello你好我是辰兮，很高兴你能来阅读，昵称是希望自己能不断精进，向着优秀程序员前行！  
>   
> 博客来源于项目以及编程中遇到的问题总结，偶尔会有读书分享，我会陆续更新Java前端、后台、数据库、项目案例等相关知识点总结，感谢你的阅读和关注，希望我的博客能帮助到更多的人，分享获取新知，大家一起进步!  
>   
> 吾等采石之人，应怀大教堂之心，愿我们奔赴在各自的热爱里…

### 概念学习 ###

在Java中，注解是一种用于为代码添加元数据（metadata）的声明性方式。它可以用于描述、配置和标记代码的各个部分，包括类、方法、字段、参数等。

注解使用`@`符号紧跟着注解名称的方式进行标记，可以放置在任何语法合法的地方，如类、方法的声明、变量的声明等。注解可以具有元素（attribute），这些元素可以包含值，可以有默认值。

![在这里插入图片描述][37ab78c2b7694b1181fe8baa07ac8ae9.png]

注解的主要作用如下：

1.  描述：注解可以用于为代码添加描述性信息，帮助理解代码的含义和用途。
2.  配置：注解可以用于配置代码的行为，可以为代码提供一些配置选项。
3.  标记：注解可以用于标记代码的某些特征，用于辅助处理代码逻辑。

Java中的常见注解包括：

1.  `@Override`：用于标记方法重写父类方法。
2.  `@Deprecated`：用于标记已经过时的方法、类或字段。
3.  `@SuppressWarnings`：用于抑制编译器警告。
4.  `@FunctionalInterface`：用于标记函数式接口。
5.  `@Retention`：用于指定注解的保留策略。
6.  `@Target`：用于指定注解的目标。

除了这些内置注解外，开发者还可以自定义注解，通过`@interface`关键字创建自定义注解类型。自定义注解可以用于实现特定的逻辑，通过反射机制可以获取注解的信息。

--------------------

### 语法定义 ###

Java注解的语法定义如下：

1.  **注解声明**：使用`@interface`关键字定义一个注解，紧跟着注解的名称。
2.  **注解元素**：注解可以包含多个元素，用来传递数据或配置信息。注解元素的定义语法与接口的方法定义类似，可以包含修饰符、返回类型、名称和参数列表。
3.  **元素参数**：注解元素可以定义默认值和可选性。使用语法`default`关键字为注解元素指定默认值。
4.  **元注解**：元注解是用来注解其他注解的注解。Java提供了多个元注解，如`@Retention`、`@Target`、`@Documented`等。元注解可以为注解提供更多信息，如注解的生命周期、作用范围等。

下面是一个示例注解的语法定义：

public @interface MyAnnotation {
        
        // 定义注解元素
        String value() default ""; // 带有默认值的注解元素
        int count(); // 必须指定的注解元素
    }

--------------------

### 案例入门 ###

好的，下面是一个自定义的Java注解案例：

import java.lang.annotation.*;
    
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    public @interface MyAnnotation {
        
        String value();
        int count() default 0;
    }
    
    @MyAnnotation(value = "TestClass", count = 5)
    class TestClass {
        
        public void printMessage() {
        
            System.out.println("This is a test class.");
        }
    }
    
    public class Main {
        
        public static void main(String[] args) {
        
            Class<TestClass> clazz = TestClass.class;
            MyAnnotation annotation = clazz.getAnnotation(MyAnnotation.class);
            System.out.println("Value: " + annotation.value());
            System.out.println("Count: " + annotation.count());
    
            TestClass testObj = new TestClass();
            testObj.printMessage();
        }
    }

在上述案例中，我们定义了一个名为`MyAnnotation`的注解。该注解有两个成员变量，分别是`value`和`count`。`value`成员变量是一个字符串类型，`count`成员变量是一个整数类型，默认值为0。

然后，在`TestClass`类上使用`@MyAnnotation`注解，并提供相应的值。在`Main`类中，我们使用反射获取`TestClass`类的注解，并打印出注解的值。同时，我们创建了`TestClass`对象，并调用了`printMessage()`方法。

当程序运行时，会输出以下结果：

Value: TestClass
    Count: 5
    This is a test class.

通过使用自定义注解，我们可以在类上添加额外的标记信息，并且可以在运行时使用反射获取到注解的信息。

--------------------

### 拓展案例 ###

举一个简单的例子，假设我们希望通过注解来生成一个简单的日志输出功能。首先，我们定义一个注解 `@Log`：

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface Log {
        
    }

然后，我们编写一个处理器类，用于处理 `@Log` 注解并生成相应的日志输出代码：

import java.lang.reflect.Method;
    
    public class LogProcessor {
        
    
        public static void process(Object object) {
        
            Class<?> clazz = object.getClass();
            Method[] methods = clazz.getDeclaredMethods();
    
            for (Method method : methods) {
        
                if (method.isAnnotationPresent(Log.class)) {
        
                    System.out.println("Executing method: " + method.getName());
                    try {
        
                        method.invoke(object);
                    } catch (Exception e) {
        
                        e.printStackTrace();
                    }
                    System.out.println("Method executed successfully.");
                }
            }
        }
    }

接下来，我们可以在业务代码中使用 `@Log` 注解来标注需要添加日志的方法：

public class Example {
        
    
        @Log
        public void doSomething() {
        
            System.out.println("Doing something...");
        }
    
        public void doSomethingElse() {
        
            System.out.println("Doing something else...");
        }
    }

最后，我们可以在主程序中使用 `LogProcessor` 类来处理标注了 `@Log` 注解的方法：

public class Main {
        
    
        public static void main(String[] args) {
        
            Example example = new Example();
            LogProcessor.process(example);
        }
    }

当我们运行主程序时，会自动执行标注了 `@Log` 注解的方法并生成相应的日志输出。

![在这里插入图片描述][5537b923f3bf4e369cb97745300c7565.png]

这个例子的原理是，在 `LogProcessor` 类中通过反射机制获取到被处理类的所有方法，并判断是否标注了 `@Log` 注解。如果标注了该注解，则执行相应的方法，并进行日志输出。通过注解的方式可以简化代码的编写，提高代码的可读性和可维护性。同时，这也展示了注解处理器的基本原理，即使用反射机制获取注解信息，并根据注解信息进行相应的处理操作。

--------------------

📖☕️🌊📝📚🎩🚀  
📣非常感谢你阅读到这里，如果这篇文章对你有帮助，希望能留下你的点赞👍 关注❤️ 分享👥 留言💬thanks！！！

📚愿我们奔赴在各自的热爱里！

[37ab78c2b7694b1181fe8baa07ac8ae9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/52c3af5658364302a6bdaa6c93476c0b.png
[5537b923f3bf4e369cb97745300c7565.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/25/87639b6ff7f8438085af2db30719988d.png