# TomAgent

**Repository Path**: miacandyfang/tom-agent

## Basic Information

- **Project Name**: TomAgent
- **Description**: Tom哥打造的智能体
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-05
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

根据提供的代码结构和组件信息，以下是适用于该项目的 README.md 内容：

```
# Tom Agent 项目说明

Tom Agent 是一个基于 Spring Boot 的后端服务应用，旨在提供用户管理功能，包括用户登录、注册、信息更新、密码修改、用户删除等操作，并内置了全局异常处理机制。

## 项目特点

- 使用 Spring Boot 快速搭建后端服务。
- 集成 MyBatis Plus，简化数据库操作。
- 提供统一的 RESTful API 接口。
- 异常处理模块化，通过 `GlobalExceptionHandler` 统一处理各类异常。
- 支持用户信息的增删改查和安全控制。
- 模块化设计，结构清晰，便于维护和扩展。

## 模块概览

- `TomAgentApplication`: 应用启动类。
- `SysUserController`: 提供用户相关操作的 RESTful API。
- `SysUserService`: 用户业务逻辑接口。
- `SysUserServiceImpl`: 用户业务逻辑实现类。
- `SysUserMapper`: 用户数据库操作接口。
- `SysUser`: 用户实体类，对应数据库表 `sys_user`。
- `MyMetaObjectHandler`: 自动填充创建和更新时间等字段。
- `MybatisPlusConfig`: 配置 MyBatis Plus 插件。
- `GlobalExceptionHandler`: 全局异常处理类，捕获并处理运行时异常。
- `BusinessException`: 自定义业务异常类。

## 快速开始

### 环境要求

- JDK 1.8 或以上版本
- Maven 3.5 或以上版本
- MySQL 5.7 或以上版本
- Git

### 构建与运行

1. **克隆项目**

   ```bash
   git clone https://gitee.com/miacandyfang/tom-agent.git
   cd tom-agent
   ```

2. **配置数据库**

   修改 `src/main/resources/application.yml` 文件中的数据库连接信息：

   ```yaml
   spring:
     datasource:
       url: jdbc:mysql://localhost:3306/tom_agent?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
       username: root
       password: root
       driver-class-name: com.mysql.cj.jdbc.Driver
   ```

3. **构建项目**

   ```bash
   mvn clean install
   ```

4. **运行项目**

   ```bash
   mvn spring-boot:run
   ```

5. **访问接口**

   启动成功后，访问 `http://localhost:8080/api/user` 相关接口进行测试。

## API 文档

- **用户登录**：`POST /api/user/login`
- **用户注册**：`POST /api/user/register`
- **获取用户信息**：`GET /api/user/info/{id}`
- **更新用户信息**：`PUT /api/user/update`
- **修改密码**：`POST /api/user/change-password`
- **删除用户**：`DELETE /api/user/delete/{id}`

## 异常处理

系统内置了全局异常处理器，可处理以下异常类型：

- `BusinessException`: 业务逻辑异常
- `NullPointerException`: 空指针异常
- `IllegalArgumentException`: 参数异常
- `RuntimeException`: 运行时异常
- `Exception`: 通用异常捕获

## 日志

系统使用 `logback` 作为日志框架，配置文件位于 `src/main/resources/logback-spring.xml`。

## 测试

项目包含单元测试类 `TomAgentApplicationTests`，可使用以下命令运行测试：

```bash
mvn test
```

## 贡献

欢迎提交 Issue 和 Pull Request 来帮助改进本项目。

## 许可证

本项目采用 MIT License，详情请查看 [LICENSE](LICENSE) 文件。
```