# garbage-frame

**Repository Path**: LanyXP/garbage-frame

## Basic Information

- **Project Name**: garbage-frame
- **Description**: 我的脚手架项目
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-04-28
- **Last Updated**: 2025-04-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# garbage-frame

#### 项目简介
garbage-frame，"垃圾"脚手架！由于工作原因，每周六日更新项目。项目的灵感大多数来源于SpringBladeX这个开源收费的项目，公司内部使用的就是这个SpringBladeX快速开发框架。
在公司开发中，所有的项目都是在已经搭建好的基础上进行开发的。自己并不清楚项目的一个搭建过程，以及一些Jar包的加入……基于这样的背景，自己尝试做一个轻量级快速开发框架，随着自己技术的提升，后续会涵盖平时业务开发的常用场景，做到开箱即用。用户可根据自身情况选择组件来进行使用。采取组件化开发模式。
例如你要使用Redis，则选择Redis组件；使用Websocket，则引入Websocket组件，你不需要再开发什么，只需要按照组件规则进行使用即可。
同时，也会包含一些经典的工具以及经典的设计模式代码，你的业务场景一旦用到，就可以直接使用。
项目整体采用maven模块化开发，封装了许多的模块，彼此解耦。满足日常开发需要。

#### 内置模块
**garbage-frame**
- garbage-common-mybatisplus:采用MP进行数据库交互
- garbage-common-redis:缓存组件，提供基于redis的操作封装，redis分布式锁，后续会引入guava的cache工具类，hutool的也可以考虑
- garbage-common-swagger:swagger组件，提供整体项目访问API的入口及接口文档
- garbage-common-web:web组件，提供统一异常处理，统一返回值
- garbage-common-log:log组件，提供异步日志
- garbage-common-tool:tool工具类模板，提供一些常用的工具类
- 后续还会更新许多模块：garbage-common-websocket、garbage-common-job、garbage-common-tools、garbage-common-test……

#### garbage-user
这个模块中结合业务提供了大量的实例，展示如何直接使用这个脚手架，可以直接参考这个模块来建立自己的项目进行使用。目前已经提供的示例功能
- 完整的一套CRUD流程
- mapstruct的使用方式
- redis缓存使用，封装RedisUtil
- redis原始分布式锁封装
- 项目启动缓存预热
- 自定义banner
- 集成lombok
- 集成druid连接池及数据库连接监控
- 集成Mybatisplus的优化器及拦截器
- 统一数据库基础实体封装
- 集成swagger，并自定义信息
- easycode插件自动生成代码
- SpringCache注解缓存集成
- 基于disruptor高性能队列实现异步日志
- 基于AOP实现日志切面
- 借助freemarker模板引擎技术实现复杂word文件的导出
- 实际开发中常用的设计模式：如策略+工厂、构造者、模板方法模式等
- 基于guava完成本地缓存+函数式编程