Java注解处理器实现代码依赖注入

在软件开发中，依赖注入（DI）是一种广泛使用的设计模式，旨在减少组件间的耦合度，提高代码的可维护性和可测试性。传统的依赖注入框架如Spring、Guice等虽然功能强大，但在某些场景下，它们可能会显得过于笨重。本文将探讨如何利用Java注解处理器（Annotation Processor）来生成代码，实现轻量级的依赖注入。

Java注解处理器实现代码依赖注入

什么是注解处理器？

注解处理器是Java编译器的一个插件，它可以在编译期间读取和处理注解，生成额外的源代码或编译时错误。通过注解处理器，我们可以在编译阶段动态生成代码，从而减少手动编写重复代码的工作量。

设计注解

首先，我们需要定义一些注解来标记需要依赖注入的类和方法。例如，我们可以定义一个@Inject注解来标记需要注入依赖的字段或方法。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.CLASS)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface Inject {
}

实现注解处理器

接下来，我们需要实现一个注解处理器来处理@Inject注解。注解处理器需要继承AbstractProcessor类，并重写process方法。

import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.RoundEnvironment;
import javax.annotation.processing.Processor;
import javax.annotation.processing.SupportedAnnotationTypes;
import javax.annotation.processing.SupportedSourceVersion;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
import javax.tools.Diagnostic;

@SupportedAnnotationTypes("com.example.Inject")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class InjectProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(Inject.class)) {
            if (element.getKind() == ElementKind.FIELD || element.getKind() == ElementKind.METHOD) {
                generateInjectionCode(element);
            }
        }
        return true;
    }

    private void generateInjectionCode(Element element) {
        // 生成依赖注入代码的逻辑
        processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, "Generating injection code for " + element);
    }
}

生成依赖注入代码

在generateInjectionCode方法中，我们可以使用JavaPoet库来生成代码。JavaPoet是一个用于生成.java源文件的库，它提供了丰富的API来构建类、方法、字段等。

import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;

private void generateInjectionCode(Element element) {
    String className = element.getEnclosingElement().getSimpleName().toString() + "Injector";
    TypeSpec.Builder classBuilder = TypeSpec.classBuilder(className)
            .addModifiers(Modifier.PUBLIC, Modifier.FINAL);

    MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder("inject")
            .addParameter(ClassName.get(element.getEnclosingElement().asType()), "target")
            .addModifiers(Modifier.PUBLIC, Modifier.STATIC);

    // 生成具体的注入代码
    methodBuilder.addStatement("target.$L = new $T()", element.getSimpleName(), element.asType());

    classBuilder.addMethod(methodBuilder.build());

    JavaFile javaFile = JavaFile.builder(element.getEnclosingElement().getQualifiedName().toString(), classBuilder.build())
            .build();

    try {
        javaFile.writeTo(processingEnv.getFiler());
    } catch (IOException e) {
        processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Failed to generate injector class: " + e.getMessage());
    }
}

使用注解

现在，我们可以在代码中使用@Inject注解来标记需要注入依赖的字段或方法。

public class UserService {
    @Inject
    private UserRepository userRepository;

    public void getUser() {
        User user = userRepository.findById(1);
        System.out.println(user.getName());
    }
}

编译时，注解处理器会自动生成UserServiceInjector类，包含inject方法，用于注入UserRepository实例。