当前位置：首页 > news >正文

java注解的概念与分类

news 2024/9/25 20:55:16

Java注解（Annotations）是Java SE 5引入的一项重要特性，它允许在源代码中添加元数据（metadata），从而为编译器、工具和运行时系统提供了额外的信息。注解可以用于文档生成、编译时检查、代码生成等多种用途。

Java注解的概念

Java注解是一种特殊的标记，用来标注Java代码中的类、方法、字段、构造函数等。注解本身也是一个接口，可以包含元数据（metadata）信息。注解的主要用途包括：

文档生成：用于生成API文档。
编译时检查：用于编译时的静态分析和错误检测。
代码生成：用于自动生成代码，如ORM框架中的实体类生成。
运行时处理：用于运行时动态处理注解信息，如Spring框架中的依赖注入。

Java注解的分类

Java注解可以分为以下几类：

内置注解（Built-in Annotations）
元注解（Meta-Annotations）
自定义注解（Custom Annotations）

1. 内置注解（Built-in Annotations）

Java内置注解主要有三种，分别是@Override、@Deprecated和@SuppressWarnings。

@Override：表示方法重写了父类的方法。
@Deprecated：表示类或方法已被废弃，建议不再使用。
@SuppressWarnings：表示抑制编译警告。

示例

1public class Example {
2    @Override
3    public String toString() {
4        return "Example";
5    }
6
7    @Deprecated
8    public void deprecatedMethod() {
9        // 已废弃的方法
10    }
11
12    @SuppressWarnings("unchecked")
13    public void uncheckedMethod() {
14        // 忽略编译警告
15    }
16}

2. 元注解（Meta-Annotations）

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

@Retention：用于指定注解的保留策略。
@Target：用于指定注解的目标类型。
@Documented：用于指定是否将注解包含在JavaDoc中。
@Inherited：用于指定注解是否可以被子类继承。

示例

1import java.lang.annotation.ElementType;
2import java.lang.annotation.Retention;
3import java.lang.annotation.RetentionPolicy;
4import java.lang.annotation.Target;
5
6@Retention(RetentionPolicy.RUNTIME)
7@Target(ElementType.METHOD)
8public @interface MyAnnotation {
9    String value() default "";
10}

详细说明

@Retention：指定注解的保留策略，可以是SOURCE（源码级）、CLASS（字节码级）或RUNTIME（运行时）。
@Documented：指定注解是否应该包含在JavaDoc中。
@Inherited：指定注解是否可以被子类继承

3. 自定义注解（Custom Annotations）

自定义注解是由开发者自己定义的注解，可以包含任意数量的成员变量。自定义注解通常用于特定的应用场景。

示例

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {String value() default "";int number() default 0;
}

使用自定义注解

public class Example {@MyAnnotation(value = "Hello", number = 42)public void myMethod() {// 方法体}
}

注解的使用

1. 创建自定义注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {String value() default "";int number() default 0;
}

2. 使用自定义注解

public class Example {@MyAnnotation(value = "Hello", number = 42)public void myMethod() {// 方法体}
}

3. 处理自定义注解

import java.lang.reflect.Method;public class AnnotationProcessor {public static void processAnnotations(Object obj) {Class<?> clazz = obj.getClass();Method[] methods = clazz.getDeclaredMethods();for (Method method : methods) {if (method.isAnnotationPresent(MyAnnotation.class)) {MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);String value = annotation.value();int number = annotation.number();System.out.println("Value: " + value + ", Number: " + number);}}}
}public class Main {public static void main(String[] args) {Example example = new Example();AnnotationProcessor.processAnnotations(example);}
}