集成新版(5.17+)Activiti Modeler与Rest服务-白红宇

声明：

此教程适合Activiti 5.17+版本。

本博客所涉及的内容均可在中找到。

在线demo可以访问菜单路径：管理模块 -> 流程管理 -> 模型工作区，可以『创建』或者『编辑』模型

1. 简介

上一篇介绍整合Activiti Modeler已经有2年多时间了，自从Activiti 5.17版本发布以后该教程已经不适用了，很多网友也反馈不知道怎么把Activiti Modeler整合到自己的项目中去，为此抽时间为适配5.17+版本的集成方法整理成这篇博文，希望对有需求的网友有帮助。

最新版本的kft-activiti-demo已经使用了5.17+版本的Activiti，并且集成了最新的Activiti Modeler组件，可以下载最新源码：。

1.1 新版Activiti Modeler特性

先来欣赏一下新版的界面，相比上一版漂亮了许多，调性高了~~~

新版Activiti Modeler

界面布局：上（工具区）、左（组件类目）、右（工作区）、右下（属性区）

Activiti Modeler内部的实现上还是以oryx为图形组件为内核，用angular.js作为界面基本元素的基础组件以及调度oryx的API。

2. 官方Activiti Explorer的集成方式

先从Github下载官方Activiti源码，地址：。

2.1 Activiti Exploer的内部结构-Java

源码目录（如果是zip下载请先解压缩）中找到modules/activiti-webapp-explorer2/src/main子目录，结构如下：

├── assembly├── java│   └── org│       └── activiti├── resources│   └── org│       └── activiti└── webapp    ├── META-INF    ├── VAADIN    │   ├── themes    │   └── widgetsets    ├── WEB-INF    ├── diagram-viewer    │   ├── images    │   └── js    └── editor-app        ├── configuration        ├── css        ├── editor        ├── fonts        ├── i18n        ├── images        ├── libs        ├── partials        ├── popups        └── stencilsets

我们需要关注的目录是webapp/editor-app，以及java/org/activiti，目录结构：

Activiti Explorer源码目录

新版本的Activiti Explorer放弃了XML方式的配置方式，采用Bean Configuration的方式代替，上图中org/activiti/explorer/conf包中就是各种配置，在org/activiti/explorer/servlet/WebConfigurer类用Servlet 3.0方式配置Servlet映射关系，映射的路径为/service/*。

2.2 Activiti Exploer的内部结构-Web

新版本Activiti Modeler的Web资源不再像旧版那么散乱，新版本只需要关注：

src/main/webapp/editor-app：目录中包含设计器里面所有的资源：angular.js、oryx.js以及配套的插件及css

src/main/webapp/modeler.html：设计器的主页面，用来引入各种web资源

src/main/resources/stencilset.json: bpmn标准里面各种组件的json定义，editor以import使用。

3. 整合到自己的项目中

了解过网友的需求不知道如何整合新版Activiti Modeler的原因有两个：

不知道怎么把注解的方式转换为XML方式

和自己应用的整合参数配置

3.1 Activiti Rest接口与Spring MVC配置

3.1.1 Maven依赖

Activiti Modeler对后台服务的调用通过Spring MVC方式实现，所有的Rest资源统一使用注解RestController标注，所以在整合到自己项目的时候需要依赖Spring MVC，Modeler模块使用的后台服务都存放在activiti-modeler模块中，在自己的项目中添加依赖：


        
     
      org.activiti
         
     
      activiti-modeler
         
     
      5.19.0
     
    
        
     
      org.activiti
         
     
      activiti-diagram-rest
         
     
      5.19.0

模块作用：

activiti-modeler模块提供模型先关的操作：创建、保存、转换json与xml格式等

activiti-diagram-rest模块用来处理流程图有关的功能：流程图布局（layout）、节点高亮等

3.1.2 准备基础服务类

复制文件(https://github.com/henryyan/kft-activiti-demo/tree/master/src/main/java/org/activiti/explorer) 里面的java文件到自己项目中。

3.1.3 Activiti Spring配置

创建文件src/main/resources/beans/beans-activiti.xml定义Activiti引擎的beans：

在spring初始化的时候引入即可，例如在web.xml中使用通配符方式：


        
     
      contextConfigLocation
         
     
      classpath*:/beans/beans-*.xml

3.1.4 Spring MVC配置

创建文件WEB-INF/spring-mvc-modeler.xml，内容如下：

上面XML中告知spring mvc扫描路径为**

3.1.5 web.xml中配置Servlet服务

在web.xml中配置下面的Servlet：


        
     
      ModelRestServlet
         
     
      org.springframework.web.servlet.DispatcherServlet
         
             
      
       contextConfigLocation
              
      
       /WEB-INF/spring-mvc-modeler.xml
          
         
     
      1
     
    
        
     
      ModelRestServlet
         
     
      /service/*

3.1.6 模型设计器的Web资源

直接从Activiti Explorer中复制文件modeler.html文件到src/main/webapp目录即可，该文件会引入定义基本的布局（div）、引入css以及js文件。

修改editor-app/app-cfg.js文件的contextRoot属性为自己的应用名称，例如/kft-activiti-demo/service

3.1.7 模型控制器

在中已经介绍过ModelController类的作用了，这里需要在基础上稍微做一点调整：

create方法中在创建完Model后跳转页面由service/editor?id=改为modeler.html?modelId=

当从模型列表编辑某一个模型时也需要把路径修改为modeler.html?modelId=

4. 整合Activiti Rest

有了Activiti Modeler的基础只需要依葫芦画瓢即可。

4.1 Maven依赖


        
     
      org.activiti
         
     
      activiti-rest
         
     
      5.19.0

4.3 Activiti组件包扫描

文件src/main/resources/beans/beans-activiti.xmlcontext:component-scan标签的base-package属性中添加org.activiti.rest.service包，包里面包含了所有Rest API的接口Rest Controller。

4.4 添加Rest安全认证组件

package org.activiti.conf;import org.activiti.rest.security.BasicAuthenticationProvider;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.security.authentication.AuthenticationProvider;import org.springframework.security.config.annotation.web.builders.HttpSecurity;import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;import org.springframework.security.config.annotation.web.servlet.configuration.EnableWebMvcSecurity;import org.springframework.security.config.http.SessionCreationPolicy;@Configuration@EnableWebSecurity@EnableWebMvcSecuritypublic class SecurityConfiguration extends WebSecurityConfigurerAdapter {    @Bean    public AuthenticationProvider authenticationProvider() {        return new BasicAuthenticationProvider();    }    @Override    protected void configure(HttpSecurity http) throws Exception {        http.authenticationProvider(authenticationProvider())            .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS).and()            .csrf().disable()            .authorizeRequests()            .anyRequest().authenticated()            .and()            .httpBasic();    }}

4.5 spring mvc配置文件

创建文件WEB-INF/spring-mvc-rest.xml：

4.6 配置Servlet映射


        
     
      RestServlet
         
     
      org.springframework.web.servlet.DispatcherServlet
         
             
      
       contextConfigLocation
              
      
       /WEB-INF/spring-mvc-rest.xml
          
         
     
      1
     
    
        
     
      RestServlet
         
     
      /rest/*

4.7 访问Rest接口

现在启动应用可以访问 http://localhost:8080/your-app/rest/management/properties 以Rest方式查看引擎的属性列表，如果在网页中访问会提示输入用户名密码；也可以访问在线demo测试