# LightningGenerator

**Repository Path**: zyxi/LightningGenerator

## Basic Information

- **Project Name**: LightningGenerator
- **Description**: 一个简单易用的自动代码生成工具包
- **Primary Language**: Java
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-02
- **Last Updated**: 2022-01-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <a href="#">
   <img alt="LightningGenerator_Logo" src="https://s3.ax1x.com/2021/02/13/yr5k9A.png">
  </a>
</p>
<p align="center">
  LightningGenerator 自动代码生成工具包
</p>

<p align="center">
  <a href="#">
   <img alt="maven" src="https://img.shields.io/maven-central/v/org.apache.maven/apache-maven.svg">
  </a>
  <a href="#">
   <img alt="code style" src="https://img.shields.io/badge/%20LICENSE-GPL--2.0-blue.svg">
  </a>
  <a href="#">
   <img alt="code style" src="https://img.shields.io/badge/BUILD-PASSING-green.svg">
  </a>
  <a href="#">
   <img src="https://img.shields.io/badge/LightningGenerator-V1.0 releases-green.svg" >
  </a>
</p>

# 1、项目介绍
LightningGenerator一款代码生成工具包，可根据自定义的模板生成相应的代码<br>
> 支持 <img src="https://img.shields.io/badge/-MySQL-blue"> <img src="https://img.shields.io/badge/-Oracle-red">

## 基础功能
- 1、提供一套可以根据模板文件生成模板代码的API
- 2、提供一套可以根据字符串模板生成模板代码的API
- 3、提供一套简便获取创建的数据库相关元数据的API
- 4、提供命令行的交互式方式，便于生成模板代码与查看数据信息
- 5、提供完善的项目模板，包括Pojo、Dao、Service、Controller层代码以及常见的Mybatis XML配置等

# 2、环境配置
- 需安装JDK 8或以上

# 3、配置文件

lightningGenerator.properties
```properties
# ============= 基础配置 =============
# 编程语言
basic.language=JAVA
# 所属包名
basic.packageName=com.example.demo
# 命名风格
basic.nameStyle=HUMP
# 作者
basic.author=LightningGenerator
# 版本号
basic.version=v1.0.0

# ============= 数据库配置 =============
# 使用数据库
db.dbCategory=MYSQL
# 数据库驱动
db.driver=com.mysql.cj.jdbc.Driver
# 数据库URL
db.url=jdbc:mysql://127.0.0.1:3306/test?serverTimezone=GMT
# 用户名
db.user=***
# 密码
db.password=***
# 需要生成的表 全部：*, 否则使用“,” 分割
db.includeTables=*
# 需要排除的表 使用“,” 分割
# db.excludeTables=

# DBCP2配置
# db.initialSize=20
# db.maxTotal=80
# db.maxIdle=40
# db.minIdle=20
# db.maxWaitMillis=6000

# ============= 模板配置 =============
# 模板输入路径
template.templateBaseInputPath=E:\\template
# 模板输出路径
template.templateBaseOutputPath=C:\\gen
# 映射文件路径
template.templateMapping[pojo]=${metaData.className}.java
template.templateMapping[mapper]=${metaData.className}Dao.xml
template.templateMapping[dao]=${metaData.className}Dao.java
template.templateMapping[service]=${metaData.className}Service.java
template.templateMapping[service.impl]=${metaData.className}ServiceImpl.java
template.templateMapping[controller]=${metaData.className}Controller.java

# ============= 自定义配置 =============
# 自定义配置，会自动生成默认Key可在模板中使用
user.helloworld=hahahah
```

# 4、如何使用
> 3.1 使用命令行方式

命令`java -jar LightningGenerator-vx.x.x.jar`<br>
跟随参数

|  名称   |  参数  | 必填 | 备注 |
|  ----  |  ----  | ---- | ---- |
|  -h    |   -    |   否   | 查看帮助 |
|  -c     | 配置文件路径 |  是   | 指定配置文件 |
|  -s     | -      |  否   | 进行简易SQL命令行|
|  -g     | -      |  否   | 根据配置文件设置生成模板代码 |

运行`java -jar LightningGenerator-vx.x.x.jar -h` 查看帮助

[![y23SAO.png](https://s3.ax1x.com/2021/02/17/y23SAO.png)](https://imgchr.com/i/y23SAO)

使用`java -jar LightningGenerator-vx.x.x.jar -c 配置文件路径 -g` 生成代码

[![y23JbV.png](https://s3.ax1x.com/2021/02/17/y23JbV.png)](https://imgchr.com/i/y23JbV)

使用`java -jar LightningGenerator-vx.x.x.jar -c 配置文件路径 -s` 进入SQL命令行

[![y23tET.png](https://s3.ax1x.com/2021/02/17/y23tET.png)](https://imgchr.com/i/y23tET)


> 3.2 使用代码方式 

...

# 5、模板参数

|  名称   |  参数  | 备注 |
|  ----  | ----  | ---- |
| 单元格  | 单元格 | 单元格 |
| 单元格  | 单元格 | 单元格 |

# 6、案例演示


# 7、交流与改进
> 如果你有任何的想法或是建议那就给我们留言吧

<p>QQ交流群 252495388 
<a target="_blank" href="https://jq.qq.com/?_wv=1027&k=afw4lO2i" rel="nofollow">
<img border="0" src="https://pub.idqqimg.com/wpa/images/group.png" alt="LuckyFrame官方交流①群" title="LuckyFrame官方交流①群"></a>
</p>

# 8、一些问题
> 1、Windows上使用CMD生成乱码

原因: