sx 3 місяців тому
батько
коміт
758a5dcf74
1 змінених файлів з 73 додано та 0 видалено
  1. 73 0
      代码生成器使用说明.md

+ 73 - 0
代码生成器使用说明.md

@@ -0,0 +1,73 @@
+# renren-code-generator 代码生成器
+
+## 项目简介
+
+基于 [renren-generator](https://gitee.com/renrenio/renren-generator) 二次开发的**数据库表代码生成器**。连接目标数据库后,通过 Web 页面选择数据表,一键生成前后端 CRUD 代码,打包为 zip 下载。
+
+## 技术栈
+
+Spring Boot 2.2.6 + MyBatis-Plus + Velocity 模板引擎 + Vue(前端页面)
+
+## 支持的数据库
+
+MySQL、Oracle、SQLServer、PostgreSQL、MongoDB、达梦(DM)
+
+## 生成的代码文件
+
+| 类型 | 文件 |
+|------|------|
+| 后端 | Entity、Controller、Service、ServiceImpl、Dao、Mapper(接口+XML)、EntityMapper |
+| 参数对象 | AddPO、UpdatePO、PagePO、VO、DTO |
+| 前端 | index.vue、add-or-update.vue |
+| 其他 | menu.sql(菜单初始化SQL) |
+
+## 使用步骤
+
+### 1. 修改数据库连接
+
+编辑 `src/main/resources/application.yml`,配置目标数据库的 url / username / password,并通过 `renren.database` 指定数据库类型(如 `mysql`、`dm`、`oracle` 等)。
+
+```yaml
+spring:
+  datasource:
+    driverClassName: com.mysql.cj.jdbc.Driver
+    url: jdbc:mysql://你的数据库地址:3306/数据库名?useUnicode=true&characterEncoding=UTF-8&useSSL=false
+    username: 用户名
+    password: 密码
+
+renren:
+  database: mysql
+```
+
+### 2. 修改生成配置
+
+编辑 `src/main/resources/generator.properties`:
+
+| 配置项 | 说明 | 示例 |
+|--------|------|------|
+| `package` | 生成代码的包名 | `com.kingdom` |
+| `moduleName` | 模块名(影响生成目录结构) | `main` |
+| `tablePrefix` | 表前缀,生成类名时自动去除 | `t_main_` |
+| `author` | 注释中的作者 | `zhangsan` |
+| `email` | 注释中的邮箱 | `zhangsan@qq.com` |
+
+### 3. 启动项目
+
+运行 `src/main/java/io/renren/RenrenApplication.java` 主类,服务启动在 **81 端口**。
+
+### 4. 生成代码
+
+浏览器访问 `http://localhost:81`,在页面中勾选需要生成的表,点击「生成代码」按钮,浏览器会自动下载 `renren.zip`,解压后将文件拷贝到对应工程目录即可。
+
+## 自定义模板(可选)
+
+生成模板位于 `src/main/resources/template/` 目录(`.vm` 文件),如需调整生成代码的风格或结构,直接修改对应模板即可。
+
+## 常见问题
+
+| 问题 | 解决方案 |
+|------|----------|
+| 启动报数据库连接失败 | 检查 application.yml 中数据库地址、端口、账号密码是否正确,确认数据库服务已启动 |
+| 页面看不到表 | 确认 `renren.database` 配置与实际数据库类型一致 |
+| 生成的类名带前缀 | 在 generator.properties 中配置正确的 `tablePrefix` |
+| 切换达梦/Oracle等数据库 | 修改 application.yml 中注释的对应数据库配置,并修改 `renren.database` 的值 |