可以使用属性启用/禁用spring boot@RestController吗？

Question

给定一个带有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);
    }
}

如果/除非某个应用程序属性存在/不存在，是否有注释或技术可以阻止endpoint启动。

注意：测试方法内部的属性并分解不是解决方案，因为endpoint将存在。

我不关心粒度：即只启用/禁用一个方法或整个类都可以。

因为概要文件不是属性，所以通过概要文件进行控制并不能解决我的问题。

Answer 1

在某些情况下，@ConditionalOnXXX无法工作，例如，依赖另一个bean实例来检查条件。（XXXCondition类无法调用bean）。

在这种情况下，请在Java配置文件中注册控制器。

请参阅源代码（Spring webmvc 5.1.6）：

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));
       }

应该在类型级别为控制器bean添加@RequestMapping注释。请参见：

@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;
    }
}

Answer 2

在此添加此问题和另一个问题。

这是我的答案：

我实际上会使用@ReFresScope 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
    }
}

使用过滤器还有其他选择：

@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)
    }
}

My Github解释如何在运行时禁用

Answer 3

我使用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，则组件将启动，否则不会启动。