Activiti Cloud Query (JPA) 镜像文档

1. 镜像概述和主要用途

Activiti Cloud Query Service 的 JPA 实现。该服务使用关系型数据库存储 Runtime Bundles（运行时包）发出的事件，以高效方式支持读取和查询操作。作为参考实现，鼓励用户根据特定领域需求进行修改和定制。

此服务基于 activiti-cloud-starter-query 模块构建，开发者可像使用其他 Spring Boot Starter 一样，基于该模块创建自定义版本的查询服务。

2. 核心功能和特性

JPA 数据存储：采用 JPA（Java Persistence API）与关系型数据库交互，高效存储流程事件数据
可扩展性：基于 Spring Boot Starter 构建，支持通过自定义实现扩展功能
事件消费与存储：消费流程引擎事件（如流程实例启动、任务完成等）并持久化到数据库
查询接口：提供标准化接口，支持查询流程实例、任务、变量等事件数据
微服务兼容：符合 Activiti Cloud 微服务架构，可与其他 Activiti Cloud 组件无缝集成

3. 使用场景和适用范围

流程事件查询：需要查询历史或实时流程事件数据（如流程状态、任务分配、变量变更等）的场景
流程监控与审计：企业流程管理中的监控面板、审计追踪需求
报表生成：基于流程事件数据生成自定义业务报表
自定义扩展：作为基础服务，通过扩展 activiti-cloud-starter-query 模块构建特定领域的查询服务

4. 构建与运行

4.1 从源码构建（Spring Boot）

通过 Git 和 Maven 从源码构建并运行：

bash
# 克隆代码仓库
git clone [***]
# 进入项目目录
cd activiti-cloud-query/
# 构建并运行
mvn clean install spring-boot:run

4.2 使用 Docker 镜像运行

直接使用 Docker 镜像部署：

bash
# 拉取并运行最新版镜像，映射端口 8182
docker run -p 8182:8182 -d --name activiti-cloud-query activiti/activiti-cloud-query:latest

5. 配置说明

5.1 环境变量

以下环境变量用于配置服务行为，可通过 -e 参数在 Docker 运行时指定：

环境变量	对应配置项	默认值	描述
ACT_QUERY_PORT	server.port	8182	服务端口
ACT_QUERY_APP_NAME	spring.application.name	query	应用名称
ACT_QUERY_PRODUCER_DEST	spring.cloud.stream.bindings.producer.destination	engineEvents	生产者目标事件队列
ACT_QUERY_PRODUCER_CONTENT_TYPE	spring.cloud.stream.bindings.producer.contentType	application/json	生产者消息格式
ACT_QUERY_CONSUMER_DEST	spring.cloud.stream.bindings.queryConsumer.destination	engineEvents	消费者目标事件队列
ACT_QUERY_CONSUMER_GROUP	spring.cloud.stream.bindings.queryConsumer.group	query	消费者组名称
ACT_QUERY_CONSUMER_CONTENT_TYPE	spring.cloud.stream.bindings.queryConsumer.contentType	application/json	消费者消息格式
ACT_QUERY_JACKSON_FAIL_ON_UNWRAPPED_IDS	spring.jackson.serialization.fail-on-unwrapped-type-identifiers	false	Jackson 序列化时是否对未包装类型标识符失败
ACT_KEYCLOAK_URL	keycloak.auth-server-url	[***]	Keycloak 认证服务器 URL
ACT_KEYCLOAK_REALM	keycloak.realm	springboot	Keycloak 领域
ACT_KEYCLOAK_RESOURCE	keycloak.resource	activiti	Keycloak 资源名称
ACT_KEYCLOAK_CLIENT	keycloak.public-client	true	是否为公开客户端
ACT_KEYCLOAK_SSL_REQUIRED	keycloak.ssl-required	none	SSL 要求级别
ACT_KEYCLOAK_ROLES	keycloak.security-constraints[0].authRoles[0]	user	安全约束角色
ACT_KEYCLOAK_PATTERNS	keycloak.security-constraints[0].securityCollections[0].patterns[0]	/*	安全约束 URL 模式
ACT_KEYCLOAK_PRINCIPAL_ATTRIBUTE	keycloak.principal-attribute	preferred-username	Principal 属性
ACT_KEYCLOAK_CLIENT_APP	activiti.keycloak.admin-client-app	admin-cli	Keycloak 管理员客户端应用
ACT_KEYCLOAK_CLIENT_USER	activiti.keycloak.client-user	client	Keycloak 客户端用户
ACT_KEYCLOAK_CLIENT_PASSWORD	activiti.keycloak.client-password	client	Keycloak 客户端密码
ACT_RABBITMQ_HOST	spring.rabbitmq.host	rabbitmq	RabbitMQ 主机地址
ACT_EUREKA_URL	eureka.client.serviceUrl.defaultZone	[***]	Eureka 服务注册中心 URL
ACT_QUERY_HOST	eureka.instance.hostname	activiti-cloud-query	Eureka 实例主机名
ACT_QUERY_EUREKA_CLIENT_ENABLED	eureka.client.enabled	true	是否启用 Eureka 客户端