SpringBoot项目快速开发框架JeecgBoot——项目简介及系统架构!
项目简介及系统架构
Jeecg Boot是一款基于Spring Boot的开发平台,它采用前后端分离架构,集成的框架有Spring Boot 2.x、Spring Cloud、Ant Design of Vue、Mybatis-plus、Shiro和JWT,而且它支持微服务开发。Jeecg Boot还有强大的代码生成功能,能够使用代码生成器一键生成前后端代码,实现项目的快速开发。
Jeecg Boot属于低代码开发平台,可以应用在任何J2EE项目的开发中,尤其适合SaaS项目、企业管理信息系统(MIS)、内部办公系统(OA)、企业资源计划系统(ERP)、客户关系管理系统(CRM)等,它具有半智能手工合并的开发方式,可以提高70%的开发效率或更多,极大地降低了开发成本。
系统功能介绍
Jeecg Boot有成熟的后端模板,也有很高的UI页面水平,不需要做项目开发的重复性工作。Jeecg Boot还独创了在线开发模式,包含一系列在线智能开发,如在线配置表单、在线配置报表、在线设计图表和在线设计流程等。
JEECG团队的开发宗旨是:简单的功能由Online Coding配置实现(在线配置表单、在线配置报表、在线设计图表、在线设计流程和在线设计表单),复杂的功能由代码生成器生成,并进行手工合并,既能保证智能性又能兼顾灵活。
业务中的流程运转采用工作流来实现,还能扩展流程任务接口,由开发者实现具体的业务逻辑。表单提供多种解决方案,如表单设计器、Online配置表单和编码表单,还实现流程与表单的分离设计(松耦合),并支持任务节点的灵活配置,这样既能保证公司流程的保密性,又能减少开发人员的工作量。Jeecg Boot框架已经具备大量可用的功能,在项目开发时可以直接利用现有功能,而不再需要二次开发。已经具备的功能如下:
├─系统管理
│ ├─用户管理、角色管理、菜单管理、部门管理
│ ├─权限设置(支持按钮权限、数据权限)、表单权限(控制字段禁用、隐藏)
│ ├─我的部门(二级管理员)、字典管理、分类字典、系统公告
│ └─职务管理、通讯录、多租户管理
├─消息中心
│ ├─消息管理、模板管理
├─代码生成器(低代码)
│ ├─代码生成器功能(一键生成前后端代码,生成后无须修改便可直接用,是后端开发的福
音)
│ ├─代码生成器模板(提供4套模板,分别支持单表和一对多模型,有不同风格可供选择)
│ ├─代码生成器模板(生成代码,自带Excel导入和导出功能)
│ ├─查询过滤器(查询逻辑无须进行编码,系统根据页面配置自动生成)
│ ├─高级查询器(弹窗自动组合查询条件)
│ ├─Excel导入和导出工具集成(支持单表,一对多,导入和导出)
│ ├─平台移动自适应支持
├─系统监控
│ ├─Gateway路由网关、性能扫描监控
│ │ ├─监控 Redis、Tomcat、JVM、服务器信息、请求追踪、磁盘监控
│ ├─定时任务、系统日志
│ ├─消息中心(支持短信、邮件、微信推送等)
│ ├─数据日志(记录数据快照,可对比快照查看数据变更情况)
│ ├─系统通知、SQL监控、swagger-UI(在线接口文档)
│—报表示例
│ ├─曲线图、饼状图、柱状图、折线图、面积图、雷达图、仪表图、进度条、排名列表
│—大屏模板
│ ├─作战指挥中心大屏、物流服务中心大屏
│—常用示例
│ ├─自定义组件、对象存储(对接阿里云)、JVXETable示例(各种复杂的ERP布局示例)
│ ├─单表模型示例、一对多模型示例、打印示例、一对多TAB示例
│ └─内嵌table示例、常用选择组件、异步树table、接口模拟测试
│ └─表格合计示例、异步树列表示例、一对多JEditable
│ └─JEditable组件示例、图片拖拽排序、图片翻页、图片预览、PDF预览
│—封装通用组件
│ ├─行编辑表格JEditableTable、省略显示组件、时间控件、高级查询
│ └─用户选择组件、报表组件封装、字典组件、下拉多选组件、选人组件│ └─选部门组件、通过部门选人组件、在线code编辑器、上传文件组件
│ └─封装曲线、柱状图、饼状图、折线图等报表组件
│ └─验证码组件、树列表组件、表单禁用组件
│—更多页面模板
│ ├─各种高级表单、各种列表效果、结果页面、异常页面、个人页面
├─高级功能
│ ├─系统编码规则、单点登录CAS集成方案
│ ├─提供App发布方案、集成Web Socket消息通知机制
├─积木报表设计器(低代码)
│ ├─打印设计器、数据报表设计、图形报表设计(支持ECharts)
│—流程模块功能(暂不开源)
│ ├─流程设计器、在线表单设计、我的任务、历史流程
│ └─流程实例管理、流程监听管理、流程表达式、我发起的流程
│ └─我的抄送、流程委派、抄送、跳转
更多的功能还在开发中,有兴趣的读者可以关注其进度。
项目开发环境和前后端技术栈
Jeecg Boot的项目开发环境如下:
语言:Java 8;
IDE(Java):基于IDEA或Eclipse安装Lombok插件;
IDE(前端):WebStorm或IDEA;
依赖管理:Maven;
数据库:MySQL 5.7、Oracle 11g或SQL Server 2017;
缓存:Redis。
后端使用的技术栈如下:
基础框架:Spring Boot 2.3.5.RELEASE;
微服务框架:Spring Cloud Alibaba 2.2.3.RELEASE;
持久层框架:Mybatis-plus 3.4.1;
安全框架:Apache Shiro 1.7.0、Jwt 3.11.0;微服务技术栈:Spring Cloud Alibaba、Nacos、Gateway、Sentinel、Skywalking;
数据库连接池:阿里巴巴Druid 1.1.22;
缓存框架:Redis;
日志打印:Logback;
其他:Fastjson、Poi、Swagger-UI、Quartz、Lombok(简化代码)等。
前端使用的技术栈如下:
Vue 2.6.10、Vuex、Vue Router;
Axios;
ant-design-vue;
Webpack、YARN;
vue-cropper——头像裁剪组件;
@antv/g2——Alipay AntV数据可视化图表;
Viser-vue——antv/g2封装实现;
eslint、@vue/cli 3.2.1;
vue-print-nb——打印。
系统结构
Jeecg Boot项目使用Maven作为依赖的管理工具,项目的目录结构是标准的Maven目录。其目录结构如下:
|jeecg-boot
|--->jeecg-boot-base
|------->jeecg-boot-base-api
|----------->jeecg-system-cloud-api
|----------->jeecg-system-local-api
|------->jeecg-boot-base-core
|------->jeecg-boot-base-tools
|--->jeecg-boot-module-demo|--->jeecg-boot-module-system
|--->jeecg-boot-starter
|--->jeecg-boot-module
Jeecg Boot项目的父目录为jeecg-boot,其中包含有多个模块,如jeecg-boot-base、jeecg-boot-module-demo、jeecg-boot-module-system、jeecg-boot-starter和jeecg-boot-module。在这些模块中,jeecg-bootstarter和jeecg-boot-module是微服务必需的项目,jeecg-boot是以SpringBoot为基础搭建的项目,其他的模块都以jeecg-boot为父模块,而jeecg-boot-base下还有子模块jeecg-boot-base-api、jeecg-boot-basecore和jeecg-boot-base-tools。
系统的功能模块
本书使用的Jeecg Boot版本号为2.4.5,这是截至本书写作时Jeecg Boot最新发布的版本。注意,Jeecg Boot 2.4.5版本底层使用的JDK版本和之前的章节使用版本有所不同,它使用的是JDK 1.8,请读者注意更换。下载最新版的Jeecg Boot 2.4.5并将其导入IDEA中,会自动加载Maven的依赖,加载完成后,项目的目录如图8.1所示。
图8.1 Jeecg Boot的目录结构
在图8.1中,项目名称为jeecg-boot,jeecg-boot是父POM,对子模块提供项目依赖,当前项目下有3个模块,分别如下:
jeecg-boot-base为通用模块,包括工具类、配置、权限、查询过滤器、注解和接口等;
jeecg-boot-module-demo为项目的案例代码模块;
jeecg-boot-module-system为系统管理权限等功能模块,默认作为启动项目。jeecg-boot-base项目包括3个项目,分别如下:
jeecg-boot-base-api为API接口项目(又分为云API和本地API项目);
jeecg-boot-base-core为核心项目;
jeecg-boot-base-tools为Jeecg Boot的工具项目。
在后端项目开发中,只需要启动jeecg-boot-module- system就可以访问项目的首页。jeecg-boot-starter为微服务启动模块,jeecg-cloud-module为微服务生态模块,因为本次不涉及微服务,所以最后两个模块不用处理。
使用项目根目录中的docker-compose.yml文件即可在Docker中启动单一的Jeecg Boot项目,docker-compose- server.yml使用Docker启动JeecgBoot和Nginx服务器。使用docker-compose.yml可以快速启动服务,不需要一步一步地搭建依赖的应用。docker-compose.yml文件的内容如下:
version: '2'
services:
jeecg-boot-mysql:
build:
context: ./db
environment:
MYSQL_ROOT_PASSWORD: root
MYSQL_ROOT_HOST: '%'
TZ: Asia/Shanghai
restart: always
container_name: jeecg-boot-mysql
image: jeecg-boot-mysql
command:
--character-set-server=utf8mb4
--collation-server=utf8mb4_general_ci
--explicit_defaults_for_timestamp=true
--lower_case_table_names=1
--max_allowed_packet=128M
--default-authentication-plugin=caching_sha2_password
ports: - 3306:3306
jeecg-boot-redis:
image: redis:5.0
ports:
- 6379:6379
restart: always
hostname: jeecg-boot-redis
container_name: jeecg-boot-redis
jeecg-boot-system:
build:
context: ./jeecg-boot-module-system
restart: on-failure
depends_on:
- jeecg-boot-mysql
- jeecg-boot-redis
container_name: jeecg-boot-system
image: jeecg-boot-system
hostname: jeecg-boot-system
ports:
- 8080:8080
上述代码使用的docker-compose.yml版本是2,使用了MySQL服务和Redis服务,最后启动jeecg-boot-system服务完成项目的启动。
本项目的数据库脚本文件为
jeecg-boot/db/jeecgboot-mysql-5.7.sql,需要手动连接MySQL 5.7,再执行SQL脚本。使用不同的MySQL客户端可能会出现错误,请注意修改,以完成SQL脚本的导入。
提示:如果使用了非MySQL数据库,请注意使用对应的数据库脚本。
配置文件
项目开发中涉及独特的配置文件,包括数据库的配置、Redis的配置和服务器端口的配置等。在Jeecg Boot项目中,配置文件保存在jeecg-boot
module-system/src/main/resources目录下,开发时使用applicationdev.yml文件。因为本地开发使用的是开发环境,所以需要查看开发环境的配置。
数据库的配置信息如下:
datasource:
master:
url: jdbc:mysql://127.0.0.1:3306/jeecg-boot?characterEncoding=UTF-
8&useUnicode=true&useSSL=false&tinyInt1isBit=false&allowPublicKeyRetri
e
val=true&serverTimezone=Asia/Shanghai
username: root
password: root
driver-class-name: com.mysql.cj.jdbc.Driver
Redis的配置如下:
redis:
database: 0
host: 127.0.0.1
lettuce:
pool:
max-active: 8 #最大的数据库连接数量,设为-1表示没有限制
max-idle: 8 #最大等待连接的数量,设为0表示没有限制
#建立连接的最长等待时间,如果超过此时间将出现异常,设为-1表示无限制
max-wait: -1ms
min-idle: 0 #最小等待连接的数量,设为0表示没有限制
shutdown-timeout: 100ms password: ''
port: 6379
读者可根据自己的数据库配置来修改代码。当前项目使用的日志配置文件是logback- spring.xml,banner.txt为项目启动的自定义标题图案。其他的配置文件可以根据自身的需要进行修改,如非必要可以直接启动项目,而不需要再修改配置。