# rocks

**Repository Path**: wang-mengqing/rocks

## Basic Information

- **Project Name**: rocks
- **Description**: rocks开发平台后端项目
https://gitee.com/rocksdev/rocks-ui (前端)
https://gitee.com/rocksdev/rocks （后端）
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://gitee.com/rocksdev/rocks
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2025-04-27
- **Last Updated**: 2025-04-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">Rocks（后端）</h1>
<br>      
<br>      
<p align="center">
    Rocks是基于Springboot3 + JDK21 + Vue3 + Element-plus构建的中后台系统快速开发平台,目的是提高开发人员开发效率，降低企业信息化、数字化开发成本。
    <br>
    <br>
    <a href="http://spring.io/projects/spring-boot">
        <img src="https://img.shields.io/badge/spring--boot-3.4.1-green.svg" alt="spring-boot">
    </a>
    <a href="http://mp.baomidou.com">
        <img src="https://img.shields.io/badge/mybatis--plus-3.5.10.1-blue.svg" alt="mybatis-plus">
    </a>  
    <a href="https://www.hutool.cn/">
        <img src="https://img.shields.io/badge/hutool-6.0.0-blue.svg" alt="hutool">
    </a>
</p>


### 技术栈

 分类               | 内容                                                                                                                                                                               
-------------------|-------------------------------------------------------------------------------
 编程语言           | Java 17/21                                                                                        
 开发框架           | Spring Boot 3.4   
 安全框架	       | pring Authorization Server / SaToken （双认证中心支持）                                                                           
 任务调度            | XXL-JOB                                                                                      
 数据库支持          | MySQL8、Oracle 12C+、SQL Server 2017+、PostgreSQL 16+、 达梦8、 TiDB 4 
 持久层框架	      | MyBatis & MyBatis Plus                                                                                                                  
 数据库连接池        | Druid                                                                                                                              
 服务注册与发现/配置中心             | Nacos
 熔断组件             | Sentinel   
 网关组件             | Spring Cloud Gateway   
 日志管理             | Logback   
 运行容器             | Undertow / Docker
 分布式事务	        | Seata
 工作流	        | Flowable 7

### 项目结构
可根据业务需要，调整项目名称、包名、项目结构，但不建议破坏项目中各模块的依赖关系。
``` 
rocks
├── rocks-api -- 对外服务接口模块：对外接口及出入参实体
├── rocks-common -- SSM框架公共模块：实体、常量、枚举、工具类
├── rocks-consumer -- 服务接口消费模块：外部接口代理层，不做具体业务处理
├── rocks-dal -- dal层模块：表实体、mapper、crud接口、结果集实体
├── rocks-service -- 业务服务层
├── rocks-provider -- 对外服务接口业务实现模块：
├── rocks-web -- 控制层模块：control层及项目启动配置
```


#### 项目内部模块依赖规则

 模块名        | 依赖模块                
------------|---------------------
 common模块   | 无                   
 dal模块      | api(对外返回实体作为结果集)    
 service模块  | common、dal、consumer 
 api模块      | 无                   
 provider模块 | service、api         
 consumer模块 | 无                   
 web        | service             

### 代码生成器(MyBatis Generator)使用规范

本项目gen模块用于生成dal层代码：

    1、在config.properties中填写要生成dal层代码的表名及模块名称
    
    2、运行Main类中的main方法
### 环境准备
- **Mysql**: 版本 8.0.0 或更高
- **Redis**: 版本 8.0.0 或更高
- **XXL-JOB**: 版本 2.4.0 或更高
- **JDK**: 版本 17 或更高

### 快速开始
#### 1. 安装依赖
使用maven下载依赖，建议使用阿里云mavne镜像地址
```xml
<mirror>
    <id>alimaven</id>
    <name>aliyun maven</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    <mirrorOf>central</mirrorOf>
</mirror>
```
#### 2. 创建数据库，并执行初始化脚本
字符集: utf8mb4
排序规则：utf8mb4_general_ci
初始脚本位置： doc/db/rocks-init.sql
#### 3. 初始化并运行xxl_job
官网地址： http://www.xuxueli.com/xxl-job/
#### 4. 将项目配置改成自己的
如：数据库地址、数据库用户名/密码、redis相关配置、项目端口号等
#### 4. 启动main
main方法位置： io.gitee.rocksdev.RocksApplication