# 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-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 一、项目模块说明

```bash
├─tornado-common
	项目的通用模块，提供基础模型，通用常量，通用工具类
├─tornado-core				
	项目的核心模块，所有的业务模块都需引用该模块，是项目的基础其中包含分布式锁、异常处理、分布式链路追，id注入等相关通用模块
├─tornado-dict				
	数据字典模块，收集项目中的所有字典数据（实现BaseEnum的枚举），将其根据配置的规则存储在不同的介质中，并提供相应api
├─tornado-generator			
	基础mybatisplus的逆向工程，在其基础上扩展DTO、VO、QueryDTO等模块，并定制基于tornado-myabatis-plus的模块
├─tornado-mybatis-plus		
	在mybatisplus的基础上进一封装，实现基于DTO的数据操作，以及基于xxxQueryDTO的查询操作，统一定义wrapper实现查询，并提供sql语句解析器可实现影子表的查询，以及对SQL语句条件的修改，同时提供sql查询插件，用于监控sql执行日志
├─tornado-security
│  └─tornado-security-core
	基于springsecurity 封装用户登录、授权相关功能，通过实现指定的接口即可实现用户的登录认证
├─tornado-sms
	提供用户通知的简单封装，提供短信模块的管理、发送等功能，支持阿里云、腾讯云、邮箱、mock等实现方式只需通过简单的配置即可实现短信的发送，亦可以自定义自己的实现
├─tornado-springdoc
	基于OpenAPI 3.0 的文档管理工具，在springdoc的基础上扩展出可实现基于注解方式的分组处理，只需在对应的api上标注，@ApiVersion即可
├─tornado-storage
	分布式文件存储模块，通过软连接的方式实现重复文件的上传、通过hash值实现秒传，支持阿里云OSS、Minio、Local等方式的文件存储，通过文件表的方式让文件在业务系统中的流转通过文件id进行流转
├─tornado-test
	项目的测试模块
└─tornado-unique
	分布式id的生成处理方案，目前支持雪花、UUID、自定义RedisId生成器等实现
```