前言

一直以来想找个合适的机会写一写关于VueAdminWork的整体框架原理以及一细节。前期觉得还是不太成熟，而且也没准备好要怎么写。今天打算试写一篇关于VueAdminWork的整体框架设计。写得不好还请各位小伙伴见谅[谢谢]

以下的说明是VueAdminWorkP（Vue3 + Vite2 + NaiveUI + Typescript）版本为例来进行介绍的

VueAdminWork框架的设计初衷和说明

很多用过后台管理系统的小伙伴一定会有一个感觉就是要么功能少，要么页面不美观。或多或少都会存在这样那样的问题，其实我在使用别人的后台管理模板的时候也是一样的感觉。

所以就下定决心要自己搞一款属于自己的后台管理系统，不仅如此，还要尽可能地兼顾到大部分人的需求。但是由于个人能力始终有限，VueAdminWork框架到现在还有很多很多需要完善的地方。在今后的时间，我会继续努力去完善给大家带来更好的开源作品。

做这样一款框架也是对自己的知识体系的沉淀，在这过程也学习到了很多很多知识。中间也曾想到放弃，但是咬牙坚持到了最后，还好没有放弃。

VueAdminWork框架发展至今已经有6款不同技术架构的版本。其实目前开源了4款。另一款基于Antd的版本也准备开源。

这里面我要重点说明一下，VueAdminWork全部都是由我本人一点点代码写出来的，从一个简单的html页面项目，一点点发展到现在的体系。

绝对不是随便从网上下载一个模板改改样式改改文字就变成自己的了。

这样的行为是让人不耻的。

VueAdminWork运行原理和模型

VueAdminWork和一个普通的项目一样，入口也是 main.ts 或者 main.js 。也存在一个 App.vue组件。

可以看成一个普通的Vue项目

App.vue代码如下：

<template>
  <n-notification-provider>
    <n-message-provider>
      <router-view />
    </n-message-provider>
  </n-notification-provider>
</template>

是不是很简单……

框架本身的运行原理也是非常简单的，用下面一张图就可以清楚地表示

在整体的架构上，设计的构思就是框架由一个个组件组合来成，这样便于后期的维护和替换。

VueAdminWork采用了两级路由，从而对应两级视图渲染的方式。如下

最外层的路由对应的组件是: Layout。

Layout对应的模板代码如下：

<template>
  <n-config-provider
    :theme-overrides="state.themeOverrides"
    :theme="state.theme === 'dark' ? darkTheme : null"
    :locale="zhCN"
    style="height: 100%"
  >
    <n-global-style />
    <n-loading-bar-provider>
      <n-dialog-provider>
        <n-element
          class="vaw-layout-container"
          :class="[state.device === 'mobile' && 'is-mobile', state.theme]"
        >
          <div
            v-if="state.device === 'mobile'"
            class="mobile-shadow"
            :class="[state.isCollapse ? 'close-shadow' : 'show-shadow']"
            @click="closeMenu"
          ></div>
          <template v-if="state.device === 'mobile'">
            <SideBar />
            <MainLayout />
          </template>
          <template v-else>
            <template v-if="state.layoutMode === 'ttb'">
              <VAWHeader />
              <MainLayout :show-nav-bar="false" />
            </template>
            <template v-else-if="state.layoutMode === 'ltr'">
              <SideBar />
              <MainLayout />
            </template>
            <template v-else-if="state.layoutMode === 'lcr'">
              <TabSplitSideBar />
              <MainLayout />
            </template>
            <template v-else-if="state.layoutMode === 'tlr'">
              <VAWHeader />
              <SideBar :showLogo="false" />
              <MainLayout :show-nav-bar="false" />
            </template>
          </template>
        </n-element>
        <WaterMark />
      </n-dialog-provider>
    </n-loading-bar-provider>
  </n-config-provider>
</template>

同时，为了适配移动端，Layout还有很多关于 移动端的代码。这里不多介绍关于移动端的适配情况了。

Layout组件是整个项目运行的骨架和载体。根据用户的配置来进行切换不同的布局模式。是最重要的一个组件

每个组件负责不同的功能，比如：

• SideBar 只负责显示 菜单列表
• TabBar只显示已经访问过的页面标题
• NavBar只显示页面导航相关的功能
• ……

正是因为这样一个个的小组件，最终组合在一起形成框架的基本的模型。

工作区Main.vue

而我们平时用得最多的就是工作区（也就是第二级路由页面），是由 Main.vue实现，代码如下：

<template>
  <router-view v-slot="{ Component }">
    <transition :name="state.pageAnim + '-transform'" mode="out-in" appear>
      <keep-alive :include="cachedViews">
        <component :is="Component" :key="key" />
      </keep-alive>
    </transition>
  </router-view>
</template>


<script lang="ts">
  import { computed, defineComponent, ref, watch } from 'vue'
  import { useRoute } from 'vue-router'
  import store from '../store'
  export default defineComponent({
    name: 'Main',
    setup() {
      const state = store.state
      const cachedViews = computed(() => {
        return state.cachedView.map((it: string) => it)
      })
      const route = useRoute()
      const key = ref(route.fullPath)
      watch(
        () => route.fullPath,
        (newVal) => {
          key.value = newVal
        }
      )
      return {
        key,
        state,
        cachedViews,
      }
    },
  })
</script>

这样就可以根据浏览器中不同的路径来实现不同的页面切换