Erupt Framework 是一个通用后台管理框架。Erupt 可快速的构建管理页面,零前端代码、零CURD、自动建表,仅需单个类文件 + 简洁的注解配置,即可快速开发企业级Admin
管理后台!
后台管理系统非常重要,但开发存在一定的痛点,如:开发效率低、界面不美观、交互不理想、工作量重复、存在安全漏洞、后端研发被迫写前端代码等。
Erupt提供企业级中后台管理系统的全栈解决方案,提供超多业务组件,简洁美观的后台页面,支持23类数据组件,多种数据源支持,严密的安全策略,压缩研发周期,降低研发成本。
注:我不是代码生成器,代码生成器并非后台开发的最优解。代码生成器的本质还是生成繁琐的后台代码,一旦修改后期生成的代码很难合并,虽然减轻了一部分工作,可解决方式并非最佳。
特性 | Features
- 易于上手:仅需了解@Erupt与@EruptField两个注解即可上手开发。
- 代码简洁:前端零代码,后端template、controller、service、dao都不需要,仅需一个实体类即可。
- 敏捷开发:仅单个
.java
文件即可实现后台管理功能,专注业务与核心功能的研发。 - 快速迭代:需求变更仅需修改或添加注解配置即可,迭代速度比需求讨论速度还快。
- 功能强大:动态条件处理,支持增删改查等功能代理接口,Session存储机制选择,行为日志记录等。
- 高安全性:可靠的安全机制,登录白名单,菜单权限验证,请求头检查,注解项检查,细颗粒度权限控制,为你的数据保驾护航。
- 自动建表:依托于JPA可自动帮你完成数据库建表相关工作。
- 低侵入性:几乎所有功能都围绕注解而展开,不影响Spring Boot其他功能或三方库库的使用。
- 多数据源:MySQL、Oracle、SQL Server、PostgreSQL、H2,甚至支持MongoDB。
- 多种组件:支持滑动输入、时间选择、开关、图片上传、代码编辑器、自动完成、树、多选框、地图等23类组件
- 丰富展示:普通文本、二维码、链接、图片、HTML、代码段、iframe、swf等
- 代码生成:erupt代码已经足够简洁,代码生成器可进一步提升开发效率。
- 扩展性强:支持自定义数据源实现、自定义页面、自定义模板、自定义附件上传机制等。
- 界面美观:每个交互都精心设计,产品思维打磨,只为了更好的操作体验。
- 响应式布局:支持PC端手机端等各种规格的设备中使用。
Erupt
一个通用后台管理框架,据说有 超低代码量、 零前端代码、零 CURD操作、无需建表,纯Java注解开发等特色,号称三分钟就可以搭建一个完整的后台管理系统。
额~ 听着好像还挺流批的,到底是不是有这么魔幻,咱们一起用起来感受下。
首先来搭建一下环境,目前Erupt
支持Java
版本1.8.0
及以上、Spring Boot
版本2.0
及其以上。
搭建easy
pom.xml
引入必要的jar
包
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--用户权限管理-->
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-upms</artifactId>
<version>1.6.7</version>
</dependency>
<!--接口数据安全-->
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-security</artifactId>
<version>1.6.7</version>
</dependency>
<!--后台WEB界面-->
<dependency>
<groupId>xyz.erupt</groupId>
<artifactId>erupt-web</artifactId>
<version>1.6.7</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>compile</scope>
</dependency>
</dependencies>
application.yml
文件只要简单配置数据源就好,提前准备个数据库。
spring:
datasource:
url: jdbc:mysql://127.0.0.1:3306/erupt?characterEncoding=UTF8&allowMultiQueries=true
username: root
password: 123456
jpa:
show-sql: true
generate-ddl: true
database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
database: mysql
profiles:
active: dev
mail:
username: xxxx@qq.com
password: xxxxxxx
host: smtp.qq.com
properties:
mail.smtp.ssl.auth: true
mail.smtp.ssl.enable: true
mail.smtp.ssl.required: true
server:
port: 8888
其实到这Erupt
的环境就搭建完了,额~ ,这就完了?
咱们什么也没干,项目是个空壳子,一行代码也没写,好像连个表也没建啊!
别着急咱们先启动下项目,看到控制台打印出很多建表语句和插入语句,这是因为Erupt
框架底层应用JPA
持久化,预置创建了一些系统表和数据。
注意:Erupt
预置表只会随项目第一次启动构建一次,如果想重新创建,需删除.Erupt
文件(一般在项目的工作空间内),获取文件位置方式
System.getProperty("user.dir")
再看数据库里创建了16张系统表,其中e_upms_user
表是用户表,默认只有一个管理员账号,用户名、密码都是erupt
。
紧接着我们访问http://127.0.0.1:8888/
,看一下是个什么效果,竟然有个完整的登录页面。
用上边的用户名、密码直接登录,erupt
已经预先实现了完整的权限控等功能,而到这我们几乎是没写过什么代码的,都是框架封装好了的,菜单类数据全部从数据库动态获取,一个基础的后台管理系统就搭建完了,有点哇塞。
有趣的页面
那么问题来了?想要自定义页面怎么办?
开篇我们就说过erupt
是零前端代码,全部基于Java
注解开发的,接下来用Java
注解写个简单页面体验下。
erupt
有两个核心注解@Erupt
,@EruptField
-
@Erupt
注解修饰类,代表定义一个页面 -
@EruptField
注解修饰字段,代表页面上显示的字段名 -
@Power
注解控制是否操作按钮,增、删、改、查、导入、导出等 -
@Search
注解表示字段为搜索条件 -
@Table
注解表示页面取数据对应的表,如果不设置,页面第一次初始化的时候,会根据类字段值自动创建一张和类名一致的表名。
“注解类型比较多,不一一列举了,更多的自己到官网瞅:
https://www.erupt.xyz
下边我们定义一个Student
类,加上@Erupt
,@EruptField
注解,这样页面和元素就算写完了,是不是有点颠覆认知。
/*
* @Erupt注解修饰在类上,@EruptField注解修饰在字段上
* 其他注解均为Jpa注解
*/
@Getter
@Setter
@Erupt(name = "学生表",
power = @Power(importable = true, export = true)
)
@Entity
//@Table(name = "t_student")
public class Student extends BaseModel {
@EruptField(
views = @View(title = "学生姓名"),
edit = @Edit(title = "学生姓名", notNull = true, search = @Search(vague = true))
)
private String studentName;
@EruptField(
views = @View(title = "所属班级"),
edit = @Edit(title = "所属班级", notNull = true)
)
private String studentClass;
@EruptField(
views = @View(title = "学生年龄"),
edit = @Edit(title = "学生年龄", notNull = true)
)
private String studentAge;
@Lob
@EruptField(
views = @View(title = "学生性别"),
edit = @Edit(title = "学生性别", notNull = true)
)
private String studentSex;
@EruptField(
views = @View(title = "考核状态"),
edit = @Edit(title = "考核状态", notNull = true, boolType = @BoolType(trueText = "通过", falseText = "挂科"), search = @Search)
)
private Boolean status;
}
但此时新创建的页面不会显示出来,还需要我们手动做一个映射关系,在菜单维护中自定义个菜单,类型值一定要为新建的 类名 Student
。
保存刷新后会看到我们的新页面出现了,而且页面的功能很完整,基础操作、查询、导入、导出功能都自动实现了。
页面新增一个学生信息,对应的Student
表也多了条记录,而这个持久化的过程完全由框架来做。
尽管Erupt
框架对前后端代码做了深度封装,但它提供了丰富灵活的自定义接口,来满足我们的个性化需求。
比如我们在录入新学生信息时,希望屏蔽名字为张三
的同学,可以对页面按钮功能做代理dataProxy
,实现自定义的逻辑,对哪个按钮代理就实现对应方法即可,如beforeAdd
、afterAdd
是对新增按钮的代理。
@Getter
@Setter
@Erupt(name = "学生表",dataProxy = {StudentDataProxy.class},
power = @Power(importable = true, export = true)
)
@Entity
//@Table(name = "t_student")
public class Student extends BaseModel {
}
public class StudentDataProxy implements DataProxy<Student> {
@Override
public void beforeAdd(Student student) {
//后台字段校验
if ("张三".equals(student.getStudentName())) {
throw new EruptApiErrorTip("名称禁止为张三!");
}
}
@Override
public void afterAdd(Student student) {
}
@Override
public void afterUpdate(Student student) {
}
@Override
public void afterDelete(Student student) {
}
}
当我们在页面录入名字为张三
的同学时,成功屏蔽。其他类似的功能还有很多,这里就不一一举例了,看文档看文档~
如果我们想要按传统的方式开发接口,不用担心会和Erupt
的页面生成规则有冲突,丝毫不会受影响。而且Erupt
内部集成了JPA
,提供了现成的dao
接口,只要调用对应API即可上手开发。
如果你不想手写Java
代码也没关系,Erupt
还提供了代码生成器,自定义Java
类名和字段名,可以生成代码,直接copy
就行了。
说到这我只介绍了Erupt
一丢丢的基础特性,主要是想让小伙伴知道有这么个敏捷利器。
不仅如此它还支持丰富的数据类型,内置了像定时任务管理
、多表联合查询
、前后端分离部署
、接口权限
、操作记录
、多数据源
、邮件系统
、黑白名单
等等很多实用功能,都直接调用API就可以用。
说在后边
Erupt
框架的优点是显而易见的,快捷、高效、上手容易,对新手相当的友好,但在实际生产环境中我只是用它来做一些配置字典类的数据管理。
因为它的深度封装虽然让开发变的简单高效,可对于业务相对复杂、高度定制的系统来说,Erupt
框架显得力不从心,更关键的一点,它的社区并不算特别活跃,毕竟是个小众框架。
不过,技术从来都是服务于业务的,如果你的业务与Erupt
的气质相匹配,别犹豫,用它!