Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
uni-app
提交
a3828b2d
U
uni-app
项目概览
DCloud
/
uni-app
15 天 前同步成功
通知
702
Star
38704
Fork
3642
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
7
列表
看板
标记
里程碑
合并请求
1
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
uni-app
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
7
Issue
7
列表
看板
标记
里程碑
合并请求
1
合并请求
1
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
a3828b2d
编写于
10月 22, 2020
作者:
inkwalk
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
doc: admin.md 1.0.2 update
上级
5961cdae
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
95 addition
and
33 deletion
+95
-33
docs/uniCloud/admin.md
docs/uniCloud/admin.md
+95
-33
未找到文件。
docs/uniCloud/admin.md
浏览文件 @
a3828b2d
# uniCloud
Admin
# uniCloud
admin 基础框架
### 什么是uniCloud Admin
### 什么是uniCloud Admin
uniCloud
Admin,是基于uni-app和uniCloud的应用后台管理框架
。
uniCloud
admin 基础框架,是基于uni-app和uniCloud的应用后台管理框架。HBuilder X 2.9.5+ 支持,请更新到最新版本使用
。
-
它使用uni-app的宽屏适配,可自动适配PC宽屏和手机各端。了解
[
宽屏适配
](
https://uniapp.dcloud.io/adapt
)
-
它使用uni-app的宽屏适配,可自动适配PC宽屏和手机各端。了解
[
宽屏适配
](
https://uniapp.dcloud.io/adapt
)
-
它基于uniCloud,是serverless的云开发。了解
[
uniCloud
](
https://uniapp.dcloud.io/uniCloud/README
)
-
它基于uniCloud,是serverless的云开发。了解
[
uniCloud
](
https://uniapp.dcloud.io/uniCloud/README
)
-
它基于uni-id,
是uniCloud之上
的用户账户、权限系统。了解
[
uni-id
](
https://uniapp.dcloud.io/uniCloud/uni-id
)
-
它基于uni-id,
admin 框架使用的是 uni-id
的用户账户、权限系统。了解
[
uni-id
](
https://uniapp.dcloud.io/uniCloud/uni-id
)
> 它只是一个框架,具体业务需要开发者自己开发或从插件市场导入相关插件
> 它只是一个框架,具体业务需要开发者自己开发或从插件市场导入相关插件
### uniCloud Admin内置的功能包括:
### uniCloud Admin内置的功能包括:
-
管理员账户初始化、登录、修改密码
-
管理员账户初始化、登录、修改密码
-
顶部topWindow的设置:比如logo更换、右上角部分
连
接更换。详见项目根目录的
`admin.config.js`
文件
-
顶部topWindow的设置:比如logo更换、右上角部分
链
接更换。详见项目根目录的
`admin.config.js`
文件
-
左侧leftWindow的菜单设置:菜单包括两类,一类是动态菜单,具备业务和权限功能,在数据库的
`opendb-admin-menu`
表中增加删除菜单;另一类是静态菜单,不会根据登录用户角色变化,在项目根目录的
`admin.config.js`
文件中配置
-
左侧leftWindow的菜单设置:菜单包括两类,一类是动态菜单,具备业务和权限功能,在数据库的
`opendb-admin-menu`
表中增加删除菜单;另一类是静态菜单,不会根据登录用户角色变化,在项目根目录的
`admin.config.js`
文件中配置
-
开发模式下的 debug 功能,帮助开发者及时发现报错和搜索错误信息,可在
`admin.config.js`
文件中配置
-
开发模式下的 debug 功能,帮助开发者及时发现报错和搜索错误信息,可在
`admin.config.js`
文件中配置
...
@@ -24,7 +24,7 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
...
@@ -24,7 +24,7 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
<div
class=
"barcode-img-box"
>
<div
class=
"barcode-img-box"
>
<img
src=
"https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/9303c360-11f1-11eb-b680-7980c8a877b8.png"
width=
"75%"
/>
<img
src=
"https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/9303c360-11f1-11eb-b680-7980c8a877b8.png"
width=
"75%"
/>
</div>
</div>
<p
style=
"text-algin: center"
>
PC端
</p>
<p
style=
"text-algin: center
; width: 75%
"
>
PC端
</p>
</div>
</div>
<div
class=
"clear-style barcode-view"
>
<div
class=
"clear-style barcode-view"
>
<div
class=
"barcode-img-box"
>
<div
class=
"barcode-img-box"
>
...
@@ -38,7 +38,7 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
...
@@ -38,7 +38,7 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
#### 创建
#### 创建
[
HBuilderX
](
https://www.dcloud.io/hbuilderx.html
)
2.9.5+版本新建 uni-app 项目,选择 uniCloud admin 项目模板,如下图
,HBuilderX 2.9+可以从插件市场的
[
uniCloud admin 链接
](
)获取
[
HBuilderX
](
https://www.dcloud.io/hbuilderx.html
)
2.9.5+版本新建 uni-app 项目,选择 uniCloud admin 项目模板,如下图
![
download-admin
](
https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/d5fdccf0-11f2-11eb-b244-a9f5e5565f30.png
)
![
download-admin
](
https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/d5fdccf0-11f2-11eb-b244-a9f5e5565f30.png
)
...
@@ -60,10 +60,6 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
...
@@ -60,10 +60,6 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
├── common
├── common
│ └── uni.css
# 公共样式
│ └── uni.css
# 公共样式
├── components
# 自定义组件
├── components
# 自定义组件
│ └── common
# 自定义组件共用逻辑
│ └── sidebar-item
# 侧边栏菜单组成元素,
│ └── password
# 修改密码组件
│ └── error
# 开发模式下的 debug 错误列表组件
├── js_sdk
# js sdk
├── js_sdk
# js sdk
├── pages
# 页面
├── pages
# 页面
│ │── index
# 首页
│ │── index
# 首页
...
@@ -82,6 +78,15 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
...
@@ -82,6 +78,15 @@ uniCloud Admin,是基于uni-app和uniCloud的应用后台管理框架。
└── uni.scss
└── uni.scss
```
```
### 登录后跳转配置
1.
通过
[
admin.config.js
](
https://github.com/dcloudio/uni-template-admin/blob/master/admin.config.js
)
登录后跳转地址的配置
```
js
export
default
{
launch_path
:
'
/pages/index/index
'
,
// 登录后跳转至的页面地址(若配置为空,则自动跳转至左侧菜单第一个页面)
};
###
顶部窗口
(
导航栏
)
###
顶部窗口
(
导航栏
)
1
.
通过
[
admin
.
config
.
js
](
https
:
//github.com/dcloudio/uni-template-admin/blob/master/admin.config.js) 配置导航栏内容
1
.
通过
[
admin
.
config
.
js
](
https
:
//github.com/dcloudio/uni-template-admin/blob/master/admin.config.js) 配置导航栏内容
...
@@ -113,26 +118,23 @@ $top-window-text-color: #999; /* 文字颜色 */
...
@@ -113,26 +118,23 @@ $top-window-text-color: #999; /* 文字颜色 */
### 左侧窗口(菜单栏)
### 左侧窗口(菜单栏)
1.
通过
[
admin.config.js
](
https://github.com/dcloudio/uni-template-admin/blob/master/admin.config.js
)
配置侧边栏内容,侧边栏的菜单包括根据用户角色动态显示的动态菜单,和所有用户都能看到静态菜单。
#### 静态菜单和动态菜单
- 菜单包括两类,一类是动态菜单,具备业务和权限功能
> 动态菜单的逻辑: 用户登录时,会根据用户的*角色*去查找其拥有的*权限*,在根据*权限*去查找对应的*菜单*
- 另一类是静态菜单,不会根据登录用户角色变化
*菜单的属性*
#### 管理静态菜单
| 字段 | 类型 | 必填 | 描述 |
通过 [admin.config.js](https://github.com/dcloudio/uni-template-admin/blob/master/admin.config.js) 配置侧边栏内容,所有用户都能看到静态菜单。
|:-|:-|:-|:-|
|
\_
id | Object ID | 是 | Id保持唯一 |
| name | String | 是 | 菜单文字 |
| icon | String | 否 | 菜单图标 |
| url | String | 否 | 菜单对应的页面链接(只有没有子菜单的菜单项可以配置) |
| children | Array | 否 | 子菜单,重复它的父菜单的数据结构 |
静态菜单 secondaryMenus 配置如下:
```
js
```
js
export default {
export default {
// 侧边栏
// 侧边栏
sideBar: {
sideBar: {
// 配置静态菜单列表(放置在用户被授权的菜单列表下边)
// 配置静态菜单列表(放置在用户被授权的菜单列表下边)
s
econdaryMenus
:
[{
s
taticMenu
: [{
_id: 'demo',
_id: 'demo',
name: '系统设置',
name: '系统设置',
icon: 'el-icon-menu',
icon: 'el-icon-menu',
...
@@ -140,14 +142,6 @@ export default {
...
@@ -140,14 +142,6 @@ export default {
_id: 'table',
_id: 'table',
name: '用户',
name: '用户',
url: '/pages/demo/table/table'
url: '/pages/demo/table/table'
},{
_id
:
'
table
'
,
name
:
'
角色
'
,
url
:
'
/pages/demo/table/table
'
},{
_id
:
'
table
'
,
name
:
'
权限
'
,
url
:
'
/pages/demo/table/table
'
}]
}]
}, {
}, {
_id: 'app',
_id: 'app',
...
@@ -163,7 +157,61 @@ export default {
...
@@ -163,7 +157,61 @@ export default {
};
};
```
```
2.
通过
[
uni.scss
](
https://github.com/dcloudio/uni-template-admin/blob/master/uni.scss
)
配置侧边栏样式
#### 管理动态菜单
在云后台数据库的 `opendb-admin-menu` 表中管理菜单, 对菜单增删改查。如下图:
![add-menu](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-dc-site/85da1640-147a-11eb-899d-733ae62bed2f.png)
增加如下菜单:例如
```
bash
订单管理 (_id: order) # 父菜单
└── 食物 (_id: food) # 子菜单
```
1. 添加父菜单
菜单的 `parent_id` 字段为空, 即为一级菜单
> tips: 如无子菜单,或子菜单`url` 字段为空,则不能在页面显示
```
json
{
"_id": "order",
"name": "订单管理",
"icon": "",
"url": "",
"sort": 1000,
"parent_id": "",
"permission": [],
"status": 1
}
```
2. 添加子菜单
将子菜单的 `parent_id` 指向父菜单的 `_id`即可,孙菜单就是将子菜单的 `_id` 当做父菜单
> tips: 子菜单下没有子孙菜单,必须配置 `url` 字段,否则不能在页面显示
```
json
{
"_id": "phone",
"name": "手机",
"icon": "",
"url": "/phone",
"sort": 1001,
"parent_id": "order",
"permission": [],
"status": 1
}
```
#### 侧边栏样式管理
通过 [uni.scss](https://github.com/dcloudio/uni-template-admin/blob/master/uni.scss) 配置侧边栏样式
> 调整菜单颜色时,只需设置菜单背景色 ``$menu-bg-color``,自行搭配文字前景色即可
> 调整菜单颜色时,只需设置菜单背景色 ``$menu-bg-color``,自行搭配文字前景色即可
...
@@ -208,9 +256,7 @@ $menu-text-color-actived: #409eff; /* 菜单激活前景色 */
...
@@ -208,9 +256,7 @@ $menu-text-color-actived: #409eff; /* 菜单激活前景色 */
> [详情](https://uniapp.dcloud.io/uniCloud/uni-id?id=%e7%94%a8%e6%88%b7%e8%a1%a8)
> [详情](https://uniapp.dcloud.io/uniCloud/uni-id?id=%e7%94%a8%e6%88%b7%e8%a1%a8)
5. 验证码表 `uni-verify`
5. 验证码表 `uni-verify`
> [详情](https://uniapp.dcloud.io/uniCloud/uni-id?id=%e7%94%a8%e6%88%b7%e8%a1%a8)
> [详情](https://uniapp.dcloud.io/uniCloud/uni-id?id=%e7%94%a8%e6%88%b7%e8%a1%a8)
6.
存储表(系统使用,开发不需要修改)
`opendb-admin-storage`
6. 权限验证
7.
权限验证
```html
```html
<template>
<template>
...
@@ -225,12 +271,16 @@ $menu-text-color-actived: #409eff; /* 菜单激活前景色 */
...
@@ -225,12 +271,16 @@ $menu-text-color-actived: #409eff; /* 菜单激活前景色 */
### 新增页面
### 新增页面
新增页面可以自己开发页面,也可以从插件市场下载插件。
- 可以新增普通的页面,在前端callfunction,后台搭配云函数操作
- 可以新增普通的页面,在前端callfunction,后台搭配云函数操作
- 可以使用uni-clientdb,在前端直接操作数据库,后台配置db schema进行权限和格式校验
- 可以使用uni-clientdb,在前端直接操作数据库,后台配置db schema进行权限和格式校验
- 可以使用云函数单文件路由,在项目中默认包含了一个uni-cloud-router的单文件路由,也可以使用插件市场的其他单文件路由
- 可以使用云函数单文件路由,在项目中默认包含了一个uni-cloud-router的单文件路由,也可以使用插件市场的其他单文件路由
建议页面统一放在 ``pages`` 目录,以便管理。由于是云端一体的开发模式,简单的理解为,在前端实现页面和 *api 接口*,这里需要转换一下观念,api 也是在前端实现的。
建议页面统一放在 ``pages`` 目录,以便管理。由于是云端一体的开发模式,简单的理解为,在前端实现页面和 *api 接口*,这里需要转换一下观念,api 也是在前端实现的。
#### 自己开发页面
以登录功能为例,这里使用的是 `可以新增普通的页面,在前端callfunction,后台搭配云函数操作` 和 `项目中默认的 uni-cloud-router 的单文件路由` 的方式新增页面,以下是代码片段,完整代码见项目源码:
以登录功能为例,这里使用的是 `可以新增普通的页面,在前端callfunction,后台搭配云函数操作` 和 `项目中默认的 uni-cloud-router 的单文件路由` 的方式新增页面,以下是代码片段,完整代码见项目源码:
1. 新增前端 vue 页面
1. 新增前端 vue 页面
...
@@ -319,6 +369,18 @@ module.exports = class UserService extends Service {
...
@@ -319,6 +369,18 @@ module.exports = class UserService extends Service {
```
```
#### 从插件市场下载插件,怎么注册菜单进去
以[uniCloud admin管理项目-权限管理插件](https://ext.dcloud.net.cn/plugin?id=3269)
*使用步骤:*
1. 从插件市场导入插件
2. 在 HBuilder X 2.9.5 中选择添加插件的项目
3. 覆盖项目的 db_init.json 文件, 点击“确定覆盖”
4. 在 db_init.json 文件上右键,点击“初始化云数据库”
5. 刷新 admin 即可在菜单栏看到新增的菜单
### 关于 uni-cloud-router 的用法
### 关于 uni-cloud-router 的用法
> [详情](https://uniapp.dcloud.io/uniCloud/uni-cloud-router)
> [详情](https://uniapp.dcloud.io/uniCloud/uni-cloud-router)
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录