Javajava
Java 注解与反射实战：自定义日志与参数校验注解实现
本文通过两个实战案例演示 Java 注解与反射的应用。首先实现自定义@Log 注解，利用反射拦截方法调用，自动记录执行时间、参数及异常；其次实现@NotNull 和@Range 注解，对方法参数进行非空及范围校验。文章涵盖注解定义、元注解说明、解析器核心逻辑及测试验证，展示了如何通过声明式编程减少重复代码，提升开发效率。掌握此技术有助于深入理解 Spring 等框架底层机制。
本文通过两个实战案例演示 Java 注解与反射的应用。首先实现自定义@Log 注解，利用反射拦截方法调用，自动记录执行时间、参数及异常；其次实现@NotNull 和@Range 注解，对方法参数进行非空及范围校验。文章涵盖注解定义、元注解说明、解析器核心逻辑及测试验证，展示了如何通过声明式编程减少重复代码，提升开发效率。掌握此技术有助于深入理解 Spring 等框架底层机制。
在日常开发中，我们经常遇到两类重复工作：
日志记录：每个重要方法都要写 "开始执行"、"参数是 xxx"、"执行结束" 的代码； 参数校验：判断输入是否为 null、年龄是否在合理范围、手机号格式是否正确等。
这些工作机械且冗余，而注解 + 反射正是解决这类问题的 "银弹"——用注解标记需要处理的地方，用反射自动执行逻辑，实现 "一次定义，多处复用"。
本文将带你从零实现两个实用案例：
@Log：自动记录方法调用细节；@NotNull、@Range：自动校验方法参数合法性。全程实战，代码可直接运行，搭配图解帮你吃透底层逻辑。
@Log——自动记录方法调用轨迹我们需要一个注解，标记在方法上后，能自动完成：
记录方法开始执行的时间；打印方法参数（可选）；记录方法执行耗时；打印返回结果（可选）；捕获并记录方法抛出的异常。
@Log 注解import java.lang.annotation.*;
/**
* 只能标记在方法上
*/
@Target(ElementType.METHOD)
/**
* 运行时保留，允许反射获取
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
// 操作描述（如"创建订单"）
String description() default "";
// 是否记录参数
boolean recordParams() default true;
// 是否记录返回值
boolean recordResult() default true;
// 是否记录异常
boolean recordException() default true;
}
元注解说明：
@Target(ElementType.METHOD)：限制注解仅用于方法（符合日志记录的场景）；@Retention(RetentionPolicy.RUNTIME)：必须保留到运行时，否则反射无法获取。
@Log 注解的业务类public class OrderService {
// 标记日志：记录参数和返回值，描述为"创建订单"
@Log(description = "创建订单", recordParams = true, recordResult = true)
public String createOrder(String userId, double amount) {
if (amount <= 0) {
throw new IllegalArgumentException("金额必须大于 0");
}
// 模拟业务耗时
try {
Thread.sleep(100);
} catch (InterruptedException e) {
e.printStackTrace();
}
return "ORDER_" + System.currentTimeMillis();
}
// 标记日志：不记录返回值（无返回值），描述为"取消订单"
@Log(description = "取消订单", recordParams = true, recordResult = false)
public void cancelOrder(String orderId) {
if (orderId == null || orderId.isEmpty()) {
throw new IllegalArgumentException("订单 ID 不能为空");
}
// 模拟业务耗时
try {
Thread.sleep(50);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
通过反射拦截方法调用，解析 @Log 注解并执行日志记录逻辑：
import java.lang.reflect.Method;
import java.util.Arrays;
public class LogAnnotationProcessor {
/**
* 执行带日志注解的方法
* @param target 目标对象
* @param methodName 方法名
* @param args 方法参数
* @return 方法返回值
*/
public static Object executeWithLog(Object target, String methodName, Object... args) {
try {
// 1. 获取方法对应的 Class 对象和参数类型
Class<?>[] paramTypes = Arrays.stream(args)
.map(arg -> arg == null ? Object.class : arg.getClass())
.toArray(Class[]::new);
Method method = target.getClass().getMethod(methodName, paramTypes);
// 2. 检查方法是否有@Log 注解，无则直接执行
if (!method.isAnnotationPresent(Log.class)) {
return method.invoke(target, args);
}
// 3. 解析注解属性
Log logAnnotation = method.getAnnotation(Log.class);
String description = logAnnotation.description();
boolean recordParams = logAnnotation.recordParams();
boolean recordResult = logAnnotation.recordResult();
boolean recordException = logAnnotation.recordException();
// 4. 记录方法开始日志
long System.currentTimeMillis();
System.out.println( + (description.isEmpty() ? methodName : description) + );
(recordParams) {
System.out.println( + Arrays.toString(args));
}
Object result;
{
result = method.invoke(target, args);
} (Exception e) {
(recordException) {
System.out.println( + e.getCause().getMessage());
}
e;
}
System.currentTimeMillis();
System.out.println( + (endTime - startTime) + );
(recordResult) {
System.out.println( + result);
}
System.out.println( + (description.isEmpty() ? methodName : description) + );
result;
} (Exception e) {
( + e.getMessage(), e);
}
}
}
public class LogTest {
public static void main(String[] args) {
OrderService orderService = new OrderService();
// 测试正常创建订单
LogAnnotationProcessor.executeWithLog(orderService, "createOrder", "user_001", 99.9);
// 测试取消订单
LogAnnotationProcessor.executeWithLog(orderService, "cancelOrder", "ORDER_123456");
// 测试异常场景（金额为负数）
try {
LogAnnotationProcessor.executeWithLog(orderService, "createOrder", "user_002", -10.0);
} catch (Exception e) {
// 此处仅捕获，不处理（异常已被日志记录）
}
}
}
===== 【日志开始】创建订单 =====
参数：[user_001, 99.9]
耗时：101ms
返回值：ORDER_1698765432100
===== 【日志结束】创建订单 =====
===== 【日志开始】取消订单 =====
参数：[ORDER_123456]
耗时：50ms
===== 【日志结束】取消订单 =====
===== 【日志开始】创建订单 =====
参数：[user_002, -10.0]
执行异常：金额必须大于 0
===== 【日志结束】创建订单 =====
（注：核心展示流程节点：调用方法→反射检查注解→记录开始日志→执行方法→记录结束日志）
我们需要两个注解：
@NotNull：标记参数不能为 null；@Range：标记数值参数必须在指定范围内（如年龄 1-120 岁）。
实现效果：方法调用时自动校验参数，不符合规则则抛出明确的异常信息。
@NotNull 注解import java.lang.annotation.*;
@Target(ElementType.PARAMETER) // 仅用于方法参数
@Retention(RetentionPolicy.RUNTIME)
public @interface NotNull {
// 校验失败的提示信息
String message() default "参数不能为 null";
}
@Range 注解import java.lang.annotation.*;
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Range {
long min() default 0; // 最小值（包含）
long max() default Long.MAX_VALUE; // 最大值（包含）
String message() default "参数不在指定范围内";
}
public class UserService {
// 新增用户：ID 不能为空，年龄必须 1-120 岁
public void addUser(
@NotNull(message = "用户 ID 不能为空") String userId,
@Range(min = 1, max = 120, message = "年龄必须在 1-120 岁之间") int age) {
System.out.println("新增用户成功：userId=" + userId + ", age=" + age);
}
// 更新积分：积分必须≥0
public void updatePoints(
@NotNull String userId,
@Range(min = 0, message = "积分不能为负数") int points) {
System.out.println("更新积分成功：userId=" + userId + ", points=" + points);
}
}
通过反射获取方法参数上的注解，逐个校验参数是否符合注解规则：
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.Arrays;
public class ParamValidator {
/**
* 校验方法参数是否符合注解规则
* @param target 目标对象
* @param methodName 方法名
* @param args 方法参数
* @throws IllegalArgumentException 校验失败时抛出
*/
public static void validate(Object target, String methodName, Object... args) throws Exception {
// 1. 获取方法对象
Class<?>[] paramTypes = Arrays.stream(args)
.map(arg -> arg == null ? Object.class : arg.getClass())
.toArray(Class[]::new);
Method method = target.getClass().getMethod(methodName, paramTypes);
// 2. 获取方法参数列表（包含注解信息）
Parameter[] parameters = method.getParameters();
// 3. 遍历参数，执行校验
for (int i = 0; i < parameters.length; i++) {
Parameter param = parameters[i];
Object arg = args[i];
// 当前参数值
// 3.1 校验@NotNull 注解
if (param.isAnnotationPresent(NotNull.class)) {
NotNull notNull = param.getAnnotation(NotNull.class);
if (arg == null) {
(notNull.message());
}
}
(param.isAnnotationPresent(Range.class) && arg Number) {
param.getAnnotation(Range.class);
((Number) arg).longValue();
(value < range.min() || value > range.max()) {
(range.message());
}
}
}
method.invoke(target, args);
}
}
public class ValidatorTest {
public static void main(String[] args) {
UserService userService = new UserService();
// 测试正常参数
try {
ParamValidator.validate(userService, "addUser", "user_001", 25);
} catch (Exception e) {
System.out.println("错误：" + e.getMessage());
}
// 测试 null 参数（userId 为 null）
try {
ParamValidator.validate(userService, "addUser", null, 25);
} catch (Exception e) {
System.out.println("错误：" + e.getMessage());
}
// 测试年龄超出范围（150 岁）
try {
ParamValidator.validate(userService, "addUser", "user_002", 150);
} catch (Exception e) {
System.out.println("错误：" + e.getMessage());
}
// 测试积分负数
try {
ParamValidator.validate(userService, "updatePoints", "user_003", -10);
} catch (Exception e) {
System.out.println("错误：" + e.getMessage());
}
}
}
新增用户成功：userId=user_001, age=25
错误：用户 ID 不能为空
错误：年龄必须在 1-120 岁之间
错误：积分不能为负数
（注：核心展示流程节点：获取方法→遍历参数→校验注解→执行方法）
明确作用范围：用
@Target严格限制注解的使用场景（如日志注解只用于方法）； 合理生命周期：需要反射解析的注解必须用@Retention(RUNTIME)； 属性精简实用：只保留必要的属性（如日志注解的description、校验注解的message），并设置合理默认值。
缓存反射结果：
Method、Parameter等对象的获取有性能开销，可通过ConcurrentHashMap缓存注解与方法的映射关系； 批量处理注解：用getAnnotations()一次性获取所有注解，避免多次反射调用； 异常友好提示：校验或日志失败时，异常信息要明确（如 "年龄必须在 1-120 岁之间" 而非 "参数错误"）。
日志注解：Spring 的
@Log、Lombok 的@Log4j2功能更完善，但自定义注解可灵活适配业务需求（如对接特定日志系统）； 参数校验：JSR-303 规范（javax.validation）提供了丰富的校验注解，但自定义注解可实现框架不支持的特殊校验（如手机号格式、身份证号规则）。
通过本文的两个实战案例，你应该体会到：
注解是 "声明式编程" 的载体，让代码更简洁、意图更明确； 反射是注解的 "执行引擎"，让标记转化为实际逻辑。
这对组合在框架开发（如 Spring、MyBatis）中无处不在，掌握它们能让你从 "使用者" 升级为 "设计者"。
动手练习：尝试扩展本文案例 ——
level 属性（INFO/ERROR），实现不同级别日志的输出；@Pattern 注解，校验字符串是否符合正则表达式（如手机号、邮箱）。
微信公众号「极客日志」，在微信中扫描左侧二维码关注。展示文案：极客日志 zeeklog
查找任何按下的键的javascript键代码、代码、位置和修饰符。 在线工具，Keycode 信息在线工具，online
JavaScript 字符串转义/反转义；Java 风格 \uXXXX（Native2Ascii）编码与解码。 在线工具，Escape 与 Native 编解码在线工具，online
使用 Prettier 在浏览器内格式化 JavaScript 或 HTML 片段。 在线工具，JavaScript / HTML 格式化在线工具，online
Terser 压缩、变量名混淆，或 javascript-obfuscator 高强度混淆（体积会增大）。 在线工具，JavaScript 压缩与混淆在线工具，online
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具，Base64 字符串编码/解码在线工具，online
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具，Base64 文件转换器在线工具，online