百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT技术 > 正文

Spring Boot 控制 Controller 接口的4种方式,哪种更适合你?

wptr33 2025-07-19 23:05 31 浏览

环境:SpringBoot3.4.2



1. 简介

动态控制接口的可用性是常见的需求,例如灰度发布、功能降级、紧急熔断等场景。基于 Spring Boot 我们可以通过多种灵活的方式来实现Controller接口的动态开关,包括基于AOP和非AOP的方案,以满足不同粒度和实时性的需求。

AOP方案(如自定义注解+切面)适用于方法级别的细粒度控制,结合配置中心(如Nacos)可实现运行时动态调整。非AOP方案(如拦截器、条件装配、动态路由)则适用于请求级或Controller级的控制,其中拦截器适合请求前置处理,条件装配(@ConditionalOnProperty)适用于启动时静态开关,而动态路由则能在URL匹配阶段进行高效拦截。此外,结合Spring Cloud Config或Actuator端点,可实现配置的实时刷新和远程管理。

选择合适的方案需综合考虑动态生效需求、实现复杂度及性能影响。接下来,我将介绍4种实现方案。

2.实战案例

2.1 方案1:基于@ConditionalOnProperty

该方案利用Spring Boot的 @ConditionalOnProperty 条件装配机制,在应用启动时根据配置文件(如application.yml)决定是否注册Controller,适用于无需运行时动态调整的场景。如下示例:

@RestController  
@ConditionalOnProperty(name = "pack.features.users.enabled", havingValue = "true")  
public class UserController {
}  

当配置文件中的
pack.features.users.enabled
配置为true后,Spring才会注册UserController接口。

优点:

  • 零编码,直接依赖Spring原生支持
  • 启动时确定,避免运行时检查开销

缺点:

  • 需重启生效,无法动态调整
  • 粒度较粗,仅支持类/Bean级别控制

2.2 基于AOP实现

通过自定义注解(如 @FeatureToggle )标记需控制的接口,结合AOP动态拦截请求,高级点我们结合配置中心(如Nacos)实时判断是否放行。支持方法级细粒度控制,无需重启即可生效,适合灰度发布、熔断降级等场景。

自定义注解

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface FeatureToggle {


  /**功能名称(用于关联配置)*/
  String featureName() ;
  /**关闭时的提示信息*/
  String defaultError() default "服务不可用" ;
}

定义切面

@Aspect
@Component
public class FeatureToggleAspect {


  private static final String PREFIX = "pack.features." ;
  private static final String SUFFIX = ".enabled" ;


  private final Environment env;
  public FeatureToggleAspect(Environment env) {
    this.env = env;
  }
  @Pointcut(value = "@within(toggle) || @annotation(toggle)")
  public void matchAnnotatedClassOrMethod(FeatureToggle toggle) {}


  @Around("matchAnnotatedClassOrMethod(toggle)")
  public Object checkFeature(ProceedingJoinPoint pjp, FeatureToggle toggle) throws Throwable {
    String propertyKey = null ;
    if (toggle == null) {
      toggle = AopUtils.getTargetClass(pjp.getTarget()).getAnnotation(FeatureToggle.class) ;
    }
    if (toggle == null) {
      return pjp.proceed() ;
    }
    propertyKey = PREFIX + toggle.featureName() + SUFFIX ;
    boolean isEnabled = Boolean.parseBoolean(env.getProperty(propertyKey, "false")) ;
    if (!isEnabled) {
      throw new RuntimeException(toggle.defaultError()) ;
    }
    return pjp.proceed() ;
  }
}

该切面支持类和方法级别的。需要注意的是这里一定要判断toggle是否为空情况。

使用示例:

@RestController
@RequestMapping("/users")
@FeatureToggle(featureName = "user")
public class UserController {
  @FeatureToggle(featureName = "user.query")
  @GetMapping("/query")
  public ResponseEntity<?> query() {
    return ResponseEntity.ok("query...") ;
  }


  @GetMapping("/create")
  public ResponseEntity<?> create() {
    return ResponseEntity.ok("create...") ;
  }
}

配置文件

pack:
  features:
    user:
      enabled: false
    user.query:
      enabled: true

运行结果

此种方式,解耦性好,支持动态刷新,注解配置灵活。如果你需要了解动态刷新功能,那么请参考下面文章:

技术专家!Spring AOP + Nacos + Prometheus 实现动态限流及实时监控

技巧!Spring Boot 动态刷新及实时监控配置文件的变化

2.3 基于拦截器实现

通过实现HandlerInterceptor前置拦截请求,结合配置动态控制接口访问。在请求进入Controller前进行开关判断。

定义配置属性类

@Component
@ConfigurationProperties(prefix = "pack.features")
public class FeatureProperties {
  // 存储所有功能开关状态
  private final Map<String, State> toggle = new ConcurrentHashMap<>();
  // 检查功能是否启用
  public boolean isEnabled(String featureName) {
    State state = toggle.get(featureName) ;
    if (state == null) {
      return false ;
    }
    return state.enabled() ;
  }
  public static record State(Boolean enabled) {}
  public Map<String, State> getToggle() {
    return toggle;
  }
}

配置文件

pack:
  features:
    toggle:
      user:
        enabled: false
      '[user.query]':
        enabled: true

定义拦截器

@Component
public class FeatureToggleInterceptor implements HandlerInterceptor {
  private final FeatureProperties featureProperties ;
  public FeatureToggleInterceptor(FeatureProperties featureProperties) {
    this.featureProperties = featureProperties;
  }
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
    if (handler instanceof HandlerMethod) {
      HandlerMethod hm = (HandlerMethod) handler;
      // 检查方法或类上的注解
      FeatureToggle toggle = hm.getMethodAnnotation(FeatureToggle.class);
      if (toggle == null) {
        toggle = hm.getBeanType().getAnnotation(FeatureToggle.class);
      }
      if (toggle != null && !featureProperties.isEnabled(toggle.featureName())) {
        throw new RuntimeException(toggle.defaultError()) ;
      }
    }
    return true;
  }
}

注册拦截器

@Component
public class WebConfig implements WebMvcConfigurer {
  private final FeatureToggleInterceptor toggleInterceptor;
  public WebConfig(FeatureToggleInterceptor toggleInterceptor) {
    this.toggleInterceptor = toggleInterceptor;
  }
  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(toggleInterceptor).addPathPatterns("/**") ;
  }
}

最终执行效果与上面的AOP一样。

优点:避免AOP开销,适合URL级管控。

2.4 自定义HandlerMapping

通过自定义
RequestMappingHandlerMapping
在路由匹配阶段动态控制请求,根据配置决定是否返回处理器。相比拦截器更底层,直接在Spring MVC路由层拦截。如下代码示例:

public class PackHandlerMapping extends RequestMappingHandlerMapping {
  private final FeatureProperties featureProperties;
  public PackHandlerMapping(FeatureProperties featureProperties) {
    this.featureProperties = featureProperties;
  }
  @Override
  protected HandlerMethod getHandlerInternal(HttpServletRequest request) throws Exception {
    HandlerMethod handler = super.getHandlerInternal(request);
    if (handler != null) {
      FeatureToggle toggle = handler.getMethodAnnotation(FeatureToggle.class);
      if (toggle == null) {
        toggle = handler.getBeanType().getAnnotation(FeatureToggle.class) ;
      }
      if (toggle != null && !featureProperties.isEnabled(toggle.featureName())) {
        return null ;
      }
    }
    return handler;
  }
}

注册处理器

@Component
public class HandlerConfig implements WebMvcRegistrations {
  private final FeatureProperties featureProperties ;
  public HandlerConfig(FeatureProperties featureProperties) {
    this.featureProperties = featureProperties;
  }
  @Override
  public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
    return new PackHandlerMapping(featureProperties) ;
  }
}

运行效果

此种方式,在路由匹配阶段控制,性能较好。

相关推荐

Python字符串终极指南!单引号、双引号、三引号区别全解析

导语:Python中字符串(str)是最核心的数据类型!无论你是输出"HelloWorld"还是处理用户数据,都离不开它。今天彻底讲清字符串的三大定义方式及其核心区别,新手必看!...

python 字符串的定义和表示_python字符串的用法

在Python中,字符串是一序列字符的集合。定义一个字符串可以使用单引号或双引号括起来的字符序列。...

简单的python-熟悉字符串相关的操作

str.py:#-*-coding:utf-8-*-#测试函数deff():#字符串使用单引号定义s1='test'print(s...

Python初学者:3招搞定长字符串逐行读取,代码超简单

刚学Python的小伙伴,是不是遇到过这种尴尬情况?拿到一段老长的多行字符串——比如从文档里复制的日志、一段带换行的文章,想一行一行处理,如果直接打印全堆在一起,手动切又怕漏行,咋整啊?别慌!今天就给...

Python 字符串_python字符串型怎么表达

除了数字,Python还可以操作字符串。字符串的形式是单引号('......')双引号(''.........'')或三个单引号(''&...

贴身口语第二关:请求帮忙、道歉、指路、接受礼物

02-@askforhelp请求协助1.F:Excuseme.Canyouhelpme?M:Yes,whatcanIdoforyou?...

NBA赛季盘点之九大装逼&amp;炫技时刻:“歪嘴战神”希罗领衔

欢迎大家来到直播吧NBA赛季盘点,历经许多波折,2019-20赛季耗时整整一年才圆满收官。魔幻的一年里有太多的时刻值得我们去铭记,赛场上更是不乏球员们炫技与宣泄情绪的装逼时刻,本期盘点就让我们来回顾一...

一手TTS-2语音合成模型安装教程及实际使用

语音合成正从云端调用走向本地部署,TTS-2模型作为开源语音生成方案之一,正在被越来越多开发者尝试落地。本篇文章从环境配置到推理调用,详尽拆解TTS-2的安装流程与使用技巧,为语音产品开发者提供...

网友晒出身边的巨人 普通人站一旁秒变“霍比特人”

当巨人遇到霍比特人,结果就是“最萌身高差”。近日网友们晒出了身边的巨人,和他们站在一起,普通人都变成了“霍比特人”。CanYouTellWho'sRelated?TheDutchGiant...

分手后我们还能做朋友吗?_分手后我们还能做朋友吗

Fewrelationshipquestionsareaspolarizingaswhetherornotyoushouldstayfriendswithanex.A...

如何用C语言实现Shellcode Loader

0x01前言之前github找了一个基于go的loader,生成后文件大小6M多,而且细节不够了解,一旦被杀,都不知道改哪里,想来还是要自己写一个loader...

微星Z490如何装Windows10系统以及怎么设 BIOS

小晨儿今天给大家讲一下msi微星Z490重怎样装系统以及怎么设置BIOS。一、安装前的准备工作1、一、安装前的准备工作1、备份硬盘所有重要的文件(注:GPT分区转化MBR分区时数据会丢失)2...

超实用!互联网软件开发人员不可不知的 Git 常用操作命令

在互联网软件开发的协作场景中,Git是不可或缺的版本控制工具。掌握其核心命令,能让代码管理效率大幅提升。本文精选Git高频实用命令,结合场景化说明,助你快速上手。仓库初始化与克隆...

AI项目的持续集成持续部署实践_ai 项目

在独立开发AI工具的过程中,笔者逐步实践了一套高效的软件项目持续集成与持续部署(CI/CD)流程。这套流程以Git、GitHub和Vercel为核心,实现了从代码提交到生产环境上线的全链路自动化。这篇...

总结几个常用的Git命令的使用方法

1、Git的使用越来越广泛现在很多的公司或者机构都在使用Git进行项目和代码的托管,Git有它自身的优势,很多人也喜欢使用Git。...