# 前端手册

# 菜单路由

通过用户的角色返回相应的菜单路由,前端关键代码: src/router/index.js

 // 部分代码
 store.dispatch('GetInfo').then(res => { // 拉取user_info
          // 动态路由,拉取菜单
          loadMenus(next, to)
        }).catch((err) => {
          console.log(err)
          store.dispatch('LogOut').then(() => {
            location.reload() // 为了重新实例化vue-router对象 避免bug
          })
        })

# 可配置项

//当设置 true 的时候该路由不会再侧边栏出现 如401,login等页面,或者如一些编辑页面/edit/1
hidden: true // (默认 false)

//当设置 noredirect 的时候该路由在面包屑导航中不可被点击
redirect: 'noredirect'

//当你一个路由下面的 children 声明的路由大于1个时,自动会变成嵌套的模式--如组件页面
//只有一个时,会将那个子路由当做根路由显示在侧边栏--如引导页面
//若你想不管路由下面的 children 声明的个数都显示你的根路由
//你可以设置 alwaysShow: true,这样它就会忽略之前定义的规则,一直显示根路由
alwaysShow: true

name: 'router-name' //设定路由的名字,一定要填写不然使用<keep-alive>时会出现各种问题
meta: {
  title: 'title' //设置该路由在侧边栏和面包屑中展示的名字
  icon: 'svg-name' //设置该路由的图标
  noCache: true //如果设置为true,则不会被 <keep-alive> 缓存(默认 false)
  breadcrumb: false // 如果设置为false,则不会在breadcrumb面包屑中显示,
  affix: true // 设置成true表示,tag-view不可删除
}

# 添加图标

如果你没有在本项目 Icon 中找到需要的图标,可以到 iconfont.cn 上选择并生成自己的业务图标库,再进行使用。或者其它 svg 图标网站,下载 svg 并放到 src/assets/icons/svg 文件夹之中就可以了,下载方式如下图:

使用方式:

<svg-icon icon-class="password" /> //icon-class 为 icon 的名字

# 添加菜单

也不是所有菜单都需要存入数据库,有些公共的菜单只需要在 src/router/routers.js 中添加就可以了,如:个人中心页面

{
    path: '/user',
    component: Layout,
    hidden: true,
    redirect: 'noredirect',
    children: [
      {
        path: 'center',
        component: () => import('@/views/system/user/center'),
        name: '个人中心',
        meta: { title: '个人中心', icon: 'user' }
      }
    ]
  }

# 动态菜单

本项目的动态菜单支持到 4级 菜单,支持 外链,支持自定义图标,添加教程如下:

# (1) 添加外链

外链菜单路由地址必须带上 https:// 或者 http://,并且外链菜单选择

# (2) 内部菜单

  • 外链菜单:这个选择否就好
  • 菜单缓存:选择为 那么切换到其他菜单当前菜单会缓存
  • 菜单课件:如果不想在左侧显示,可以选择为
  • 路由地址:这个就是浏览器访问菜单的地址
  • 组件名称:这个非必填,如果设置了菜单缓存,那么必填,不然缓存会无效
  • 组件路径:项目的组件文件的路径 src/views
添加内部菜单 组件路径对应

# 分配菜单

创建完菜单还需要在角色管理中给角色分配菜单

# 权限控制

可以引入权限判断函数或者使用全局指令函数实现前端的权限控制
1、使用全局指令函数v-permission=""

<!-- 新增 -->
<div v-permission="['admin','user:add']" style="display: inline-block;margin: 0px 2px;">
      <el-button
        class="filter-item"
        size="mini"
        type="primary"
        icon="el-icon-plus"
        @click="add">新增</el-button>
      <eForm ref="form" :sup_this="sup_this" :is-add="true" :dicts="dicts"/>
    </div>

2、使用判断函数 checkPermission()

<template>
  	<el-tab-pane v-if="checkPermission(['admin'])" label="Admin">
		admin 权限的用户才能看到
	 </el-tab-pane>
</template>

<script>
import checkPermission from '@/utils/permission' // 权限判断函数

export default{
   methods: {
    checkPermission
   }
}
</script>

# 数据加载

本系统数据加载使用了两种模式:

  1. 混入模式,相对简单
  2. 组件模式,功能强大

具体查看源码

# 自定义主键

系统里面默认的主键是 id,如果主键字段不是 id 使用 curd 组件就会出现问题,这个时候需要自定义主键名称

在 index.vue 中找到下面节点,并且指定 idField, 由于系统默认是根据 id 字段降序,所以这里排序规则也需要修改

cruds() {
    return CRUD({ title: '图片', idField: 'pictureId', sort: 'pictureId,desc', url: 'api/pictures', crudMethod: { ...crudPic }})
  }

# 多字段排序

多字段排序方式在 crud.js 中的注释中说明了,这里再写个例子

代码如下:

cruds() {
    return CRUD({ title: '图片', sort: ['id,asc', 'name,desc'], url: 'api/pictures', crudMethod: { ...crudPic }})
  }

# 操作按钮隐藏

找到如下节点,在 optShow 中设置表格上方的按钮显与隐

cruds() {
    return [
      CRUD({ title: '字典详情', url: 'api/dictDetail', query: { dictName: '' }, sort: ['dictSort,asc', 'id,desc'],
        crudMethod: { ...crudDictDetail },
        optShow: {
          add: true,
          edit: true,
          del: true,
          reset: false
        },
        queryOnPresenterCreated: false
      })
    ]
  }

# 数据字典

首先我们需要在字典管理中创建一个字典

# 使用全局组件

TIP

建议使用该方式

使用方式:

<template>
  <div class="app-container">
  </div>
</template>

<script>
export default {
  // 设置数据字典
  dicts: ['job_status'],
  created() {
    // 得到完整数据
    console.log(this.dict.job_status)
    // 打印简化后的label数据
    console.log(this.dict.job_status.label)
  }
}
</script>

打印如下:

1、完整数据

2、简化后的label数据

# 使用混入方式

源码位于: src/mixins/initDict.js,代码如下

(1)引入组件

import initDict from '@/mixins/initDict'
export default {
  mixins: [initDict]
}

(2)使用钩子函数获取字典

import initDict from '@/mixins/initDict'
export default {
 mixins: [initDict],
 created() {
    this.$nextTick(() => {
      // 加载数据字典
      this.getDict('job_status')
    })
  }
}

(3)使用字典

<el-form-item v-if="form.pid !== 0" label="状态" prop="enabled">
        <el-radio v-for="item in dicts" :key="item.id" v-model="form.enabled" :label="item.value">{{ item.label }}</el-radio>
 </el-form-item>

# 文件上传

上传文件时接口都是需要带上 Token 才能访问的,因此需要组件支持 Header 配置,详细代码见

tools->picture->index.vue

# 获取Token

import { getToken } from '@/utils/auth'

data() {
    return {
      headers: {
        'Authorization': getToken()
      }
    }
  }

# 配置组件

指定 Header :headers="headers"

<!--上传图片-->
<el-upload
:on-preview="handlePictureCardPreview"
:before-remove="handleBeforeRemove"
:on-success="handleSuccess"
:on-error="handleError"
:headers="headers"
:file-list="fileList"
:action="imagesUploadApi"
list-type="picture-card"
>
<i class="el-icon-plus" />
</el-upload>

# 异常处理

src/utils/request.js 文件中对所有的 request请求进行拦截, 通过response 拦截器对接口返回的状态码进行分析与异常处理,代码如下

// response 拦截器
service.interceptors.response.use(
  response => {
    const code = response.status
    if (code < 200 || code > 300) {
      Notification.error({
        title: response.message
      })
      return Promise.reject('error')
    } else {
      return response.data
    }
  },
  error => {
    let code = 0
    try {
      code = error.response.data.status
    } catch (e) {
      if (error.toString().indexOf('Error: timeout') !== -1) {
        Notification.error({
          title: '网络请求超时',
          duration: 5000
        })
        return Promise.reject(error)
      }
    }
    if (code) {
      if (code === 401) {
        store.dispatch('LogOut').then(() => {
          // 用户登录界面提示
          Cookies.set('point', 401)
          location.reload()
        })
      } else if (code === 403) {
        router.push({ path: '/401' })
      } else {
        const errorMsg = error.response.data.message
        if (errorMsg !== undefined) {
          Notification.error({
            title: errorMsg,
            duration: 5000
          })
        }
      }
    } else {
      Notification.error({
        title: '接口请求失败',
        duration: 5000
      })
    }
    return Promise.reject(error)
  }
)

# 系统组件

在这里列出系统使用到的组件,方便大家使用