调整升级文档及FAQ文档的结构

This commit is contained in:
Zhaoyang 2020-07-08 10:31:17 +08:00
parent 3bcbc4be99
commit bfd3b3bcf7
3 changed files with 22 additions and 16 deletions

View File

@ -95,14 +95,23 @@ module.exports = {
]
}
],
'/guide/notes/': [
'/guide/notes/faq': [
{
title: '版本升级&FAQ',
title: 'FAQ',
collapsable: true,
sidebarDepth: 2,
children: [
['/guide/notes/upgrade', '版本升级指南'],
['/guide/notes/faq', 'FAQ'],
['/guide/notes/faq/main', 'FAQ'],
]
}
],
'/guide/notes/upgrade': [
{
title: '版本升级指南',
collapsable: true,
sidebarDepth: 2,
children: [
['/guide/notes/upgrade/2_0_x升级至2_1_x', '2.0.x升级至2.1.x'],
]
}
]
@ -115,8 +124,8 @@ module.exports = {
{ text: 'core基础内核', link: '/guide/diboot-core/设计理念' },
{ text: 'IAM身份认证', link: '/guide/diboot-iam/介绍' },
{ text: 'File文件组件', link: '/guide/diboot-file/介绍' },
{ text: '版本升级指南', link: '/guide/notes/upgrade' },
{ text: 'F&Q', link: '/guide/notes/faq' },
{ text: '版本升级指南', link: '/guide/notes/upgrade/2_0_x升级至2_1_x' },
{ text: 'F&Q', link: '/guide/notes/faq/main' },
]
}, {
text: '前端项目 指南',

View File

@ -1,8 +1,6 @@
## v2.0.x 升级至 v2.1.x
## 组件更改说明
### 组件更改说明
#### 1. diboot-core
### diboot-core
* v2.1.x 版本开始BaseCrudRestController移除了方法中的request参数改为在BaseController中统一注入以简化继承代码。
子类需要时直接用request变量即可无需再定义request参数。
修改: 调用父类方法的Controller方法需删除方法中的request参数定义及传递。
@ -63,7 +61,7 @@ devtools从2.1版本开始不再支持extdata的特殊处理。
* v2.1.x版本依赖组件升级为: Spring Boot 2.3.xMybatis-Plus 3.3.xfastjson 1.2.7x。根据您的依赖情况,可能会有依赖冲突需要解决。
#### 2. diboot-devtools
### diboot-devtools
* v2.1版本开始,配置参数:
新增 **diboot.devtools.output-path** 代码的生成根路径配置项,
如entity, dto, controller, mapper, service, vo等路径无自定义需求仅配置该根路径即可。
@ -84,9 +82,8 @@ v2.1.x版本开始支持前端代码生成如果需要该功能则需配
diboot.devtools.output-path-frontend=/Workspace/diboot-antd-admin-ent/
~~~
#### 3. diboot-iam
### 升级实操指南
## 升级实操指南
> 将diboot所有的组件版本号替换至2.1.x的最新版本然后按照下述内容进行相关更改即可。
@ -94,7 +91,7 @@ diboot.devtools.output-path-frontend=/Workspace/diboot-antd-admin-ent/
后端项目升级完成后需要重新生成基础代码在此过程中如果对旧版本基础代码有更改则需要对旧版本基础代码做一个备份2.1.x版本已经不再从启动时候自动生成初始代码了需要您手动到diboot devtools中的初始化页面进行手动生成。
:::
#### 1. SpringBoot版本
### 1. SpringBoot版本调整
* 2.1.x已支持SpringBoot2.3.x版本请先升级SpringBoot版本为2.3.x
* 更改spring-boot-starter-test依赖项如下
@ -112,7 +109,7 @@ diboot.devtools.output-path-frontend=/Workspace/diboot-antd-admin-ent/
</dependency>
```
#### Controller文件相关更改
### 2. 所有Controller代码调整
* 更改BaseCustomCrudRestController类的传入参数如下
```java
public class BaseCustomCrudRestController<E extends BaseEntity, VO extends Serializable> extends BaseCrudRestController {
@ -191,7 +188,7 @@ public JsonResult deleteEntityMapping(@PathVariable("id")Long id) throws Excepti
后端项目升级完成后需要重新生成基础代码在此过程中如果对旧版本基础代码有更改则需要对旧版本基础代码做一个备份2.1.x版本已经不再从启动时候自动生成初始代码了需要您手动到diboot devtools中的初始化页面进行手动生成。
:::
#### diboot-antd-admin前端项目升级
### 3. diboot-antd-admin前端调整
> 前端项目需要先从github的release notes中下载一个2.1.0版本的源码包,以下升级流程将依赖于此源码包。
* 先更新package.json依赖到最2.1.0版本的依赖,具体如下: