uni-app之页面通讯——uni.$emit、uni.$on、uni.$once、uni$off

策马游疆 發表於 2021-9-6 21:41:00

uni-app之页面通讯——uni.$emit、uni.$on、uni.$once、uni$off

<h1>uni.$emit(eventName,Object)</h1>
触发全局的自定义事件，附加参数都会传给监听器回调函数。
<table border="0">
<tbody>
<tr style="background-color: rgba(51, 51, 51, 1)">
<td>属性</td>
<td>类型</td>
<td>描述</td>
</tr>
<tr>
<td>eventName</td>
<td>String</td>
<td>事件名</td>
</tr>
<tr>
<td>Object</td>
<td>Object</td>
<td>触发全局的自定义事件，附加参数都会传给监听器回调函数。</td>
</tr>
</tbody>
</table>
示例代码如下：
<div class="cnblogs_code">
<pre> uni.$emit('update',{msg:'页面更新'})</pre>
</div>
<h1 id="on">uni.$on(eventName,callback)</h1>
监听全局的自定义事件，事件由 <code>uni.$emit</code> 触发，回调函数会接收事件触发函数的传入参数。
<table border="0">
<tbody>
<tr style="background-color: rgba(51, 51, 51, 1)">
<td>属性</td>
<td>类型</td>
<td>描述</td>
</tr>
<tr>
<td>eventName</td>
<td>String</td>
<td>事件名</td>
</tr>
<tr>
<td>callback</td>
<td>Function</td>
<td>事件的回调函数。</td>
</tr>
</tbody>
</table>
示例代码如下：
<div class="cnblogs_code">
<pre>uni.$on('update',function(data){
console.log('监听到事件来自 update ，携带参数 msg 为：' + data.msg);
})</pre>
</div>
<h1 id="once">uni.$once(eventName,callback)</h1>
监听全局的自定义事件，事件由 <code>uni.$emit</code> 触发，但仅触发一次，在第一次触发之后移除该监听器。
<table border="0">
<tbody>
<tr style="background-color: rgba(51, 51, 51, 1)">
<td>属性</td>
<td>类型</td>
<td>描述</td>
</tr>
<tr>
<td>eventName</td>
<td>String</td>
<td>事件名</td>
</tr>
<tr>
<td>callback</td>
<td>Function</td>
<td>事件的回调函数。</td>
</tr>
</tbody>
</table>
<h1>uni.$off()</h1>
移除全局自定义事件监听器。
<table border="0">
<tbody>
<tr style="background-color: rgba(51, 51, 51, 1)">
<td>属性</td>
<td>类型</td>
<td>描述</td>
</tr>
<tr>
<td>eventName</td>
<td>String</td>
<td>事件名</td>
</tr>
<tr>
<td>callback</td>
<td>Function</td>
<td>事件的回调函数。</td>
</tr>
</tbody>
</table>
<ul>
<li>如果uni.$off没有传入参数，则移除App级别的所有事件监听器；</li>
<li>如果只提供了事件名（eventName），则移除该事件名对应的所有监听器；</li>
<li>如果同时提供了事件与回调，则只移除这个事件回调的监听器；</li>
<li>提供的回调必须跟$on的回调为同一个才能移除这个回调的监听器；</li>
</ul>
<h1>代码示例</h1>
<code>$emit</code>、<code>$on</code>、<code>$off</code>常用于跨页面、跨组件通讯，这里为了方便演示放在同一个页面。
<div class="cnblogs_code">
<pre> 1 <template>
 2 <view class="content">
 3 <view class="data">
 4 <text>{{val}}</text>
 5 </view>
 6 <button type="primary" @click="comunicationOff">结束监听</button>
 7 </view>
 8 </template>
 9
10 <script>
11 export default {
12 data() {
13 return {
14 val: 0
15 }
16 },
17 onLoad() {
18 setInterval(()=>{
19 uni.$emit('add', {
20 data: 2
21 })
22 },1000)
23 uni.$on('add', this.add)
24 },
25 methods: {
26 comunicationOff() {
27 uni.$off('add', this.add)
28 },
29 add(e) {
30 this.val += e.data
31 }
32 }
33 }
34 </script>
35
36 <style>
37 .content {
38 display: flex;
39 flex-direction: column;
40 align-items: center;
41 justify-content: center;
42 }
43
44 .data {
45 text-align: center;
46 line-height: 40px;
47 margin-top: 40px;
48 }
49
50 button {
51 width: 200px;
52 margin: 20px 0;
53 }
54 </style></pre>
</div>
<ul>
<li>uni.$emit、 uni.$on 、 uni.$once 、uni.$off 触发的事件都是 App 全局级别的，跨任意组件，页面，nvue，vue 等</li>
<li>使用时，注意及时销毁事件监听，比如，页面 onLoad 里边 uni.$on 注册监听，onUnload 里边 uni.$off 移除，或者一次性的事件，直接使用 uni.$once 监听</li>
</ul>
<h1>参考网址</h1>
<ul>
<li>页面通讯：https://uniapp.dcloud.io/api/window/communication?id=emit</li>
</ul>

</div>
<div id="MySignature" role="contentinfo">
有志者，事竟成，破釜沉舟，百二秦关终属楚；苦心人，天不负，卧薪尝胆，三千越甲可吞吴。 
来源：https://www.cnblogs.com/luyj00436/p/15235880.html

頁: [1]

琼殿技术论坛's Archiver

uni-app之页面通讯——uni.$emit、uni.$on、uni.$once、uni$off