# mp-util

**Repository Path**: yelisheng_admin/mp-util

## Basic Information

- **Project Name**: mp-util
- **Description**: 这是一个基于 Spring Boot 和 MyBatis-Plus 的工具库项目，包含核心工具模块和自动配置模块。核心模块提供查询工具类、常量定义和自定义注解，Starter 模块实现 Spring Boot 自动配置。依赖 MyBatis-Plus、Hutool 和 Lombok，结构清晰，适用于简化 MyBatis-Plus 操作场景，是企业级项目的通用工具组件。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2025-03-27
- **Last Updated**: 2025-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 项目框架结构文档

## 一、依赖包清单
### Spring 生态
- spring-boot-autoconfigure 2.7.18
- spring-boot-configuration-processor 2.7.18

### 数据持久层
- mybatis-plus-boot-starter 3.5.3.1

### 工具类
- lombok 1.18.24
- hutool-all 5.8.26

### 测试相关
- junit-jupiter 5.10.2
- mockito-core 4.11.0
- assertj-core 3.24.2

## 二、模块结构
### 1. 核心工具模块 (mp-util-core)
- 工具类层：com.github.yelisheng.utils
- 常量定义：com.github.yelisheng.constant
- 注解定义：com.github.yelisheng.annotation

### 2. 自动配置模块 (mp-util-spring-boot-starter)
- 自动配置类：com.github.yelisheng.autoconfigure

## 三、MVC架构规范
### 基础工具类架构
由于本项目是工具类库架构，采用以下分层规范：

### 工具类层
路径：`mp-util-core/src/main/java/com/github/yelisheng/utils`
- 核心工具方法实现
- 包含：MpUtil.java

### 常量定义层
路径：`mp-util-core/src/main/java/com/github/yelisheng/constant`
- 系统级常量定义
- 包含：QueryType.java、QueryStatic.java

### 注解层
路径：`mp-util-core/src/main/java/com/github/yelisheng/annotation`
- 自定义注解定义
- 包含：MpQuery.java

### 自动配置层
路径：`mp-util-spring-boot-starter/src/main/java/com/github/yelisheng/autoconfigure`
- Spring Boot Starter 自动配置类
- 包含：MpUtilAutoConfiguration.java

## 四、多模块说明
本项目采用双模块Maven结构，通过功能划分实现模块化设计：
1. mp-util-core：提供核心工具类、常量定义和注解等基础能力
2. mp-util-spring-boot-starter：提供Spring Boot生态的自动配置支持