简介
npm 是目前最流行的 JavaScript 包管理器之一。pumlhorse-express 是用于在 Express 应用程序中使用 Pumlhorse 的中间件，Pumlhorse 是一个功能强大的流程引擎。本文将介绍如何使用 pumlhorse-express 中间件。
安装
使用 npm 安装 pumlhorse-express，如下所示：
npm install pumlhorse-express
使用
使用 pumlhorse-express 中间件的基本结构如下：
const express = require('express')
const { pumlhorse } = require('pumlhorse-express')
const app = express()
app.use('/api', pumlhorse({filePath: './api.puml'}))
app.listen(3000)其中， pumlhorse 函数接受一个配置对象 options 作为参数：
filePath: 必需。指定 Pumlhorse 文件的路径。相对路径或绝对路径。
通过 app.use 将 pumlhorse-express 中间件添加到 Express 应用程序中。
在你的 Pumlhorse 文件中，你将创建流程以及使用任务库。
创建流程
在 pumlhorse 文件中创建流程时，如下所示：
@startuml
title Get User Information
* -> {Start} : Start
{Start} -> get_user_info: get user info
get_user_info -> check_user_info: check user info
check_user_info -> end_user_info : end user info
end_user_info -> * : End
@enduml以上的 Pumlhorse 文件定义了名为 "Get User Information" 的流程，包括从 Start 到 End 的三个任务。
任务
创建任务库的方式是在 /src 目录下创建 Js 文件，例如 getUserInfo.js。然后以下面的例子编写函数：
module.exports = async () => {
// your code
}该函数可以使用 ES module，例如：
import axios from 'axios'
const getUserInfo = async () => {
const response = await axios.get('https://api.github.com/users/petehunt')
return response.data
}
export default getUserInfo让我们返回到流程中并使用上述任务：
-- -------------------- ---- ------- --------- ----- --- ---- ----------- - -- ------- - ----- ------- -- ------------- ------------- -- --------------- --------------- -- ------------- - --- ---- ---- ------------- -- - - --- --- --------- ----- - --------- ----- ----- --------------- ----------------- --- - --- -------
保存后重新启动您的 Express 应用程序，您的用户信息应该会在 https://api.github.com/users/petehunt 上得到。
更多配置
你可以通过更多配置来使用 pumlhorse-express：
db: 非必需。一个方法，它用于在执行流程期间将得到的数据保存到数据库中。方法应该返回一个 promise。logger: 非必需。一个方法，它用于日志记录。
示例代码
-- -------------------- ---- ------- ----- ------- - ------------------ ----- - --------- - - ---------------------------- ----- --- - --------- ----- -- - ------ - -- ---- ---- -- -------- ---- - ----- ------ - --------- -- - -------------------- - --------------- ----------- --------- ------------- --- ------ --- ----------------
总结
本文介绍了如何使用 pumlhorse-express 中间件来执行流程，并包含了示例代码。通过这个例子，你可以了解到如何将 pumlhorse 与 Express 应用程序结合使用，以及如何在 Pumlhorse 文件中创建流程和任务库。
注意，Pumlhorse 是一个功能强大的流程引擎，当你掌握更多知识后，你可以根据自己的业务需求进行更多的定制化。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600558e181e8991b448d630f