Wang-Template：简洁易用的报告生成系统

2024-09-24 13:55:39作者：裴锟轩Denise

项目介绍

Wang-Template 是一款从实际生产平台中抽离出来的报告渲染模块，现已独立成为一个简洁易用的报告生成系统。该系统采用前后端分离的架构，专注于报告生成，支持对接任意数据源，并通过自定义模板生成各种类型的报告。无论是企业内部的报告生成需求，还是对外提供的数据分析报告，Wang-Template 都能轻松应对。

项目技术分析

核心技术栈

Java 8+：作为后端开发语言，保证了系统的稳定性和性能。
Spring 5.3.31：提供了强大的依赖注入和AOP功能，简化了开发流程。
Spring Boot 2.7.18：快速构建独立的、生产级别的Spring应用，减少了大量的配置工作。

支持的数据源类型

关系型数据库 SQL：通过JDBC接口实现数据查询，已验证支持MySQL、Postgresql和H2数据库。

支持的报告类型

Word报告：使用 poi-tl 支持Word模板的编辑，生成Word报告。
文本报告：使用 FreeMarker 支持任意文本报告的编辑，生成TXT、Markdown、HTML等格式的报告。

项目及技术应用场景

Wang-Template 适用于多种场景，包括但不限于：

企业内部报告生成：如财务报表、销售报告、运营分析等。
数据分析平台：作为数据分析结果的输出模块，生成可视化的报告。
智能客服系统：生成客服对话记录报告，辅助客服质量监控。
教育培训：生成学生成绩报告、课程进度报告等。

项目特点

1. 轻量化

Wang-Template 专注于报告生成，不涉及其他复杂功能，使得系统轻量化，易于部署和维护。

2. 可扩展

采用模块化架构和面向接口的设计，使得系统易于扩展，可以快速对接新的数据源和渲染方式。

3. 易整合

系统设计简洁，易于整合到其他系统中，作为报告生成功能的模块。

4. 更智能

整合了大文本人工智能服务，提供更智能化的报告生成能力，如自动数据分析、智能推荐等。

部署与使用

快速部署

参考 Docker Compose 的快速部署项目：

Github: https://github.com/52jing/wang-template-compose
Gitee: https://gitee.com/i52jing/wang-template-compose

后端部署

使用 Docker 部署

docker build -t wang-template-backend:1.0 .
docker run -d --name wang-template-backend -p 8000:8000 -v <path-to-config>/application-prod.yml:/opt/config/application-prod.yml wang-template-backend:1.0

手动部署

使用 Maven 构建打包：

mvn clean package -DskipTests

前端部署

使用 Docker 部署

docker build -t wang-template-admin:1.0 .
docker run -d --name wang-template-admin -p 8001:80 wang-template-admin:1.0

手动部署

使用 Vite 构建打包：

yarn build

系统截图

配置数据源

配置数据源参数

数据源详情

测试获取数据

配置模版

创建生成任务

查看结果

配置说明

配置文件

添加配置文件 application-prod.yml 或 application-prod.properties，可参考 app/src/main/resources/example-application-dev.yml 文件。

配置数据库

在 spring.datasource.druid 项下配置或在 mybatis-flex.datasource.master 下配置。

配置附件存储

附件存储基于 x-file-storage，支持本地存储、MinIO、公有云对象存储等。

配置报告分析（人工智能）

启用报告指标分析，并配置 Kimi API 密钥。

模版说明

模版上下文对象

所有的模版都注入了渲染的上下文对象，对象格式如下：

{
  "templateName": "",
  "datasourceName": "",
  "params": {},
  "envs": {
    "year": 2024,
    "month": 6,
    "day": 12,
    "dayOfWeek": 3,
    "hour": 0,
    "minute": 0,
    "second": 0
  },
  "data": {}
}