更新相关文档

This commit is contained in:
Zhaoyang 2019-11-03 23:12:40 +08:00
parent 45620a7a18
commit 5213c9cb50
3 changed files with 36 additions and 21 deletions

View File

@ -3,31 +3,30 @@
<div class="home">
<div class="hero">
<p class="action">
<!--<a href="" class="nav-link action-button">快速上手 </a>-->
<!--<a href="javascript:;" class="nav-link action-button" @click="showVideo">了解diboot2.0</a>-->
<a href="" class="button white">快速上手</a>
<a :href="$withBase('/guide/diboot-core/安装.html')" class="button white">快速上手</a>
<!--
<i class="fa fa-2x fa-play-circle" aria-hidden="true"></i>
<a href="javascript:;" class="button has-icon" @click="showVideo">
<img class="icon" src="/play-circle.png" alt="">
了解diboot2.0
</a>
-->
</p>
</div>
<div class="custom content">
<div class="features">
<div class="feature">
<h2>简明优先</h2>
<p>对以 markdown 为中心的项目结构做最简化的配置帮助你专注于创作</p>
<h2>单表CRUD无SQL</h2>
<p>借助强大的mybatis-plus单表CRUD无SQL</p>
</div>
<div class="feature">
<h2>Vue 驱动</h2>
<p>享用 Vue + webpack 开发环境 markdown 中使用 Vue 组件并通过 Vue 开发自定义主题</p>
<h2>关联无SQL</h2>
<p>单表直接关联中间表多表关联数据字典关联等都将无SQL轻松实现</p>
</div>
<div class="feature">
<h2>性能高效</h2>
<p>VuePress 将每个页面生成为预渲染的静态 HTML每个页面加载之后然后作为单页面应用程序(SPA)运行</p>
<h2>自动化工具Devtools</h2>
<p>支持五大数据库的数据结构维护数据结构图形化展示从实体类到Rest接口的代码生成与更新等</p>
</div>
</div>
</div>
@ -44,6 +43,7 @@
<li>电话0512-62988949</li>
<li>Q Q281550336</li>
<li>邮箱service@dibo.ltd</li>
<li>技术交流QQ群731690096</li>
</ul>
</div>
<div class="footer-item"></div>

View File

@ -2,20 +2,27 @@
> 数据设计完成后,需要提交相关更改。点开右上角「提交更新」下拉菜单,这里有三个按钮:仅更新数据库、更新数据库和代码、重新生成代码并更新数据库。
## 仅更新数据库
选择该操作,只是对**数据库表结构**及**样例数据**进行更新,不会涉及代码。
同时以SQL的形式保存修改内容到`update.sql`文件。
## 更新数据库
* 该操作,只是对**数据库表结构**及**样例数据**进行更新,不会涉及代码的生成与更新。
* 数据结构相关更改将以SQL代码的形式保存修改内容到`update.sql`文件保存更改的update.sql文件存放位置可以根据以下配置来设置更新的sql文件存放文职。
```properties
# 此处使用相对于项目的相对路径
diboot.devtools.output-path-sql=devtools-example/src/main/resources/
```
## 更新数据库和代码
选择该操作,除了更新**数据库表结构**及**样例数据**以外,同时会**更新**相关代码(`Entity`、`VO`、`Service及其实现类`、`Mapper及映射文件`、`Controller`)。
同时以SQL的形式保存修改内容到`update.sql`文件。
::: tip
非devtools自动生成的代码仍将保留。
* 该操作会更新**数据库表结构**及**样例数据**以及将数据结构的更改SQL记录到对应的sql文件中这点与**仅更新数据库**功能相同。
* 会在已有代码的基础上对Entity、VO、Service及其实现类、Mapper类、Controller类中涉及到的代码进行更新。
* 更新过程中,近会对更改的相关字段所涉及到的相关字段以及方法进行更新。
* 这些被更新的字段以及方法不会影响到其他的字段以及方法,因此对于相关联的字段以及方法之外的代码并没有破坏作用。
* 对于被更新的方法将会覆盖原方法目前将会覆盖的方法主要为entity以及vo中与更改相关联的字段的**getter/setter**方法以及在设置关联数据情况下也将覆盖相对应的Controller文件中的**attachMore**方法
:::warning
注意:**更新可能会因为设置关联关系等原因覆盖掉controller文件中的attachMore方法**,但对其他字段及方法无影响。
:::
## 重新生成代码并更新数据库
选择该操作,除了更新**数据库表结构**及**样例数据**外,同时会**重新生成**相关代码(`Entity`、`VO`、`Service及其实现类`、`Mapper及映射文件`、`Controller`)
同时以SQL的形式保存修改内容到`update.sql`文件
## 更新数据库&生成代码
* 该操作会更新**数据库表结构**及**样例数据**以及将数据结构的更改SQL记录到对应的sql文件中这点与**仅更新数据库**功能相同
* 会**重新生成*Entity、VO、Service及其实现类、Mapper及其映射文件、Controller文件等
::: warning
该功能是完全的重新生成代码非devtools自动生成的代码将被覆盖
注意:该功能是完全的重新生成代码,同名的相关文件都将被覆盖。
:::

View File

@ -67,6 +67,14 @@ diboot.devtools.enable-diboot-shiro=false
* diboot.devtools.enable-lombok是否引入`Lombok`注解若设置true请注意添加Lombok依赖。
* diboot.devtools.enable-diboot-shiro是否引入`diboot-shiro`注解若设置true请注意添加diboot-shiro依赖。
:::warning
如果您使用的是**PostgreSQL数据库**那么需要额外添加两行配置以此来适配boolean类型字段所对应的数据库的boolean类型需添加的配置如下
:::
```properties
mybatis-plus.global-config.db-config.logic-delete-value=true
mybatis-plus.global-config.db-config.logic-not-delete-value=false
```
## 初始化数据库
diboot-devtools在初次运行中会自动安装所需数据库表如果已经存在则不做操作。