18. 系统设置
本章向您展示如何在任何Web环境中设置Web Flow系统以供使用。
18.1. Java 配置和 XML 命名空间
Web Flow 提供了对基于 Java 和 XML 的配置的专用配置支持。
要开始使用基于 XML 的配置，请按如下方式声明 webflow 配置 XML 命名空间：
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:webflow="http://www.springframework.org/schema/webflow-config"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/webflow-config
https://www.springframework.org/schema/webflow-config/spring-webflow-config.xsd">
<!-- Setup Web Flow here -->
</beans>要开始使用 Java 配置，请在 @Configuration 类中扩展 AbstractFlowConfiguration，如下所示：
@Configuration
public class WebFlowConfig extends AbstractFlowConfiguration {
}
18.2. 基本系统配置
接下来的两部分展示了在您的应用程序中设置 Web Flow 系统所需的最低配置：
18.2.1. 注册一个FlowRegistry
您可以在XML中的FlowRegistry注册您的流程，如下所示：
<webflow:flow-registry id="flowRegistry">
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" />
</webflow:flow-registry>你可以通过以下方式在 Java 中的 FlowRegistry 注册你的流程：
@Bean
public FlowDefinitionRegistry flowRegistry() {
return getFlowDefinitionRegistryBuilder()
.addFlowLocation("/WEB-INF/flows/booking/booking.xml")
.build();
}
18.2.2. 部署一个 FlowExecutor
你可以按照以下方式部署一个FlowExecutor，它是用于在XML中执行流的核心服务：
<webflow:flow-executor id="flowExecutor" />您可以部署一个FlowExecutor，这是用于在 Java 中执行流的核心服务：
@Bean
public FlowExecutor flowExecutor() {
return getFlowExecutorBuilder(flowRegistry()).build();
}
查看本指南的Spring MVC 集成和JSF 集成部分，了解如何分别将 Web Flow 系统与 MVC 和 JSF 环境集成。
18.3. flow-registry选项
本节探讨 flow-registry 的配置选项。
18.3.1. 指定流程位置
您可以使用 location 元素来指定要注册的流程定义的路径。 默认情况下，除非定义了注册表基本路径（请参阅 流程位置基本路径），否则流程的注册表标识符等于其文件名减去文件扩展名。
以下示例指定了 XML 中的流位置：
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" />以下示例指定了 Java 中的流程位置：
return getFlowDefinitionRegistryBuilder()
.addFlowLocation("/WEB-INF/flows/booking/booking.xml")
.build();
18.3.2. 分配自定义流程标识符
您可以指定一个ID，为流程分配自定义的注册表标识符。
以下示例展示了如何在 XML 中分配自定义流程标识符：
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" id="bookHotel" />以下示例展示了如何在 Java 中分配自定义流程标识符：
return getFlowDefinitionRegistryBuilder()
.addFlowLocation("/WEB-INF/flows/booking/booking.xml", "bookHotel")
.build();
18.3.3. 分配流元属性
您可以使用 flow-definition-attributes 元素为已注册的流分配自定义元属性。
以下示例展示了如何在 XML 中分配流元属性：
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml">
<webflow:flow-definition-attributes>
<webflow:attribute name="caption" value="Books a hotel" />
</webflow:flow-definition-attributes>
</webflow:flow-location>以下示例展示了如何在 Java 中分配流元属性：
Map<String, Object> attrs = ... ;
return getFlowDefinitionRegistryBuilder()
.addFlowLocation("/WEB-INF/flows/booking/booking.xml", null, attrs)
.build();
18.3.4. 使用位置模式注册流程
您可以使用 flow-location-patterns 元素注册与特定资源位置模式匹配的流。
以下示例展示了如何在 XML 中注册一个流程：
<webflow:flow-location-pattern value="/WEB-INF/flows/**/*-flow.xml" />以下示例展示了如何在 Java 中注册一个流程：
return getFlowDefinitionRegistryBuilder()
.addFlowLocationPattern("/WEB-INF/flows...
.build();
18.3.5. 流程位置基础路径
您可以使用 base-path 属性为应用程序中的所有流定义一个基础位置。 所有流的位置都相对于该基础路径。 基础路径可以是资源路径（例如 /WEB-INF）或类路径上的位置（例如 classpath:org/springframework/webflow/samples）。
以下示例显示了如何在 XML 中设置基础路径：
<webflow:flow-registry id="flowRegistry" base-path="/WEB-INF">
<webflow:flow-location path="/hotels/booking/booking.xml" />
</webflow:flow-registry>以下示例展示了如何在 Java 中设置基础路径：
return getFlowDefinitionRegistryBuilder()
.setBasePath("/WEB-INF")
.addFlowLocationPattern("/hotels/booking/booking.xml")
.build();
定义基础路径后，分配流标识符的算法会略有变化。 流现在被分配的注册表标识符等于它们的基础路径和文件名之间的路径段。 例如，如果某个流定义位于 /WEB-INF/hotels/booking/booking-flow.xml，而基础路径是 /WEB-INF，那么到该流的剩余路径为 hotels/booking，这将成为流 ID。
为每个流程定义创建一个目录 将每个流程定义打包到一个唯一的目录中是一种最佳实践。 这样做可以提高模块化程度，让依赖的资源能够与流程定义一起打包。 当使用约定时，还可以防止两个流程拥有相同的标识符。 |
如果没有指定基础路径，或者流程定义直接位于基础路径上，则会使用从文件名（去掉扩展名）派生的流程ID。 例如，如果一个流程定义文件是booking.xml，那么流程标识符就简单地是booking。
位置模式在与注册表基础路径结合使用时特别强大。 而不是让流程标识符成为 *-flow，而是基于目录路径。 以下示例展示了如何在 XML 中将基础路径与流程位置模式结合起来：
<webflow:flow-registry id="flowRegistry" base-path="/WEB-INF">
<webflow:flow-location-pattern value="/**/*-flow.xml" />
</webflow:flow-registry>以下示例展示了如何在 Java 中将基础路径与流位置模式结合使用：
return getFlowDefinitionRegistryBuilder()
.setBasePath("/WEB-INF")
.addFlowLocationPattern("...
.build();
在前面的示例中，假设您在WEB-INF目录内的/user/login、/user/registration、/hotels/booking和/flights/booking目录中存在流。 那么最终会得到流ID分别为user/login、user/registration、hotels/booking和flights/booking。
18.3.6. 配置 FlowRegistry 层次结构
您可以使用 parent 属性将两个流注册表通过层次结构链接在一起。 当查询子注册表时，如果找不到请求的流，它会委托给其父注册表。
以下示例在 XML 中为两个流注册表建立了父子关系：
<!-- my-system-config.xml -->
<webflow:flow-registry id="flowRegistry" parent="sharedFlowRegistry">
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" />
</webflow:flow-registry>
<!-- shared-config.xml -->
<webflow:flow-registry id="sharedFlowRegistry">
<!-- Global flows shared by several applications -->
</webflow:flow-registry>以下示例为 Java 中的两个流注册表建立了父级关系：
@Configuration
public class WebFlowConfig extends AbstractFlowConfiguration {
@Autowired
private SharedConfig sharedConfig;
@Bean
public FlowDefinitionRegistry flowRegistry() {
return getFlowDefinitionRegistryBuilder()
.setParent(this.sharedConfig.sharedFlowRegistry())
.addFlowLocation("/WEB-INF/flows/booking/booking.xml")
.build();
}
}
@Configuration
public class SharedConfig extends AbstractFlowConfiguration {
@Bean
public FlowDefinitionRegistry sharedFlowRegistry() {
return getFlowDefinitionRegistryBuilder()
.addFlowLocation("/WEB-INF/flows/shared.xml")
.build();
}
}
18.3.7. 配置自定义FlowBuilder服务
您可以使用flow-builder-services属性（在XML中）或FlowBuilderServices对象（在Java中）来自定义用于在flow-registry中构建流程的服务和设置。 如果未指定flow-builder-services元素，则使用默认的服务实现。 当指定了该元素时，您只需引用想要自定义的服务即可。
以下示例显示了如何在 XML 中创建自定义流程构建器服务：
<webflow:flow-registry id="flowRegistry" flow-builder-services="flowBuilderServices">
<webflow:flow-location path="/WEB-INF/flows/booking/booking.xml" />
</webflow:flow-registry>
<webflow:flow-builder-services id="flowBuilderServices" />以下示例展示了如何在 Java 中创建自定义的流程构建器服务：
@Bean
public FlowDefinitionRegistry flowRegistry() {
return getFlowDefinitionRegistryBuilder(flowBuilderServices())
.addFlowLocation("/WEB-INF/flows/booking/booking.xml")
.build();
}
@Bean
public FlowBuilderServices flowBuilderServices() {
return getFlowBuilderServicesBuilder().build();
}
可配置的服务包括conversion-service、expression-parser和view-factory-creator元素（在XML中）以及ConversionService、ExpressionParser和ViewFactoryCreator接口（在Java中）。这些服务通过引用您必须定义的自定义bean来进行配置。
以下示例展示了如何在 XML 中定义可配置的服务：
<webflow:flow-builder-services id="flowBuilderServices"
conversion-service="conversionService"
expression-parser="expressionParser"
view-factory-creator="viewFactoryCreator" />
<bean id="conversionService" class="..." />
<bean id="expressionParser" class="..." />
<bean id="viewFactoryCreator" class="..." />以下示例展示了如何在 Java 中定义可配置的服务：
@Bean
public FlowBuilderServices flowBuilderServices() {
return getFlowBuilderServicesBuilder()
.setConversionService(conversionService())
.setExpressionParser(expressionParser)
.setViewFactoryCreator(mvcViewFactoryCreator())
.build();
}
@Bean
public ConversionService conversionService() {
// ...
}
@Bean
public ExpressionParser expressionParser() {
// ...
}
@Bean
public ViewFactoryCreator viewFactoryCreator() {
// ...
}
使用转换服务
您可以使用 conversion-service 属性（在 XML 中）或 ConversionService 接口（在 Java 中）来自定义 Web Flow 系统使用的 ConversionService。 类型转换在流执行期间需要时用于将一种类型转换为另一种类型，例如处理请求参数、调用操作等。 许多常见的对象类型（如数字、类和枚举）都受支持。 但是，您可能需要为自定义数据类型提供自己的类型转换和格式化逻辑。 请参阅 执行类型转换 以获取有关如何提供自定义类型转换逻辑的重要信息。
使用表达式解析器
您可以使用expression-parser属性（在XML中）或ExpressionParser接口（在Java中）来自定义Web Flow系统使用的ExpressionParser。 默认的ExpressionParser会在类路径中可用的情况下使用统一表达式语言（Unified Expression Language）。 否则，它将使用Spring表达式语言。
18.4. 设置流执行器选项
本节探讨流执行器的配置选项。
18.4.1. 附加流执行监听器
您可以使用 flow-execution-listeners 元素（在 XML 中）或 addFlowExecutionListener 方法（在 Java 中）来注册监听器，以观察流执行的生命周期。
以下示例展示了如何在 XML 中创建流执行监听器：
<webflow:flow-execution-listeners>
<webflow:listener ref="securityListener"/>
<webflow:listener ref="persistenceListener"/>
</webflow:flow-execution-listeners>以下示例展示了如何在 Java 中创建流执行监听器：
@Bean
public FlowExecutor flowExecutor() {
return getFlowExecutorBuilder(flowRegistry())
.addFlowExecutionListener(securityListener())
.addFlowExecutionListener(persistenceListener())
.build();
}
您还可以配置一个监听器来仅观察特定的流程。
以下示例展示了如何在 XML 中配置监听器以仅监控两个流程：
<webflow:listener ref="securityListener" criteria="securedFlow1,securedFlow2"/>以下示例展示了如何在 Java 中配置监听器以仅监控两个流：
@Bean
public FlowExecutor flowExecutor() {
return getFlowExecutorBuilder(flowRegistry())
.addFlowExecutionListener(securityListener(), "securedFlow1,securedFlow2")
.build();
}
18.4.2. 调整流执行持久化
您可以使用 flow-execution-repository 元素（在 XML 中）或 FlowExecutor 接口（在 Java 中）来调整流执行持久化设置。
以下示例展示了如何在 XML 中调整流执行：
<webflow:flow-executor id="flowExecutor" flow-registry="flowRegistry">
<webflow:flow-execution-repository max-executions="5" max-execution-snapshots="30" />
</webflow:flow-executor>以下示例调整了 Java 中的流执行：
@Bean
public FlowExecutor flowExecutor() {
return getFlowExecutorBuilder(flowRegistry())
.setMaxFlowExecutions(5)
.setMaxFlowExecutionSnapshots(30)
.build();
}