如何使 REST 控制器以环境为条件?

Question

我们有一个用例，我们希望在除生产环境之外的每个环境中启用一组端点。 我们的想法不是为这个用例实现自定义安全实现，而是使用 Spring 的条件注释的变体来仅在非生产环境中启用控制器。

我们最初的尝试是通过注入指定环境类型(例如开发、测试、生产等)的动态系统属性来使用 @ConditionalOnExpression，并将该属性与正则表达式进行匹配，但我们无法让 SpEL 表达式以适合我们需求的方式正确解析。

@RestController
@ConditionalOnExpression("${property.name} matches ^((?!prod).)*$")
public class TestDataController

我们也考虑过使用 @ConditionalOnProperty，但似乎没有办法允许此属性接受多个有效值。

@RestController
@ConditionalOnProperty(
value = "property.name",
havingValue = "value1" or "value2",
matchIfMissing = true)
public class TestDataController

我们最后一次尝试是编写一个自定义类，扩展 Spring 的条件类以满足我们的需求。 这目前有效，但它依赖于 Java 文件 I/O，如果可能的话，我们希望避免这种情况。

有什么想法吗？

更新 29 5 月 19 日

我们能够使用以下解决方案来解决我们的问题：

1. 按以下方式定义自定义条件：

public class NotInProductionCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
final String env = context.getEnvironment().getProperty("property.name");
if (env == null || env.isEmpty()) {
return true;
}
return !env.contains("prod");
}
}

2. 使用控制器上的自定义条件：

@RestController
@Conditional(NotInProductionCondition.class)
public class TestDataController

Answer 1

您可以使用@Profile注释根据环境中设置的配置文件实例化 Bean。

@RestController
@Profile("!prod")
class MyController {
...
}

如果您没有在您的环境中使用配置文件，我想您很可能会使用某种类型的环境变量来指定环境名称。你可以把它做成这样的弹簧轮廓

spring.profiles.active = ${environmentName}