Merge branch 'develop' of https://github.com/dibo-software/diboot-v2 into develop
This commit is contained in:
commit
2b5bbe6fc7
Binary file not shown.
After Width: | Height: | Size: 102 KiB |
|
@ -4,17 +4,19 @@
|
||||||
|
|
||||||
> 众多开发团队现状: 效率低、质量差、可维护性差,我们也常听到开发者抱怨每天CRUD、工作就是搬砖。
|
> 众多开发团队现状: 效率低、质量差、可维护性差,我们也常听到开发者抱怨每天CRUD、工作就是搬砖。
|
||||||
|
|
||||||
> diboot-devtools 是面向Java开发人员的自动化助理,有了她,你可以彻底摆脱CRUD等重复性的工作,专注于数据结构设计、业务实现,提高软件的质量、效率、可维护性。
|
> diboot-devtools 是面向Java开发人员的自动化助理,有了她,你可以彻底摆脱常规SQL与CRUD等重复性的工作,专注于数据结构设计、业务实现,提高软件的质量、效率、可维护性。
|
||||||
|
|
||||||
> **diboot-devtools - 将复杂的事情简单化,重复的事情自动化**
|
> **diboot-devtools - 将复杂的事情简单化,重复的事情自动化**
|
||||||
|
|
||||||
## diboot-devtools 的核心特性
|
## diboot-devtools 的核心特性
|
||||||
* 支持多数据库(MySQL、MariaDB、PostgreSQL、ORACLE、SQLServer)
|
* 支持多种数据库(MySQL、MariaDB、PostgreSQL、ORACLE、SQLServer)
|
||||||
* 使用很简单(UI界面操作,引入依赖,配置参数后,即可随SpringBoot本地项目启动运行)
|
* 使用很简单(UI界面操作,引入依赖,配置参数后,即可随SpringBoot本地项目启动运行)
|
||||||
* 功能很强大(数据结构变更与代码联动同步,一键生成&非覆盖式更新后端代码,一键生成前端功能代码,自动记录变更SQL、维护索引)
|
* 功能很强大(数据结构变更与代码联动同步,一键生成&非覆盖式更新后端代码,自动记录变更SQL、维护索引,一键生成前端功能代码,自动进行前后端权限绑定,自动完成数据关联相关前后端工作,ER图展示关联关系等)
|
||||||
* 单表与联表场景完整CRUD功能前后端代码完全自动生成,无需手写代码
|
* 单表与联表场景完整CRUD功能前后端代码完全自动生成,无需手写代码
|
||||||
* SQL与代码很标准(devtools标准化了数据结构定义与代码实现,降低维护成本)
|
* SQL与代码很标准(devtools标准化了数据结构定义与代码实现,降低维护成本)
|
||||||
* 配置很灵活(可按需配置生成代码路径、是否启用`Lombok`、`Swagger`等)
|
* 配置很灵活(可按需配置生成代码路径、是否启用`Lombok`、`Swagger`等)
|
||||||
|
* 开发很快捷(即便需要自己编写代码来实现特定业务逻辑,也能依赖我们生成的标准基础代码来快速完成)
|
||||||
|
* 使用很省心(能自动化处理的我们都会自动化帮您搞定,让您省心)
|
||||||
* 代码基于diboot高效基础框架生成,是diboot的最佳实践
|
* 代码基于diboot高效基础框架生成,是diboot的最佳实践
|
||||||
|
|
||||||
## devtools支持的数据库版本
|
## devtools支持的数据库版本
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
推荐使用 [Spring Initializer](https://start.spring.io/),快速初始化一个 Spring Boot 工程。
|
推荐使用 [Spring Initializer](https://start.spring.io/),快速初始化一个 Spring Boot 工程。
|
||||||
如果您使用IntelliJ IDEA,可以直接通过菜单: File -> New -> Project -> Spring Initializr 创建。
|
如果您使用IntelliJ IDEA,可以直接通过菜单: File -> New -> Project -> Spring Initializr 创建。
|
||||||
|
|
||||||
> 如果需要生成前端,需下载前端项目: [diboot-element-admin](https://github.com/dibo-software/diboot-element-admin) 或 [diboot-antd-admin](https://github.com/dibo-software/diboot-antd-admin)
|
> 如果需要生成前端,需根据相关版本下载对应的前端项目: [diboot-element-admin](https://github.com/dibo-software/diboot-element-admin/releases) 或 [diboot-antd-admin](https://github.com/dibo-software/diboot-antd-admin/releases)
|
||||||
|
|
||||||
## 2. 引入依赖
|
## 2. 引入依赖
|
||||||
* Gradle项目引入依赖
|
* Gradle项目引入依赖
|
||||||
|
@ -22,9 +22,28 @@ providedCompile("com.diboot:diboot-devtools-spring-boot-starter:{latestVersion}"
|
||||||
<groupId>com.diboot</groupId>
|
<groupId>com.diboot</groupId>
|
||||||
<artifactId>diboot-devtools-spring-boot-starter</artifactId>
|
<artifactId>diboot-devtools-spring-boot-starter</artifactId>
|
||||||
<version>{latestVersion}</version>
|
<version>{latestVersion}</version>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope><!-- 打war包时剔除devtools jar -->
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
如果spring boot项目需要打jar包运行,则需要参考如下配置确保打包时剔除devtools:
|
||||||
|
~~~
|
||||||
|
<plugins>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<!-- 打jar包时剔除 -->
|
||||||
|
<excludes>
|
||||||
|
<exclude>
|
||||||
|
<groupId>com.diboot</groupId>
|
||||||
|
<artifactId>diboot-devtools-spring-boot-starter</artifactId>
|
||||||
|
</exclude>
|
||||||
|
</excludes>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
~~~
|
||||||
|
|
||||||
> diboot-devtools-spring-boot-starter 是用于开发过程的助手工具,须声明 **provided**以免打包至非开发环境。
|
> diboot-devtools-spring-boot-starter 是用于开发过程的助手工具,须声明 **provided**以免打包至非开发环境。
|
||||||
|
|
||||||
## 3. 添加配置信息
|
## 3. 添加配置信息
|
||||||
|
@ -54,7 +73,7 @@ diboot.devtools.output-path-sql=example/src/main/resources/
|
||||||
diboot.devtools.enable-lombok=true
|
diboot.devtools.enable-lombok=true
|
||||||
#diboot.devtools.enable-swagger=false
|
#diboot.devtools.enable-swagger=false
|
||||||
#diboot.devtools.generate-mapper-xml=false
|
#diboot.devtools.generate-mapper-xml=false
|
||||||
# 前端项目路径(diboot-element-admin 或 diboot-antd-admin项目)
|
# 前端项目路径(diboot-element-admin 或 diboot-antd-admin项目,此处如果与后端项目为同一项目下不同模块,可只配置模块名,否则需要配置绝对路径,即全路径)
|
||||||
diboot.devtools.output-path-frontend=/D:/Workspace/diboot/diboot-antd-admin/
|
diboot.devtools.output-path-frontend=/D:/Workspace/diboot/diboot-antd-admin/
|
||||||
~~~
|
~~~
|
||||||
|
|
||||||
|
@ -72,7 +91,7 @@ diboot.devtools.output-path-frontend=/D:/Workspace/diboot/diboot-antd-admin/
|
||||||
* generate-mapper-xml:是否生成Mapper.xml文件,默认true
|
* generate-mapper-xml:是否生成Mapper.xml文件,默认true
|
||||||
* enable-lombok:是否引入`Lombok`注解,若设置true,请注意添加Lombok依赖。
|
* enable-lombok:是否引入`Lombok`注解,若设置true,请注意添加Lombok依赖。
|
||||||
* enable-swagger:是否引入`Swagger`注解,若设置true,请注意添加Swagger依赖。
|
* enable-swagger:是否引入`Swagger`注解,若设置true,请注意添加Swagger依赖。
|
||||||
* output-path-frontend:前端Vue项目路径,用于前端代码生成。前端项目下载: [diboot-element-admin](https://github.com/dibo-software/diboot-element-admin) 或 [diboot-antd-admin](https://github.com/dibo-software/diboot-antd-admin)
|
* output-path-frontend:前端Vue项目路径,用于前端代码生成(此处如果与后端项目为同一项目下不同模块,可只配置模块名,否则需要配置绝对路径,即全路径)。前端项目下载: [diboot-element-admin](https://github.com/dibo-software/diboot-element-admin) 或 [diboot-antd-admin](https://github.com/dibo-software/diboot-antd-admin)
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
如果您使用的是**PostgreSQL数据库**,那么需要额外添加两行配置,以此来适配boolean类型字段所对应的数据库的boolean类型,需添加的配置如下:
|
如果您使用的是**PostgreSQL数据库**,那么需要额外添加两行配置,以此来适配boolean类型字段所对应的数据库的boolean类型,需添加的配置如下:
|
||||||
|
@ -111,11 +130,27 @@ diboot-devtools在初次运行中,会自动检测安装以diboot_前缀的数
|
||||||
```
|
```
|
||||||
* Maven配置
|
* Maven配置
|
||||||
```
|
```
|
||||||
|
// dependency节点
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>com.diboot</groupId>
|
<groupId>com.diboot</groupId>
|
||||||
<artifactId>diboot-devtools-spring-boot-starter</artifactId>
|
<artifactId>diboot-devtools-spring-boot-starter</artifactId>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope><!-- 打war包时剔除 -->
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
|
//plugins节点配置
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.springframework.boot</groupId>
|
||||||
|
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<!-- 打jar包时剔除 -->
|
||||||
|
<excludes>
|
||||||
|
<exclude>
|
||||||
|
<groupId>com.diboot</groupId>
|
||||||
|
<artifactId>diboot-devtools-spring-boot-starter</artifactId>
|
||||||
|
</exclude>
|
||||||
|
</excludes>
|
||||||
|
</configuration>
|
||||||
|
</plugin>
|
||||||
```
|
```
|
||||||
|
|
||||||
* 方式二(为devtools创建专属项目,与代码项目隔离开):
|
* 方式二(为devtools创建专属项目,与代码项目隔离开):
|
||||||
|
|
|
@ -96,7 +96,7 @@
|
||||||
|
|
||||||
填写样例数据,方便后续的开发调试。
|
填写样例数据,方便后续的开发调试。
|
||||||
::: warning
|
::: warning
|
||||||
注:非空字段的样例数据不能为空,并且须严格按照字段的数据类型填写。
|
注:在2.0.x版本中,非空字段的样例数据不能为空,并且须严格按照字段的数据类型填写。在2.1.x版本中,非空字段的样例数据可以被自动填充个,也可以自己填写。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## 关联配置
|
## 关联配置
|
||||||
|
@ -105,3 +105,5 @@
|
||||||
|
|
||||||
## 关系图
|
## 关系图
|
||||||
> 显示数据表之间的关联关系,方便开发人员清晰的了解项目的数据模型。
|
> 显示数据表之间的关联关系,方便开发人员清晰的了解项目的数据模型。
|
||||||
|
|
||||||
|
![关联配置示例](./images/er_example.jpg)
|
||||||
|
|
Loading…
Reference in New Issue