# email-ec-boot

**Repository Path**: coding_13/email-ec-boot

## Basic Information

- **Project Name**: email-ec-boot
- **Description**: 发送谷歌邮箱
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-06
- **Last Updated**: 2025-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 邮件服务系统（Email Service System）

## 项目简介

本项目是一个基于Spring Boot的邮件服务系统，用于处理电子邮件的发送请求。系统结构清晰，模块化设计良好，便于维护和扩展。

## 主要功能

- 提供REST API接口用于发送电子邮件
- 支持统一的响应格式
- 集成日志记录和异常处理
- 支持MDC上下文跟踪，便于日志追踪

## 技术栈

- Spring Boot
- Spring AOP
- SLF4J
- Jackson JSON处理
- Maven

## 模块说明

- `email-front-boot`: 主应用模块，包含启动类和控制器
- `email-common-core`: 核心工具类和通用组件
- `email-web-common`: Web相关公共组件，包括全局异常处理器
- `email-dto`: 数据传输对象模块
- `email-service`: 邮件服务接口及实现
- `email-constant`: 常量定义
- `email-enums`: 枚举定义

## 核心特性

### 统一响应格式

使用`ResponseDTO`类作为所有API的返回模型，确保响应格式一致性。

### 日志记录

通过`LoggingAspect`类实现AOP日志记录，自动记录控制器方法的调用前后信息。

### 异常处理

全局异常处理器`ControllerErrorAdvice`统一处理各种异常，返回标准化的错误信息。

### MDC跟踪

支持请求链路跟踪，通过`WebTraceFilter`和`MDCTraceUtil`实现请求上下文的跟踪ID和跨度ID管理。

## 接口文档

### 发送邮件

**URL:** `/v1/email/send`

**方法:** POST

**请求体:** `EmailSendDTO`对象，包含邮件发送所需的所有信息

**返回值:** `ResponseDTO<Void>`对象，表示请求处理结果

## 配置文件

- `application.yml`: 主配置文件
- `application-dev.yml`: 开发环境配置
- `application-test.yml`: 测试环境配置
- `logback.xml`: 日志配置

## 启动方式

1. 确保已安装Java 8+和Maven
2. 执行命令: `mvn spring-boot:run`

## 依赖管理

使用Maven进行依赖管理，具体依赖项在各个模块的`pom.xml`文件中定义。

## 日志

系统使用SLF4J作为日志门面，具体实现为Logback，配置文件为`logback.xml`。

## 许可证

本项目遵循Apache 2.0协议，请参阅具体项目文件中的许可证声明。