Java学习十六—掌握注解：让编程更简朴

一、关于注解

1.1 简介

Java 注解（Annotation）是一种特别的语法结构，可以在代码中嵌入元数据。它们不直接影响代码的运行，但可以通过工具和框架提供额外的信息，帮助在编译、摆设或运行时进行处置惩罚。

​

初学者可以这样明确注解：想像代码具有生命，注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲，注解如同一张标签。

‍
1.2 发展

Java注解的发展可以追溯到Java 5.0的发布，引入了注解这一特性，为开发者提供了一种新的元数据形式，允许在代码中添加范例信息而不改变步伐的逻辑。以下是Java注解发展的一些关键里程碑：

• Java 5.0 (2004) : 引入了注解的概念，包括@Override​, @Deprecated​, @SuppressWarnings​等内置注解。
  
• Java 6.0 (2006) : 增加了对注解的元注解支持，比方@Retention​, @Target​, @Documented​，这些元注解可以用来定义其他注解的元数据。
  
• Java 7.0 (2011) : 引入了@SafeVarargs​和@FunctionalInterface​注解，用于提供关于可变参数和函数式接口的编译时检查。
  
• Java 8.0 (2014) : 引入了@Repeatable​注解，允许在一个元素上利用同一个注解范例多次。同时，Java 8也是Spring框架开始广泛利用注解的时期，比方@Autowired​, @RestController​等。
  
• Java 11.0 (2018) : 在这个版本中，Java模块系统（Jigsaw项目）正式成为Java的一部门，引入了@Module​, @Requires​, @Exports​等模块相关的注解。
  
• Spring框架的发展: 从Spring 1.x的@Transactional​和@ManagedResource​开始，Spring框架逐渐引入了更多的注解来简化设置和提高开发服从。到了Spring 3.x，引入了@Configuration​, @ComponentScan​, @EnableAutoConfiguration​等注解，进一步推动了注解编程的普及。
  
• Spring 4.x (2013) : 引入了@Conditional​注解，允许基于条件创建Bean，这是Spring Boot中自动设置的核心。
  
• Spring 5.x (2017) : 引入了@Indexed​注解，用于提高注解驱动的组件扫描性能。
  

Java注解的发展不仅提高了代码的可读性和可维护性，也为框架和库的开发者提供了强盛的工具，使得他们能够创建更加灵活和强盛的API。随着Java语言和相关框架的不断进步，注解将继续在软件开发中扮演重要角色。
‍
1.3 特点

Java注解是一种强盛的工具，它使得代码更加清晰、模块化，而且可以与编译器、开发工具和运行时情况紧密协作，提高开发服从和代码质量。
‍
优点

• 增强代码可读性
  
  
  
  • 注解提供了清晰的元数据，使代码更易于明确，特别是在利用框架时，可以淘汰对 XML 设置的依靠。
    
  
  
• 淘汰样板代码
  
  
  
  • 利用注解可以淘汰大量的样板代码，简化设置。比方，在 Spring 框架中，可以通过注解来代替繁琐的 XML 设置。
    
  
  
• 编译时检查
  
  
  
  • 通过注解处置惩罚器，可以在编译时检查注解的利用，帮助开发者及早发现问题，提升代码质量。
    
  
  
• 灵活性
  
  
  
  • 注解可以与各种编程范式结合利用，如面向对象编程、面向切面编程等，为开发者提供了灵活的编程方式。
    
  
  
• 支持元编程
  
  
  
  • 注解与反射机制结合，可以在运行时动态地处置惩罚元数据，适用于许多框架和库的设计，如 ORM 和依靠注入。
    
  
  
• 自定义能力
  
  
  
  • 开发者可以根据需要创建自定义注解，灵活地定义元数据，满足特定的需求。
    
  
  

‍
缺点

• 性能开销
  
  
  
  • 利用反射机制读取注解大概会带来性能开销，尤其是在大规模应用中，频仍的反射调用会影响运行服从。
    
  
  
• 调试困难
  
  
  
  • 注解的利用大概使得调试过程变得复杂，尤其是在错误信息中不明确标识出注解的影响，大概导致追踪问题时的困惑。
    
  
  
• 学习曲线
  
  
  
  • 对于初学者而言，明确注解及其用法大概需要一定的学习成本，特别是在注解与反射结合利用时。
    
  
  
• 过度利用
  
  
  
  • 过度利用注解大概导致代码难以维护和明确，尤其是当多个注解叠加在同一元素上时，大概使得逻辑变得复杂。
    
  
  
• 编译器支持
  
  
  
  • 并非所有的 IDE 和工具都完全支持注解的编写和利用，大概会导致一些兼容性问题。
    
  
  
• 不适用于所有场景
  
  
  
  • 在一些简朴的场景中，利用注解大概显得过于复杂，反而增加了开发和维护的成本。
    
  
  

‍
1.4 利用场景

Java 注解在很多场景下都有应用，比方：

• 代码分析工具：比方利用 @Deprecated​ 标记方法过期，帮助开发者识别风险和改进代码。
  
• 编译时处置惩罚：比方通过自定义注解，在编译时生成辅助代码，如 Lombok 库。
  
• 运行时处置惩罚：通过反射机制，可以在运行时获取和处置惩罚注解信息，实现动态的举动。
  

‍
‍
二、基本语法

Java 注解的语法主要包括定义注解、利用注解以及元注解。以下是详细的语法示例和解释：
2.1 定义注解

利用 @interface​ 关键字定义一个注解。可以定义元素（属性）和默认值。

1. public @interface MyAnnotation {
2.     // 定义一个字符串类型的元素，带有默认值
3.     String value() default "default value";
5.     // 定义一个整型元素，带有默认值
6.     int count() default 0;
7. }

复制代码

‍
2.2 注解的元注解

元注解是用来注解其他注解的注解。Java 提供了以下元注解：

• @Retention：定义注解的生命周期。
  
• @Target：定义注解可以应用于哪些 Java 元素（类、方法、字段等）。
  
• @Documented：表示该注解应该被 javadoc 工具记录。
  
• @Inherited：表示该注解可以被子类继承。
  

1. import java.lang.annotation.ElementType;
2. import java.lang.annotation.Retention;
3. import java.lang.annotation.RetentionPolicy;
4. import java.lang.annotation.Target;
6. @Retention(RetentionPolicy.RUNTIME) // 注解在运行时可用
7. @Target(ElementType.METHOD) // 注解可以用于方法
8. public @interface MyMethodAnnotation {
9.     String description();
10. }

复制代码

‍
2.3 利用注解

利用自定义注解时，直接在需要的元素上加上注解即可。

1. public class MyClass {
3.     @MyMethodAnnotation(description = "This is a custom method annotation")
4.     public void myAnnotatedMethod() {
5.         // 方法实现
6.     }
7. }

复制代码

‍
2.4 访问注解

利用反射机制在运行时访问注解信息。

1. import java.lang.reflect.Method;
3. public class AnnotationExample {
4.     public static void main(String[] args) throws Exception {
5.         Method method = MyClass.class.getMethod("myAnnotatedMethod");
7.         if (method.isAnnotationPresent(MyMethodAnnotation.class)) {
8.             MyMethodAnnotation annotation = method.getAnnotation(MyMethodAnnotation.class);
9.             System.out.println("Description: " + annotation.description());
10.         }
11.     }
12. }

复制代码

‍
2.5 组合注解

可以将多个注解组合在一起利用。

1. @MyAnnotation
2. @AnotherAnnotation
3. public class AnotherClass {
4.     // 类实现
5. }

复制代码

‍
‍
三、Java 预置的注解

Java 提供了一些预置的注解，这些注解在 Java 开发中非常常用。以下是一些主要的预置注解及其用途：
1. @Override​

• 用途：用于指示一个方法重写了超类的方法。
  
• 示例：
  1. @Override
  2. public String toString() {
  3.     return "This is my object";
  4. }

  复制代码

2. @Deprecated​

• 用途：标记一个元素（类、方法或字段）为不推荐利用，大概在将来的版本中被删除。
  
• 示例：
  1. @Deprecated
  2. public void oldMethod() {
  3.     // 不推荐使用
  4. }

  复制代码

3. @SuppressWarnings​

• 用途：克制编译器发出的特定警告。可以指定警告范例，如未利用的变量、未检查的转换等。
  
• 示例：
  1. @SuppressWarnings("unchecked")
  2. public void myMethod() {
  3.     List list = new ArrayList(); // 编译器可能会发出未检查的转换警告
  4. }

  复制代码

4. @FunctionalInterface​

• 用途：用于指示一个接口是函数式接口，即该接口只包含一个抽象方法。
  
• 示例：
  1. @FunctionalInterface
  2. public interface MyFunctionalInterface {
  3.     void execute();
  4. }

  复制代码

5. @SafeVarargs​

• 用途：用于指示可变参数方法是范例安全的，适用于不可变的泛型。
  
• 示例：
  1. @SafeVarargs
  2. public static <T> void safeMethod(T... elements) {
  3.     // 处理元素
  4. }

  复制代码

6. @Native​

• 用途：标记一个字段为本地常量，通常用于与 C/C++ 代码交互。
  
• 示例：
  1. @Native
  2. public static final int NATIVE_CONSTANT = 100;

  复制代码

‍
‍
四、示例

示例1—利用注解（标记过期的方法）

在 Java 中，利用 @Deprecated​ 注解可以标记一个方法或类已经过期，鼓励开发者利用新的实现或方法。

1. class DeprecatedExample {
3.     @Deprecated
4.     public void oldMethod() {
5.         System.out.println("This method is deprecated.");
6.     }
8.     public void newMethod() {
9.         System.out.println("This is the new method.");
10.     }
12.     public static void main(String[] args) {
13.         DeprecatedExample obj = new DeprecatedExample();
15.         // 调用过时的方法
16.         obj.oldMethod();
18.         // 调用新方法
19.         obj.newMethod();
20.     }
21. }

复制代码

在这个示例中，oldMethod​ 被标记为过期的，当我们调用它时会得到编译器警告，提醒我们不要继续利用这个方法。

​
‍
‍
示例2—自定义注解

1.定义注解

‍

​
‍
‍

​

1. //自定义注解必须的元注解target，指明注解的作用域（此处指明的是在类和方法上起作用）
2. @Target({ElementType.TYPE, ElementType.METHOD})
3. //元注解retention声明该注解在何时起作用（此处指明的是在运行时起作用）
4. @Retention(RetentionPolicy.RUNTIME)
5. public @interface MyAnnotation {
7.     //注解中需声明参数，格式为：参数类型 + 参数名();
8.     String value() default "";
10. }

复制代码

‍
2.利用注解

​

1. public class CustomAnnotation {
3.     @MyAnnotation(value = "这是一个测试方法")
4.     public void test() {
5.         System.out.println("执行 test 方法");
6.     }
8. }

复制代码

‍
3.获取和利用注解信息

​
‍

1. public class AnnotationDemo {
3.     public static void main(String[] args) {
5.         try {
6.             // 获取 CustomAnnotation 类的 Class 对象
7.             Class<CustomAnnotation> clazz = CustomAnnotation.class;
9.             // 获取 test 方法
10.             Method method = clazz.getMethod("test");
12.             // 检查该方法是否有 MyAnnotation 注解
13.             if (method.isAnnotationPresent(MyAnnotation.class)) {
14.                 // 获取 MyAnnotation 注解
15.                 MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
16.                 // 打印注解的 value 值
17.                 System.out.println("注解的值: " + annotation.value());
18.             }
20.             // 调用 test 方法
21.             CustomAnnotation customAnnotation = new CustomAnnotation();
22.             customAnnotation.test();
24.         } catch (NoSuchMethodException e) {
25.             throw new RuntimeException(e);
26.         }
28.     }
29. }

复制代码

‍

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。