Spring Boot中如何动态实现@Component标注的类？

我有如下Java接口：

import org.springframework.stereotype.Repository;

@Repository
public interface ITest {
    void testFunc();
}

并且在控制器中注入使用该接口：

@RestController()
@CrossOrigin(origins = "*")
@RequestMapping("/api/users")
public class UserController {

    @Autowired
    private UserService userService;

    @Autowired
    private ITest iTest;

    @GetMapping()
    public List<User> test() {
        return this.userService.getUsers();
    }

    @GetMapping("/test")
    public String ttest() {
        iTest.testFunc();
        return "Hello World!";
    }

}

手动添加该接口的实现类时一切正常，但我希望根据特定配置在运行时动态生成并添加实现类。我尝试了以下代码但未生效，请问遗漏了哪些步骤？

@SpringBootApplication
public class EcommerceApplication {

    public static void main(String[] args) throws IOException, NoSuchMethodException, ClassNotFoundException, IllegalAccessException, InstantiationException, InvocationTargetException {
        String s = "package com.justtech.ecommerce.db;\n" +
                "\n" +
                "import org.springframework.stereotype.Component;\n" +
                "\n" +
                "@Component\n" +
                "public class Test2 implements ITest {\n" +
                "\n" +
                "\n" +
                "    @Override\n" +
                "    public void testFunc() {\n" +
                "        System.err.println(\"Hello World\");\n" +
                "    }\n" +
                "}\n";
        dynamicClass(s, "com.justtech.ecommerce.db.Test2", "Test2");
        SpringApplication.run(EcommerceApplication.class, args);
    }


    static void dynamicClass(String sourceCode, String className, String fileName) throws IOException, NoSuchMethodException, ClassNotFoundException, IllegalAccessException, InstantiationException, InvocationTargetException {
        System.err.println(System.getProperty("user.dir"));
        File parent = new File(System.getProperty("user.dir"));
        File sourceFile = new File(parent, fileName + ".java");
        sourceFile.deleteOnExit();

        FileWriter writer = new FileWriter(sourceFile);
        writer.write(sourceCode);
        writer.close();

        JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();
        StandardJavaFileManager standardJavaFileManager = javaCompiler.getStandardFileManager(null, null, null);
        File parentDir = sourceFile.getParentFile();
        standardJavaFileManager.setLocation(StandardLocation.CLASS_OUTPUT, Arrays.asList(parentDir));
        Iterable<? extends JavaFileObject> compilationUnits = standardJavaFileManager.getJavaFileObjectsFromFiles(Arrays.asList(sourceFile));
        javaCompiler.getTask(null, standardJavaFileManager, null, null, null, compilationUnits).call();
        standardJavaFileManager.close();

        URLClassLoader urlClassLoader = URLClassLoader.newInstance(new URL[]{parentDir.toURI().toURL()});
        Class<?> dynamicClass = urlClassLoader.loadClass(className);


//        Method formula1 = dynamicClass.getDeclaredMethod("formula1");
//        formula1.invoke(dynamicClass.newInstance());
    }

}

问题分析与解决方案 #

你的代码仅完成了动态编译和类加载，但未将动态生成的类注册到Spring容器中，导致Spring无法自动注入该实例。以下是需要补充的关键步骤：

1. 统一类加载器上下文 #

你使用了自定义URLClassLoader，但Spring上下文默认使用应用类加载器，这会导致Spring无法识别动态类。需让自定义类加载器继承应用上下文类加载器：

URLClassLoader urlClassLoader = new URLClassLoader(
    new URL[]{parentDir.toURI().toURL()}, 
    Thread.currentThread().getContextClassLoader()
);

2. 手动将动态类注册为Spring Bean #

Spring启动过程中或启动后，需通过BeanDefinitionRegistry将动态类注册为Bean，才能被@Autowired识别。

方式一：通过ApplicationContextInitializer提前注册

static class DynamicBeanInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
    private final Class<?> dynamicClass;

    public DynamicBeanInitializer(Class<?> dynamicClass) {
        this.dynamicClass = dynamicClass;
    }

    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        BeanDefinitionRegistry registry = (BeanDefinitionRegistry) applicationContext.getBeanFactory();
        GenericBeanDefinition beanDef = new GenericBeanDefinition();
        beanDef.setBeanClass(dynamicClass);
        // 可指定Bean作用域，默认单例
        beanDef.setScope("singleton");
        registry.registerBeanDefinition("test2", beanDef);
    }
}

在启动Spring时添加该初始化器：

// 加载动态类后
DynamicBeanInitializer initializer = new DynamicBeanInitializer(dynamicClass);
SpringApplication application = new SpringApplication(EcommerceApplication.class);
application.addInitializers(initializer);
application.run(args);

方式二：Spring启动后手动注册

ConfigurableApplicationContext context = SpringApplication.run(EcommerceApplication.class, args);
BeanDefinitionRegistry registry = (BeanDefinitionRegistry) context.getBeanFactory();
GenericBeanDefinition beanDef = new GenericBeanDefinition();
beanDef.setBeanClass(dynamicClass);
registry.registerBeanDefinition("test2", beanDef);

3. 优化编译输出路径 #

你将编译后的class文件放在项目根目录，可能不在Spring组件扫描路径内。建议输出到target/classes（Maven/Gradle类输出目录），确保类路径可见：

File parent = new File(System.getProperty("user.dir") + "/target/classes");
parent.mkdirs(); // 确保目录存在

完整修改后的主类示例 #

@SpringBootApplication
public class EcommerceApplication {

    public static void main(String[] args) throws Exception {
        String s = "package com.justtech.ecommerce.db;\n" +
                "\n" +
                "import org.springframework.stereotype.Component;\n" +
                "\n" +
                "@Component\n" +
                "public class Test2 implements ITest {\n" +
                "\n" +
                "    @Override\n" +
                "    public void testFunc() {\n" +
                "        System.err.println(\"Hello World\");\n" +
                "    }\n" +
                "}\n";
        Class<?> dynamicClass = dynamicClass(s, "com.justtech.ecommerce.db.Test2", "Test2");
        
        // 初始化Spring并注册动态Bean
        SpringApplication application = new SpringApplication(EcommerceApplication.class);
        application.addInitializers(new DynamicBeanInitializer(dynamicClass));
        application.run(args);
    }


    static Class<?> dynamicClass(String sourceCode, String className, String fileName) throws Exception {
        // 输出到target/classes目录
        File parent = new File(System.getProperty("user.dir") + "/target/classes");
        parent.mkdirs();
        File sourceFile = new File(parent, fileName + ".java");
        sourceFile.deleteOnExit();

        try (FileWriter writer = new FileWriter(sourceFile)) {
            writer.write(sourceCode);
        }

        JavaCompiler javaCompiler = ToolProvider.getSystemJavaCompiler();
        try (StandardJavaFileManager standardJavaFileManager = javaCompiler.getStandardFileManager(null, null, null)) {
            standardJavaFileManager.setLocation(StandardLocation.CLASS_OUTPUT, Arrays.asList(parent));
            Iterable<? extends JavaFileObject> compilationUnits = standardJavaFileManager.getJavaFileObjectsFromFiles(Arrays.asList(sourceFile));
            // 检查编译是否成功
            Boolean compileSuccess = javaCompiler.getTask(null, standardJavaFileManager, null, null, null, compilationUnits).call();
            if (!compileSuccess) {
                throw new RuntimeException("动态类编译失败");
            }
        }

        // 使用上下文类加载器加载
        URLClassLoader urlClassLoader = new URLClassLoader(
            new URL[]{parent.toURI().toURL()}, 
            Thread.currentThread().getContextClassLoader()
        );
        return urlClassLoader.loadClass(className);
    }

    static class DynamicBeanInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        private final Class<?> dynamicClass;

        public DynamicBeanInitializer(Class<?> dynamicClass) {
            this.dynamicClass = dynamicClass;
        }

        @Override
        public void initialize(ConfigurableApplicationContext applicationContext) {
            BeanDefinitionRegistry registry = (BeanDefinitionRegistry) applicationContext.getBeanFactory();
            GenericBeanDefinition beanDef = new GenericBeanDefinition();
            beanDef.setBeanClass(dynamicClass);
            registry.registerBeanDefinition("test2", beanDef);
        }
    }

}

额外注意事项 #

• 动态编译需要完整JDK环境（不能用JRE），否则ToolProvider.getSystemJavaCompiler()会返回null。
• 若动态类依赖其他类，需确保这些类在类加载器的可见范围内。
• 如需更复杂的Bean配置（比如构造函数注入、属性设置），可使用BeanDefinitionBuilder构建Bean定义。

内容的提问来源于stack exchange，提问作者Sohayb Saleh