如何将Pinia Store中的子Action标记为私有仅暴露主Action？

你可以通过以下几种方式将子Action设为私有，仅对外暴露主Action：

1. 下划线命名约定（社区通用方案） #

Pinia社区默认用下划线开头标记内部私有Action，这是一种约定俗成的规范，虽然不能强制阻止外部调用，但能明确告知开发者这些方法是内部逻辑，不应直接使用。

示例（选项式写法）：

import { defineStore } from 'pinia'

export const useMyStore = defineStore('myStore', {
  state: () => ({
    data1: '',
    data2: 0,
    data3: []
  }),
  actions: {
    // 对外暴露的主Action
    async masterAction(payload) {
      await this._updateData1(payload.data1)
      await this._updateData2(payload.data2)
      await this._updateData3(payload.data3)
    },
    // 私有子Action，以下划线开头
    async _updateData1(value) {
      this.data1 = value
    },
    async _updateData2(value) {
      this.data2 = value
    },
    async _updateData3(value) {
      this.data3 = [...this.data3, value]
    }
  }
})

2. 模块作用域隐藏（彻底私有） #

将子Action的逻辑抽成模块内部的普通函数，不挂载到Store的actions对象上，这样外部组件完全无法访问这些私有逻辑，彻底实现私有性。

示例（选项式写法）：

import { defineStore } from 'pinia'

// 模块内部私有函数，外部不可见
async function updateData1(state, value) {
  state.data1 = value
}

async function updateData2(state, value) {
  state.data2 = value
}

async function updateData3(state, value) {
  state.data3 = [...state.data3, value]
}

export const useMyStore = defineStore('myStore', {
  state: () => ({
    data1: '',
    data2: 0,
    data3: []
  }),
  actions: {
    async masterAction(payload) {
      // 内部调用私有函数
      await updateData1(this.state, payload.data1)
      await updateData2(this.state, payload.data2)
      await updateData3(this.state, payload.data3)
    }
  }
})

3. Setup写法下的局部函数（最自然的私有方式） #

如果使用Pinia的setup写法，直接将子逻辑定义为setup函数内部的局部函数，不对外返回即可，外部完全无法访问这些私有方法。

示例（setup写法）：

import { defineStore } from 'pinia'
import { ref } from 'vue'

export const useMyStore = defineStore('myStore', () => {
  const data1 = ref('')
  const data2 = ref(0)
  const data3 = ref([])

  // 私有局部函数，不对外暴露
  async function updateData1(value) {
    data1.value = value
  }

  async function updateData2(value) {
    data2.value = value
  }

  async function updateData3(value) {
    data3.value = [...data3.value, value]
  }

  // 对外暴露的主Action
  async function masterAction(payload) {
    await updateData1(payload.data1)
    await updateData2(payload.data2)
    await updateData3(payload.data3)
  }

  // 仅返回需要对外暴露的状态和方法
  return {
    data1,
    data2,
    data3,
    masterAction
  }
})

方案选择建议 #

• 如果团队有明确的代码规范，下划线约定足够简单高效；
• 若需要彻底禁止外部访问，模块作用域函数或setup写法的局部函数是最优选择；
• 推荐优先使用setup写法，它的私有逻辑实现更直观、自然。

内容的提问来源于stack exchange，提问作者Loren