Erupt Framework 简单了解
Erupt Framework
简介 | Intro
Erupt 是一个低代码 全栈类 框架，它使用 Java 注解 动态生成页面以及增、删、改、查、权限控制等后台功能。
零前端代码、零 CURD、自动建表，仅需 一个类文件 + 简洁的注解配置，快速开发企业级 Admin 管理后台。
提供企业级中后台管理系统的全栈解决方案，大幅压缩研发周期，专注核心业务。
特性 | Features
- 易于上手：会简单的 Spring Boot 基础知识即可
- 使用简单：仅需了解 @Erupt 与 @EruptField 两个注解即可上手开发
- 代码简洁：前端零代码，后端 template、controller、service、dao 都不需要，仅需一个类文件即可
- 敏捷开发：仅单个
.java文件即可实现后台管理功能，专注业务与核心功能的研发 - 快速迭代：需求变更仅需修改或添加注解配置即可，迭代速度比需求讨论速度还快
- 功能强大：动态条件处理，支持增删改查等功能代理接口，Session存储机制选择，行为日志记录等
- 自动建表：依托于JPA可自动帮你完成数据库建表相关工作
- 低侵入性：几乎所有功能都围绕注解而展开，不影响Spring Boot其他功能或三方库库的使用
- 多数据源：支持：MySQL、Oracle、SQL Server、PostgreSQL、H2，甚至支持 MongoDB
- 大量组件：滑动输入、时间选择、一对多、图片上传、代码编辑器、自动完成、树、多对多、地图等23类组件
- 丰富展示：普通文本、二维码、链接、图片、HTML、代码段、iframe、swf等
- 代码生成：erupt代码已经足够简洁，代码生成器可进一步提升开发效率
- 高扩展性：支持自定义数据源实现、自定义页面、动态权限管理、生命周期函数、自定义OSS等
- 界面美观：每个交互都精心设计，产品思维打磨，只为了更好的操作体验
- 权限管理：用户管理、角色管理、组织管理、菜单管理、登录日志、操作日志等
- 高安全性：可靠的安全机制，登录白名单，权限验证，注解项检查，细颗粒度权限控制，为你的数据保驾护航
- 前后端分离：后端与前端可分开部署
- 响应式布局：支持PC端手机端等各种规格的设备中使用
- 无需二次开发：仅需引用 jar 包即可 ！
- 支持扩展页面：可开发自定义页面，自定义弹出层，且支持：原生H5 / Freemarker / Thymeleaf等方式渲染
环境部署
配置简单，引用 jar 简单几步就可搭建完成
环境要求
- Java 版本 1.8.0 及以上 15 及以下，支持 GraalVM
- Spring Boot 版本 2.0 及其以上
- 浏览器要求 IE11 及以上，或其他现代浏览器
前置知识
- Java、Tomcat、Maven
- Spring Boot、JPA
- Database：SQL + MySQL / PostgreSQL / SQL Server / H2 / Oracle
开始部署
如果你觉得麻烦，可在如下仓库中拉取已配置好的演示代码
| 码云 | github | |
| java版 | ||
| kotiln版 |
注：不兼容 spring-boot-devtools
- 创建Spring Boot项目 → Spring Initializr，目录结构如下：
demo -- 项目名称
├── src
└── main
├── java -- 代码文件目录
└── com.example.demo -- 包名
└── DemoApplication -- 入口类
└── resources -- 资源文件目录
└── application.properties -- 配置文件
├── ......
└── pom.xml -- Maven依赖配置
- 在pom.xml添加erupt依赖包，版本号详见：此处为语雀文档，点击链接查看：https://www.yuque.com/yuepeng/erupt/wdic2w
<!--用户权限管理-->
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-upms</artifactId>
<version>${erupt.version}</version>
</dependency>
<!--接口数据安全-->
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-security</artifactId>
<version>${erupt.version}</version>
</dependency>
<!--后台WEB界面-->
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-web</artifactId>
<version>${erupt.version}</version>
</dependency>
${erupt.version} 参考版本号如下：(注意：spring boot版本号需要与erupt要求版本一致)
1.6.16（2021年04月24日）
Spring boot版本：2.4.3
- 在资源目录下创建如下配置文件
| 文件位置 | 功能说明 | 详细配置 |
| resources/public/app.js | 前端配置文件，可修改标题，更改Logo，页面生命周期函数等。 |
|
| resources/public/app.css | 前端样式文件（可不创建） |
|
| resources/public/home.html | 前端首页布局（不创建，首页会出现404） |
|
- 在 application.yml / application.properties 中添加数据库配置与JPA配置
示例数据库使用mysql，其他数据库请参考：此处为语雀文档，点击链接查看：https://www.yuque.com/yuepeng/erupt/ku7vx4
# application.properties写法
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/erupt?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.jpa.show-sql=true
spring.jpa.generate-ddl=true
spring.jpa.database=mysql
spring.jpa.database-platform=org.hibernate.dialect.MySQL5InnoDBDialect
# application.yml写法
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/erupt?useUnicode=true&characterEncoding=UTF-8
username: root
password: 123456
jpa:
show-sql: true
generate-ddl: true
database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
database: mysql
注：空库即可，表结构会自动创建
- pom.xml中添加对应数据库驱动包，MySQL为例：
<!-- mysql驱动包，其他数据库驱动依赖请查阅 Maven Repository → https://mvnrepository.com -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.16</version>
<scope>runtime</scope>
</dependency>
- 修改Spring Boot入口类
package com.example.demo;
@SpringBootApplication // ↓ xyz.erupt必须有
@ComponentScan({"xyz.erupt","com.xxx"}) // ↓ com.xxx要替换成实际需要扫描的代码包
@EntityScan({"xyz.erupt","com.xxx"}) // ↓ 例如DemoApplication所在的包为 com.example.demo
@EruptScan({"xyz.erupt","com.xxx"}) // → 则：com.xxx → com.example.demo
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
- 启动项目
- 启动成功后浏览器访问：http://localhost:8080