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="actions.html" /> <link rel="prev" href="getters.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 active" data-level="1.6.3" data-path="mutations.html"> <a href="mutations.html"> ミューテーション </a> </li> <li class="chapter " 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> 実際に Vuex のストアの状態を変更できる唯一の方法は、ミューテーションをコミットすることです。Vuex のミューテーションはイベントにとても近い概念です: 各ミューテーションはタイプとハンドラを持ちます。ハンドラ関数は Vuex の状態（state）を第1引数として取得し、実際に状態の変更を行います: <pre class="language-"><code class="lang-js">const store = new Vuex.Store({ state: { count: 1 }, mutations: { increment (state) { // 状態を変更する state.count++ } } }) </code></pre> 直接ミューテーションハンドラを呼び出すことはできません。この mutations オプションは、どちらかいうと "タイプが <code>increment</code> のミューテーションがトリガーされたときに、このハンドラが呼ばれる" といったイベント登録のようなものです。ミューテーションハンドラを起動するためにはミューテーションのタイプを指定して <code>store.commit</code> を呼び出す必要があります: <pre class="language-"><code class="lang-js">store.commit('increment') </code></pre> <h3 id="追加の引数を渡してコミットする">追加の引数を渡してコミットする</h3> <code>store.commit</code> に追加の引数を渡すこともできます。この追加の引数は、特定のミューテーションに対するペイロードと呼びます: <pre class="language-"><code class="lang-js">// ... mutations: { increment (state, n) { state.count += n } } </code></pre> <pre class="language-"><code class="lang-js">store.commit('increment', 10) </code></pre> ほとんどの場合、ペイロードはオブジェクトにすべきです。そうすることで複数のフィールドを含められるようになり、またミューテーションがより記述的に記録されるようになります: <pre class="language-"><code class="lang-js">// ... mutations: { increment (state, payload) { state.count += payload.amount } } </code></pre> <pre class="language-"><code class="lang-js">store.commit('increment', { amount: 10 }) </code></pre> <h3 id="オブジェクトスタイルのコミット">オブジェクトスタイルのコミット</h3> また <code>type</code> プロパティを持つオブジェクトを使って、ミューテーションをコミットすることもできます: <pre class="language-"><code class="lang-js">store.commit({ type: 'increment', amount: 10 }) </code></pre> オブジェクトスタイルでコミットするとき、オブジェクト全体がペイロードとしてミューテーションハンドラに渡されます。したがってハンドラの例は上記と同じです: <pre class="language-"><code class="lang-js">mutations: { increment (state, payload) { state.count += payload.amount } } </code></pre> <h3 id="サイレントコミット">サイレントコミット</h3> <blockquote> 注意: この機能は開発ツール内にミューテーション・フィルタが実装された後に非推奨になる予定です。 </blockquote> デフォルトでは全てのコミットされたミューテーションはプラグイン（開発ツール等）に送られます。しかし場合によっては、プラグインに全ての状態の変化を記録して欲しくないこともあるでしょう。あるいは、短い間隔やポーリングでのストアへの複数のコミットも、常に追跡する必要はないでしょう。こうしたケースでは、<code>store.commit</code> に第3引数を渡すことで、特定のミューテーションをプラグインに気付かせないようにすること（"silence"）ができます: <pre class="language-"><code class="lang-js">store.commit('increment', { amount: 1 }, { silent: true }) // オブジェクトスタイルのコミット store.commit({ type: 'increment', amount: 1 }, { silent: true }) </code></pre> <h3 id="vue-のリアクティブなルールに則ったミューテーション">Vue のリアクティブなルールに則ったミューテーション</h3> Vuex ストアの状態は Vue によってリアクティブになっているので、状態を変更すると、状態を監視している Vue コンポーネントは自動的に更新されます。これは Vuex のミューテーションは、通常の Vue と動作させているときと同じく、リアクティブな値に関する注意が必要であることを意味します: <ol> <li>あらかじめ全ての必要なフィールドによって、ストアの初期状態を初期化することが望ましいです </li> <li>新しいプロパティをオブジェクトに追加するとき、以下のいずれかが必要です: <ul> <li><code>Vue.set(obj, 'newProp', 123)</code> を使用する。あるいは </li> <li>全く新しいオブジェクトで既存のオブジェクトを置き換える。例えば、stage-3 の<a href="https://github.com/sebmarkbage/ecmascript-rest-spread" target="_blank">スプレッドシンタックス（object spread syntax）</a> を使用して、次のように書くことができます: <pre class="language-"><code class="lang-js">state.obj = { ...state.obj, newProp: 123 } </code></pre> </li> </ul> </li> </ol> <h3 id="ミューテーション・タイプに定数を使用する">ミューテーション・タイプに定数を使用する</h3> いろいろな Flux 実装において、ミューテーション・タイプに定数を使用することが共通して見られるパターンです。これはコードに対してリントツールのようなツールを利用できるという利点があり、また単一ファイルに全ての定数を設定することによって、共同で作業する人に、アプリケーション全体で何のミューテーションが可能であるかを一目見ただけで理解できるようにします: <pre class="language-"><code class="lang-js">// mutation-types.js export const SOME_MUTATION = 'SOME_MUTATION' </code></pre> <pre class="language-"><code class="lang-js">// store.js import Vuex from 'vuex' import { SOME_MUTATION } from './mutation-types' const store = new Vuex.Store({ state: { ... }, mutations: { // 定数を関数名として使用できる ES2015 の算出プロパティ名（computed property name）機能を使用できます [SOME_MUTATION] (state) { // 状態を変更する } } }) </code></pre> 定数を使用するかどうかは好みの問題です。多くの開発者による大規模なプロジェクトで役に立ちますが、完全にオプションなので、もしお気に召さなければ使用しなくても構いません。 <h3 id="ミューテーションは同期的でなければならない">ミューテーションは同期的でなければならない</h3> ひとつの重要なルールを覚えておきましょう。それはミューテーションハンドラ関数は同期的でなければならないということです。なぜか？次の例で考えてみましょう: <pre class="language-"><code class="lang-js">mutations: { someMutation (state) { api.callAsyncMethod(() => { state.count++ }) } } </code></pre> いま、開発ツールのミューテーションのログを見ながら、アプリケーションのデバッグを行っていることを想像してください。全てのミューテーションをログに記録するためには、ミューテーションの前後の状態のスナップショットを捕捉することが必要です。しかし、上の例にあるミューテーション内の非同期コールバックは、それを不可能にします: そのコールバックは、ミューテーションがコミットされた時点ではまだ呼び出されていません。そして、コールバックが実際にいつ呼び出されるかを、開発ツールは知る術がありません。いかなる状態変更でも、コールバック内で起きる場合は本質的に追跡不可能です。 <h3 id="コンポーネント内におけるミューテーションのコミット">コンポーネント内におけるミューテーションのコミット</h3> <code>this.$store.commit('xxx')</code> と書くか、もしくはコンポーネントのメソッドを <code>store.commit</code> にマッピングする <code>mapMutations</code> ヘルパーを呼び出すこと（ルートの <code>store</code> の注入が必要）で、コンポーネント内でミューテーションをコミットできます: <pre class="language-"><code class="lang-js">import { mapMutations } from 'vuex' export default { // ... methods: { ...mapMutations([ 'increment', // `this.increment()` を `this.$store.commit('increment')` にマッピングする // mapMutations はペイロードサポートする: 'incrementBy' // `this.incrementBy(amount)` を `this.$store.commit('incrementBy', amount)` にマッピングする ]), ...mapMutations({ add: 'increment' // `this.add()` を `this.$store.commit('increment')` にマッピングする }) } } </code></pre> <h3 id="アクションへ向けて">アクションへ向けて</h3> 状態変更を非同期に組み合わせることは、プログラムの動きを予測することを非常に困難にします。例えば、状態を変更する非同期コールバックを持った 2つのメソッドを両方呼び出すとき、それらがいつ呼び出されたか、どちらが先に呼び出されたかを、どうやって知ればよいのでしょう？これがまさに、状態変更と非同期の 2つの概念を分離したいという理由です。Vuex では全てのミューテーションは同期的に行うという作法になっています: <pre class="language-"><code class="lang-js">store.commit('increment') // "increment" ミューテーションによる状態変更は、この時点で行われるべきです </code></pre> 非同期的な命令を扱うために<a href="actions.html">アクション</a>を見てみましょう。 </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="getters.html" class="navigation navigation-prev " aria-label="Previous page: ゲッター"> </a> <a href="actions.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.3","depth":2,"next":{"title":"アクション","level":"1.6.4","depth":2,"path":"actions.md","ref":"actions.md","articles":[]},"previous":{"title":"ゲッター","level":"1.6.2","depth":2,"path":"getters.md","ref":"getters.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":"mutations.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>