vuex-help

<!DOCTYPE HTML> <html lang="ja" > <head> <meta charset="UTF-8"> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> <title>アクション · Vuex</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="description" content=""> <meta name="generator" content="GitBook 3.2.3"> <link rel="stylesheet" href="../gitbook/style.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css"> <link rel="stylesheet" href="../gitbook/gitbook-plugin-theme-vuejs/vue.css"> <meta name="HandheldFriendly" content="true"/> <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> <meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-status-bar-style" content="black"> <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png"> <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon"> <link rel="next" href="modules.html" /> <link rel="prev" href="mutations.html" /> </head> <body> <div class="book"> <div class="book-summary"> <div id="book-search-input" role="search"> <input type="text" placeholder="検索すると入力" /> </div> <nav role="navigation"> <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=vuejs" id="_carbonads_js"></script> <ul class="summary"> <li class="chapter " data-level="1.1" data-path="./"> <a href="./"> Introduction </a> </li> <li class="chapter " data-level="1.2" > <a target="_blank" href="https://github.com/vuejs/vuex/releases"> リリースノート </a> </li> <li class="chapter " data-level="1.3" data-path="installation.html"> <a href="installation.html"> インストール </a> </li> <li class="chapter " data-level="1.4" data-path="intro.html"> <a href="intro.html"> Vuex とは何か? </a> </li> <li class="chapter " data-level="1.5" data-path="getting-started.html"> <a href="getting-started.html"> Vuex 入門 </a> </li> <li class="chapter " data-level="1.6" data-path="core-concepts.html"> <a href="core-concepts.html"> コアコンセプト </a> <ul class="articles"> <li class="chapter " data-level="1.6.1" data-path="state.html"> <a href="state.html"> ステート </a> </li> <li class="chapter " data-level="1.6.2" data-path="getters.html"> <a href="getters.html"> ゲッター </a> </li> <li class="chapter " data-level="1.6.3" data-path="mutations.html"> <a href="mutations.html"> ミューテーション </a> </li> <li class="chapter active" data-level="1.6.4" data-path="actions.html"> <a href="actions.html"> アクション </a> </li> <li class="chapter " data-level="1.6.5" data-path="modules.html"> <a href="modules.html"> モジュール </a> </li> </ul> </li> <li class="chapter " data-level="1.7" data-path="structure.html"> <a href="structure.html"> アプリケーションの構造 </a> </li> <li class="chapter " data-level="1.8" data-path="plugins.html"> <a href="plugins.html"> プラグイン </a> </li> <li class="chapter " data-level="1.9" data-path="strict.html"> <a href="strict.html"> 厳格モード </a> </li> <li class="chapter " data-level="1.10" data-path="forms.html"> <a href="forms.html"> フォームの扱い </a> </li> <li class="chapter " data-level="1.11" data-path="testing.html"> <a href="testing.html"> テスト </a> </li> <li class="chapter " data-level="1.12" data-path="hot-reload.html"> <a href="hot-reload.html"> ホットリローディング </a> </li> <li class="chapter " data-level="1.13" data-path="api.html"> <a href="api.html"> API リファレンス </a> </li> <li class="divider"></li> <li> <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> GitBookで公開 </a> </li> </ul> </nav> </div> <div class="book-body"> <div class="body-inner"> <div class="book-header" role="navigation">  <h1> <a href="." >アクション</a> </h1> </div> <div class="page-wrapper" tabindex="-1" role="main"> <div class="page-inner"> <div id="book-search-results"> <div class="search-noresults"> <section class="normal markdown-section"> <h1 id="アクション">アクション</h1> アクションはミューテーションと似ていますが、下記の点で異なります: <ul> <li>アクションは、状態を変更するのではなく、ミューテーションをコミットします。</li> <li>アクションは任意の非同期処理を含むことができます。</li> </ul> シンプルなアクションを登録してみましょう: <pre class="language-"><code class="lang-js">const store = new Vuex.Store({ state: { count: 0 }, mutations: { increment (state) { state.count++ } }, actions: { increment (context) { context.commit('increment') } } }) </code></pre> アクションハンドラはストアインスタンスのメソッドやプロパティのセットと同じものを呼び出せるコンテキストオブジェクトを受け取ります。したがって <code>context.commit</code> を呼び出すことでミューテーションをコミットできます。あるいは <code>context.state</code> や <code>context.getters</code> で、状態やゲッターにアクセスできます。なぜコンテキストオブジェクトがストアインスタンスそのものではないのかは、後ほど<a href="modules.html">モジュール</a>で説明します。 実際にはコードを少しシンプルにするために ES2015 の<a href="https://github.com/lukehoban/es6features#destructuring" target="_blank">引数分割束縛（argument destructuring）</a>がよく使われます（特に <code>commit</code> を複数回呼び出す必要があるとき）: <pre class="language-"><code class="lang-js">actions: { increment ({ commit }) { commit('increment') } } </code></pre> <h3 id="アクションのディスパッチ">アクションのディスパッチ</h3> アクションは <code>store.dispatch</code> がトリガーとなって実行されます: <pre class="language-"><code class="lang-js">store.dispatch('increment') </code></pre> これは一見ばかげて見えるかもしれません。つまり、カウントをインクリメントしたいときに、どうして直接 <code>store.commit('increment')</code> を呼び出してミューテーションをコミットしないのか、と。ミューテーションは同期的でなければならないというのを覚えていますか？アクションはそうではありません。アクションの中では非同期の操作を行うことができます。 <pre class="language-"><code class="lang-js">actions: { incrementAsync ({ commit }) { setTimeout(() => { commit('increment') }, 1000) } } </code></pre> アクションはペイロード形式とオブジェクトスタイルのディスパッチをサポートします: <pre class="language-"><code class="lang-js">// ペイロードを使ってディスパッチする store.dispatch('incrementAsync', { amount: 10 }) // オブジェクトを使ってディスパッチする store.dispatch({ type: 'incrementAsync', amount: 10 }) </code></pre> より実践的な例として、ショッピングカートをチェックアウトするアクションを挙げます。このアクションは非同期な API の呼び出しと、複数のミューテーションのコミットをします: <pre class="language-"><code class="lang-js">actions: { checkout ({ commit, state }, products) { // 現在のカート内の商品を保存する const savedCartItems = [...state.cart.added] // チェックアウトのリクエストを送信し、楽観的にカート内をクリアする commit(types.CHECKOUT_REQUEST) // shop API は成功時のコールバックと失敗時のコールバックを受け取る shop.buyProducts( products, // 成功時の処理 () => commit(types.CHECKOUT_SUCCESS), // 失敗時の処理 () => commit(types.CHECKOUT_FAILURE, savedCartItems) ) } } </code></pre> 一連の非同期の処理を実行しつつ、ミューテーションのコミットによってのみ副作用（状態の変更）を与えていることに注意してください。 <h3 id="コンポーネント内でのアクションのディスパッチ">コンポーネント内でのアクションのディスパッチ</h3> <code>this.$store.dispatch('xxx')</code> でコンポーネント内でアクションをディスパッチできます。あるいはコンポーネントのメソッドを <code>store.dispatch</code> にマッピングする <code>mapActions</code> ヘルパーを使うこともできます（ルートの <code>store</code> の注入が必要です）: <pre class="language-"><code class="lang-js">import { mapActions } from 'vuex' export default { // ... methods: { ...mapActions([ 'increment', // `this.increment()` を `this.$store.dispatch('increment')` にマッピングする // `mapActions` もペイロードをサポートする: 'incrementBy' // `this.incrementBy(amount)` を `this.$store.dispatch('incrementBy', amount)` にマッピングする ]), ...mapActions({ add: 'increment' // `this.add()` を `this.$store.dispatch('increment')` にマッピングする }) } } </code></pre> <h3 id="アクションを構成する">アクションを構成する</h3> アクションはしばしば非同期処理を行いますが、アクションが完了したことをどうやって知れば良いのでしょう？そしてもっと重要なことは、さらに複雑な非同期処理を取り扱うために、どうやって複数のアクションを構成させるかということです。 まず知っておくべきことは <code>store.dispatch</code> がトリガーされたアクションハンドラによって返された Promise を処理できることと、<code>store.dispatch</code> もまた Promise を返すことです。 <pre class="language-"><code class="lang-js">actions: { actionA ({ commit }) { return new Promise((resolve, reject) => { setTimeout(() => { commit('someMutation') resolve() }, 1000) }) } } </code></pre> すると次のようにできます: <pre class="language-"><code class="lang-js">store.dispatch('actionA').then(() => { // ... }) </code></pre> また別のアクションで下記のように書くと: <pre class="language-"><code class="lang-js">actions: { // ... actionB ({ dispatch, commit }) { return dispatch('actionA').then(() => { commit('someOtherMutation') }) } } </code></pre> 最終的に <a href="https://tc39.github.io/ecmascript-asyncawait/" target="_blank">async / await</a> を使用することで、次のようにアクションを組み合わせることができます: <pre class="language-"><code class="lang-js">// `getData()` と `getOtherData()` が Promise を返すことを想定している actions: { async actionA ({ commit }) { commit('gotData', await getData()) }, async actionB ({ dispatch, commit }) { await dispatch('actionA') // `actionA` が完了するのを待機する commit('gotOtherData', await getOtherData()) } } </code></pre> <blockquote> <code>store.dispatch</code> で異なるモジュール内の複数のアクションハンドラをトリガーすることができます。そのようなケースでは、全てのトリガーされたハンドラが解決されたときに解決する Promise が戻り値として返ってくることになります。 </blockquote> </section> </div> <div class="search-results"> <div class="has-results"> <h1 class="search-results-title"> results matching ""</h1> <ul class="search-results-list"></ul> </div> <div class="no-results"> <h1 class="search-results-title">No results matching ""</h1> </div> </div> </div> </div> </div> <script src="//m.servedby-buysellads.com/monetization.js" type="text/javascript"></script> <div class="bsa-cpc"></div> <script> (function(){ if(typeof _bsa !== 'undefined' && _bsa) { _bsa.init('default', 'CKYD62QM', 'placement:vuejsorg', { target: '.bsa-cpc', align: 'horizontal', disable_css: 'true' }); } })(); </script> </div> <a href="mutations.html" class="navigation navigation-prev " aria-label="Previous page: ミューテーション"> </a> <a href="modules.html" class="navigation navigation-next " aria-label="Next page: モジュール"> </a> </div> <script> var gitbook = gitbook || []; gitbook.push(function() { gitbook.page.hasChanged({"page":{"title":"アクション","level":"1.6.4","depth":2,"next":{"title":"モジュール","level":"1.6.5","depth":2,"path":"modules.md","ref":"modules.md","articles":[]},"previous":{"title":"ミューテーション","level":"1.6.3","depth":2,"path":"mutations.md","ref":"mutations.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","prism","-highlight","github","-highlight","github"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/vuejs/vuex/"},"livereload":{},"search":{},"theme-vuejs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/vuejs/vuex/tree/dev/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Vuex","language":"ja","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"2.x.x"},"file":{"path":"actions.md","mtime":"2018-02-17T07:20:49.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-03-02T20:43:43.208Z"},"basePath":".","book":{"language":"ja"}}); }); </script> </div> <script src="../gitbook/gitbook.js"></script> <script src="../gitbook/theme.js"></script> <script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script> <script src="../gitbook/gitbook-plugin-github/plugin.js"></script> <script src="../gitbook/gitbook-plugin-livereload/plugin.js"></script> <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script> <script src="../gitbook/gitbook-plugin-search/search.js"></script> <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script> <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script> <script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script> </body> </html>