Skip to content

Commit 76b2043

Browse files
author
geekidea
committed
README.md
1 parent b73e24d commit 76b2043

File tree

2 files changed

+45
-19
lines changed

2 files changed

+45
-19
lines changed

README-zh.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,6 @@ mapstruct | 1.3.1.Final | 对象属性复制工具 |
9494
## CHANGELOG
9595
#### [CHANGELOG.md](https://github.com/geekidea/spring-boot-plus/blob/master/CHANGELOG.md)
9696

97-
## Java Docs
98-
#### [Java Api Docs](https://apidoc.gitee.com/geekidea/spring-boot-plus/)
99-
10097
## 使用
10198
### 克隆 spring-boot-plus
10299
```bash
@@ -148,11 +145,10 @@ INSERT INTO foo_bar (id, name, foo, bar, remark, state, version, create_time, up
148145

149146

150147
### 2.使用代码生成器生成增删改查代码
151-
152-
#### generator模块中
148+
> 代码生成入口类,在generator模块中
153149
154150
```text
155-
SpringBootPlusGenerator.java
151+
spring-boot-plus/generator/src/main/java/io/geekidea/springbootplus/generator/SpringBootPlusGenerator.java
156152
```
157153

158154
```java
@@ -232,6 +228,24 @@ public class SpringBootPlusGenerator {
232228
}
233229
```
234230

231+
#### Code Generator Templates
232+
> 使用Velocity模版生成代码,可自定义修改代码生成模版
233+
234+
```text
235+
spring-boot-plus/generator/src/main/resources
236+
```
237+
```text
238+
└── templates
239+
├── controller.java.vm 控制器代码生成模版
240+
├── entity.java.vm 实体类代码生成模版
241+
├── mapper.java.vm mapper代码生成模版
242+
├── mapper.xml.vm mapper xml 代码生成模版
243+
├── pageParam.java.vm 分页参数代码生成模版
244+
├── queryVo.java.vm 查询结果代码生成模版
245+
├── service.java.vm 服务接口代码生成模版
246+
└── serviceImpl.java.vm 服务实现代码生成模版
247+
```
248+
235249
> 生成的代码结构
236250
237251
```text
@@ -263,8 +277,9 @@ public class SpringBootPlusGenerator {
263277

264278
### 3. 启动项目
265279
> 项目入口类,在bootstrap模块中
280+
266281
```text
267-
src/main/java/io/geekidea/springbootplus/SpringBootPlusApplication.java
282+
spring-boot-plus/bootstrap/src/main/java/io/geekidea/springbootplus/SpringBootPlusApplication.java
268283
```
269284

270285
```java

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,8 @@ mapstruct | 1.3.1.Final | Object property replication tool |
9696
## CHANGELOG
9797
#### [CHANGELOG.md](https://github.com/geekidea/spring-boot-plus/blob/master/CHANGELOG.md)
9898

99-
## Java Docs
100-
#### [Java Api Docs](http://geekidea.io/spring-boot-plus-apidocs/)
10199

102-
103-
## Getting started
100+
## Quick Start
104101
### Clone spring-boot-plus
105102
```bash
106103
git clone https://github.com/geekidea/spring-boot-plus.git
@@ -110,7 +107,7 @@ cd spring-boot-plus
110107
### Maven Build
111108
> dev environment is used by default, The configuration file:application-dev.yml
112109
```bash
113-
mvn clean package -Plocal
110+
mvn clean package -Pdev
114111
```
115112

116113

@@ -149,14 +146,10 @@ INSERT INTO foo_bar (id, name, foo, bar, remark, state, version, create_time, up
149146
```
150147

151148
### 2. Generator CRUD CODE
152-
> Modify database info
153-
154-
> Modify module name / author / table name / primary key id
155-
156-
#### generator Module
149+
> Code generation entry class, in the generator module
157150
158151
```text
159-
SpringBootPlusGenerator.java
152+
spring-boot-plus/generator/src/main/java/io/geekidea/springbootplus/generator/SpringBootPlusGenerator.java
160153
```
161154

162155
```java
@@ -236,9 +229,27 @@ public class SpringBootPlusGenerator {
236229
}
237230
```
238231

232+
#### Code Generator Templates
233+
> Use Velocity template to generate code, you can customize and modify the code to generate template
234+
235+
```text
236+
spring-boot-plus/generator/src/main/resources
237+
```
238+
```text
239+
└── templates
240+
├── controller.java.vm controller generator template
241+
├── entity.java.vm entity generator template
242+
├── mapper.java.vm mapper generator template
243+
├── mapper.xml.vm mapper xml generator template
244+
├── pageParam.java.vm page param generator template
245+
├── queryVo.java.vm query vo generator template
246+
├── service.java.vm service generator template
247+
└── serviceImpl.java.vm service implement generator template
248+
```
249+
239250
```java
240251
/**
241-
* spring-boot-plus代码生成器入口类
252+
* spring-boot-plus Code Generator Main Class
242253
*
243254
* @author geekidea
244255
* @date 2019-10-22

0 commit comments

Comments
 (0)