# POYEE BASE - 基础插件

## 📋 项目简介

> POYEE BASE 是一个提供基础功能和工具的核心插件库，为上层应用提供统一的底层支持。

## 🌟 核心功能

### 自定义注解 [`annotation`](src/main/java/com/poyee/annotation)
- 数据库相关注解说明：[DB.md](DB.md)

### 基础抽象方法 [`base`](src/main/java/com/poyee/base)
> 说明：[base.md](base.md)
- **控制层**：controller 抽象类
- **业务层**：service 抽象类
- **数据层**：mapper 抽象类
  - mapper 接口
  - provider 动态SQL工具
    - [provider.md](provider.md) - 详细说明文档
    - 根据实体类注解动态生成查询SQL，无需使用 mapper.xml 文件
    - 工具内集成基础查询功能，复杂查询可自定义手写SQL
    - 使用方式：mapper.java 继承 IBaseProvider
    - 自定义SQL：业务模块在mapper包下创建provider包，创建*Provider类，编写自定义SQL逻辑
    - 参考文档：[MyBatis Provider使用指南](https://blog.csdn.net/fmwind/article/details/81534357)
- **数据模型**：entity、dto 实体类

### 通用工具 [`common`](src/main/java/com/poyee/common)
- 常量定义
- 数据库生成工具插件
- 业务异常处理工具 (exception)
- JSON处理工具 (JsonMapperUtil)
- API文档工具 (knife4j swagger2)

### 配置模块 `config`
- [自定义SQL注入器 (JoinSqlInjector)](src/main/java/com/poyee/config/JoinSqlInjector.java)
- [Redis配置](src/main/java/com/poyee/config/RedisConfig.java)

### 多数据源配置 [`dataSource`](src/main/java/com/poyee/datasource)

### Excel处理工具 [`easy`](src/main/java/com/poyee/easy)
> 说明：[easy.md](easy.md)

### 枚举定义 [`enums`](src/main/java/com/poyee/enums)

### 事件处理 [`handler`](src/main/java/com/poyee/handler)
- Excel处理：
  - [数据格式处理器 (EasyDataFormatHandler)](src/main/java/com/poyee/handler/EasyDataFormatHandler.java)
  - [分页查询监听器 (PageReadListenerHandler)](src/main/java/com/poyee/handler/PageReadListenerHandler.java)
- 消息队列：[`mq`](src/main/java/com/poyee/mq)
- 缓存工具：[`redis`](src/main/java/com/poyee/redis)
- 通用工具类：[`util`](src/main/java/com/poyee/util)

### 国际化支持 [`i18n`](src/main/java/com/poyee/i18n)
> 说明：[i18n.md](i18n.md)
- [多语言枚举 (I18nMessageEnums)](src/main/java/com/poyee/i18n/I18nMessageEnums.java)
- [多语言工具类 (I18nUtils)](src/main/java/com/poyee/i18n/I18nUtils.java)
- [多语言配置 (MessageProperties)](src/main/java/com/poyee/i18n/MessageProperties.java)
- [多语言配置文件 (message.yml)](src/main/resources/i18n/message.yml)

## 🛠️ 开发环境

<!-- 此处可添加开发环境相关信息，如JDK版本、构建工具等 -->

## 🔧 技术架构

<!-- 此处可添加技术架构相关信息，如框架版本、组件关系等 -->

## 📚 使用指南

<!-- 此处可添加项目使用说明、示例代码等 -->

## 🔄 版本历史

<!-- 此处可添加版本更新记录 -->