Vue3 封装扩展并简化Vuex在组件中的调用问题

   2023-02-07 学习力0
核心提示:目录1.创建文件utils/vueTool.js2.添加开发环境中的模块验证3.页面调用封装如果你在项目中使用了 vuex模块化,并且在项目中使用actions中函数调用频率高,推荐了解一下这种方式。比如下面两种方式调用 ,第一个是直接传参设置,第二个是添加了异步ajax返回内

如果你在项目中使用了 vuex模块化,并且在项目中使用actions中函数调用频率高,推荐了解一下这种方式。

比如下面两种方式调用 ,

第一个是直接传参设置,

第二个是添加了异步ajax返回内容 在回调到等下我们要封装的js中的成功回调里,然后这个成功回调就会反馈给组件

Vue3 封装扩展并简化Vuex在组件中的调用问题

Vue3 封装扩展并简化Vuex在组件中的调用问题

1.创建文件utils/vueTool.js

import storage from '@/utils/storage.js';
import store from '@/store/index.js';
const { dispatch, state } = store;
/**
 * @vuexFunc 调用vuex模块中的 Actions 并异步回调结果
 * @param modules {string} 调用指定的子模块 如果是全局的可以不传
 * @param funcName {string} 调用Actions 函数名称
 * @param data  {object} 
 * @param followUp  {string / object} 
 *  {
     data:{},
     followUp:string / object
     function(res){}
    },
 * data:当前调用接口需要的参数,
 * followUp 当前接口完成回调后 继续执行更新接口的 名称和参数 可以是请求地址字符串 可以是对象携带参数
 * followUp:'URL' / followUp:{url:'请求接口地址',query:{参数}}
 * function回调函数
 */
export function vuexFunc(modules = '', funcName = '', data = {}) {
    function send(followUp = '', query = null, lock = null) {
        // 消费凭证
        if (typeof lock === 'number') {
            console.log('已消费:', lock)
            lock = true
        };
        let url = '';
        if (followUp) {
            url = followUp;
        } else {
            if (!modules && typeof modules !== 'boolean') {
                console.error('Actions函数名称是必填。');
                return;
            };
            url = `${modules?modules+'/':''}${funcName}`;
        };
        
        // 开发中使用 校验当前调用的vuex模块是否存在 
        if (process.env.NODE_ENV === 'development') {
            let modulesName = followUp ? followUp.split('/')[0] : typeof modules === 'boolean' ? funcName :modules;
            if (storage.getItem('modulesKey').indexOf(modulesName) === -1) {
                console.error(`找不到 ${modulesName} 请检查!`);
                return;
            };
        };
        let queryData = {}
        if(typeof modules === 'boolean'){
            queryData = data
            
        } else {
            queryData = followUp ? query ? query : {} :data.data && Object.keys(data.data).length?data.data:{}
        }
        dispatch(url, {
            // data: followUp ? query ? query : {} : data.data,
            data: queryData,
            callback(res) {
                // 成功
                if (res !== 'failed') {
                    if (lock) {
                        console.log('停止了')
                        return
                    };
                    if (data.callback) {
                        data.callback(res);
                    };
                    if (data.followUp && typeof data.followUp === 'string') {
                        console.log('开始后续回调')
                        send(data.followUp, null, Date.now());
                    } else if (data.followUp && Object.keys(data.followUp).length) {
                        if (!data.followUp.url) {
                            console.error('缺少后续请求的url');
                            return;
                        };
                        if (!data.followUp.hasOwnProperty('query')) {
                            console.error('query字段 缺少后续请求的参数,没有参数直接传入 string Url 形参');
                            return;
                        };
                        send(data.followUp.url, data.followUp.query, Date.now())
                    };
                    // 失败 -1
                } else if (res === 'failed') {
                    if (data.failed) {
                        data.failed(res)
                    } else {
                        console.error('接口请求失败:'+url)
                    }
                };
            }
        });
    };
    send();
}

/**
 * @getState 获取vuex中state仓库
 * @param modules {string} 仓库名称 如果是子模块就传入子模块的名称
 */
export function getState(modules = '') {
    if (!modules) {
        console.error('state仓库名称是必填。');
        return;
    };
    return state[modules]
}

2.添加开发环境中的模块验证

Vue3 封装扩展并简化Vuex在组件中的调用问题

注意:如果你的vue3项目是使用webpack5创建的 那么这里的自动化导入文件 就不能使用,可以去看看我上篇文章中有写webpack5如何自动化导入模块

import { createStore } from 'vuex'
import actions from './actions'
import mutations from './mutations'
import storage from '@/utils/storage.js'


const modulesFiles = import.meta.glob('./modules/*/index.js', { eager: true });

const modules = Object.keys(modulesFiles).reduce(
    (modules, path) => {
        const moduleName = path.replace(/^\.\/(.*)\.\w+$/, '$1')
        modules[moduleName.split('/')[1]] = modulesFiles[path]?.default
        return modules
    }, {}
);

let modulesKey  = '';
if(process.env.NODE_ENV === 'development'){
    let obj = {...actions,...modules};
    for(let key in obj){
        modulesKey+=key+','
    };
    storage.setItem('modulesKey',modulesKey);
};
const store = createStore({
    modules,
    state: {
        name: 'allen',
        modulesKey:storage.getItem('modulesKey') || modulesKey,
    },
    mutations,
    actions,
    getters: {}
})

export default store

3.页面调用封装

actions函数的调用

import { vuexFunc, getState } from '@/utils/vueTool';

vuexFunc('子模块文件昵称','actions.js中定义的函数昵称',{
    data:{接口需要的参数,或者你要设置到仓库的值},
    callback(res){ // 请求回调
            console.log(res)
    }
});
//模式一(调用全局actions函数)
vuexFunc(false,'setStageCourse',{
    data:query,
    callback(res){
            console.log(res)
    }
});

//模式二(调用子模块函数中的actions函数)
vuexFunc('index','setStageCourse',{
    data:query,
    callback(res){
            console.log(res)
    }
});

// 模式三(调用完一个actions函数后立即执行另外一个actions函数)
这里调用完成signIn子模块中的loginByCode函数完成回调后,会立即去读取followUp的配置 也是对应了 子模块/signIn函数昵称去执行,followUp允许一个具体的函数路径或者一个对象可以配置函数要设置的值
vuexFunc('signIn','loginByCode',{
        data:{code:wxcode.value},
        followUp:'index/getConfig',
    callback(res){
        SignType.value = false
        storage.setItem('authorization',res.data.token);
        
    }
});

state仓库的使用

import {vuexFunc,getState} from '@/utils/vueTool'

// 获取全局state
let data = getState('全局state对象中定义的对象key')

// 获取子模块中的 state
// getState('子模块昵称') 获取到某个子模块中的state仓库对象
let data = getState('signIn').SigninType

最后:

这样既扩展了功能 也不需要原本的vuex 先导入 在解构 在调用,并且对actions的控制和错误也做到了颗粒化捕获,与拦截反馈,在一定程度上提高了开发过程中的程序调试。

后来我又思考了一下感觉还能继续优化,比如像vue2中使用...mapActions 和...mapState 直接返回多个函数对象,感觉这样会比较优雅,但是在项目中我已经开发过半了 所以就没有对这个进行重新改造,有兴趣的可以试试。

原文地址:https://www.cnblogs.com/Allen-project/archive/2023/01/27/17068971.html
 
标签: Vue3 封装 Vuex 组件
反对 0举报 0 评论 0
 

免责声明:本文仅代表作者个人观点,与乐学笔记(本网)无关。其原创性以及文中陈述文字和内容未经本站证实,对本文以及其中全部或者部分内容、文字的真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
    本网站有部分内容均转载自其它媒体,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责,若因作品内容、知识产权、版权和其他问题,请及时提供相关证明等材料并与我们留言联系,本网站将在规定时间内给予删除等相关处理.

  • vue3+TS 自定义指令:长按触发绑定的函数
    vue3+TS 自定义指令:长按触发绑定的函数而然间看到一个在vue2中写的长按触发事件的自定义指定,想着能不能把他copy到我的vue3项目中呢。编写自定义指令时遇到的几个难点1.自定义指令的类型在ts中写任何东西都要考虑到类型的问题,自定义指令的类型问题依然存
    03-08
  • Vue3 企业级优雅实战 - 组件库框架 - 9 实现组
    上文搭建了组件库 cli 的基础架子,实现了创建组件时的用户交互,但遗留了 cli/src/command/create-component.ts 中的 createNewComponent 函数,该函数要实现的功能就是上文开篇提到的 —— 创建一个组件的完整步骤。本文咱们就依次实现那些步骤。(友情提示
    03-08
  • vue3和百度地图关键字检索 定位 点击定位
    vue3和百度地图关键字检索 定位 点击定位
    效果图在index.html中引入百度地图开放平台  去申请你的ak 非常的简单可以自己百度 一下!-- 这个用官网给的有好多警告 更具百度的把 https://api.map.baidu.com/getscript?v=2.0ak=xxxxxxxxxxxxxxxxxxxxx 换为这个就没有那么多 报错了 --scripttype="text/j
    03-08
  • Vue3+TypeScript 项目中,配置 ESLint 和 Prett
    接上篇:从0搭建vite-vue3-ts项目框架:配置less+svg+pinia+vant+axios文档同步项目gitee:https://gitee.com/lixin_ajax/vue3-vite-ts-pinia-vant-less.git 一、Eslint:用于检测代码安装eslint相关依赖yarn add eslint eslint-plugin-vue @typescript-esli
    03-08
  • 一文带你了解Vue3中toRef和toRefs的用法 vue $refs的用法
    一文带你了解Vue3中toRef和toRefs的用法 vue $r
    toRef 顾名思义,不是ref 响应式数据,给它转成ref 响应式数据通俗易懂的理解: templateh3姓名:{{ person.name }}/h3h3年龄:{{ person.age }}/h3h3薪资:{{ person.job.j1.salary }}/h3button @click="person.name += '!'"修改姓名/buttonbutton @click="
    03-08
  • vue3.0 vue-router4.0打包后页面空白的解决方法
    vue3.0 vue-router4.0打包后页面空白的解决方
    开发环境可以正常渲染页面,路由跳转都没有问题,但是打包之后本地打开index.html出现报错或者页面空白的情况:脚手架版本:vue-router版本:第一种报错-资源加载失败这种错误是因为vue.config.js的配置里面 publicPath写了绝对路径,生产环境改为./相对路径
    03-08
  • vue3日历控件的具体实现 vue日历组件如何显示节日
    vue3日历控件的具体实现 vue日历组件如何显示节
    很多地方都要用到日历控件,比如生日、出发到达日期等等,本文就来介绍一下vue3日历控件的具体实现,具体如下效果如下:templatediv class="cal_con" style="margin-left:200px"div class="cal_header"!-- 顶部左侧 --div class="cal_header_left"div class="
    03-08
  • vue3全局组件自动注册功能实现 vue 全局注册
    vue3全局组件自动注册功能实现 vue 全局注册
    目录vue3全局组件自动注册前言:补充: Vue3注册全局组件1.注册单个全局组件2.批量注册全局组件vue3全局组件自动注册前言:本文主要讲述vue3的全局公共组件的自动注册第一步:建文件需要在src/components 下创建一个文件夹用于存放封装的公共组件(这里我起
    03-08
  • vue3项目目录结构示例详解 vue3.0目录结构
    目录一、vue3项目的目录结构详解二、部分主要文件详解1、index.html2、main.js(main.ts)3. package.json三、其他说明1. node版本错误2. 如何调用全局属性3. vue文件中应用vue3.0的api总结一、vue3项目的目录结构详解node_modules:通过 npm install 下载安
    03-08
  • vue3之Suspense加载异步数据的使用
    vue3之Suspense加载异步数据的使用
    Suspense使用templateSuspensetemplate #defaultProductList/ProductList/templatetemplate #fallback divloading.../div /template/Suspense/templatescript setup lang="ts" name="Cart"import ProductList from "./ProductList.vue";/scripts
    03-08
点击排行