注解简介
注解（Annotation）是一种用于提供元数据的结构，可以附加到包、类、方法、变量、参数等元素上。注解本身不会直接影响代码的运行逻辑，但可以通过工具或框架解析并使用这些元数据。
内置注解
Java提供了一些常用的内置注解，包括@Override、@Deprecated和@SuppressWarnings。
示例：使用@Deprecated和@Override
package cn.juwatech; public class AnnotationExample { @Deprecated public void oldMethod() { System.out.println("This method is deprecated"); } @Override public String toString() { return "AnnotationExample"; } public static void main(String[] args) { AnnotationExample example = new AnnotationExample(); example.oldMethod(); System.out.println(example); } }
在这个示例中，@Deprecated标记了oldMethod方法，表示该方法已经过时，不推荐使用。@Override标记了toString方法，表示该方法重写了父类的方法。
自定义注解
我们可以根据需要定义自己的注解。自定义注解需要使用@interface关键字，并可以定义一些属性（即方法）。
示例：自定义注解
package cn.juwatech; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) @interface MyAnnotation { String value(); int number() default 0; } public class CustomAnnotationExample { @MyAnnotation(value = "Hello", number = 5) public void annotatedMethod() { System.out.println("This method is annotated with @MyAnnotation"); } public static void main(String[] args) throws NoSuchMethodException { CustomAnnotationExample example = new CustomAnnotationExample(); MyAnnotation annotation = example.getClass() .getMethod("annotatedMethod") .getAnnotation(MyAnnotation.class); System.out.println("Value: " + annotation.value()); System.out.println("Number: " + annotation.number()); } }
在这个示例中，我们定义了一个名为MyAnnotation的注解，并使用@Retention(RetentionPolicy.RUNTIME)指定注解的保留策略为运行时。@MyAnnotation注解了annotatedMethod方法，并通过反射获取注解的属性值。
元注解
元注解是用于描述其他注解的注解。常用的元注解包括@Retention、@Target、@Documented和@Inherited。
@Retention：指定注解的保留策略，有SOURCE、CLASS和RUNTIME三种。@Target：指定注解的目标类型，如类、方法、字段等。@Documented：指定注解是否包含在Javadoc中。@Inherited：指定注解是否可以被子类继承。
示例：使用元注解
package cn.juwatech; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import java.lang.annotation.ElementType; @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @interface Info { String author(); String date(); } public class MetaAnnotationExample { @Info(author = "John Doe", date = "2024-06-23") public void sampleMethod() { System.out.println("This method is annotated with @Info"); } public static void main(String[] args) throws NoSuchMethodException { MetaAnnotationExample example = new MetaAnnotationExample(); Info info = example.getClass() .getMethod("sampleMethod") .getAnnotation(Info.class); System.out.println("Author: " + info.author()); System.out.println("Date: " + info.date()); } }
在这个示例中，@Info注解使用了@Retention和@Target元注解，指定了其保留策略为运行时，并且只能用于方法。
注解处理器
注解处理器用于在编译时处理注解，通常用于生成代码、验证注解等。可以通过实现javax.annotation.processing.Processor接口来创建自定义注解处理器。
示例：自定义注解处理器
首先，定义注解：
package cn.juwatech; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import java.lang.annotation.ElementType; @Retention(RetentionPolicy.SOURCE) @Target(ElementType.TYPE) public @interface AutoGenerated { String value(); }
然后，实现注解处理器：
package cn.juwatech.processor; import javax.annotation.processing.AbstractProcessor; import javax.annotation.processing.RoundEnvironment; import javax.annotation.processing.SupportedAnnotationTypes; import javax.annotation.processing.SupportedSourceVersion; import javax.lang.model.SourceVersion; import javax.lang.model.element.TypeElement; import java.util.Set; @SupportedAnnotationTypes("cn.juwatech.AutoGenerated") @SupportedSourceVersion(SourceVersion.RELEASE_8) public class AutoGeneratedProcessor extends AbstractProcessor { @Override public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { for (TypeElement annotation : annotations) { roundEnv.getElementsAnnotatedWith(annotation) .forEach(element -> { String className = element.getSimpleName().toString(); System.out.println("Processing " + className + " annotated with @AutoGenerated"); }); } return true; } }
总结
通过本文，我们详细介绍了Java中的注解使用，包括内置注解、自定义注解、元注解以及注解处理器。注解是一种强大的元数据机制，可以极大地提高代码的可读性和可维护性。掌握注解的使用技巧和最佳实践，可以帮助我们编写更加简洁、高效和优雅的代码。
