假设有一个使用@RestController注解的“标准”Spring Boot应用程序，例如：
@RestController
@RequestMapping(value = "foo", produces = "application/json;charset=UTF-8")
public class MyController {
@RequestMapping(value = "bar")
public ResponseEntity<String> bar(
return new ResponseEntity<>("Hello world", HttpStatus.OK);
}
}
是否有一种注释或技术可以防止端点在某个应用程序属性存在/不存在的情况下完全启动。
注意：在方法内部测试属性并抛出异常不是解决方案，因为端点将会存在。
我不关心粒度：即启用/禁用单个方法或整个类都可以。
由于配置文件不是属性，因此通过配置文件无法解决我的问题。
我发现使用@ConditionalOnExpression可以找到一个简单的解决方案：
@RestController
@ConditionalOnExpression("${my.controller.enabled:false}")
@RequestMapping(value = "foo", produces = "application/json;charset=UTF-8")
public class MyController {
@RequestMapping(value = "bar")
public ResponseEntity<String> bar(
return new ResponseEntity<>("Hello world", HttpStatus.OK);
}
}
有了这个注释，除非我有
my.controller.enabled=true
在我的application.properties文件中，控制器根本不会启动。
您还可以使用更方便的方式：
@ConditionalOnProperty("my.property")
如果属性存在且值为"true"，该组件将会启动，否则不会启动，其表现与上述完全相同。
针对这个问题和另一个问题 在这里。
这是我的答案：
我会使用@RefreshScope Bean，然后当你想要在运行时停止Rest Controller时，你只需要将该控制器的属性更改为false。
SO的链接引用了在运行时更改属性的方法。
这是我的工作代码片段：
@RefreshScope
@RestController
class MessageRestController(
@Value("\${message.get.enabled}") val getEnabled: Boolean,
@Value("\${message:Hello default}") val message: String
) {
@GetMapping("/message")
fun get(): String {
if (!getEnabled) {
throw NoHandlerFoundException("GET", "/message", null)
}
return message
}
}
还有其他使用Filter的替代方案：
@Component
class EndpointsAvailabilityFilter @Autowired constructor(
private val env: Environment
): OncePerRequestFilter() {
override fun doFilterInternal(
request: HttpServletRequest,
response: HttpServletResponse,
filterChain: FilterChain
) {
val requestURI = request.requestURI
val requestMethod = request.method
val property = "${requestURI.substring(1).replace("/", ".")}." +
"${requestMethod.toLowerCase()}.enabled"
val enabled = env.getProperty(property, "true")
if (!enabled.toBoolean()) {
throw NoHandlerFoundException(requestMethod, requestURI, ServletServerHttpRequest(request).headers)
}
filterChain.doFilter(request, response)
}
}
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping.isHandler(Class<?>)
@Override
protected boolean isHandler(Class<?> beanType) {
return (AnnotatedElementUtils.hasAnnotation(beanType, Controller.class) ||
AnnotatedElementUtils.hasAnnotation(beanType, RequestMapping.class));
}
@RequestMapping // Make Spring treat the bean as request handler
public class MyControllerA implements IMyController {
@RequestMapping(path = { "/path1" })
public .. restMethod1(...) {
........
}
}
@RequestMapping // Make Spring treat the bean as request handler
public class MyControllerB implements IMyController {
@RequestMapping(path = { "/path1" })
public .. restMethod1(...) {
........
}
}
@Configuration
public class ControllerConfiguration {
/**
*
* Programmatically register Controller based on certain condition.
*
*/
@Bean
public IMyController myController() {
IMyController controller;
if (conditionA) {
controller = new MyControllerA();
} else {
controller = new MyControllerB();
}
return controller;
}
}
isHandler方法只检查@Controller注解，所以如果没有@Controller注解，它将无法工作。 - undefined我猜这个问题是因为你在不同的环境中使用了不同的application.properties文件。在这种情况下，你可以使用Spring配置文件，并将配置分成不同的文件，以配置文件名后缀来区分不同的配置文件，例如：
application.properties:
spring.profiles.active=@activatedProperties@
application-local.properties:
//some config
application-prod.properties:
//some config
然后在您的构建参数中，您可以通过添加选项来指定正在构建的环境：
-Dspring.profiles.active= //<-put here profile local or prod
然后在您的应用程序中，您可以通过添加代码来启用/禁用任何Spring Bean：
@Profile("put here profile name")
比如说：
@RestController
@Profile("local")
@RequestMapping("/testApi")
public class RestForTesting{
//do some stuff
}
现在我的 RestForTesting 只会在我运行使用以下构建创建的时候才会被创建
-Dspring.profiles.active=local
@Profile注释没有任何作用。 - Joseph Tinoco
@ConditionalOnProperty，因为它比 SpEL 表达式评估稍微快一点。尝试使用@ConditionalOnProperty(prefix="my.controller", name="enabled")。 - Phil Webb