# pearl-code-generator

**Repository Path**: pearl-organization/pearl-code-generator

## Basic Information

- **Project Name**: pearl-code-generator
- **Description**: 一款简单好用的代码生成器
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 2
- **Created**: 2022-06-29
- **Last Updated**: 2025-09-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">Pearl 代码生成器</h1>

# 简介

​	`pearl-code-generator`是一个代码生成工具。功能丰富、配置灵活、上手简单。

​	如果您使用`Spring Boot`+`mybatis-plus`进行开发，该工具会成为您的得力助手，大大提高开发效率。

# 特性

- `JAVA`各层代码，例如`controller`、`service`、`entity`、`mapper`、`vo`、`dto`等。
- 多种数据库，支持`Mysql`、`Oracle`、`postgresql`、`postgresql`、`达梦`、`人大金仓`等。
- 可视化操作，所有操作都在页面上进行即可。
- 上手简单，选择方案后，一键生成即可。
- 可预览，提供预览界面，查看并检查生成代码。

# 开发计划
- 1.0 实现生成`JAVA `各层代码（已完成）
- 2.0 实现生成`VUE`前端代码
- 3.0 实现生成监控大屏代码
- 4.0 实现生成`react`代码

# 技术栈

- VUE 2.0 
- Spring Boot 2.7.3
- mybatis-plus 3.5.0
- mybatis-plus-generator 3.5.2
- freemarker 2.3.31 

# 工程结构

```
├── pearl-code-generator                              // 父项目
│       └── doc                                       // 文档、脚本等
│       └── generator-console                         // 代码生成可视化控制台
│       └── generator-server                          // 后台
```

# 使用教程

详细使用文档，请参考项目`doc`文件夹下教程。

​	**生成JAVA 代码示例**：

```
示例：USER表
api模块
-pojo
    - vo 返回给前端
        -- UserVO
    - query 查询参数对象
        -- UserQuery
    - form 表单对象
        -- UserForm
    - dto 传输层对象
        -- UserDTO
服务模块
- controller API层
	-- UserController
- service 服务层
    -- UserService
    -- impl 
        -- UserServiceImpl
- mapper 数据库映射
    -- UserMapper.java
    -- xml
        -- UserMapper.xml
- entity 实体类对象
        -- UserEntity 
```

## 1. 运行

### 	程序运行：

​		下载安装包`generator`，执行`generator\conf\pearl_generator.sql`脚本到数据库中。

​		 修改`conf\application.yml`文件中的数据库连接地址、用户密码。

​		 运行`bin\startup.cmd`启动项目，输入控制台打印的首页访问地址即可。

### 	源码运行：

​		克隆源码到本地，执行`pearl-code-generator\doc\publish\generator\conf\pearl_generator.sql`脚本到数据库中。

​		修改`generator-server`项目`application.yml`文件中的数据库连接地址、用户密码，启动项目。

​		运行前端`VUE`项目`generator-console`，访问首页即可。

## 2. 配置

​	首先添加数据源。

![1671696075319](https://gitee.com/pearl-organization/pearl-code-generator/raw/master/doc/images/1671696075319.png)

​	修改配置，大多数都有默认值，只需要修改包路径、作者名等一些不通用的配置即可。

​	![1671696124900](https://gitee.com/pearl-organization/pearl-code-generator/raw/master/doc/images/1671696124900.png)

## 3. 生成

选择数据源和方案，可查看到所有表信息。

![1671696230707](https://gitee.com/pearl-organization/pearl-code-generator/raw/master/doc/images/1671696230707.png)

点击预览，可预览当前表生成的各层代码，可直接复制。

![1671696337947](https://gitee.com/pearl-organization/pearl-code-generator/raw/master/doc/images/1671696337947.png)

选择需要生成的表，可直接生成文件到本地：

![1671696409680](https://gitee.com/pearl-organization/pearl-code-generator/raw/master/doc/images/1671696409680.png)