Java 注解（Annotation）实战指南：从基础到高级应用！

开篇语

哈喽，各位小伙伴们，你们好呀，我是喵手。运营社区：C站/掘金/腾讯云/阿里云/华为云/51CTO；欢迎大家常来逛逛

  今天我要给大家分享一些自己日常学习到的一些知识点，并以文字的形式跟大家一起交流，互相学习，一个人虽可以走的更快，但一群人可以走的更远。

  我是一名后端开发爱好者，工作日常接触到最多的就是Java语言啦，所以我都尽量抽业余时间把自己所学到所会的，通过文章的形式进行输出，希望以这种方式帮助到更多的初学者或者想入门的小伙伴们，同时也能对自己的技术进行沉淀，加以复盘，查缺补漏。

小伙伴们在批阅的过程中，如果觉得文章不错，欢迎点赞、收藏、关注哦。三连即是对作者我写作道路上最好的鼓励与支持！

前言

  你是否曾在 Java 编程中遇到过 @Override、@Entity、@Autowired 等注解？这些注解不仅出现在我们常用的框架中，像 Spring、Hibernate 等，还可以自定义和扩展，提升代码的可读性、灵活性以及开发效率。今天，我们将从基础到高级，深入解析 Java 注解的使用，帮助你更好地理解和应用这一强大特性。

什么是 Java 注解？

  Java 注解（Annotation）是一种特殊的标记，它可以添加到类、方法、变量、参数等元素上，用于提供额外的信息。注解本身不会直接影响程序的执行，它们主要作为一种元数据存在，可以被编译器、开发工具、框架等读取和处理。

  Java 中的注解通常用于：

• 编译时检查
• 代码生成工具
• 运行时反射
• 依赖注入和 AOP 等高级应用

Java 注解的基础

1. 注解的定义

Java 注解通过 @interface 关键字来定义。基本的注解结构如下：

public @interface MyAnnotation {
    String value() default "Default Value";  // 可以定义属性，属性有默认值
}

在这个例子中，MyAnnotation 是一个注解，value 是它的一个属性。default 关键字用来为属性指定默认值。注解的属性类似于方法，可以有返回类型、参数等。

2. 注解的使用

定义了注解之后，可以在代码中进行应用。我们可以将它应用于类、方法、字段、参数等位置。最常见的注解应用如下：

@MyAnnotation(value = "Custom Value")  // 使用注解
public class MyClass {
    @MyAnnotation  // 使用默认值
    private String name;

    @MyAnnotation(value = "Method Annotation")
    public void myMethod() {
        System.out.println("Method executed");
    }
}

3. 内置注解

Java 提供了若干内置注解，这些注解大多数被编译器或框架用来进行验证、增强功能。常见的内置注解包括：

• @Override：标识方法重写，编译器会验证方法是否正确重写父类方法。
• @Deprecated：标识某个方法、类或字段已废弃，建议不要使用。
• @SuppressWarnings：抑制编译器警告。
• @FunctionalInterface：标识一个接口是函数式接口，只能有一个抽象方法。

例如：

@Override
public String toString() {
    return "MyClass{}";
}

@Deprecated
public void oldMethod() {
    // 旧的实现
}

@SuppressWarnings("unchecked")
public void suppressWarningsExample() {
    List list = new ArrayList();
    list.add("test");
}

高级应用：自定义注解与反射

自定义注解的功能远不止简单的标记，它们能够和反射机制结合，实现更强大的功能。接下来，我们将深入讨论如何利用注解和反射进行高级应用。

1. 自定义注解

我们已经看到如何定义一个简单的注解，但注解还可以有更多复杂的特性。例如，可以指定注解的适用范围（如类、方法、字段等），以及在编译时或运行时是否可用。

1.1 定义注解的元注解

Java 提供了几种元注解，用来指定注解的特性：

• @Target：指定注解可以应用的 Java 元素类型（类、方法、字段等）。
• @Retention：指定注解的生命周期，SOURCE、CLASS、RUNTIME。
• @Documented：指定注解是否包含在 Javadoc 中。
• @Inherited：指定注解是否可以被子类继承。

例如，定义一个只能应用于方法且在运行时可用的注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)  // 只能应用于方法
@Retention(RetentionPolicy.RUNTIME)  // 在运行时可用
public @interface MyMethodAnnotation {
    String description() default "This is a method annotation";
}

2. 通过反射读取注解

注解本身并不会影响程序的行为，它通常通过反射读取并处理。例如，在一个框架中，Spring 就通过反射扫描类上的注解来实现依赖注入和 AOP。

2.1 使用反射读取注解

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

public class AnnotationProcessor {
    public static void processAnnotations() {
        try {
            // 获取 MyClass 的所有方法
            Method[] methods = MyClass.class.getDeclaredMethods();

            // 遍历方法，查找是否有 MyMethodAnnotation 注解
            for (Method method : methods) {
                if (method.isAnnotationPresent(MyMethodAnnotation.class)) {
                    // 获取注解
                    MyMethodAnnotation annotation = method.getAnnotation(MyMethodAnnotation.class);
                    System.out.println("Method: " + method.getName());
                    System.out.println("Description: " + annotation.description());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

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

在上面的代码中，我们使用 Method.isAnnotationPresent() 来判断一个方法是否包含某个注解，并使用 getAnnotation() 获取注解的信息。

3. 注解与 Spring 框架

Spring 框架广泛使用注解来简化 Java 开发，特别是在依赖注入和面向切面编程（AOP）中。常见的注解如 @Autowired、@Component、@Service 等。

3.1 依赖注入

Spring 使用 @Autowired 注解来自动注入依赖。我们可以直接在构造器、字段或者方法上使用它：

@Component
public class UserService {
    private final UserRepository userRepository;

    @Autowired  // 自动注入 UserRepository
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public void saveUser(User user) {
        userRepository.save(user);
    }
}

3.2 AOP 切面编程

Spring AOP 利用注解来定义切面和增强逻辑。我们可以使用 @Aspect 和 @Before 等注解来定义切面逻辑：

@Aspect
@Component
public class LoggingAspect {

    @Before("execution(* com.example.service.*.*(..))")  // 在所有 service 方法执行前
    public void logMethodExecution(JoinPoint joinPoint) {
        System.out.println("Executing method: " + joinPoint.getSignature().getName());
    }
}

4. 注解与 Java Bean Validation

Java Bean Validation 是用于验证 Java 对象的规范。它定义了一组标准注解来验证数据，如 @NotNull、@Size 等。

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class User {
    @NotNull(message = "Name cannot be null")
    @Size(min = 2, max = 100, message = "Name must be between 2 and 100 characters")
    private String name;

    // Getter 和 Setter
}

通过这些注解，我们可以在类的属性上进行数据校验，在应用程序中进行自动校验。

小结

  通过今天的实战讲解，我们已经了解了 Java 注解的基础知识以及如何在实际开发中应用它。注解作为一种元数据，可以增强代码的可读性、提高开发效率，并且与反射结合可以实现更复杂的应用。特别是在框架和工具的开发中，注解发挥着不可或缺的作用。

  从自定义注解、注解的元注解，到 Spring 的依赖注入和 AOP，Java 注解的应用场景非常广泛。掌握注解的使用，能够让你的代码更简洁、更灵活、更易于维护。如果你还没有在项目中广泛使用注解，现在正是时候开始探索它的强大功能！

… …

文末

好啦，以上就是我这期的全部内容，如果有任何疑问，欢迎下方留言哦，咱们下期见。

… …

学习不分先后，知识不分多少；事无巨细，当以虚心求教；三人行，必有我师焉！！！

wished for you successed ！！！

---

⭐️若喜欢我，就请关注我叭。

⭐️若对您有用，就请点赞叭。
⭐️若有疑问，就请评论留言告诉我叭。

---

版权声明：本文由作者原创，转载请注明出处，谢谢支持！