特别说明:源码、JDK、MySQL、Redis、Nacos、Seata、Sentinel等安装或存放路径禁止包含中文、空格、特殊字符等
Java8/11、Java17/21Spring Cloud 2021/2023+ Spring Cloud Alibaba 2021/2023 + Spring Boot 2.7/3.2MyBatis-PlusAlibaba DruidDynamic-DatasourceMySQL、SQLServer、Oracle、PostgreSQL、达梦数据库、人大金仓数据库Apache ShardingSphereSpring Cloud GatewayAlibaba NacosSpring Boot AdminSpring Cloud OpenFeign、Apache DubboSpring Cloud LoadbalancerAlibaba SentinelApache SeataApache SkyWalkingSpring Cloud Stream,兼容Apache RocketMQ、RabittMQ、Apache KafkaSa-Token + JWTMyBatis-Plus-GeneratorFlowable 6.7VelocityXXL-JOBLock4jJackson&FastjsonRedisValidationMinIO 及多个云对象存储,如阿里云 OSS、华为云 OBS、七牛云 Kodo、腾讯云 COS等Hutool、LombokKnife4jMavenELKPrometheus、Grafana、Alertmanager| 类目 | 版本或建议 |
|---|---|
| 电脑配置 | 开发电脑建议使用I3及以上CPU,32G及以上内存 |
| 操作系统 | Windows 10/11,MacOS |
| JDK | 默认使用JDK 21,如需要切换JDK 8/11/17版本请参考文档调整代码,推荐使用 OpenJDK,如 Liberica JDK、Eclipse Temurin、Alibaba Dragonwell、BiSheng 等发行版; |
| Maven | 依赖管理工具,推荐使用 3.6.3 及以上版本 |
| Redis | 数据缓存,推荐使用 5.0 及以上版本 |
| 数据库 | 兼容 MySQL 5.7.x/8.x、SQLServer 2012+、Oracle 11g、PostgreSQL 12+、达梦数据库(DM8)、人大金仓数据库(KingbaseES_V8R6) |
| IDE | 代码集成开发环境,推荐使用 IDEA2024 及以上版本,兼容 Eclipse、 Spring Tool Suite 等IDE工具 |
| 文件存储 | 默认使用本地存储,兼容 MinIO 及多个云对象存储,如 阿里云 OSS、华为云 OBS、七牛云 Kodo、腾讯云 COS 等; |
| Nacos | v2.4.3, 服务注册&发现和配置中心 |
| Seata | v2.2.0,分布式事务 |
| Sentinel(可选) | v1.8.5, 服务熔断 |
| Spring Boot Admin(可选) | 2.7.16,服务监控 |
| SkyWalking APM(可选) | v10.x, 链路追踪 |
| SkyWalking Agent (可选) | v9.3.0 |
| 消息中间件 | 默认使用 Apache RocketMQ,兼容 RabittMQ 或 Apache Kafka |
| ELK(适配) | 日志中心 |
| Prometheus(适配) | 分布式监控、告警 |
| Alertmanager(适配) | 分布式监控、告警 |
| Grafana(适配) | 分布式监控、告警 |
适用于测试或生产环境
| 类目 | 版本或建议 |
|---|---|
| 硬件 | 建议至少在 4C/32G/50G 的机器配置下运行; |
| 操作系统 | 建议使用 Windows Server 2019 及以上版本或主流 Linux 发行版本,推荐使用 Linux 环境;兼容 统信UOS,OpenEuler,麒麟服务器版 等信创环境; |
| JRE | 默认使用JRE 21,如需要切换JRE 8/11/17版本请参考文档调整代码;推荐使用 OpenJDK,如 Liberica JDK、Eclipse Temurin、Alibaba Dragonwell、BiSheng 等发行版; |
| Redis | 数据缓存,推荐使用 5.0 及以上版本 |
| 数据库 | 兼容 MySQL 5.7.x/8.x、SQLServer 2012+、Oracle 11g、PostgreSQL 12+、达梦数据库(DM8)、人大金仓数据库(KingbaseES_V8R6) |
| 文件存储 | 默认使用本地存储,兼容 MinIO 及多个云对象存储,如 阿里云 OSS、华为云 OBS、七牛云 Kodo、腾讯云 COS 等; |
| Nacos | v2.4.3, 服务注册&发现和配置中心 |
| Seata(可选) | v2.2.0,分布式事务 |
| Sentinel(可选) | v1.8.5, 服务熔断 |
| Spring Boot Admin(可选) | 2.7.16,服务监控 |
| SkyWalking APM(可选) | v10.x, 链路追踪 |
| SkyWalking Agent (可选) | v9.3.0 |
| 消息中间件 | 默认使用 Apache RocketMQ,兼容 RabittMQ 或 Apache Kafka |
| ELK(适配) | 日志中心 |
| Prometheus(适配) | 分布式监控、告警 |
| Alertmanager(适配) | 分布式监控、告警 |
| Grafana(适配) | 分布式监控、告警 |
Lombok(必需)Alibaba Java Coding GuidelinesMybatisX建议使用 Apache Maven 3.6.3 及以上版本
以解决依赖无法从公共Maven仓库下载的问题
通过官方私服下载依赖完成后,由于IDEA的缓存可能会出现部分报红,重启IDEA即可
打开Maven安装目录中的 conf/settings.xml 文件,
在 <servers></servers> 中添加如下内容
<server>
<id>maven-releases</id>
<username>jnpf-user</username>
<password>HLrQ0MA%S1nE</password>
</server>
<server>
<id>maven-snapshots</id>
<username>jnpf-user</username>
<password>HLrQ0MA%S1nE</password>
</server>
在 <mirrors></mirrors> 中添加
<mirror>
<id>maven-snapshots</id>
<mirrorOf>*</mirrorOf>
<name>maven-snapshots</name>
<url>https://repository.jnpfsoft.com/repository/maven-public/</url>
</mirror>
| 项目 | 分支 | 说明 |
|---|---|---|
| jnpf-registry | v5.2.x-stable | 中间件项目 |
| jnpf-nacos-plugin | v2.4.1-plugin-stable | Nacos插件项目源码-适配MySQL、SQLServer、Oracle、PostgreSQL、达梦数据库(DM8)、人大金仓数据库 |
| 项目 | 分支 | 说明 |
|---|---|---|
| jnpf-common | v6.0.x-stable | Java基础依赖项目源码 |
| jnpf-datareport | v6.0.x-stable | 报表后端项目源码 |
| jnpf-file-core-starter | v6.0.x-stable | 文件基础依赖项目源码 |
| jnpf-file-preview | v6.0.x-stable | 本地文档预览项目源码 |
| jnpf-java-datareport-univer | v6.0.x-stable | Java Univer报表源码 |
| jnpf-java-datareport-univer-core | v6.0.x-stable | Java Univer报表核心依赖源码,不同销售版本交付有所差异,以实际交付为准 |
| jnpf-java-tenant | v6.0.x-stable | 多租户后端项目源码,不同销售版本交付有所差异,以实际交付为准 |
| jnpf-scheduletask | v6.0.x-stable | 任务调度客户端依赖及服务端项目源码 |
| jnpf-workflow | v1.0.0-stable | 流程引擎后端项目 |
| jnpf-workflow-core | v1.0.0-stable | Flowable流程引擎基础依赖,不同销售版本交付有所差异,以实际交付为准 |
| 项目 | 分支 | 说明 |
|---|---|---|
| jnpf-web-datareport | v6.0.x-stable | 报表前端项目源码 |
| jnpf-web-datascreen-vue3 | v6.0.x-stable | 前端大屏项目源码(Vue3) |
| jnpf-web-tenant-vue3 | v6.0.x-stable | 多租户前端项目源码(Vue3),不同销售版本交付有所差异,以实际交付为准 |
| jnpf-web-monorepo | v6.0.x-stable | 前端主项目源码(Vue3),不同销售版本交付有所差异,以实际交付为准 |
| jnpf-web-monorepo-bpmn | v6.0.x-stable | 前端主项目源码(Vue3),不含流程设计器、不含Univer报表设计器前端源代码,不同销售版本交付有所差异,以实际交付为准 |
| jnpf-bpmn | v1.0.x-stable | 前端流程设计器源代码,不同销售版本交付有所差异,以实际交付为准 |
| jnpf-univer | v1.0.x-stable | 前端Univer报表设计器源代码,不同销售版本交付有所差异,以实际交付为准 |
| 项目 | 分支 | 说明 |
|---|---|---|
| jnpf-app-vue3 | v6.0.x-stable | 移动端项目源码(Vue3) |
| 项目 | 分支 | 说明 |
|---|---|---|
| jnpf-resources | v6.0.x-stable | 静态资源 |
| 项目 | 分支 | 说明 |
|---|---|---|
| jnpf-database | v6.0.x-stable | 数据库脚本或文件 |
在保证端口不冲突的情况下,可根据实际场景调整端口
| 服务名称 | 默认端口 | 描述 |
|---|---|---|
| jnpf-gateway | 30000 | 服务网关 |
| jnpf-oauth | 30001 | 认证服务 |
| jnpf-system | 30002 | 系统基础服务 |
| jnpf-visualdev | 30003 | 可视化开发(在线开发、代码生成、门户设计) |
| jnpf-workflow | 30004 | 工作流 |
| jnpf-file | 30005 | 文件服务 |
| jnpf-message | 30008 | 消息中心 |
| jnpf-scheduletask | 30009 | 任务调度(客户端) |
| jnpf-permission | 30010 | 权限服务 |
| jnpf-visualdata | 30011 | 数据大屏服务 |
| jnpf-app | 30012 | 移动端服务 |
| jnpf-extend | 30019 | 开发示例 |
| jnpf-example | 30100 | 服务模板(参考示例) |
以 MySQL数据库为例
字符集:utf8mb4
排序规则:utf8mb4_general_ci
在MySQL中创建 jnpf_nacos 数据库,并将 jnpf-database/Java微服务/jnpf_nacos_mysql.sql 导入
更多使用场景详见 jnpf-registry/nacos-server/README.md 文档说明
在MySQL中创建 jnpf_init 数据库,并将 jnpf-database/MySQL/jnpf_db_init.sql 导入。
若需要使用纯净数据库(不含Demo示例),则以【新建查询】方式导入 jnpf_dbnull_init.sql 。
若有更新脚本(Update目录下),按日期顺序执行更新
在MySQL中创建 jnpf_xxjob 数据库,并将 jnpf-database/MySQL/jnpf_xxjob_init.sql 导入。
在MySQL中创建 jnpf_flow 数据库,并将 jnpf-database/MySQL/jnpf_flow_init.sql 导入。
详见 jnpf-common 项目中的 README.md 文档说明
详见 jnpf-file-starter 项目中的 README.md 文档说明
详见 jnpf-scheduletask 项目中的 README.md 文档说明
详见 jnpf-datareport 项目中的 README.md 文档说明
详见 jnpf-java-datareport-univer 项目中的 README.md 文档说明
详见 jnpf-workflow 项目中的 README.md 文档说明
可选,如有多租户需求
详见 jnpf-java-tenant 项目中的 README.md 文档说明
打开编辑 /jnpf-app/jnpf-app-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30012
打开编辑 /jnpf-app/jnpf-app-server/src/main/resources/bootstrap.yml,主要涉及如下配置
此服务需要用到 Seata 中间件
打开编辑 /jnpf-extend/jnpf-extend-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30019
打开编辑 /jnpf-extend/jnpf-extend-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-file/jnpf-file-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30005
打开编辑 /jnpf-file/jnpf-file-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-flowable/jnpf-flowable-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30004
打开编辑 /jnpf-flowable/jnpf-flowable-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-gateway/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30000
打开编辑 /jnpf-gateway/src/main/resources/bootstrap-dev.yml,主要涉及如下配置
此服务需要用到消息中间件,默认使用
Apache RocketMQ,登录Nacos控制台修改mq.yaml配置
打开编辑 /jnpf-message/jnpf-message-server/src/main/resources/application.ymlyaml server: tomcat: uri-encoding: UTF-8 port: 30008
打开编辑 /jnpf-message/jnpf-message-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-oauth/jnpf-oauth-server/src/main/resources/application.ymlyaml server: tomcat: uri-encoding: UTF-8 port: 30001
打开编辑 /jnpf-oauth/jnpf-oauth-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-permission/jnpf-permission-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30010
打开编辑 /jnpf-permission/jnpf-permission-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-scheduletask/jnpf-scheduletask-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30009
打开编辑 /jnpf-scheduletask/jnpf-scheduletask-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-system/jnpf-system-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30002
打开编辑 /jnpf-system/jnpf-system-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-visualdata/jnpf-visualdata-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30011
打开编辑 /jnpf-visualdata/jnpf-visualdata-server/src/main/resources/bootstrap.yml,主要涉及如下配置
打开编辑 /jnpf-visualdev/jnpf-visualdev-server/src/main/resources/application.yml
server:
tomcat:
uri-encoding: UTF-8
port: 30003
打开编辑 /jnpf-visualdev/jnpf-visualdev-server/src/main/resources/bootstrap.yml,主要涉及如下配置
详见 jnpf-registry 项目中 /nacos-server/README.md 文档说明
若使用JDK9及以上版本,所有服务启动需要添加如下VM启动参数(不区分先后顺序)
--add-opens=java.base/java.lang=ALL-UNNAMED
--add-opens=java.base/java.lang.reflect=ALL-UNNAMED
--add-opens=java.base/java.lang.invoke=ALL-UNNAMED
--add-opens=java.base/java.math=ALL-UNNAMED
--add-opens=java.base/sun.net.util=ALL-UNNAMED
--add-opens=java.base/java.io=ALL-UNNAMED
--add-opens=java.base/java.net=ALL-UNNAMED
--add-opens=java.base/java.nio=ALL-UNNAMED
--add-opens=java.base/java.security=ALL-UNNAMED
--add-opens=java.base/java.text=ALL-UNNAMED
--add-opens=java.base/java.time=ALL-UNNAMED
--add-opens=java.base/java.util=ALL-UNNAMED
--add-opens=java.base/jdk.internal.module=ALL-UNNAMED
--add-opens=java.base/sun.security.util=ALL-UNNAMED
启动类:/jnpf-app/jnpf-app-server/src/main/java/jnpf/JnpfApplication
启动类:/jnpf-extend/jnpf-extend-server/src/main/java/jnpf/JnpfExtendApplication
启动类:/jnpf-file/jnpf-file-server/src/main/java/jnpf/JnpfFileAplication
启动类:/jnpf-flowable/jnpf-flowable-server/src/main/java/jnpf/JnpfFlowableApplication.java
启动类:/jnpf-gateway/src/main/java/jnpf/JnpfGatewayApplication.java
启动类:/jnpf-message/jnpf-message-server/src/main/java/jnpf/JnpfMessageApplication.java
启动类:/jnpf-oauth/jnpf-oauth-server/src/main/java/jnpf/JnpfOauthApplication.java
启动类:/jnpf-permission/jnpf-permission-server/src/main/java/jnpf/JnpfPermissionApplication.java
启动类:/jnpf-scheduletask/jnpf-scheduletask-server/src/main/java/jnpf/JnpfScheduleTaskApplication.java
启动类:/jnpf-system/jnpf-system-server/src/main/java/jnpf/JnpfSystemApplication.java
启动类:/jnpf-visualdata/jnpf-visualdata-server/src/main/java/jnpf/JnpfVisualdataApplication.java
启动类:/jnpf-visualdev/jnpf-visualdev-server/src/main/java/jnpf/JnpfVisualdevApplication.java
jar发布方式
IDEA 右侧 Maven > jnpf-java-cloud > Lifecycle 中双击 clean 清理下项目package 打包项目jar 包上传至服务器部署若使用 JDK/JRE 9及以上版本运行,需要在启动脚本中增加参数:
--add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.math=ALL-UNNAMED --add-opens=java.base/sun.net.util=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED --add-opens=java.base/java.security=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.base/java.time=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/jdk.internal.module=ALL-UNNAMED --add-opens=java.base/sun.security.util=ALL-UNNAMED
以 jnpf-app 以例
若使用 JDK/JRE 8 运行
java -Xms300m -Xmx300m -Dfile.encoding=utf-8 -jar jnpf-app-6.0.0-RELEASE.jar -> log.log
若使用 JDK/JRE 9及以上版本运行
java --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.math=ALL-UNNAMED --add-opens=java.base/sun.net.util=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.nio=ALL-UNNAMED --add-opens=java.base/java.security=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.base/java.time=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/jdk.internal.module=ALL-UNNAMED --add-opens=java.base/sun.security.util=ALL-UNNAMED -Xms300m -Xmx300m -Dfile.encoding=utf-8 -jar jnpf-app-6.0.0-RELEASE.jar -> log.log
http://localhost:30000/doc.html