# gear

**Repository Path**: mibuding/gear

## Basic Information

- **Project Name**: gear
- **Description**: springboot微服务脚手架
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-08
- **Last Updated**: 2025-08-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gear

- 这是我的spring微服务脚手架
- 使用maven构建
- 基于Spring Boot 3.x最新版本
- 支持docker、docker-compose容器化部署

## 架构设计

### 服务发现与负载均衡
- 依赖Kubernetes的Service Discovery和Load Balancing能力
- 通过K8s Service实现服务间通信和负载均衡

### 配置管理
- 采用多环境配置文件管理（application-dev.yml、application-prod.yml等）
- 配置文件本地化管理，暂不使用Nacos等配置中心

### 技术栈
- **数据访问层**: MyBatis-Plus
- **API文档**: Swagger/OpenAPI 3.0
- **JSON处理**: FastJSON2
- **消息队列**: Apache Kafka
- **实时通信**: WebSocket
- **缓存**: 本地缓存（Caffeine）+ Redis
- **数据库**: PostgreSQL 15.x（推荐）/ MySQL 8.0.x
- **连接池**: HikariCP
- **参数校验**: Spring Boot Validation
- **日志框架**: Logback + SLF4J

### 核心依赖清单

#### Spring Boot生态
- spring-boot-starter-web
- spring-boot-starter-data-redis
- spring-boot-starter-validation
- spring-boot-starter-actuator
- spring-boot-starter-websocket

#### 数据库相关
- mybatis-plus-boot-starter:3.5.4
- postgresql:42.6.0（推荐）/ mysql-connector-j:8.2.0
- HikariCP（Spring Boot默认连接池）

#### 缓存相关
- spring-boot-starter-cache
- caffeine:3.1.8（本地缓存）
- spring-boot-starter-data-redis
- Redis:7.2.x（推荐稳定版本）

#### 消息队列
- spring-kafka:3.0.12
- Apache Kafka:3.5.x（推荐稳定版本）

#### 工具类库
- fastjson2
- apache-commons-lang3（字符串、数组、日期等工具）
- apache-commons-collections4（集合工具）
- apache-commons-io（IO操作工具）
- apache-commons-codec（编码解码工具）
- mapstruct（对象映射）
- guava（Google工具库，高性能集合和缓存）

#### API文档
- springdoc-openapi-starter-webmvc-ui

#### 安全相关
- spring-boot-starter-security（可选）
- jjwt（JWT处理）

#### 测试相关
- spring-boot-starter-test
- testcontainers（集成测试）
- mockito（单元测试Mock）

#### 监控运维
- micrometer-registry-prometheus（指标监控）
- spring-boot-starter-actuator（健康检查）
- logback-classic（日志）

## 部署配置

### Docker支持
- 每个服务提供Dockerfile
- docker-compose.yml用于本地开发环境
- 支持多阶段构建优化镜像大小
- 镜像构建和推送脚本

### 环境配置
- **开发环境**：application-dev.yml
- **测试环境**：application-test.yml
- **生产环境**：application-prod.yml
- 支持环境变量覆盖配置

## 开发规范

### 代码规范
- 统一的代码格式化配置
- 统一的异常处理机制
- 统一的日志输出格式
- 统一的API响应格式

### 数据库规范
- 统一的表命名规范
- 统一的字段类型定义
- 建议使用SQL脚本管理数据库结构变更

## 模块说明

### gear-core
- 核心基础模块，提供公共功能
- 统一错误码、工具类、REST返回对象
- 全局日志管理和异常处理

### gear-auth
- 认证授权服务
- 独立运行的微服务
- 为其他服务提供统一的身份认证和权限校验

### gear-backend
- 主要业务服务
- 提供REST API接口
- 支持多级缓存和多数据源

### gear-push
- 数据推送服务
- 消费Kafka消息队列
- 通过WebSocket向客户端推送实时数据

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request