vuex-help

<!DOCTYPE HTML> <html lang="ru" > <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"> Начало работы </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"> Строгий режим (strict mode) </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 очень похожи на события: каждая мутация имеет строковый тип и функцию-обработчик. В этом обработчике и происходят, собственно, изменения состояния, переданного в функцию первым аргументом: <pre class="language-"><code class="lang-js">const store = new Vuex.Store({ state: { count: 1 }, mutations: { increment (state) { // изменяем состояние state.count++ } } }) </code></pre> Вызывать функцию-обработчик напрямую — нельзя. Это больше похоже на обработку события: "Когда мутация типа <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> в мутацию можно также передать дополнительный параметр, называемый нагрузкой (<code>payload</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> Другой способ вызвать мутацию — это передать в commit единственный параметр, в котором <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="мутации-следуют-правилам-реактивности-vue">Мутации следуют правилам реактивности Vue</h3> Поскольку состояние хранилища Vuex — это реактивная переменная Vue, при возникновении мутации зависящие от этого состояния компоненты Vue обновляются автоматически. Кроме того, это значит, что мутации Vuex имеют те же самые подводные камни, что и реактивность в обычном Vue: <ol> <li>Лучше инициализировать изначальное состояние хранилища, указав все поля в самом начале. </li> <li>При добавлении новых свойств объекту необходимо либо: <ul> <li>Использовать <code>Vue.set(obj, 'newProp', 123)</code>, либо же </li> <li>Целиком заменить старый объект новым. Например, используя <a href="https://github.com/sebmarkbage/ecmascript-rest-spread" target="_blank">синтаксис расширения объектов</a> из stage-3, можно написать так: <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 позволяют использовать // константу в качестве имени функции [SOME_MUTATION] (state) { // здесь будет изменяться состояние } } }) </code></pre> Тем не менее, использовать константы для указания типов мутаций совершенно необязательно, хотя это и может оказаться полезным в крупных проектах. <h3 id="мутации-должны-быть-синхронными">Мутации должны быть синхронными</h3> Нужно помнить одно важное правило: обработчики мутаций обязаны быть синхронными. Почему? Рассмотрим пример: <pre class="language-"><code class="lang-js">mutations: { someMutation (state) { api.callAsyncMethod(() => { state.count++ }) } } </code></pre> Теперь представьте, что вы отлаживаете приложение и смотрите в лог мутаций в инструментах разработчика. Для каждой залогированной мутации devtools должен сохранить слепки состояния приложения "до" и "после" её наступления. Однако, асинхронный коллбэк внутри приведённой выше мутации делает это невозможным: мутация-то уже записана, и у devtools нет никакой возможности знать, что далее будет вызван коллбэк, а, значит, и инициируемые им изменения становится, по сути дела, невозможно отследить. <h3 id="вызов-мутаций-в-компонентах">Вызов мутаций в компонентах</h3> Мутации можно вызывать из кода компонентов, используя <code>this.$store.commit('xxx')</code>, или применяя хелпер <code>mapMutations</code>, который проксирует вызовы <code>store.commit</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> Привнесение асинхронности в мутации могло бы изрядно затруднить понимание логики программы. Например, если вызываются два метода, оба с асинхронными коллбэками, изменяющими состояние приложения — как предсказать, какой из коллбэков будет вызван первым? Именно поэтому концепции изменений и асинхронности рассматриваются по отдельности. Во 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","theme-vuejs@git+https://github.com/pearofducks/gitbook-plugin-theme-vuejs.git","-fontsettings","-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":"Редактировать эту страницу","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":"ru","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":">3.0.0"},"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":"ru"}}); }); </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>