ApiFlow

Appearance

ApiFlow Engine - 基础配置 ​

Version: 0.1.0.alpha

基础配置 ​

当您准备创建自己的工作流项目或需要自定义配置时，本节将指导您完成基础配置。

配置文件位置 ​

主配置文件位于：

apiFlow-1.0.0/config/application.properties

核心配置项说明 ​

打开 config/application.properties，您会看到以下主要配置项：

1. 工作流项目路径（必填） ​

properties
# 工作流项目路径（必填）可填绝对路径或相对路径
project.home=examples/base_example

使用场景：

  • 场景 1： 您自己创建了一个工作流项目
  • 场景 2： 从 GitHub 等平台 clone 了一个工作流项目
  • 场景 3： 您有多个工作流项目，需要切换运行

配置方式：

properties
# 相对路径（相对于 apiFlow-1.0.0 目录）
project.home=my-workflow-project

# 绝对路径
project.home=/Users/tommy/workflows/my-project
# Windows 示例
# project.home=C:/Users/tommy/workflows/my-project

2. 服务端口 ​

properties
# 服务端口
server.port=8824

使用场景：

  • 端口被占用需要更换
  • 同一服务器运行多个 ApiFlow 实例
  • 企业内部规范要求特定端口

配置示例：

properties
server.port=9090

修改后，工作流访问地址也会相应变化：http://127.0.0.1:9090/api/welcome

3. Webhook 配置 ​

properties
# webhook 前缀
webhook.path=/api
# 外部回调 webhook 的地址
webhook.address=http://127.0.0.1:${server.port}/${webhook.path}

使用场景：

  • 修改 webhook URL 路径前缀
  • 配置外部可访问的回调地址（如公网 IP、域名）

配置示例：

properties
webhook.path=/hooks
webhook.address=https://api.example.com/hooks

4. 异步任务配置 ​

properties
# 异步任务执行器配置
async.corePoolSize=10
async.maximumPoolSize=50

# 定时任务线程池数量
cron.poolSize=5

使用场景： 根据服务器性能和工作流并发量调整线程池大小。

5. 监控管理端口 ​

properties
# 管理端口（0表示随机端口）
management.server.port=0
# 启用的监控端点
management.endpoints.web.exposure.include=health,info,workflow,shutdown

使用场景： 健康检查、监控集成、运维管理（详见"运维操作"章节）。

查看日志排查问题 ​

日志文件位置：

apiFlow-1.0.0/logs/
├── apiflow.log      # 主应用日志
└── startup.log      # 启动日志（仅守护进程模式）

实时查看日志：

bash
# 实时输出日志（Unix/Linux/macOS）
tail -f logs/apiflow.log

# 查看最近 100 行
tail -n 100 logs/apiflow.log

# Windows PowerShell
Get-Content logs\apiflow.log -Tail 100 -Wait

常见日志排查点：

  1. 工作流加载失败： 查找 Failed to load workflow 或 SyntaxError
  2. 端口占用： 查找 Port 8824 was already in use
  3. 配置错误： 查找 Failed to initialize
  4. 应用连接失败： 查找数据库、HTTP 连接错误信息

日志级别配置：

如需调整日志级别，编辑 config/logback-spring.xml：

xml
<logger name="org.apiFlow" level="DEBUG"/>

下一步： 进阶部署 - 学习生产环境推荐的部署方式（系统目录与工作流目录分离）