阅读 7982

快速打造 react 后台管理系统

项目预览地址

前言

相信很多小伙伴都有可能碰到开发后台管理系统这样的需求,那么我们该如何快速的完成这个需求呢

本文将以 react 为切入点,记录打造一个基础管理系统模板的过程,以此加深对 react 技术栈以及项目实战的理解,希望对大家开发一个这样的项目有所帮助

如果文章中有出现纰漏、错误之处,还请看到的小伙伴多多指教,先行谢过

以下↓

项目简介

react-admin 是由 create-react-app 脚手架快速构建,基于 React 生态系统搭建的后台管理系统模板。实现了登陆/注销、路由懒加载、axios封装、简单权限管理等功能,它可以帮助你快速生成管理系统模板,你只需要添加具体业务代码即可

线上预览地址 预览地址

GitHub 代码 代码地址

技术栈

此项目涉及的技术栈主要有 es6reactreact-routerreduxreact-reduxCreate React Appreact-loadableaxios等,所以你可能需要提前了解这些知识,这样会对你了解这个项目有很大的帮助

基本功能

  • 路由懒加载
  • 面包屑导航
  • 常用 UI 展示
  • echarts 全屏展示
  • 登陆/注销功能
  • axios 封装
  • 简单权限管理

项目结构

├── public                   # 不参与编译的资源文件
├── src                      # 主程序目录
│   ├── api                     # axios 封装
│   ├── assets                  # 资源文件
│   │   ├── font                    # 字体文件
│   │   └── images                  # 图片资源
│   ├── components              # 全局公共组件
│   │   ├── CustomBreadcrumb        # 面包屑导航
│   │   └── CustomMenu              # menu 菜单
│   ├── contatiners             # 页面结构组件
│   ├── routes                  # 路由目录
│   ├── store                   # redux 配置
│   ├── style                   # 样式目录
│   ├── utils                   # 工具类
│   ├── views                   # UI 页面
│   ├── APP.js                  # App.js
│   └── index.js                # index.js
├── .prettierrc.js           # 代码规范
├── config-overrides.js      # antd 样式按需加载
复制代码

整体思路

打造一个任何一个项目,除去前期需要考虑的受众群体(其实就是兼容…)之外,再加上技术选型,之后就到了页面架构层。在这个项目中,前期不在我们的考虑范围之内(已经确定了有木有),所以就从页面架构开始

一个后台管理项目,无论它是否具有权限校验功能,但是有一些公共的部分是应该有的。比如登陆页面、公共的头部、侧边栏导航、底部以及错误页面等。这些共有的部分以及权限特有的部分共同组成了这个系统

划分出这样的模块之后,一个项目基本的页面架构也就完成了,因为这一部分关系到我们之后对于页面路由的定义,所以我认为是很重要的一部分

路由

基于 react-router@5.1.1

路由功能可以说是一个 React 项目的关键,通过前面对于页面架构的划分,我们就可以很流畅的进行路由的注册

基本

react-admin 这个项目中,所使用的是 <HashRouter>

首先,我们需要区分公共页面和可能的特有页面

<Router>
    <Switch>
        <!--精确匹配是不是在首页-->
        <Route path='/' exact render={() => <Redirect to='/index' />} /> 
        <!-- 错误页面 -->
        <Route path='/500' component={View500} />
        <Route path='/login' component={Login} />
        <Route path='/404' component={View404} />
        <!-- UI页面 -->
        <Route path='/' component={DefaultLayout} />
    </Switch>
</Router>
复制代码

接下来就可以去注册路由表,再将它循环遍历到我们的视口页面上。大家可能也发现了循环遍历这个词,操作数组就意味着我们可以对它进行一系列的筛选,从而实现 路由权限 的控制(这个我们后面再说)

懒加载

作为一个 SPA 级应用,有很多优势(响应速度更快、良好的前后端分离等等),但是也存在很多缺陷,首次加载耗时过长就是我们不得不面对的问题

其实从 webpack4.0 开始,它本身已经实现了按需加载组件,但是也有它自己的一些规则(比如文件大小),所以我们还是需要对页面的首次加载进行一些处理,而路由就是一个很好的切入点

本项目使用的是 react-loadable,它可以用很简单的方式实现路由的懒加载,设置延迟时间、加载动画、服务端渲染等功能

import Loadable from 'react-loadable';
import Loading from './my-loading-component'; // 这里可以放置你的 loading

const LoadableComponent = Loadable({
  loader: () => import('./my-component'),
  loading: Loading,
});

export default class App extends React.Component {
  render() {
    return <LoadableComponent/>;
  }
}
复制代码

当然,你也可以使用 React.lazySuspense 技术(传送门),不过,它不支持服务端渲染

登录

登录的逻辑也很简单:

我们的项目首页一般情况下是 index 页面,这个时候我们就需要先去判断一个用户加载进来的时候是不是在登录状态,如果是那么就正常显示,如果不是就应该跳转到登录页面

本项目使用的是将用户的登录信息存储在 localStorage中,注销的时候清除 localStorage

关于 token 可以直接存在本地,后台设定一个过期时间就可以了

还有一种情况就是用户登录之后,但是由于长时间没有操作导致 token 过期了,这个时候可能就会出现两种选择:

  • 让用户直接跳转到登录页面重新登录
  • 查看本地是否存储了用户信息,如果有就更新用户的 token ,让其继续操作,反之则跳转到登录页面(这个取决于你将用户信息存储在哪里)

当然,具体要怎么做,还是取决于产品的需求,这里只是提供一种思路

axios 封装

基本操作

项目使用 axios 与后台进行交互,封装的部分有添加请求拦截器、响应拦截器、设置响应时间以及将 token 添加到请求头等功能

import axios from 'axios'

// 这里取决于登录的时候将 token 存储在哪里
const token = localStorage.getItem('token')

const instance = axios.create({
    timeout: 5000
})

// 设置post请求头
instance.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded'

// 添加请求拦截器
instance.interceptors.request.use(
    config => {
        // 将 token 添加到请求头
        token && (config.headers.Authorization = token)
        return config
    },
    error => {
        return Promise.reject(error)
    }
)

// 添加响应拦截器
instance.interceptors.response.use(
    response => {
        if (response.status === 200) {
            return Promise.resolve(response)
        } else {
            return Promise.reject(response)
        }
    },
    error => {
        // 相应错误处理
        // 比如: token 过期, 无权限访问, 路径不存在, 服务器问题等
        switch (error.response.status) {
            case 401:
                break
            case 403:
                break
            case 404:
                break
            case 500:
                break
            default:
                console.log('其他错误信息')
        }
        return Promise.reject(error)
    }
)

export default instance

复制代码

这里并没有对 baseUrl 进行设置,主要是考虑到项目中可能存在不止一个 url,比如图片这些资源可能存在七牛云或者阿里云这样的服务器上面,而后台接口又是另外一个url 了。所以添加了一个 config 文件,导出各个 url

// 考虑到网站可能有好几个域名,所以单独提出来

export const API = 'http://rap2api.taobao.org/app/mock/234047'

export const URLAPI = ''

复制代码

调用接口的时候就可以直接这样

import {API} from './api/config'
import axios from './api'

axios.get({
    url: API + '/login'
})
复制代码

当然,如果你并没有这样的需求,你完全可以取消 config 这个文件,将 baseUrl 一并封装进去

同样的,也并没有对常用的请求比如 getpost 等进行封装,因为使用这些方式的时候可能会对数据做一些特定的操作,比如序列化等等,所以个人感觉意义并不是很大

跨域

这里顺便记录一下跨域问题的解决方式:

如果你没有使用 npm run ejectwebpack 的配置暴露出来,可以直接在 package.json 中配置 proxy

"proxy": {
    "/api": {
      "target": "http://100.100.100.100", //后端地址
      "changeOrigin": true
    }
 }
复制代码

这样只需要在 baseUrl 后面添加 /api 就可以了

当然,如果你将 webpack 中的配置暴露出来了,那么也可以直接在 config 文件中进行设置,都是可以实现同样的效果

权限

权限功能基本上是后台管理项目中不可或缺的部分

一般情况下,权限的控制体现在页面级别以及按钮级别(用户是否可以访问某个页面或者操作某个按钮,比如新增、删除),这个权限在用户注册、分配或者后期超级管理员更改的时候确定

项目实现

在这个项目中使用简单的权限控制,希望可以给大家一些思路,具体实现方式:

  • 用户登录,从后台获取注册时的角色(权限标识)
  • 通过权限标识,对注册的 menu 菜单进行过滤,渲染到页面
getMenu = menu => {
        let newMenu,
            auth = JSON.parse(localStorage.getItem('user')).auth // 获取存储的用户权限标识
        if (!auth) {
            return menu
        } else {
            // 过滤注册的 menu
            newMenu = menu.filter(res => res.auth && res.auth.indexOf(auth) !== -1)
            return newMenu
        }
    }
复制代码
  • 通过权限标识,对注册的路由数组进行过滤
{routes.map(item => {
    return (
        <Route
            key={item.path}
            path={item.path}
            exact={item.exact}
            render={props =>
                !auth ? (
                    <item.component {...props} />
                ) : item.auth && item.auth.indexOf(auth) !== -1 ? (
                    <item.component {...props} />
                ) : (
                    // 这里也可以跳转到 403 页面
                    <Redirect to='/404' {...props} />
                )
            }></Route>
    )
})}
复制代码
  • 按钮权限,直接使用权限标识判断可否操作,隐藏或者展示即可

说明:这里对注册的路由数组进行过滤这一步进行说明,一般情况下前端路由都是提前注册好的,就算没有 menu 菜单导航,如果我们在地址栏直接输入路径也是可以访问的,这里进行一次过滤之后就可以避免这种情况。当然,我们也可以给每一个权限设定一个可以访问的路径数组,通过比较跳转的地址是否存在这个数组当中来进行相应的展示

后台控制

这里也简单说一下后台控制权限的案例,对于前端来说要简单很多

  • 用户登录,拿到需要展示的 menu 数组,直接渲染到页面(对菜单的筛选由后台完成)
  • 通过权限标识,判断用户有没有某个按钮的操作权限

至于用户在地址栏直接输入地址去访问,这里有两种情况:

  • 如果用户没有访问某一个页面的权限,那么使用其 token 请求后台数据的时候一定是不成功的,我们可以将这一个操作封装在 axios 请求中,通过不同的状态码进行页面跳转
  • 我就是访问了一个没有请求的页面(这个页面还不给没权限的人看),那我们就采用过滤权限数组的方式对其操作进行阻止

当然,这里的第二种情况很少见…

其它

项目中还集成了平时可能会遇到的一些功能需求

动画

动画使用的是 Animate.css 动画库,使用方式

// 下载
yarn add animate.css

// link标签引入
<link rel="stylesheet" href="animate.min.css">

// 或者 import 引入
import 'animate.css'
复制代码

然后在需要的盒子上面添加相应的类名即可,可以设置入场、离场动画,也可以设置动画时间、延时等

富文本

富文本编辑器使用的是 Antd 官方推荐的 braft-editor

一个基于draft-jsWeb富文本编辑器,适用于React框架,兼容主流现代浏览器

使用方式:

// 引入
import BraftEditor from 'braft-editor'

// 可以使用 BraftEditor.createEditorState 方法来将 raw 或者 html 格式的数据转换成 editorState 数据
editorState: BraftEditor.createEditorState('你好,<b>可爱的人! 很幸运在这里与你相遇!</b>')
复制代码

更多具体的组件属性及实例方法,大家可以参考其文档 传送门

echarts

echarts 相信大家不会陌生,百度的文档也很清晰,这里单独提出来主要记录开发过程中遇到的一个问题

在页面窗口变化的情况下我们可以使用

window.addEventListener('resize', function() {
    myChart.resize()
})
复制代码

这种方式保证 echarts 的正常自适应

可是当我们在点击菜单收缩展开按钮的时候并不会触发 window.resize 方法,其实页面盒子的宽度已经发生了变化,只是 echartsresize 事件已经触发结束了,这个时候我们只需要在 componentDidUpdate 这个生命周期中注册一个定时器延时触发 resize 事件就解决了,只是别忘了在 componentWillUnmount 生命周期中清除掉这个定时器

加载进度条

加载进度条使用的是 nprogress ,使用方式也很简单

// 下载
yarn add nprogress

// 引入
import NProgress from 'nprogress'

// 开始加载
NProgress.start();

// 加载结束
NProgress.done();

// 移除进度条
NProgress.remove();
复制代码

全屏插件

全屏功能使用的是 screenfull 插件

使用方式

// 下载
yarn add screenfull

if (screenfull.isEnabled) {
	screenfull.request(); // 全屏
}

.exit() // 退出
.toggle() // 可切换
复制代码

也可以给它 注册 change 事件

if (screenfull.isEnabled) {
	screenfull.on('change', () => {
		console.log('Am I fullscreen?', screenfull.isFullscreen ? 'Yes' : 'No');
	});
}
复制代码

但是别忘了移除掉这个事件

screenfull.off('change', callback);
复制代码

代码格式统一

Create React App 提供了一组最常见的错误规则,在代码运行的时候会有错误信息提示,所以 Eslint 规则在这里并不是必须的,如果你也想在代码书写的时候就提示错误可以进行下面这个步骤:

下载 eslint

yarn add eslint
复制代码

添加一个 .eslintrc.js 文件或者在 package.json 文件中的 eslintConfig 对象中直接添加你需要使用的规则

更多规则可以参考这里

项目中并没有使用 eslint,只是添加了 pretter 为项目统一了编码风格

至于如何在项目中集成 pretter ,具体的使用方式可以参考 官方文档,这里就不在叙述了

webpack拓展

相信大家在开发这样的项目的时候,肯定或多或少会有一些定制化的东西需要修改 webpck 的配置

当我们使用 create react app 创建项目的时候,webpack 的配置默认是不暴露出来的,如果我们想修改它的配置,可以使用 yarn eject 或者 npm run eject 命令将其暴露出来再去修改

但是,如果我们并不想暴露 webpack 的配置,还想去配置它该怎么办呢

antd 的样式按需加载就是通过这种方式实现的

react-app-rewiredreact 社区开源的一个修改 CRA 配置的工具,例如扩展 Create React AppWebpack 配置,而 customize-cra 提供了一组用于自定义利用 react-app-rewired 核心功能的 Create React App 配置, 可以通过 config-overrides.js 文件来对 webpack 配置进行扩展

简单点: 使用 react-app-rewiredcustomize-cra 可以实现我们的需求

使用方式:

  • 首先肯定是先下载这两个包了
  • 然后在我们的项目根目录创建一个 config-overrides.js 文件
// 文件里面这么写,比如说我们设置一个绝对路径

const { override, addWebpackAlias } = require('customize-cra')
const path = require('path')

module.exports = override(    
   addWebpackAlias({        
       ['@']: path.resolve(__dirname, 'src')   
   })
)
复制代码
  • 最后修改 package.json 文件中的 scripts
"scripts": {
    "start": "react-app-rewired start",
    "build": "react-app-rewired build",
    "test": "react-app-rewired test",
    "eject": "react-scripts eject"
}
复制代码

结束,这样我们就可以在项目中愉快地使用这个 @

当然,customize-cra 这个包为我们还提供了很多封装好的 API,详情请 参见这里

最后

这个项目都是本人闲暇时间开发,主要是为了熟悉 react 开发流程以及其周边生态的使用,项目还是比较简陋,后期会进行迭代开发,将其打造成一个更加实用的后台管理模板

如果觉得不错或者对你有些许的帮助,欢迎 star,或者你有更好的实现方式、有趣的 idea,也欢迎留言交流

感兴趣的小伙伴可以 点击这里 ,也可以扫描下方二维码关注我的微信公众号,查看更多前端小片段,欢迎 star 关注

image