# tornado

**Repository Path**: tornado-xc/tornado

## Basic Information

- **Project Name**: tornado
- **Description**: 基础工具库
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2023-05-02
- **Last Updated**: 2025-11-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 一、项目介绍及模块说明
该项目主要是基于SpringBoot开发的一套基础脚手架，使用该脚手架用户只需关注与业务本身的开发，无需做过多的繁杂配置，项目中包含了项目开发
过程中的各种开发模块，方便开发者快速搭建项目。如：消息发送、日志处理、文件上传、分布式锁、分布式会话等。项目中使用了较多的设计模块预留了
较多的扩展点方便后续对功能的扩展，下面是整个功能模块的设计图：

![img.png](doc/images/img.png)
* tornado-common
    * 通用工具、常量、基础模块
* tornado-core
    * 包含统一异常处理、统一返回结果、通用配置、线程池配置、分布式锁、链路追踪、各类工具类
* tornado-mybatis-plus
    * 持久层框架，对Mybatis-plus的进一步封装，支持DTO/VO/DO等模块的划分，封装通用wrapper实现单表查询
* tornado-generator
    * 代码生成器，在mybatis plus的基础上添加了VO/DTO/DO等模块的生成，并根据tornado-mybatis-plus的设计自动生成符合项目规范的代码
* tornado-dict
    * 通过简单的配置即可实现数据字典的配置，并自动生成对应的枚举类，方便前端使用
* tornado-springdoc
    * 对springdoc的进一步封装，支持swagger3.0，并添加了自定义的参数解析器，从而实现通过简单的注解实现接口的管理
* tornado-security  
    * 集成了spring-security，并添加了自定义的认证、鉴权、登录、登出、权限校验等模块，集成Spring Session Redis实现分布式会话
* tornado-log
    * 日志处理模块，支持对web请求日志、业务日志的记录，并支持多种处理方式如：DB、ES、MQ等
* tornado-sms
    * 集成了阿里云、腾讯云短信以及邮箱短信通知，并添加了自定义的短信发送接口，支持短信发送记录的保存和查询
* tornado-storage
    * 集成了阿里云、Minio、本地等存储方式，支持文件的上传、下载、删除、分片上传等功能
* tornado-unique
    * 分布式id生成器
* tornado-test
    * 测试模块