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

java注解（Annotation）编程

news 2025/11/23 19:20:02

一、基本概念
- 1. 定义
- 2. 语法
- 3. 类型
二、内置注解
- @Override：
- @Deprecated：
- @SuppressWarnings：
三、元注解
- @Target：
- @Retention：
- @Documented：
- @Inherited：
四、自定义注解
五、注解的使用
六、应用场景
七、注解demo
- 需求场景1 ：假设需求是字段脱敏将数字2 都替换为 *

java注解（Annotation）是Java语言在JDK
5中引入的一个重要特性，它提供了一种为代码添加元数据的方式。这些元数据可以在编译时或运行时被读取，以执行特定的任务或提供额外的信息。以下是关于Java注解的详细解释：

一、基本概念

1. 定义

Java注解是代码中的特殊标记，用于给代码添加一些信息，这些信息不会改变代码的执行逻辑，但可以被编译器或其他工具用来生成代码、创建文档、做静态分析或进行其他处理。

2. 语法

Java注解以“@”符号开头，后跟注解名称和可能的参数。例如，@Override是一个Java内置注解，用于标记一个方法是重写父类的方法。

3. 类型

Java注解本质上是一种特殊的接口，但它的定义使用了@interface关键字而不是interface。注解内部可以定义元素（类似于接口中的方法），这些元素可以有默认值。

二、内置注解

Java提供了几种内置注解，它们分别用于不同的目的：

@Override：

表示当前的方法是重写父类中的方法。如果方法签名不匹配，编译器将报错。

@Deprecated：

表示某个类或方法已经过时，不推荐使用。使用这些元素时，编译器通常会给出警告。

@SuppressWarnings：

用于抑制编译器产生的特定警告。例如，@SuppressWarnings(“unchecked”)可以抑制未检查的转换警告。

三、元注解

元注解是用于定义注解的注解，Java提供了几种元注解来定义其他注解的行为：

@Target：

用于指定注解可以应用的Java元素类型（如类、方法、字段等）。

@Retention：

用于指定注解的保留策略，即注解信息在何时可用。它有三个值：SOURCE（只在源代码中保留）、CLASS（在源代码和类文件中保留，但运行时不可见）、RUNTIME（在源代码、类文件和运行时都保留，因此可以通过反射读取）。

@Documented：

表示该注解会被javadoc工具提取成文档。

@Inherited：

表示子类可以继承父类中的注解。

四、自定义注解

除了使用Java内置注解外，开发者还可以根据需要定义自己的注解。定义自定义注解时，需要使用@interface关键字，并指定注解的元素（如果有的话）。例如：

public @interface MyAnnotation {String value() default "defaultValue";int id() default -1;
}

五、注解的使用

注解可以在编译时或运行时被读取和处理。处理注解的常见方式有两种：

编译时处理：通过注解处理器（Annotation Processor）在编译时读取注解信息，并生成额外的代码或其他文件。这种方式常用于代码生成、静态分析等场景。

运行时处理：通过反射机制在运行时读取注解信息，并根据注解信息执行相应的逻辑。这种方式常用于框架设计、配置管理、动态代理等场景。

六、应用场景

Java注解在许多领域都有广泛的应用，包括但不限于：

框架设计：如Spring、Hibernate等框架大量使用注解来简化配置和代码编写。

代码生成：通过注解处理器自动生成重复或模板化的代码，如getter和setter方法、日志记录代码等。

配置管理：将配置信息直接写在代码中，减少外部配置文件的使用。

静态分析：通过注解提供额外的语义信息，帮助静态分析工具检测代码中的潜在问题。

动态代理：通过注解和反射机制实现动态代理模式，实现AOP等功能。

综上所述，Java注解是一种强大的元数据机制，它允许开发者给代码添加额外的信息，并在编译时或运行时读取和使用这些信息。通过合理使用注解，可以简化代码编写、提高开发效率、减少错误并提高代码质量。

七、注解demo

需求场景1 ：假设需求是字段脱敏将数字2 都替换为 *

首先创建注解@interface

package com.demo.codedemolist.anotation;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.FIELD)
public @interface DesenStr {String source() default "";String target() default "";
}

创建注解操作的类

package com.demo.codedemolist.anotation;import com.demo.codedemolist.anotation.DesenStr;
import java.lang.reflect.Field;public class AnnotationClass {public Object parse(Object o) {Class<?> mClass = null;Object o1 = o;try {mClass = o.getClass();Field[] fields = mClass.getDeclaredFields();for (Field field : fields) {if (field.isAnnotationPresent(DesenStr.class)) {field.setAccessible(true);DesenStr annotation = field.getAnnotation(DesenStr.class);String source = annotation.source();// 待匹配String target = annotation.target();// 替换为String s = String.valueOf(field.get(o1));String replace = s.replace(source,target);field.set(o1, replace);}}} catch (IllegalAccessException e) {e.printStackTrace();}return o1;}
}

测试类

package com.demo.codedemolist;import com.demo.codedemolist.anotation.AnnotationClass;
import com.demo.codedemolist.anotation.UserInfo;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;@SpringBootTest
class CodeDemoListApplicationTests {@Testvoid contextLoads() {}@Testvoid parse(){UserInfo userInfo= new UserInfo ("1328223342","张三");System.out.println(userInfo);// 1328223342 张三Object parseObject = new AnnotationClass().parse(userInfo);if(parseObject instanceof UserInfo){UserInfo newUserInfo = (UserInfo) parseObject;System.out.println(newUserInfo);// 132****342 张三}}}