Java注解基本原理

Java注解基本原理

注解目前非常的流行,很多主流框架都支持注解,而且自己编写代码的时候也会尽量的去用注解,一时方便,而是代码更加简洁。

 注解的语法比较简单,除了@符号的使用之外,它基本与Java固有语法一致。Java SE5内置了三种标准注解:

 @Override,表示当前的方法定义将覆盖超类中的方法。

 @Deprecated,使用了注解为它的元素编译器将发出警告,因为注解@Deprecated是不赞成使用的代码,被弃用的代码。

 @SuppressWarnings,关闭不当编译器警告信息。

 上面这三个注解多少我们都会在写代码的时候遇到。Java还提供了4中注解,专门负责新注解的创建。
注解方式用法
@Target表示该注解可以用于什么地方,可能的ElementType参数有:CONSTRUCTOR:构造器的声明FIELD:域声明(包括enum实例)。LOCAL_VARIABLE:局部变量声明METHOD:方法声明。 PACKAGE:包声明。PARAMETER:参数声明。TYPE:类、接口(包括注解类型)或enum声明。
@Retention表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括:SOURCE:注解将被编译器丢弃。CLASS:注解在class文件中可用,但会被VM丢弃。RUNTIME:VM将在运行期间保留注解,因此可以通过反射机制读取注解的信息。
@Document将注解包含在Javadoc中
@Inherited允许子类继承父类中的注解

定义一个注解的方式:

1 @Target(ElementType.METHOD)
2 @Retention(RetentionPolicy.RUNTIME)
3 public @interface Test {
4  
5 }

除了@符号,注解很像是一个接口。定义注解的时候需要用到元注解,上面用到了@Target和@RetentionPolicy,它们的含义在上面的表格中已近给出。

在注解中一般会有一些元素以表示某些值。注解的元素看起来就像接口的方法,唯一的区别在于可以为其制定默认值。没有元素的注解称为标记注解,上面的@Test就是一个标记注解。

注解的可用的类型包括以下几种:所有基本类型、String、Class、enum、Annotation、以上类型的数组形式。元素不能有不确定的值,即要么有默认值,要么在使用注解的时候提供元素的值。而且元素不能使用null作为默认值。注解在只有一个元素且该元素的名称是value的情况下,在使用注解的时候可以省略“value=”,直接写需要的值即可。

下面看一个定义了元素的注解。

1 @Target(ElementType.METHOD)
2 @Retention(RetentionPolicy.RUNTIME)
3 public @interface UseCase {
4      public String id();
5      public String description() default "no description";
6 }

定义了注解,必然要去使用注解。

 1 public class PasswordUtils {
 2      @UseCase(id = 47, description = "Passwords must contain at least one numeric")
 3      public boolean validatePassword(String password) {
 4          return (password.matches("\\w*\\d\\w*"));
 5      }
 6  
 7      @UseCase(id = 48)
 8      public String encryptPassword(String password) {
 9          return new StringBuilder(password).reverse().toString();
10      }
11  }

使用注解最主要的部分在于对注解的处理,那么就会涉及到注解处理器。

 从原理上讲,注解处理器就是通过反射机制获取被检查方法上的注解信息,然后根据注解元素的值进行特定的处理。
public static void main(String[] args) {
     List<Integer> useCases = new ArrayList<Integer>();
     Collections.addAll(useCases, 47, 48, 49, 50);
     trackUseCases(useCases, PasswordUtils.class);
 }
 
 public static void trackUseCases(List<Integer> useCases, Class<?> cl) {
     for (Method m : cl.getDeclaredMethods()) {
         UseCase uc = m.getAnnotation(UseCase.class);
         if (uc != null) {
             System.out.println("Found Use Case:" + uc.id() + " "
                         + uc.description());
             useCases.remove(new Integer(uc.id()));
         }
     }
     for (int i : useCases) {
         System.out.println("Warning: Missing use case-" + i);
     }
 }
Found Use Case:47 Passwords must contain at least one numeric

Found Use Case:48 no description

Warning: Missing use case-49

Warning: Missing use case-50

上面的三段代码结合起来是一个跟踪项目中用例的简单例子。

### Java注解的工作原理 Java注解是一种用于提供元数据的语言特性,它可以在编译期或运行时被处理。以下是关于Java注解工作原理及其实现机制的详细介绍。 #### 一、注解的基本概念 注解(Annotation)是Java语言的重要特性之一,主要用于向代码中添加元数据信息[^3]。这些元数据可以描述类、方法、字段或其他程序元素的行为特征。根据生命周期的不同,注解可分为两类: - **编译时注解**:仅在编译期间有效,通常由注解处理器解析并执行特定逻辑后丢弃。 - **运行时注解**:保留到运行时,可以通过反射机制访问和使用。 #### 二、注解的声明周期控制 `@Retention` 是一个标准注解,用于定义其他注解的生命周期。它的取值范围包括 `SOURCE`(源码级别)、`CLASS`(字节码级别,默认值)以及 `RUNTIME`(运行时级别)。只有标记为 `RUNTIME` 的注解才能通过反射获取[^1]。 #### 三、注解的实现机制 为了深入理解注解的原理,需掌握以下几个关键技术点: ##### 1. 接口的向上转型 接口的向上转型是指子类对象能够赋值给父类或接口类型的变量。这种设计使得注解处理器能够在不关心具体实现的情况下统一处理各种注解实例[^2]。 ##### 2. 反射机制 Java反射允许程序在运行时动态加载类、创建对象、调用方法或访问字段。对于运行时注解而言,反射是其核心实现手段。开发者可通过 `Class.getAnnotations()` 或 `Method.getAnnotation(Class<T> annotationClass)` 方法来读取指定注解的信息[^4]。 ##### 3. JDK动态代理 虽然动态代理本身并非直接服务于注解功能,但在某些框架(如Spring AOP)中,它是基于注解扩展业务逻辑的关键技术之一。例如,在拦截器模式下,动态代理会结合注解完成横切关注点的功能增强。 #### 四、典型注解案例分析 以 `@SuppressWarnings` 为例,该注解属于编译期注解,旨在告知编译器忽略特定警告消息。它可以作用于多种目标(如类、方法、字段),并通过内部机制屏蔽不必要的提示信息[^5]。 --- ### 示例代码展示 以下是一个简单的自定义注解示例,演示如何利用反射机制读取运行时注解的数据。 ```java import java.lang.annotation.*; import java.lang.reflect.*; // 定义一个运行时注解 @Retention(RetentionPolicy.RUNTIME) @interface MyAnnotation { String value(); } // 使用注解修饰类成员 public class AnnotationExample { @MyAnnotation("This is a test message") public void annotatedMethod() {} public static void main(String[] args) throws Exception { Method method = AnnotationExample.class.getMethod("annotatedMethod"); // 判断是否存在指定注解 if (method.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation annotation = method.getAnnotation(MyAnnotation.class); System.out.println(annotation.value()); // 输出注解值 } } } ``` 上述代码展示了如何定义带有参数的注解,并借助反射提取其中存储的信息。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值