Java注解与反射实现日志与校验

Java 注解与反射实战：自定义日志与参数校验注解

本文将手把手教你如何使用Java注解和反射机制实现两个实用的自定义注解：

@Loggable - 方法执行日志注解
@ValidParam - 参数校验注解

1. 项目结构

text

复制代码

annotation-demo/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           ├── annotation/
│   │   │           │   ├── Loggable.java
│   │   │           │   ├── ValidParam.java
│   │   │           │   └── ValidationException.java
│   │   │           ├── service/
│   │   │           │   ├── UserService.java
│   │   │           │   └── impl/
│   │   │           │       └── UserServiceImpl.java
│   │   │           ├── model/
│   │   │           │   └── User.java
│   │   │           └── Main.java
│   │   └── resources/
│   └── test/
│       └── java/
└── pom.xml

2. 自定义注解实现

2.1 日志注解 @Loggable

java

复制代码

// Loggable.java
package com.example.annotation;

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Loggable {
    // 日志级别
    LogLevel level() default LogLevel.INFO;
    
    // 是否记录方法参数
    boolean logParams() default true;
    
    // 是否记录返回值
    boolean logResult() default true;
    
    // 是否记录执行时间
    boolean logExecutionTime() default true;
    
    // 自定义日志消息
    String value() default "";
}

enum LogLevel {
    DEBUG, INFO, WARN, ERROR
}

2.2 参数校验注解 @ValidParam

java

复制代码

// ValidParam.java
package com.example.annotation;

import java.lang.annotation.*;

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidParam {
    // 是否非空
    boolean notNull() default false;
    
    // 字符串最小长度
    int minLength() default 0;
    
    // 字符串最大长度
    int maxLength() default Integer.MAX_VALUE;
    
    // 最小值（用于数字）
    long min() default Long.MIN_VALUE;
    
    // 最大值（用于数字）
    long max() default Long.MAX_VALUE;
    
    // 正则表达式验证
    String regex() default "";
    
    // 自定义错误消息
    String message() default "参数验证失败";
}

2.3 自定义异常类

java

复制代码

// ValidationException.java
package com.example.annotation;

public class ValidationException extends RuntimeException {
    public ValidationException(String message) {
        super(message);
    }
    
    public ValidationException(String message, Throwable cause) {
        super(message, cause);
    }
}

3. 数据模型

java

复制代码

// User.java
package com.example.model;

public class User {
    private String username;
    private String email;
    private int age;
    
    public User() {}
    
    public User(String username, String email, int age) {
        this.username = username;
        this.email = email;
        this.age = age;
    }
    
    // Getters and Setters
    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }
    
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
    
    public int getAge() { return age; }
    public void setAge(int age) { this.age = age; }
    
    @Override
    public String toString() {
        return String.format("User{username='%s', email='%s', age=%d}", 
                           username, email, age);
    }
}

4. 服务层实现

4.1 服务接口

java

复制代码

// UserService.java
package com.example.service;

import com.example.model.User;

public interface UserService {
    User createUser(String username, String email, int age);
    User getUserById(@com.example.annotation.ValidParam(notNull = true) String userId);
    void updateUser(@com.example.annotation.ValidParam(notNull = true) User user);
}

4.2 服务实现（使用注解）

java

复制代码

// UserServiceImpl.java
package com.example.service.impl;

import com.example.annotation.Loggable;
import com.example.annotation.ValidParam;
import com.example.model.User;
import com.example.service.UserService;

public class UserServiceImpl implements UserService {
    
    @Override
    @Loggable(level = LogLevel.INFO, logParams = true, logResult = true, 
              logExecutionTime = true, value = "创建用户")
    public User createUser(
            @ValidParam(notNull = true, minLength = 3, maxLength = 20) String username,
            @ValidParam(notNull = true, regex = "^[A-Za-z0-9+_.-]+@(.+)$") String email,
            @ValidParam(min = 1, max = 150) int age) {
        
        System.out.println("创建用户: " + username);
        return new User(username, email, age);
    }
    
    @Override
    @Loggable(level = LogLevel.DEBUG, logExecutionTime = true)
    public User getUserById(@ValidParam(notNull = true, minLength = 1) String userId) {
        System.out.println("获取用户: " + userId);
        // 模拟从数据库获取用户
        return new User("testUser", "test@example.com", 25);
    }
    
    @Override
    @Loggable(level = LogLevel.WARN, logParams = true)
    public void updateUser(@ValidParam(notNull = true) User user) {
        System.out.println("更新用户: " + user.getUsername());
        // 模拟更新逻辑
    }
}

5. 注解处理器（核心）

java

复制代码

// AnnotationProcessor.java
package com.example.annotation;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.lang.reflect.Proxy;
import java.util.Arrays;

public class AnnotationProcessor implements InvocationHandler {
    
    private final Object target;
    
    private AnnotationProcessor(Object target) {
        this.target = target;
    }
    
    @SuppressWarnings("unchecked")
    public static <T> T createProxy(T target) {
        return (T) Proxy.newProxyInstance(
            target.getClass().getClassLoader(),
            target.getClass().getInterfaces(),
            new AnnotationProcessor(target)
        );
    }
    
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 1. 参数校验
        validateParameters(method, args);
        
        // 2. 日志记录（方法执行前）
        Loggable loggable = method.getAnnotation(Loggable.class);
        long startTime = 0;
        if (loggable != null) {
            startTime = logMethodStart(loggable, method, args);
        }
        
        try {
            // 3. 执行原始方法
            Object result = method.invoke(target, args);
            
            // 4. 日志记录（方法执行后）
            if (loggable != null) {
                logMethodEnd(loggable, method, result, startTime);
            }
            
            return result;
        } catch (Exception e) {
            // 5. 异常处理
            if (loggable != null && loggable.level().ordinal() >= LogLevel.ERROR.ordinal()) {
                System.err.println("[" + loggable.level() + "] 方法执行异常: " + 
                                 method.getName() + " - " + e.getCause().getMessage());
            }
            throw e.getCause();
        }
    }
    
    private void validateParameters(Method method, Object[] args) {
        Parameter[] parameters = method.getParameters();
        
        for (int i = 0; i < parameters.length; i++) {
            ValidParam validParam = parameters[i].getAnnotation(ValidParam.class);
            if (validParam != null && args != null) {
                validateParameter(validParam, args[i], parameters[i].getName());
            }
        }
    }
    
    private void validateParameter(ValidParam validParam, Object arg, String paramName) {
        if (validParam.notNull() && arg == null) {
            throw new ValidationException(paramName + ": " + validParam.message() + " - 不能为null");
        }
        
        if (arg == null) {
            return; // 如果允许为null，且确实为null，则跳过其他验证
        }
        
        // 字符串验证
        if (arg instanceof String) {
            String str = (String) arg;
            if (str.length() < validParam.minLength()) {
                throw new ValidationException(paramName + ": " + validParam.message() + 
                                            " - 长度不能小于 " + validParam.minLength());
            }
            if (str.length() > validParam.maxLength()) {
                throw new ValidationException(paramName + ": " + validParam.message() + 
                                            " - 长度不能大于 " + validParam.maxLength());
            }
            if (!validParam.regex().isEmpty() && !str.matches(validParam.regex())) {
                throw new ValidationException(paramName + ": " + validParam.message() + 
                                            " - 格式不匹配");
            }
        }
        
        // 数字验证
        if (arg instanceof Number) {
            Number num = (Number) arg;
            long value = num.longValue();
            if (value < validParam.min()) {
                throw new ValidationException(paramName + ": " + validParam.message() + 
                                            " - 值不能小于 " + validParam.min());
            }
            if (value > validParam.max()) {
                throw new ValidationException(paramName + ": " + validParam.message() + 
                                            " - 值不能大于 " + validParam.max());
            }
        }
        
        // 对象验证（检查是否为null）
        if (validParam.notNull() && arg == null) {
            throw new ValidationException(paramName + ": " + validParam.message() + " - 不能为null");
        }
    }
    
    private long logMethodStart(Loggable loggable, Method method, Object[] args) {
        long startTime = System.currentTimeMillis();
        StringBuilder logMessage = new StringBuilder();
        
        logMessage.append("[").append(loggable.level()).append("] ");
        
        if (!loggable.value().isEmpty()) {
            logMessage.append(loggable.value());
        } else {
            logMessage.append("执行方法: ").append(method.getName());
        }
        
        if (loggable.logParams() && args != null && args.length > 0) {
            logMessage.append(" | 参数: ").append(Arrays.toString(args));
        }
        
        System.out.println(logMessage.toString());
        return startTime;
    }
    
    private void logMethodEnd(Loggable loggable, Method method, Object result, long startTime) {
        StringBuilder logMessage = new StringBuilder();
        
        logMessage.append("[").append(loggable.level()).append("] ");
        logMessage.append("方法完成: ").append(method.getName());
        
        if (loggable.logResult() && result != null) {
            logMessage.append(" | 返回值: ").append(result);
        }
        
        if (loggable.logExecutionTime()) {
            long executionTime = System.currentTimeMillis() - startTime;
            logMessage.append(" | 执行时间: ").append(executionTime).append("ms");
        }
        
        System.out.println(logMessage.toString());
    }
}

6. 主程序测试

java

复制代码

// Main.java
package com.example;

import com.example.annotation.AnnotationProcessor;
import com.example.annotation.ValidationException;
import com.example.model.User;
import com.example.service.UserService;
import com.example.service.impl.UserServiceImpl;

public class Main {
    public static void main(String[] args) {
        // 创建代理对象
        UserService userService = AnnotationProcessor.createProxy(new UserServiceImpl());
        
        System.out.println("=== 正常测试 ===");
        try {
            // 正常创建用户
            User user = userService.createUser("john_doe", "john@example.com", 25);
            System.out.println("创建的用户: " + user);
            
            // 获取用户
            User fetchedUser = userService.getUserById("123");
            System.out.println("获取的用户: " + fetchedUser);
            
            // 更新用户
            userService.updateUser(user);
            
        } catch (Exception e) {
            System.err.println("异常: " + e.getMessage());
        }
        
        System.out.println("\n=== 参数校验测试 ===");
        try {
            // 用户名过短
            userService.createUser("jo", "john@example.com", 25);
        } catch (ValidationException e) {
            System.err.println("验证异常: " + e.getMessage());
        }
        
        try {
            // 邮箱格式错误
            userService.createUser("john_doe", "invalid-email", 25);
        } catch (ValidationException e) {
            System.err.println("验证异常: " + e.getMessage());
        }
        
        try {
            // 年龄超出范围
            userService.createUser("john_doe", "john@example.com", 200);
        } catch (ValidationException e) {
            System.err.println("验证异常: " + e.getMessage());
        }
        
        try {
            // 用户ID为null
            userService.getUserById(null);
        } catch (ValidationException e) {
            System.err.println("验证异常: " + e.getMessage());
        }
    }
}

7. Maven配置

xml

复制代码

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
                             http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>com.example</groupId>
    <artifactId>annotation-demo</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>
    
    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>
    
    <dependencies>
        <!-- 如果需要额外的依赖可以在这里添加 -->
    </dependencies>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

8. 运行结果示例

text

复制代码

=== 正常测试 ===
[INFO] 创建用户 | 参数: [john_doe, john@example.com, 25]
创建用户: john_doe
[INFO] 方法完成: createUser | 返回值: User{username='john_doe', email='john@example.com', age=25} | 执行时间: 12ms
创建的用户: User{username='john_doe', email='john@example.com', age=25}
[DEBUG] 执行方法: getUserById
获取用户: 123
[DEBUG] 方法完成: getUserById | 执行时间: 1ms
获取的用户: User{username='testUser', email='test@example.com', age=25}
[WARN] 执行方法: updateUser | 参数: [User{username='john_doe', email='john@example.com', age=25}]
更新用户: john_doe

=== 参数校验测试 ===
验证异常: username: 参数验证失败 - 长度不能小于 3
验证异常: email: 参数验证失败 - 格式不匹配
验证异常: age: 参数验证失败 - 值不能大于 150
验证异常: userId: 参数验证失败 - 不能为null

9. 扩展功能

9.1 添加AOP支持（使用Spring AOP）

如果你在使用Spring框架，可以结合Spring AOP实现更强大的功能：

java

复制代码

@Aspect
@Component
public class AnnotationAspect {
    
    @Around("@annotation(loggable)")
    public Object processLoggable(ProceedingJoinPoint joinPoint, Loggable loggable) throws Throwable {
        // 实现类似的日志逻辑
        return joinPoint.proceed();
    }
    
    @Before("execution(* *(.., @ValidParam (*), ..))")
    public void validateParameters(JoinPoint joinPoint) {
        // 实现类似的参数校验逻辑
    }
}

9.2 添加配置文件支持

可以扩展注解，使其支持从配置文件读取日志级别等配置：

java

复制代码

@Loggable(level = "${log.level:INFO}", value = "${log.message:}")

总结

通过这个实战项目，我们实现了：

自定义注解 ：定义了@Loggable和@ValidParam注解
反射处理：使用Java反射机制读取注解信息
动态代理：通过动态代理实现方法的拦截和增强
参数校验：实现了全面的参数验证逻辑
日志记录：实现了方法执行的全链路日志

这种基于注解和反射的实现方式具有很好的解耦性和可扩展性，可以在不修改业务代码的情况下为系统添加通用功能。rd.xjyl.gov.cn/upload/1982077759995215872.html