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

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

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

环境: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) ;
  }
}

运行效果

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

相关推荐

oracle数据导入导出_oracle数据导入导出工具

关于oracle的数据导入导出,这个功能的使用场景,一般是换服务环境,把原先的oracle数据导入到另外一台oracle数据库,或者导出备份使用。只不过oracle的导入导出命令不好记忆,稍稍有点复杂...

继续学习Python中的while true/break语句

上次讲到if语句的用法,大家在微信公众号问了小编很多问题,那么小编在这几种解决一下,1.else和elif是子模块,不能单独使用2.一个if语句中可以包括很多个elif语句,但结尾只能有一个...

python continue和break的区别_python中break语句和continue语句的区别

python中循环语句经常会使用continue和break,那么这2者的区别是?continue是跳出本次循环,进行下一次循环;break是跳出整个循环;例如:...

简单学Python——关键字6——break和continue

Python退出循环,有break语句和continue语句两种实现方式。break语句和continue语句的区别:break语句作用是终止循环。continue语句作用是跳出本轮循环,继续下一次循...

2-1,0基础学Python之 break退出循环、 continue继续循环 多重循

用for循环或者while循环时,如果要在循环体内直接退出循环,可以使用break语句。比如计算1至100的整数和,我们用while来实现:sum=0x=1whileTrue...

Python 中 break 和 continue 傻傻分不清

大家好啊,我是大田。...

python中的流程控制语句:continue、break 和 return使用方法

Python中,continue、break和return是控制流程的关键语句,用于在循环或函数中提前退出或跳过某些操作。它们的用途和区别如下:1.continue(跳过当前循环的剩余部分,进...

L017:continue和break - 教程文案

continue和break在Python中,continue和break是用于控制循环(如for和while)执行流程的关键字,它们的作用如下:1.continue:跳过当前迭代,...

作为前端开发者,你都经历过怎样的面试?

已经裸辞1个月了,最近开始投简历找工作,遇到各种各样的面试,今天分享一下。其实在职的时候也做过面试官,面试官时,感觉自己问的问题很难区分候选人的能力,最好的办法就是看看候选人的github上的代码仓库...

面试被问 const 是否不可变?这样回答才显功底

作为前端开发者,我在学习ES6特性时,总被const的"善变"搞得一头雾水——为什么用const声明的数组还能push元素?为什么基本类型赋值就会报错?直到翻遍MDN文档、对着内存图反...

2023金九银十必看前端面试题!2w字精品!

导文2023金九银十必看前端面试题!金九银十黄金期来了想要跳槽的小伙伴快来看啊CSS1.请解释CSS的盒模型是什么,并描述其组成部分。...

前端面试总结_前端面试题整理

记得当时大二的时候,看到实验室的学长学姐忙于各种春招,有些收获了大厂offer,有些还在苦苦面试,其实那时候的心里还蛮忐忑的,不知道自己大三的时候会是什么样的一个水平,所以从19年的寒假放完,大二下学...

由浅入深,66条JavaScript面试知识点(七)

作者:JakeZhang转发链接:https://juejin.im/post/5ef8377f6fb9a07e693a6061目录...

2024前端面试真题之—VUE篇_前端面试题vue2020及答案

添加图片注释,不超过140字(可选)...

今年最常见的前端面试题,你会做几道?

在面试或招聘前端开发人员时,期望、现实和需求之间总是存在着巨大差距。面试其实是一个交流想法的地方,挑战人们的思考方式,并客观地分析给定的问题。可以通过面试了解人们如何做出决策,了解一个人对技术和解决问...