Flowable Form 用户手册 (v 6.8.1)

1
FormEngine formEngine = FormEngines.getDefaultFormEngine()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

  <bean id="formEngineConfiguration" class="org.flowable.dmn.engine.impl.cfg.StandaloneFormEngineConfiguration">

    <property name="jdbcUrl" value="jdbc:h2:mem:flowable;DB_CLOSE_DELAY=1000" />
    <property name="jdbcDriver" value="org.h2.Driver" />
    <property name="jdbcUsername" value="sa" />
    <property name="jdbcPassword" value="" />

    <property name="databaseSchemaUpdate" value="true" />

  </bean>

</beans>

1
2
3
4
5
6
FormEngineConfiguration.
  createFormEngineConfigurationFromResourceDefault();
  createFormEngineConfigurationFromResource(String resource);
  createFormEngineConfigurationFromResource(String resource, String beanName);
  createFormEngineConfigurationFromInputStream(InputStream inputStream);
  createFormEngineConfigurationFromInputStream(InputStream inputStream, String beanName);

1
2
FormEngineConfiguration.createStandaloneFormEngineConfiguration();
FormEngineConfiguration.createStandaloneInMemFormEngineConfiguration();

1
2
3
4
FormEngine formEngine = FormEngineConfiguration.createStandaloneInMemFormEngineConfiguration()
  .setDatabaseSchemaUpdate(FormEngineConfiguration.DB_SCHEMA_UPDATE_FALSE)
  .setJdbcUrl("jdbc:h2:mem:my-own-db;DB_CLOSE_DELAY=1000")
  .buildFormEngine();

1
 <bean id="formEngineConfiguration" class="org.flowable.form.engine.impl.cfg.StandaloneFormEngineConfiguration">

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
<bean id="processEngineConfiguration" class="org.flowable.engine.impl.cfg.StandaloneProcessEngineConfiguration">

    <property name="configurators">
      <list>
        <ref bean="formEngineConfigurator" />
      </list>
    </property>
    ...
</bean>

<bean id="formEngineConfiguration" class="org.flowable.form.engine.impl.cfg.StandaloneFormEngineConfiguration">
    <property name="jdbcUrl" value="jdbc:h2:mem:flowable;DB_CLOSE_DELAY=1000" />
    <property name="jdbcDriver" value="org.h2.Driver" />
    <property name="jdbcUsername" value="sa" />
    <property name="jdbcPassword" value="" />
</bean>

<bean id="formEngineConfigurator" class="org.flowable.form.engine.configurator.FormEngineConfigurator">
    <property name="formEngineConfiguration" ref="formEngineConfiguration" />
</bean>

1
2
3
4
<property name="jdbcUrl" value="jdbc:h2:mem:flowable_dmn;DB_CLOSE_DELAY=1000" />
<property name="jdbcDriver" value="org.h2.Driver" />
<property name="jdbcUsername" value="sa" />
<property name="jdbcPassword" value="" />

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" >
  <property name="driverClassName" value="com.mysql.jdbc.Driver" />
  <property name="url" value="jdbc:mysql://localhost:3306/flowable_dmn" />
  <property name="username" value="flowable" />
  <property name="password" value="flowable" />
  <property name="defaultAutoCommit" value="false" />
</bean>

<bean id="formEngineConfiguration" class="org.flowable.form.engine.impl.cfg.StandaloneFormEngineConfiguration">

    <property name="dataSource" ref="dataSource" />
    ...

1
2
3
4
5
6
7
8
9
<beans >

  <bean id="formEngineConfiguration" class="org.flowable.form.engine.impl.cfg.StandaloneFormEngineConfiguration">
    <!-- ... -->
    <property name="databaseSchemaUpdate" value="true" />
    <!-- ... -->
  </bean>

</beans>

1
<property name="formCacheLimit" value="10" />

1
2
3
<property name="formCache">
  <bean class="org.flowable.MyCache" />
</property>

1
2
3
4
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

1
2
3
4
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>jcl-over-slf4j</artifactId>
</dependency>

1
2
3
4
5
FormEngine formEngine = FormEngines.getDefaultFormEngine();
FormRuleService formRuleService = formEngine.getFormRuleService();
FormRepositoryService formRepositoryService = formEngine.getFormRepositoryService();
FormService formService = formEngine.getFormService();
FormManagementService formManagementService = formEngine.getFormManagementService();

1
2
3
4
List<FormDeployment> formDeployments = formRepositoryService.createDeploymentQuery()
    .deploymentNameLike("deployment%")
    .orderByDeployTime()
    .list();

1
2
3
4
5
6
7
8

long count = formRepositoryService.createNativeDeploymentQuery()
    .sql("SELECT count(*) FROM " + formManagementService.getTableName(FormDeploymentEntity.class) + " D1, "
        + formManagementService.getTableName(FormDefinitionEntity.class) + " D2 "
        + "WHERE D1.ID_ = D2.DEPLOYMENT_ID_ "
        + "AND D1.ID_ = #{deploymentId}")
    .parameter("deploymentId", deployment.getId())
    .count();

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@ExtendWith(FlowableFormExtension.class)
// 如果需要自定义表单配置，则应取消注释下面的部分
//@FormConfigurationResource("custom1.flowable.form.cfg.xml")
class MyFormDefinitionTest {

  private FormEngine formEngine;

  @BeforeEach
  void setUp(FormEngine formEngine) {
    this.formEngine = formEngine;
  }

  @Test
  @FormDeploymentAnnotation
  void formUsageExample() {
    FormService formService = formEngine.getFormService();

    FormInstance result = formService.getFormInstanceModelById(
        "f7689f79-f1cc-11e6-8549-acde48001122", null);

    Assertions.assertNotNull(result);
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
public class MyFormDefinitionTest {

  @Rule
  public FlowableFormRule flowableFormRule = new FlowableFormRule("custom1.flowable.form.cfg.xml");

  @Test
  @FormDeploymentAnnotation
  public void formUsageExample() {
    FormEngine formEngine = flowableFormRule.getFormEngine();
    FormService formService = dmnEngine.getFormService();

    FormInstance result = formService.getFormInstanceModelById(
        "f7689f79-f1cc-11e6-8549-acde48001122", null);

    Assert.assertNotNull(result));
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
public class FormEnginesServletContextListener implements ServletContextListener {

  public void contextInitialized(ServletContextEvent servletContextEvent) {
    FormEngines.init();
  }

  public void contextDestroyed(ServletContextEvent servletContextEvent) {
    FormEngines.destroy();
  }

}

1
FormEngines.getDefaultFormEngine()

1
FormEngines.getFormEngine("myName");

1
2
3
4
5
6
7
<bean id="formEngineConfiguration" class="org.flowable.form.spring.SpringFormEngineConfiguration">
    ...
</bean>

<bean id="formEngine" class="org.flowable.form.spring.FormEngineFactoryBean">
  <property name="formEngineConfiguration" ref="formEngineConfiguration" />
</bean>

1
2
3
4
5
6
7
8
9
<bean id="formEngineConfiguration" class="org.flowable.spring.SpringFormEngineConfiguration">
  ...
  <property name="deploymentResources"
    value="classpath*:/org/flowable/spring/test/autodeployment/autodeploy/*.form" />
</bean>

<bean id="formEngine" class="org.flowable.form.spring.FormEngineFactoryBean">
  <property name="formEngineConfiguration" ref="formEngineConfiguration" />
</bean>

1
2
3
4
5
6
<bean id="formEngineConfiguration"
    class="org.flowable.form.spring.SpringFormEngineConfiguration">
  ...
  <property name="deploymentResources" value="classpath*:/flowable/*.form" />
  <property name="deploymentMode" value="single-resource" />
</bean>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
@ExtendWith(FlowableFormSpringExtension.class)
@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = SpringJunitJupiterTest.TestConfiguration.class)
public class SpringJunit4Test {

    @Autowired
    private FormEngine formEngine;

    @Autowired
    private FormService formService;

    @Test
    @FormDeploymentAnnotation
    public void simpleFormInstanceTest() {
        FormInstance result = formService.getFormInstanceModelById(
            "f7689f79-f1cc-11e6-8549-acde48001122", null);

        Assertions.assertNotNull(result));
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:org/flowable/spring/test/junit4/springTypicalUsageTest-context.xml")
public class SpringJunit4Test {

    @Autowired
    private FormEngine formEngine;

    @Autowired
    private FormService formService;

    @Autowired
    @Rule
    public FlowableFormRule flowableSpringRule;

    @Test
    @FormDeploymentAnnotation
    public void simpleFormInstanceTest() {
        FormInstance result = formService.getFormInstanceModelById(
            "f7689f79-f1cc-11e6-8549-acde48001122", null);

        Assert.assertNotNull(result));
    }
}

1
2
3
<bean id="flowableFormRule" class="org.flowable.form.engine.test.FlowableFormRule">
    <property name="formEngine" ref="formEngine"/>
</bean>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
    "key": "form1",
    "name": "My first form",
    "fields": [
        {
            "id": "input1",
            "name": "Input1",
            "type": "text",
            "required": false,
            "placeholder": "empty"
        }
    ]
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
    "key": "form2",
    "name": "My second form",
    "fields": [
        {
            "id": "input2",
            "name": "Input2",
            "type": "text",
            "required": false,
            "placeholder": "empty"
        }
    ]
}

1
2
3
4
5
formRepository
    .createDeployment()
    .category("yourCategory")
    ...
    .deploy();

1
formRepository.setFormDefinitionCategory("e9c2a6c0-c085-11e6-9096-6ab56fad108a", "yourCategory");

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "key": "form1",
    "name": "My first form",
    "fields": [
        {
            "id": "input1",
            "name": "Input1",
            "type": "text",
            "required": false,
            "placeholder": "empty"
        }
    ],
    "outcomes": [
        {
            "id": "null",
            "name": "Accept"
        },
        {
            "id": "null",
            "name": "Reject"
        }
    ]
}