函数式 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，部分信息会丢失。

除了使用 ApplicationContextInitializer 和 FunctionRegistration 外，另一种方法是让应用程序本身实现 Function（或 Consumer 或 Supplier）。例如（等同于上面）

@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 类型类，并使用 SpringApplication 的另一种 run() 方法形式注册它，这也将奏效。关键是泛型类型信息必须在运行时通过类声明可用。

假设你有

@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 http://localhost: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.2.2</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");
	}

}