CaptainJike / helio-boot-modular

基于 Spring Boot 3.x,是一款预置SaaS、RBAC能力的单体项目脚手架,适合初学者学习 JavaWeb 开发的良好实践;本项目已拆分多Maven模块,单模块版请移步至helio-boot项目

Home Page:https://helio.uncarbon.cc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

helio-boot-modular

项目介绍

基于 Spring Boot 3.x,是一款预置SaaS、RBAC能力的单体项目脚手架,适合初学者学习 JavaWeb 开发的良好实践
按职责拆分为多Maven模块,依然是大单体,但命名及用途对标helio-cloud;适合多人协作、但不打算使用微服务架构的团队
单模块版请移步至helio-boot项目

JDK compatibility: 17 - 21

前端演示站】 【官方文档】 【主要技术栈依赖】 【快速启动步骤】 【更新记录】 【编码良好实践

需要先安装 MySQLRedis 等必需中间件

基础支撑构件 helio-starters 已推送至Maven**仓库,加载时会自动拉取

配套后台管理前端模板 & 代码生成器

项目名 简介 Gitee GitHub
helio-generator 可一键生成单体or微服务版的前、后端代码,减少无谓的重复劳动 Gitee GitHub
helio-admin-vue-vben 基于Vue vben admin 改造适配的前端框架,开箱即用 Gitee GitHub

源码包结构

├───api
│   ├───admin-api  【Maven模块】admin-api,用于后台管理的HTTP-API
│   │   └───src
│   │       └───main
│   │           └───java
│   │               └───cc
│   │                   └───uncarbon
│   │                       └───module
│   │                           └───adminapi
│   │                               ├───aspect         自定义切面
│   │                               │   └───extension  自定义切面扩展类
│   │                               ├───constant       常量
│   │                               ├───helper         助手类
│   │                               ├───model          抽象模型
│   │                               │   └───response   用于响应的
│   │                               ├───util           静态工具类
│   │                               └───web            即:Controller
│   │                                   ├───auth       登录登出接口
│   │                                   ├───common     常用通用接口
│   │                                   ├───oss        对象存储接口
│   │                                   └───sys        预置系统管理接口(如:后台用户、后台角色、后台菜单等)
│   └───app-api 【Maven模块】app-api,用于C端的HTTP-API【只是一个骨架,并没有业务实现】
│       └───src
│           └───main
│               └───java
│                   └───cc
│                       └───uncarbon
│                           └───module
│                               └───appapi
│                                   ├───constant  常量
│                                   └───web       即:Controller
├───attachments  附件
│   └───db  数据库变更脚本
│       ├───MySQL
│       │   └───upgrade  Helio升级时MySQL变更脚本
│       └───PostgreSQL
│           └───upgrade  Helio升级时PostgreSQL变更脚本
├───bootstrap  【Maven模块】项目主入口,负责启动SpringBoot
│   └───src
│       ├───main
│       │   ├───java
│       │   │   └───cc
│       │   │       └───uncarbon
│       │   │           ├───config       全局配置类
│       │   │           └───interceptor  Web拦截器
│       │   └───resources  资源,包含符合Spring Boot标准的YAML配置文件、Logback配置文件等
│       │       └───i18n  国际化文案定义
├───service-module
│   ├───oss  【Maven模块】对象存储服务
│   │   ├───oss-facade  【Maven模块】对象存储服务门面
│   │   │   └───src
│   │   │       └───main
│   │   │           └───java
│   │   │               └───cc
│   │   │                   └───uncarbon
│   │   │                       └───module
│   │   │                           └───oss
│   │   │                               ├───constant  常量
│   │   │                               ├───enums     枚举
│   │   │                               ├───facade    门面
│   │   │                               └───model     抽象模型
│   │   │                                   ├───request   用于请求的
│   │   │                                   └───response  用于响应的
│   │   └───oss-service  【Maven模块】对象存储服务实现
│   │       └───src
│   │           └───main
│   │               └───java
│   │                   └───cc
│   │                       └───uncarbon
│   │                           └───module
│   │                               └───oss
│   │                                   ├───biz      门面实现类
│   │                                   ├───config   配置类
│   │                                   ├───entity   实体
│   │                                   ├───mapper   Mybatis Mapper
│   │                                   └───service  服务类
│   └───sys  【Maven模块】预置系统管理服务
│       ├───sys-facade  【Maven模块】预置系统管理服务门面
│       │   └───src
│       │       └───main
│       │           └───java
│       │               └───cc
│       │                   └───uncarbon
│       │                       └───module
│       │                           └───sys
│       │                               ├───annotation  自定义注解
│       │                               ├───constant    常量
│       │                               ├───enums       枚举
│       │                               ├───extension   自定义扩展
│       │                               │   └───impl    自定义扩展实现类
│       │                               ├───facade  门面
│       │                               └───model   抽象模型
│       │                                   ├───request   用于请求的
│       │                                   └───response  用于响应的
│       └───sys-service  【Maven模块】预置系统管理服务实现
│           └───src
│               └───main
│                   └───java
│                       └───cc
│                           └───uncarbon
│                               └───module
│                                   └───sys
│                                       ├───biz      门面实现类
│                                       ├───entity   实体
│                                       ├───mapper   Mybatis Mapper
│                                       │   └───xml  Mybatis Mapper XML
│                                       ├───service  服务类
│                                       └───util     静态工具类

About

基于 Spring Boot 3.x,是一款预置SaaS、RBAC能力的单体项目脚手架,适合初学者学习 JavaWeb 开发的良好实践;本项目已拆分多Maven模块,单模块版请移步至helio-boot项目

https://helio.uncarbon.cc

License:Mulan Permissive Software License, Version 2


Languages

Language:Java 82.9%Language:PLpgSQL 17.0%Language:Dockerfile 0.1%Language:Shell 0.0%