全面解析Java中的注解与注释

什么是注解？

注解（Annotation） 是一种标记，在 Java 中提供了一种可在源代码中嵌入任何元数据的方法。注解可以用来表示一些关于程序代码（程序元素）的元数据，这些元数据和程序（元素）本身没有任何关联，但是它们通常被其他工具和框架所用，比如 web 框架、持久化框架等，可以说注解为 Java 的元数据提供了一种强大的方式。

注解可以被应用在 Java 中的包、类、方法、变量、参数等程序元素上，我们可以定义我们自己的注解，并在代码中声明和使用它。

注解与注释的区别？

在 Java 中，我们常使用的另一种标记就是 注释（Comment），注释和注解虽然有些类似，但是它们有着本质的不同。

注释是 Java 的一种语言特性，经过编译之后会被丢弃，不会产生任何效果。注释主要用来为开发人员之间留下交流的记录和思考的历程。

注解则是一种源代码级别的标记，它提供了一种更加通用的方式来注解元数据，这些注解信息可以在程序运行时被读取和处理。

注解的作用：

注解为我们的 Java 代码添加了一些元数据，这些元数据可以提供给编译器、代码编辑器、框架、库等执行时运行和操作。在实际的开发中，注解经常被用来：

1. 为代码添加元数据信息，被其他工具和框架使用。
2. 能够在编译期、编译时、运行期等时期，保存我们的一些信息，以达到想要的结果。
3. 能够改善代码的可读性、组织性和可维护性。

如何编写注解？

我们可以通过 @interface 关键字来定义我们自己的注释。

@Target(ElementType.METHOD) //表示这个注解可以用来修饰方法
@Retention(RetentionPolicy.RUNTIME) //表示这个注解会保留在运行时
@interface MyAnnotation {
    String description();
}

如上述代码所示，@interface 关键字表明这是一个注解定义，而 MyAnnotation 则是注解类型的名称。其中，@Target 和 @Retention 都是元注解，用于说明我们的注解可以用来修饰哪些程序元素，以及该注解的生命周期。

@Target(ElementType.METHOD) 意味着该注解只可以用于修饰方法；

@Retention(RetentionPolicy.RUNTIME) 表示该注解在运行期可以被保留。

在以上 MyAnnotation 注解定义中，声明了一个字符串变量 description 作为注解属性。

如何使用注解？

可以在 Java 中的包、类、方法、变量、参数等程序元素上使用注解，下面以修饰方法为例，在方法声明前加上 @MyAnnotation 的形式来标注该方法有注解：

@MyAnnotation(description = "测试methodAnnotation...")
public void methodAnnotation() {
    System.out.println("methodAnnotation");
}

在以上示例中，使用 @MyAnnotation(description = "测试methodAnnotation...") 的方式声明该方法有注解，并且传递了一个字符串 "测试methodAnnotation..." 作为注解属性，我们可以在程序运行时通过反射来获取该注解信息。

示例1：自定义注解并获取信息

下面的代码展示了如何创建自定义注解，以及如何在运行时读取该注解的信息：

import java.lang.annotation.*;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    String author() default "unknown";
}

@MyAnnotation(author = "James")
public class Application {

    public static void main(String[] args) {
        MyAnnotation myAnnotation = Application.class.getAnnotation(MyAnnotation.class);
        System.out.println(myAnnotation.author());
    }
}

以上代码中，我们定义了一个注解 MyAnnotation，通过 @Target(ElementType.TYPE) 表示该注解只能修饰类， @Retention(RetentionPolicy.RUNTIME) 表示该注解会在运行时保留。

在 Application 类中，我们使用 @MyAnnotation(author = "James") 注解修饰该类，并传递一个字符串 "James" 作为 author 属性的值。在 main 函数中，调用 Application.class.getAnnotation(MyAnnotation.class) 获取 MyAnnotation 类实例，然后调用该实例的 author 方法获取 author 属性的值。

示例2：Spring 的注解使用

Spring 框架常用的注解包含 @Component、@Repository、@Service、@Controller、@Autowired、@Qualifier、@RequestMapping 等。

下面的代码展示了如何通过 Spring 的 @Autowired 和 @Qualifier 注解来实现自动注入：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;

public class UserController {

    @Autowired
    @Qualifier("userService")
    private UserService userService;

    //...
}

以上代码中，我们使用了 @Autowired 和 @Qualifier 注解来实现 UserService 的自动注入。其中，@Autowired 表示自动装配该属性，而 @Qualifier 则表示需要使用 "userService" 作为该属性的值。

总结

注解为我们的 Java 代码添加了元数据，可以为编译器、代码编辑器、框架、库等提供更多的信息。我们可以通过定义自己的注解，并在程序中进行使用来达到不同的目的，如增强可读性、组织性和可维护性等。java 中的注解还有很多用法和细节，可以再进一步学习。