Erupt 通用数据管理框架使用教程

Erupt 通用数据管理框架使用教程

erupt 🚀 对象模型 → 数据可视化管理 0️⃣ 前端代码、0️⃣ 代码生成、0️⃣ SQL、0️⃣ API声明、0️⃣ DTO / VO / BO、表结构自动生成 🛡 内置严密安全策略，细颗粒权限隔离 ☁️ Cloud开发能力，不停机升级，轻依赖，集群内每个服务都可以轻松实现数据可视化 ️☁️ 项目地址: https://gitcode.com/gh_mirrors/er/erupt

1. 项目的目录结构及介绍

Erupt 项目的主要目录结构如下：

erupt/
├── erupt-annotation -- 核心注解声明
├── erupt-core -- 核心功能实现
├── erupt-data -- 数据实现包
├── erupt-jpa -- 关系型数据库erupt实现
├── erupt-mongodb -- mongodb数据库erupt实现
├── erupt-job -- 定时任务功能，支持动态定时任务、邮件发送、任务日志等功能
├── erupt-upms -- 用户权限管理
├── erupt-security -- 接口数据安全
├── erupt-web -- 编译后的前端页面
├── erupt-tpl -- 支持在 erupt 中自定义页面、自定义图表、自定义弹出层，模板引擎支持：FreeMarker / Thymeleaf / 原生H5 / Velocity 等
├── erupt-tpl-ui -- 在 erupt-tpl 中可使用的 UI 库
│   ├── ant-design
│   ├── element-ui
│   └── amis
├── erupt-generator -- 代码生成器，通过配置生成 erupt 代码段
└── erupt-monitor -- 基于erupt实现的服务监控

目录详细介绍

• erupt-annotation: 包含 Erupt 框架的核心注解，用于定义数据模型和页面配置。
• erupt-core: 实现 Erupt 框架的核心功能，如动态生成页面、数据操作等。
• erupt-data: 提供数据访问的实现，支持多种数据源。
• erupt-jpa 和 erupt-mongodb: 分别针对关系型数据库和 MongoDB 的具体实现。
• erupt-job: 提供定时任务功能，支持动态配置和日志记录。
• erupt-upms: 实现用户权限管理功能。
• erupt-security: 提供接口数据安全相关的功能。
• erupt-web: 包含编译后的前端页面文件。
• erupt-tpl: 支持自定义页面和组件，提供多种模板引擎支持。
• erupt-tpl-ui: 提供可使用的 UI 库，如 Ant Design、Element UI 等。
• erupt-generator: 用于生成 Erupt 代码段的工具。
• erupt-monitor: 基于 Erupt 实现的服务监控功能。

2. 项目的启动文件介绍

Erupt 项目的启动文件通常位于 erupt-web 模块中，主要的启动类为 EruptApplication。以下是一个示例启动类：

package xyz.erupt.web;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class EruptApplication {

    public static void main(String[] args) {
        SpringApplication.run(EruptApplication.class, args);
    }
}

启动步骤

1. 确保已安装 Java 和 Maven。
2. 克隆项目代码到本地：

   git clone https://github.com/erupts/erupt.git
   

3. 进入项目目录：

   cd erupt/erupt-web
   

4. 使用 Maven 命令启动项目：

   mvn spring-boot:run
   

3. 项目的配置文件介绍

Erupt 项目的配置文件主要位于 src/main/resources 目录下，常见的配置文件包括：

• application.properties 或 application.yml：Spring Boot 的主配置文件，用于配置数据库连接、服务器端口等信息。
• erupt.properties：Erupt 框架的专用配置文件，用于配置 Erupt 特有的功能。

示例配置

application.properties:

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/erupt?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=123456
spring.jpa.hibernate.ddl-auto=update

erupt.properties:

erupt.upload.path=/data/upload
erupt.security.enable=true
erupt.upms.enable=true

配置说明

• server.port: 应用程序运行端口。
• spring.datasource.url: 数据库连接 URL。
• spring.datasource.username: 数据库用户名。
• spring.datasource.password: 数据库密码。
• spring.jpa.hibernate.ddl-auto: JPA 的数据库表生成策略。
• erupt.upload.path: 文件上传路径。
• erupt.security.enable: 是否启用安全功能。
• erupt.upms.enable: 是否启用用户权限管理功能。

通过以上配置，可以基本完成 Erupt 项目的启动和运行。更多详细配置和功能

erupt 🚀 对象模型 → 数据可视化管理 0️⃣ 前端代码、0️⃣ 代码生成、0️⃣ SQL、0️⃣ API声明、0️⃣ DTO / VO / BO、表结构自动生成 🛡 内置严密安全策略，细颗粒权限隔离 ☁️ Cloud开发能力，不停机升级，轻依赖，集群内每个服务都可以轻松实现数据可视化 ️☁️ 项目地址: https://gitcode.com/gh_mirrors/er/erupt