函数式 Bean 定义

Spring Cloud Function 支持用于小型应用程序的“函数式”bean声明方式,这些应用程序需要快速启动。函数式bean声明是 Spring Framework 5.0 的一项功能,在 5.1 中进行了重大改进。

比较函数式与传统的 Bean 定义

这是一个使用熟悉的@Configuration@Bean声明风格的普通 Spring Cloud Function 应用程序。

@SpringBootApplication
public class DemoApplication {

  @Bean
  public Function<String, String> uppercase() {
    return value -> value.toUpperCase();
  }

  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }

}

现在来看函数式 bean:用户应用程序代码可以重铸成“函数式”形式,如下所示

@SpringBootConfiguration
public class DemoApplication implements ApplicationContextInitializer<GenericApplicationContext> {

  public static void main(String[] args) {
    FunctionalSpringApplication.run(DemoApplication.class, args);
  }

  public Function<String, String> uppercase() {
    return value -> value.toUpperCase();
  }

  @Override
  public void initialize(GenericApplicationContext context) {
    context.registerBean("demo", FunctionRegistration.class,
        () -> new FunctionRegistration<>(uppercase())
            .type(FunctionTypeUtils.functionType(String.class, String.class)));
  }

}

主要区别在于:

  • 主类是一个ApplicationContextInitializer

  • @Bean方法已转换为对context.registerBean()的调用。

  • @SpringBootApplication已被替换为@SpringBootConfiguration,表示我们没有启用 Spring Boot 自动配置,但仍然将该类标记为“入口点”。

  • Spring Boot 的SpringApplication已被 Spring Cloud Function 的FunctionalSpringApplication替换(它是其子类)。

在 Spring Cloud Function 应用程序中注册的业务逻辑 bean 类型为FunctionRegistration。这是一个包装器,包含函数以及有关输入和输出类型的信息。在应用程序的@Bean形式中,可以反射地导出该信息,但在函数式 bean 注册中,除非我们使用FunctionRegistration,否则其中一些信息会丢失。

使用ApplicationContextInitializerFunctionRegistration的另一种方法是使应用程序本身实现Function(或ConsumerSupplier)。示例(等同于上述内容)

@SpringBootConfiguration
public class DemoApplication implements Function<String, String> {

  public static void main(String[] args) {
    FunctionalSpringApplication.run(DemoApplication.class, args);
  }

  @Override
  public String apply(String value) {
    return value.toUpperCase();
  }

}

如果您添加一个单独的、独立的Function类型类并使用run()方法的替代形式使用SpringApplication注册它,它也可以工作。主要的是泛型类型信息通过类声明在运行时可用。

假设您有

@Component
public class CustomFunction implements Function<Flux<Foo>, Flux<Bar>> {
	@Override
	public Flux<Bar> apply(Flux<Foo> flux) {
		return flux.map(foo -> new Bar("This is a Bar object from Foo value: " + foo.getValue()));
	}

}

您可以这样注册它

@Override
public void initialize(GenericApplicationContext context) {
		context.registerBean("function", FunctionRegistration.class,
				() -> new FunctionRegistration<>(new CustomFunction()).type(CustomFunction.class));
}

函数式 Bean 声明的局限性

大多数 Spring Cloud Function 应用程序的范围与整个 Spring Boot 相比相对较小,因此我们可以轻松地将其适应这些函数式 bean 定义。如果您超出该有限范围,可以通过切换回@Bean样式配置或使用混合方法来扩展您的 Spring Cloud Function 应用程序。例如,如果您想利用 Spring Boot 自动配置与外部数据存储的集成,则需要使用@EnableAutoConfiguration。如果您愿意,您的函数仍然可以使用函数式声明进行定义(即“混合”样式),但在这种情况下,您需要使用spring.functional.enabled=false显式关闭“完全函数式模式”,以便 Spring Boot 可以重新控制。

函数可视化和控制

Spring Cloud Function 支持通过 Actuator 端点以及编程方式可视化FunctionCatalog中可用的函数。

编程方式

要以编程方式查看应用程序上下文中的可用函数,您只需要访问FunctionCatalog。在那里,您可以找到获取目录大小、查找函数以及列出所有可用函数名称的方法。

例如:

FunctionCatalog functionCatalog = context.getBean(FunctionCatalog.class);
int size = functionCatalog.size(); // will tell you how many functions available in catalog
Set<String> names = functionCatalog.getNames(null); will list the names of all the Function, Suppliers and Consumers available in catalog
. . .

Actuator

由于 Actuator 和 Web 是可选的,您必须首先添加一个 Web 依赖项,然后手动添加 Actuator 依赖项。以下示例显示如何添加 Web 框架的依赖项

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
</dependency>

以下示例显示如何添加 WebFlux 框架的依赖项

<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

您可以按如下方式添加 Actuator 依赖项

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

您还必须通过设置以下属性来启用functions Actuator 端点:--management.endpoints.web.exposure.include=functions

访问以下 URL 查看 FunctionCatalog 中的函数:<host>:<port>/actuator/functions

例如:

curl https://127.0.0.1:8080/actuator/functions

您的输出应该如下所示

{"charCounter":
	{"type":"FUNCTION","input-type":"string","output-type":"integer"},
 "logger":
 	{"type":"CONSUMER","input-type":"string"},
 "functionRouter":
 	{"type":"FUNCTION","input-type":"object","output-type":"object"},
 "words":
 	{"type":"SUPPLIER","output-type":"string"}. . .

测试函数式应用程序

Spring Cloud Function 还提供了一些集成测试实用程序,Spring Boot 用户会非常熟悉这些实用程序。

假设这是您的应用程序

@SpringBootApplication
public class SampleFunctionApplication {

    public static void main(String[] args) {
        SpringApplication.run(SampleFunctionApplication.class, args);
    }

    @Bean
    public Function<String, String> uppercase() {
        return v -> v.toUpperCase();
    }
}

这是包装此应用程序的 HTTP 服务器的集成测试

@SpringBootTest(classes = SampleFunctionApplication.class,
            webEnvironment = WebEnvironment.RANDOM_PORT)
public class WebFunctionTests {

    @Autowired
    private TestRestTemplate rest;

    @Test
    public void test() throws Exception {
        ResponseEntity<String> result = this.rest.exchange(
            RequestEntity.post(new URI("/uppercase")).body("hello"), String.class);
        System.out.println(result.getBody());
    }
}

或者当使用函数 bean 定义样式时

@FunctionalSpringBootTest
public class WebFunctionTests {

    @Autowired
    private TestRestTemplate rest;

    @Test
    public void test() throws Exception {
        ResponseEntity<String> result = this.rest.exchange(
            RequestEntity.post(new URI("/uppercase")).body("hello"), String.class);
        System.out.println(result.getBody());
    }
}

此测试与您为同一应用程序的@Bean版本编写的测试几乎相同——唯一的区别是使用了@FunctionalSpringBootTest注释,而不是常规的@SpringBootTest。所有其他部分,如@Autowired TestRestTemplate,都是标准的 Spring Boot 功能。

为了帮助正确依赖,以下是 POM 中的摘录

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    . . . .
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-function-web</artifactId>
        <version>4.1.3</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

或者您可以使用仅FunctionCatalog编写非 HTTP 应用程序的测试。例如

@FunctionalSpringBootTest
public class FunctionalTests {

	@Autowired
	private FunctionCatalog catalog;

	@Test
	public void words() {
		Function<String, String> function = catalog.lookup(Function.class,
				"uppercase");
		assertThat(function.apply("hello")).isEqualTo("HELLO");
	}

}