一文详解SpringBoot中控制器的动态注册与卸载

2025-07-06 18:50
文章标签 springboot 卸载 详解 控制器 一文 注册 动态 spring java

本文主要是介绍一文详解SpringBoot中控制器的动态注册与卸载，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

《一文详解SpringBoot中控制器的动态注册与卸载》在项目开发中,通过动态注册和卸载控制器功能,可以根据业务场景和项目需要实现功能的动态增加、删除,提高系统的灵活性和可扩展性,下面我们就来看看Sp...

在项目开发中，通过动态注册和卸载控制器功能，可以根据业务场景和项目需要实现功能的动态增加、删除，提高系统的灵活性和可扩展性。

本文将介绍如何在 SpringBoot 中实现控制器的动态注册和卸载。

项目结构

src
└── main
    ├── Java
    │   └── com
    │       └── example
    │           ├── DynamicControllerApplication.java
    │           ├── controller
    │           │   ├── DemoController.java
    │           │   └── DynamicControllerRegistry.java
    │           │   └── DynamicController.java
    │           │   └── ControllerManagement.java
    │           └── config
    │               └── WebConfig.java
    └── resources
        └── application.properties

1. 创建 Spring Boot 启动类

首先，创建一个启动类 DynamicControllerApplication.java。

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DynamicControllerApplication {
    public static void main(String[] args) {
        SpringApplication.run(DynamicControllerApplication.class, args);
    }
}

2. 创建一个测试控制器

接下来，我们创建一个控制器 DemoController.java，该控制器将返回简单的字符串响应。

// 动态控制器注解
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface DynamicController {

    // 启动时注册
    boolean startupRegister() default true;

}

// 测试控制器
package com.example.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annoChina编程tation.RestController;

@RestController
@RequestMapping("/demo")
@DynamicController(startupRegister = false)
public class DemoController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello from Dynamic Controller!";
    }

}

3. 创建动态控制器注册类

然后，我们创建一个 DynamicControllerRegistry.java 类，用于动态注册和卸载控制器。

package com.example.controller;

import cn.hutool.core.util.ReflectUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

@Component
@Slf4j
public class DynamicControllerRegistry {

    @Autowired
  php  private ApplicationContext applicationContext;

    @Autowired
    private RequestMappingHandlerMapping reChina编程questMappingHandlerMapping;

    private final Map<String, String> registeredControllers = new HashMap<>();

    public String registerController(Object controller,String methodName) {
        Class<?> controllerClass = controller.getClass();
        String key = key(controllerClass,methodName);
        String url = "";
        if (!registeredControllers.containsKey(key)) {
            Method m编程China编程ethod = ReflectUtil.getMethod(controllerClass,methodName);
            RequestMapping methodMapping = AnnotatedElementUtilswww.chinasem.cn.findMergedAnnotation(method, RequestMapping.class);
            RequestMapping requestMapping = controllerClass.getAnnotation(RequestMapping.class);

            url = getMethodUrl(requestMapping,methodMapping);
            // 注册控制器
            requestMappingHandlerMapping.registerMapping(
                    RequestMappingInfo.paths(url).methods(methodMapping.method()).build(),
                    controller,method
            );
            registeredControllers.put(key,url);
        }else{
            url = registeredControllers.get(key);
            log.warn("controller already registered:{}",url);
        }
        return url;
    }

    public String unregisterController(Class<?> controllerClass,Method method) {
        RequestMapping methodMapping = AnnotatedElementUtils.findMergedAnnotation(method, RequestMapping.class);
        RequestMapping requestMapping = controllerClass.getAnnotation(RequestMapping.class);
        String url = getMethodUrl(requestMapping,methodMapping);
        RequestMappingInfo mappingInfo = RequestMappingInfo.paths(url).methods(methodMapping.method()).build();
        requestMappingHandlerMapping.unregisterMapping(mappingInfo);
        registeredControllers.remove(key(controllerClass,method.getName()));
        log.info("unregister controller:{}", url);
        return url;
    }

    public String unregisterController(Class<?> controllerClass,String methodName) {
        Method method = ReflectUtil.getMethod(controllerClass,methodName);
        return unregisterController(controllerClass,method);
    }

    private String key(Class<?> controllerClass, String method){
        return controllerClass.getName() + "." + method;
    }

    private String getMethodUrl(RequestMapping requestMapping,RequestMapping methodMapping){
        String baseUrl = "";
        String url = "";
        if(requestMapping != null){
            baseUrl = requestMapping.value()[0];
        }
        if(methodMapping != null) {
            String[] values = methodMapping.value();
            if (values.length > 0) {
                url = baseUrl + values[0];
            }
        }
        return url;
    }

}

4. 创建 Web 配置类

创建配置类 WebConfig.java ，实现项目启动时将不需要注册的控制器进行卸载。

package com.example.config;

import cn.hutool.core.util.ClassUtil;
import com.example.controller.DynamicController;
import com.example.controller.DynamicControllerRegistry;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.web.bind.annotation.RequestMapping;

import java.lang.reflect.Method;
import java.util.Map;
import java.util.Set;

@Configuration
@Slf4j
public class WebConfig {

    @Autowired
    private DynamicControllerRegistry dynamicControllerRegistry;

    @Bean
    public Void unregisterDynamicController() {
        Set<Class<?>> classes = ClassUtil.scanPackageByAnnotation("com.example", DynamicController.class);
        for(Class<?> clazz : classes) {
            DynamicController dynamicController = clazz.getAnnotation(DynamicController.class);
            boolean needRegister = dynamicController.startupRegister();
            if(needRegister) {
                continue;
            }

            // 默认不需要注册的controller，需要在启动时注销掉
            RequestMapping requestMapping = clazz.getAnnotation(RequestMapping.class);
            Method[] methods = clazz.getDeclaredMethods();
            for(Method method : methods) {
                dynamicControllerRegistry.unregisterController(clazz,method);
            }
        }

        return null;
    }
}

5. 创建动态控制器注册和卸载控制器

创建一个新的控制器 ControllerManagement.java，用于处理控制器的注册和卸载请求。

package com.example.controller;

import cn.hutool.extra.spring.SpringUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/controller")
public class ControllerManagement {

    @Autowired
    private DynamicControllerRegistry dynamicControllerRegistry;

    @PostMapping("/register")
    public String registerController(@RequestParam String controllerBeanName, @RequestParam String methodName) {
        Object controller = SpringUtil.getBean(controllerBeanName);
        String url = dynamicControllerRegistry.registerController(controller, methodName);
        return "Controller registered at: " + url;
    }

    @DeleteMapping("/unregister")
    public String unregisterController(@RequestParam String controllerBeanName, @RequestParam String methodName) {
        Object controller = SpringUtil.getBean(controllerBeanName);
        String url = dynamicControllerRegistry.unregisterController(controller.getClass(),methodName);
        return "Controller unregistered from: " + url;
    }
}

6. 测试注册控制器

1. 启动服务

2. 访问 http://localhost:8080/demo/hello ，此时应该是404，因为没有注册控制器

3. POST http://localhost:8080/controller/register?methodName=hello&controllerBeanName=demoController 注册控制器

4. 再次访问 http://localhost:8080/demo/hello

7. 卸载控制器

1. POST http://localhost:8080/controller/unregister?methodName=hello&controllerBeanName=demoController 卸载控制器

2. 再次访问 <http://localhost:8080/demo/hello>，此时应该是404，因为控制器已被卸载

结论

通过以上步骤，我们实现了在 Spring Boot 中动态注册和卸载控制器的功能。

这样的实现能够根据实际需求动态增减功能。

到此这篇关于一文详解SpringBoot中控制器的动态注册与卸载的文章就介绍到这了,更多相关SpringBoot控制器注册与卸载内容请搜索China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)！

这篇关于一文详解SpringBoot中控制器的动态注册与卸载的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1155314。

相关文章

MySQL 主从复制部署及验证(示例详解)

MySQL 主从复制部署及验证(示例详解)

《MySQL主从复制部署及验证(示例详解)》本文介绍MySQL主从复制部署步骤及学校管理数据库创建脚本,包含表结构设计、示例数据插入和查询语句,用于验证主从同步功能,感兴趣的朋友一起看看吧... 目录mysql 主从复制部署指南部署步骤1.环境准备2. 主服务器配置3. 创建复制用户4. 获取主服务器状态5
阅读更多...
SpringBoot中六种批量更新Mysql的方式效率对比分析

SpringBoot中六种批量更新Mysql的方式效率对比分析

《SpringBoot中六种批量更新Mysql的方式效率对比分析》文章比较了MySQL大数据量批量更新的多种方法,指出REPLACEINTO和ONDUPLICATEKEY效率最高但存在数据风险,MyB... 目录效率比较测试结构数据库初始化测试数据批量修改方案第一种 for第二种 case when第三种
阅读更多...
Java docx4j高效处理Word文档的实战指南

Java docx4j高效处理Word文档的实战指南

《Javadocx4j高效处理Word文档的实战指南》对于需要在Java应用程序中生成、修改或处理Word文档的开发者来说,docx4j是一个强大而专业的选择,下面我们就来看看docx4j的具体使用... 目录引言一、环境准备与基础配置1.1 Maven依赖配置1.2 初始化测试类二、增强版文档操作示例2.
阅读更多...
一文详解如何使用Java获取PDF页面信息

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸（宽高）四、获取页面旋转角度五、判断
阅读更多...
Spring Boot中的路径变量示例详解

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs
阅读更多...
MySql基本查询之表的增删查改+聚合函数案例详解

MySql基本查询之表的增删查改+聚合函数案例详解

《MySql基本查询之表的增删查改+聚合函数案例详解》本文详解SQL的CURD操作INSERT用于数据插入（单行/多行及冲突处理）,SELECT实现数据检索（列选择、条件过滤、排序分页）,UPDATE... 目录一、Create1.1 单行数据 + 全列插入1.2 多行数据 + 指定列插入1.3 插入否则更
阅读更多...
Redis中Stream详解及应用小结

Redis中Stream详解及应用小结

《Redis中Stream详解及应用小结》RedisStreams是Redis5.0引入的新功能,提供了一种类似于传统消息队列的机制,但具有更高的灵活性和可扩展性,本文给大家介绍Redis中Strea... 目录1. Redis Stream 概述2. Redis Stream 的基本操作2.1. XADD
阅读更多...
JAVA中安装多个JDK的方法

JAVA中安装多个JDK的方法

《JAVA中安装多个JDK的方法》文章介绍了在Windows系统上安装多个JDK版本的方法,包括下载、安装路径修改、环境变量配置（JAVA_HOME和Path）,并说明如何通过调整JAVA_HOME在... 首先去oracle官网下载好两个版本不同的jdk（需要登录Oracle账号，没有可以免费注册）下载完
阅读更多...
Spring StateMachine实现状态机使用示例详解

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​，用于描述对象在其生命
阅读更多...
Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

《SpringBoot结合WxJava实现文章上传微信公众号草稿箱与群发》本文将详细介绍如何使用SpringBoot框架结合WxJava开发工具包,实现文章上传到微信公众号草稿箱以及群发功能,... 目录一、项目环境准备1.1 开发环境1.2 微信公众号准备二、Spring Boot 项目搭建2.1 创建
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2