uni-app 全局变量的几种实现方式
uni-app 全局变量的几种实现方式
公用模块
定义一个专用的模块,用来组织和管理这些全局的变量,在需要的页面引入。
注意这种方式只支持多个vue页面或多个nvue页面之间公用,vue和nvue之间不公用。
示例如下:
在 uni-app 项目根目录下创建 common 目录,然后在 common 目录下新建 helper.js 用于定义公用的方法。
const websiteUrl = 'http://uniapp.dcloud.io';
const now = Date.now || function () {
return new Date().getTime();
};
const isArray = Array.isArray || function (obj) {
return obj instanceof Array;
};
export default {
websiteUrl,
now,
isArray
}
接下来在 pages/index/index.vue 中引用该模块
<script>
import helper from '../../common/helper.js';
export default {
data() {
return {};
},
onLoad(){
console.log('now:' + helper.now());
},
methods: {
}
}
</script>
这种方式维护起来比较方便,但是缺点就是每次都需要引入。
挂载 Vue.prototype
将一些使用频率较高的常量或者方法,直接扩展到 Vue.prototype 上,每个 Vue 对象都会“继承”下来。
注意这种方式只支持vue页面
示例如下:
在 main.js 中挂载属性/方法
Vue.prototype.websiteUrl = 'http://uniapp.dcloud.io';
Vue.prototype.now = Date.now || function () {
return new Date().getTime();
};
Vue.prototype.isArray = Array.isArray || function (obj) {
return obj instanceof Array;
};
然后在 pages/index/index.vue 中调用
<script>
export default {
data() {
return {};
},
onLoad(){
console.log('now:' + this.now());
},
methods: {
}
}
</script>
这种方式,只需要在 main.js 中定义好即可在每个页面中直接调用。
Tips
- 每个页面中不要在出现重复的属性或方法名。
- 建议在 Vue.prototype 上挂载的属性或方法,可以加一个统一的前缀。比如 $url、global_url 这样,在阅读代码时也容易与当前页面的内容区分开。
globalData
小程序中有个globalData概念,可以在 App 上声明全局变量。 Vue 之前是没有这类概念的,但 uni-app 引入了globalData概念,并且在包括H5、App等平台都实现了。
globalData支持vue和nvue共享数据。
globalData是一种比较简单的全局变量使用方式。
定义:App.vue
<script>
export default {
globalData: {
text: 'text'
},
onLaunch: function() {
console.log('App Launch')
},
onShow: function() {
console.log('App Show')
},
onHide: function() {
console.log('App Hide')
}
}
</script>
<style>
/*每个页面公共css */
</style>
js中操作globalData的方式如下:
赋值:getApp().globalData.text = 'test'
取值:console.log(getApp().globalData.text) // 'test'
如果需要把globalData的数据绑定到页面上,可在页面的onshow声明周期里进行变量重赋值。HBuilderX 2.0.3起,nvue页面在uni-app
编译模式下,也支持onshow。
Vuex
Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化。
HBuilderX 2.2.5+起,支持vue和nvue之间共享。
这里以登录后同步更新用户信息为例,简单说明下 Vuex 的用法,更多更详细的 Vuex 的内容,建议前往其官网 Vuex 学习下。
举例说明:
在 uni-app 项目根目录下新建 store 目录,在 store 目录下创建 index.js 定义状态值
const store = new Vuex.Store({
state: {
login: false,
token: '',
avatarUrl: '',
userName: ''
},
mutations: {
login(state, provider) {
console.log(state)
console.log(provider)
state.login = true;
state.token = provider.token;
state.userName = provider.userName;
state.avatarUrl = provider.avatarUrl;
},
logout(state) {
state.login = false;
state.token = '';
state.userName = '';
state.avatarUrl = '';
}
}
})
然后,需要在 main.js 挂载 Vuex
import store from './store'
Vue.prototype.$store = store
最后,在 pages/index/index.vue 使用
<script>
import {
mapState,
mapMutations
} from 'vuex';
export default {
computed: {
...mapState(['avatarUrl', 'login', 'userName'])
},
methods: {
...mapMutations(['logout'])
}
}
</script>
详细示例,请下载附件,在 HBuilderX 中运行。
示例操作步骤:
未登录时,提示去登录。跳转至登录页后,点击“登录”获取用户信息,同步更新状态后,返回到个人中心即可看到信息同步的结果。
注意:对比前面的方式,该方式更加适合处理全局的并且值会发生变化的情况。
注意事项
- .vue 和 .nvue 并不是一个规范,因此一些在 .vue 中适用的方案并不适用于 .nvue。 Vue 上挂载属性,不能在 .nvue 中使用。
更多
关于登录状态的维护,还可以参考 uni-app 的登录模板示例。可以在 github 获取源码,也可以在新建 uni-app 时“从模板创建”选择登录模板。
在uni-app中,全局变量的实现方式多种多样,这里主要介绍几种常用的方法,并附上相应的代码示例。
1. 使用 globalData
在 App.vue
中定义全局变量
App.vue
是 uni-app 的全局入口文件,可以在其 data
函数中定义 globalData
对象,用于存储全局变量。
// App.vue
<script>
export default {
data() {
return {
globalData: {
userInfo: null,
token: ''
}
}
},
onLaunch() {
// 初始化全局变量
console.log('App Launch');
},
methods: {
// 可以定义一个方法来修改全局变量
setGlobalData(key, value) {
this.globalData[key] = value;
},
getGlobalData(key) {
return this.globalData[key];
}
}
}
</script>
在其他页面中可以通过 getApp().globalData
访问这些全局变量。
// 在其他页面中
const app = getApp();
console.log(app.globalData.userInfo);
app.setGlobalData('token', 'new_token_value');
2. 使用 Vuex 进行状态管理
对于复杂的应用,推荐使用 Vuex 进行状态管理。Vuex 允许你创建一个集中的存储库,用于管理应用的所有组件的状态。
// store/index.js
import Vue from 'vue';
import Vuex from 'vuex';
Vue.use(Vuex);
export default new Vuex.Store({
state: {
userInfo: null,
token: ''
},
mutations: {
SET_USERINFO(state, userInfo) {
state.userInfo = userInfo;
},
SET_TOKEN(state, token) {
state.token = token;
}
},
actions: {
updateUserInfo({ commit }, userInfo) {
commit('SET_USERINFO', userInfo);
},
updateToken({ commit }, token) {
commit('SET_TOKEN', token);
}
}
});
在 main.js
中引入并使用 Vuex store。
// main.js
import Vue from 'vue';
import App from './App';
import store from './store';
Vue.config.productionTip = false;
App.mpType = 'app';
const app = new Vue({
...App,
store
});
app.$mount();
在其他组件中,可以通过 this.$store.state
、this.$store.commit
和 this.$store.dispatch
来访问和修改状态。
总结
以上两种方法各有优劣,globalData
适合简单的全局变量存储,而 Vuex 则更适合复杂的状态管理。根据项目的实际需求选择合适的方法即可。