# ruoyi-eggjs-cli
**Repository Path**: never-Giveup/ruoyi-eggjs-cli
## Basic Information
- **Project Name**: ruoyi-eggjs-cli
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-26
- **Last Updated**: 2025-12-26
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# ruoyi-eggjs-cli
> Egg.js MyBatis 风格的 Service 代码生成器，附带内网穿透功能
基于 MyBatis XML 映射文件自动生成 Egg.js Service 层代码，减少重复劳动，提高开发效率。
## 目录
- [特性](#特性)
- [安装](#安装)
- [使用方法](#使用方法)
- [工作原理](#工作原理)
- [示例](#示例)
- [自动监听模式](#自动监听模式)
- [目录结构对照](#目录结构对照)
- [SQL 类型映射](#sql-类型映射)
- [命名规范](#命名规范)
- [配置要求](#配置要求)
- [开发工作流](#开发工作流)
- [FRP 内网穿透](#frp-内网穿透)
- [常见问题](#常见问题)
- [完整示例项目](#完整示例项目)
- [联系方式](#联系方式)
- [贡献指南](#贡献指南)
- [License](#license)
## 特性
- ✅ 自动扫描 XML Mapper 文件并生成对应的 Service 代码
- ✅ 支持多数据库类型（MySQL、SQLite、PostgreSQL 等）
- ✅ 支持多数据源配置
- ✅ 实时监听模式，XML 文件变化时自动重新生成
- ✅ 自动生成符合命名规范的方法（驼峰命名）
- ✅ 智能识别 SQL 类型（select、selects、insert、update、delete）
- ✅ 生成进度可视化显示
- ✅ 附带内网穿透功能（FRP）
## 安装
```bash
$ npm install ruoyi-eggjs-cli --save-dev
```
## 使用方法
### 基础用法
在项目根目录执行：
```bash
# 使用当前目录作为项目路径
$ psy mapper
# 指定项目路径
$ psy mapper /path/to/your/project
```
### 完整参数
```bash
$ psy mapper [projectPath] [options]
```
**参数说明：**
| 参数 | 说明 | 默认值 |
| --- | --- | --- |
| `projectPath` | 项目路径 | 当前工作目录 |
| `-m, --mapperDir` | Mapper XML 文件所在目录（相对路径） | `mapper` |
| `-d, --defaultDatabse` | 默认数据库类型 | `mysql` |
| `-w, --watch` | 是否启用自动监听模式 | `true` |
### 使用示例
```bash
# 基础用法，使用默认配置
$ psy mapper
# 指定 Mapper 目录
$ psy mapper -m custom-mapper
# 指定默认数据库为 SQLite
$ psy mapper -d sqlite
# 禁用自动监听
$ psy mapper -w false
# 组合使用
$ psy mapper /my/project -m mapper -d mysql -w true
```
## 工作原理
### 1. 扫描 XML 文件
CLI 会扫描指定目录下的所有 `.xml` 文件：
```
./mapper/
├── mysql/
│ └── ruoyi/
│ ├── SysUserMapper.xml
│ └── SysRoleMapper.xml
└── sqlite/
└── cache/
└── CacheMapper.xml
```
### 2. 生成 Service 代码
根据 XML 文件的目录结构和内容，自动生成对应的 Service 文件：
```
./app/service/db/
├── mysql/
│ └── ruoyi/
│ ├── SysUserMapper.js
│ └── SysRoleMapper.js
└── sqlite/
└── cache/
└── CacheMapper.js
```
### 3. Service 代码结构
生成的 Service 类包含以下内容：
- **基础方法**：
- `mapper(sqlid, values, params)` - 获取 SQL 语句
- `db()` - 获取数据库实例
- **自动生成的方法**（根据 XML 中的 SQL 语句）：
- `xxxMapper(values, params)` - 生成 SQL
- `xxx(values, params)` - 执行 SQL 并返回结果
## 示例
### 输入：XML Mapper 文件
```xml
INSERT INTO sys_user (user_name, nick_name, email)
VALUES (#{userName}, #{nickName}, #{email})
UPDATE sys_user
user_name = #{userName},
email = #{email},
update_time = NOW()
WHERE user_id = ?
DELETE FROM sys_user WHERE user_id = ?
```
### 输出：生成的 Service 代码
```javascript
// app/service/db/mysql/ruoyi/SysUserMapper.js
const Service = require('egg').Service;
class SysUserMapperService extends Service {
mapper(sqlid, values, params) {
return this.app.mapper('mapper/mysql/ruoyi/SysUserMapper.xml', sqlid, values, params)
}
db() {
return this.app.mysql.get('ruoyi');
}
selectUserListMapper(values, params) {
return this.mapper('selectUserList', values, params);
}
async selectUserList(values, params) {
return await this.db().select(this.selectUserListMapper(values, params));
}
selectUserByIdMapper(values, params) {
return this.mapper('selectUserById', values, params);
}
async selectUserById(values, params) {
return await this.db().select(this.selectUserByIdMapper(values, params));
}
insertUserMapper(values, params) {
return this.mapper('insertUser', values, params);
}
async insertUser(values, params) {
return await this.db().insert(this.insertUserMapper(values, params));
}
updateUserMapper(values, params) {
return this.mapper('updateUser', values, params);
}
async updateUser(values, params) {
return await this.db().update(this.updateUserMapper(values, params));
}
deleteUserMapper(values, params) {
return this.mapper('deleteUser', values, params);
}
async deleteUser(values, params) {
return await this.db().del(this.deleteUserMapper(values, params));
}
}
module.exports = SysUserMapperService;
```
### 使用生成的 Service
```javascript
// app/controller/user.js
class UserController extends Controller {
async list() {
const { ctx } = this;
const params = ctx.request.body;
// 调用生成的 Service
const users = await ctx.service.db.mysql.ruoyi.sysUserMapper.selectUserList(
ctx.helper.page(params),
params
);
ctx.body = { code: 200, data: users };
}
async info() {
const { ctx } = this;
const { userId } = ctx.params;
const user = await ctx.service.db.mysql.ruoyi.sysUserMapper.selectUserById([userId]);
ctx.body = { code: 200, data: user };
}
async add() {
const { ctx } = this;
const user = ctx.request.body;
const insertId = await ctx.service.db.mysql.ruoyi.sysUserMapper.insertUser([], user);
ctx.body = { code: 200, data: insertId };
}
async update() {
const { ctx } = this;
const user = ctx.request.body;
await ctx.service.db.mysql.ruoyi.sysUserMapper.updateUser([user.userId], user);
ctx.body = { code: 200, message: '更新成功' };
}
async remove() {
const { ctx } = this;
const { userId } = ctx.params;
await ctx.service.db.mysql.ruoyi.sysUserMapper.deleteUser([userId]);
ctx.body = { code: 200, message: '删除成功' };
}
}
```
## 自动监听模式
启用监听模式（默认开启）后，CLI 会自动监听 XML 文件的变化：
```bash
$ psy mapper
✔ 生成成功
✔ 自动监听模式已启动
```
**监听功能：**
1. **文件变更**：修改 XML 文件后自动重新生成对应的 Service
2. **文件删除**：删除 XML 文件后自动删除对应的 Service 文件
3. **智能更新**：只在 SQL ID 发生变化时才重新生成，避免不必要的文件写入
```bash
# 修改 XML 文件后
./mapper/mysql/ruoyi/SysUserMapper.xml has been changed
# 删除 XML 文件后
./mapper/mysql/ruoyi/SysRoleMapper.xml has been removed
```
## 目录结构对照
### 单数据库
```bash
# 输入
./mapper/
└── dbname/
└── TableMapper.xml
# 输出
./app/service/db/
└── dbname/
└── TableMapper.js
# Service 中的 db() 方法
db() {
return this.app.mysql.get('dbname');
}
```
### 多数据库
```bash
# 输入
./mapper/
└── mysql/
└── dbname/
└── TableMapper.xml
# 输出
./app/service/db/
└── mysql/
└── dbname/
└── TableMapper.js
# Service 中的 db() 方法
db() {
return this.app.mysql.get('dbname');
}
```
## SQL 类型映射
CLI 会根据 XML 中的标签类型，自动调用对应的数据库方法：
| XML 标签 | 数据库方法 | 返回值 |
| --- | --- | --- |
| `