vuex-help
Version:
a utilies library reduce boilerplate for vuex
593 lines (297 loc) • 30 kB
HTML
<html lang="kr" >
<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="strict.html" />
<link rel="prev" href="structure.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</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/tree/1.0/docs">
1.0 버전 문서를 보려면?
</a>
</li>
<li class="chapter " data-level="1.3" >
<a target="_blank" href="https://github.com/vuejs/vuex/releases">
릴리즈 노트
</a>
</li>
<li class="chapter " data-level="1.4" data-path="installation.html">
<a href="installation.html">
설치
</a>
</li>
<li class="chapter " data-level="1.5" data-path="intro.html">
<a href="intro.html">
Vuex가 무엇인가요?
</a>
</li>
<li class="chapter " data-level="1.6" data-path="getting-started.html">
<a href="getting-started.html">
시작하기
</a>
</li>
<li class="chapter " data-level="1.7" >
<span>
핵심 컨셉
</span>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="state.html">
<a href="state.html">
상태
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="getters.html">
<a href="getters.html">
Getters
</a>
</li>
<li class="chapter " data-level="1.7.3" data-path="mutations.html">
<a href="mutations.html">
변이
</a>
</li>
<li class="chapter " data-level="1.7.4" data-path="actions.html">
<a href="actions.html">
액션
</a>
</li>
<li class="chapter " data-level="1.7.5" data-path="modules.html">
<a href="modules.html">
모듈
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="structure.html">
<a href="structure.html">
애플리케이션 구조
</a>
</li>
<li class="chapter active" data-level="1.9" data-path="plugins.html">
<a href="plugins.html">
플러그인
</a>
</li>
<li class="chapter " data-level="1.10" data-path="strict.html">
<a href="strict.html">
Strict 모드
</a>
</li>
<li class="chapter " data-level="1.11" data-path="forms.html">
<a href="forms.html">
폼 핸들링
</a>
</li>
<li class="chapter " data-level="1.12" data-path="testing.html">
<a href="testing.html">
테스팅
</a>
</li>
<li class="chapter " data-level="1.13" data-path="hot-reload.html">
<a href="hot-reload.html">
핫 리로딩
</a>
</li>
<li class="chapter " data-level="1.14" 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">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<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>
<p>Vuex 저장소는 각 변이에 대한 훅을 노출하는 <code>plugins</code> 옵션을 허용합니다. Vuex 플러그인은 저장소를 유일한 전달인자로 받는 함수입니다.</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">const</span> myPlugin <span class="token operator">=</span> store <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// 저장소가 초기화 될 때 불립니다.</span>
store<span class="token punctuation">.</span><span class="token function">subscribe</span><span class="token punctuation">(</span><span class="token punctuation">(</span>mutation<span class="token punctuation">,</span> state<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// 매 변이시마다 불립니다.</span>
<span class="token comment" spellcheck="true">// 변이는 { type, payload } 포맷으로 제공됩니다.</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
</code></pre>
<p>그리고 다음과 같이 사용할 수 있습니다.</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// ...</span>
plugins<span class="token punctuation">:</span> <span class="token punctuation">[</span>myPlugin<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<h3 id="플러그인-내부에서-변이-커밋하기">플러그인 내부에서 변이 커밋하기</h3>
<p>플러그인은 상태를 직접 변이할 수 없습니다. 컴포넌트와 마찬가지로 변이를 커밋하여 변경을 트리거 할 수 있습니다.</p>
<p>변이을 커밋함으로써 플러그인을 사용하여 데이터 소스를 저장소에 동기화 할 수 있습니다. 예를 들어, websocket 데이터 소스를 저장소에 동기화하려면 (이는 사실 인위적인 예제입니다. 실제로 <code>createPlugin</code> 함수는 더 복잡한 작업을 위해 몇 가지 추가 옵션을 필요로 할 수 있습니다)</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">export</span> <span class="token keyword">default</span> <span class="token keyword">function</span> createWebSocketPlugin <span class="token punctuation">(</span>socket<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">return</span> store <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
socket<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">'data'</span><span class="token punctuation">,</span> data <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
store<span class="token punctuation">.</span><span class="token function">commit</span><span class="token punctuation">(</span><span class="token string">'receiveData'</span><span class="token punctuation">,</span> data<span class="token punctuation">)</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
store<span class="token punctuation">.</span><span class="token function">subscribe</span><span class="token punctuation">(</span>mutation <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
<span class="token keyword">if</span> <span class="token punctuation">(</span>mutation<span class="token punctuation">.</span>type <span class="token operator">===</span> <span class="token string">'UPDATE_DATA'</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
socket<span class="token punctuation">.</span><span class="token function">emit</span><span class="token punctuation">(</span><span class="token string">'update'</span><span class="token punctuation">,</span> mutation<span class="token punctuation">.</span>payload<span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<pre class="language-"><code class="lang-js"><span class="token keyword">const</span> plugin <span class="token operator">=</span> <span class="token function">createWebSocketPlugin</span><span class="token punctuation">(</span>socket<span class="token punctuation">)</span>
<span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
state<span class="token punctuation">,</span>
mutations<span class="token punctuation">,</span>
plugins<span class="token punctuation">:</span> <span class="token punctuation">[</span>plugin<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<h3 id="상태-스냅샷-가져오기">상태 스냅샷 가져오기</h3>
<p>때로는 플러그인이 상태의 "스냅샷"을 얻고자 할 수 있으며, 또한 변이 이후 상태와 변이 이전 상태를 비교할 수 있습니다. 이를 달성하기 위해서는 상태 객체에 대한 깊은 복사를 수행해야합니다 :</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">const</span> myPluginWithSnapshot <span class="token operator">=</span> store <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
<span class="token keyword">let</span> prevState <span class="token operator">=</span> _<span class="token punctuation">.</span><span class="token function">cloneDeep</span><span class="token punctuation">(</span>store<span class="token punctuation">.</span>state<span class="token punctuation">)</span>
store<span class="token punctuation">.</span><span class="token function">subscribe</span><span class="token punctuation">(</span><span class="token punctuation">(</span>mutation<span class="token punctuation">,</span> state<span class="token punctuation">)</span> <span class="token operator">=</span><span class="token operator">></span> <span class="token punctuation">{</span>
<span class="token keyword">let</span> nextState <span class="token operator">=</span> _<span class="token punctuation">.</span><span class="token function">cloneDeep</span><span class="token punctuation">(</span>state<span class="token punctuation">)</span>
<span class="token comment" spellcheck="true">// prevState와 nextState를 비교하십시오.</span>
<span class="token comment" spellcheck="true">// 다음 변이를 위한 상태 저장</span>
prevState <span class="token operator">=</span> nextState
<span class="token punctuation">}</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
</code></pre>
<p><strong>상태 스냅 샷을 사용하는 플러그인은 개발 중에 만 사용해야합니다.</strong> webpack 또는 Browserify를 사용하는 경우 빌드 도구가 이를 처리 할 수 있습니다.</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// ...</span>
plugins<span class="token punctuation">:</span> process<span class="token punctuation">.</span>env<span class="token punctuation">.</span>NODE_ENV <span class="token operator">!==</span> <span class="token string">'production'</span>
<span class="token operator">?</span> <span class="token punctuation">[</span>myPluginWithSnapshot<span class="token punctuation">]</span>
<span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<p>플러그인은 기본적으로 사용됩니다. 배포를 위해서는 webpack의 <a href="https://webpack.js.org/plugins/define-plugin/" target="_blank">DefinePlugin</a> 또는 <a href="https://github.com/hughsk/envify" target="_blank">envify</a>가 필요합니다. Browserify가 <code>process.env.NODE_ENV !== 'production'</code>의 값을 최종 빌드를 위해 <code>false</code>로 변환합니다.</p>
<h3 id="내장-로거-플러그인">내장 로거 플러그인</h3>
<blockquote>
<p><a href="https://github.com/vuejs/vue-devtools" target="_blank">vue-devtools</a>를 사용하고 있으면 필요 없을 수 있습니다.</p>
</blockquote>
<p>Vuex에는 일반적인 디버깅을 위한 로거 플러그인이 함께 제공됩니다.</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">import</span> createLogger <span class="token keyword">from</span> <span class="token string">'vuex/dist/logger'</span>
<span class="token keyword">const</span> store <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Vuex<span class="token punctuation">.</span>Store</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
plugins<span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token function">createLogger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<p><code>createLogger</code> 함수는 몇 가지 옵션을 가질 수 있습니다.</p>
<pre class="language-"><code class="lang-js"><span class="token keyword">const</span> logger <span class="token operator">=</span> <span class="token function">createLogger</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
collapsed<span class="token punctuation">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token comment" spellcheck="true">// 로그를 가지는 변이 자동 확장</span>
filter <span class="token punctuation">(</span>mutation<span class="token punctuation">,</span> stateBefore<span class="token punctuation">,</span> stateAfter<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// returns true if a mutation should be logged</span>
<span class="token comment" spellcheck="true">// `mutation` is a { type, payload }</span>
<span class="token keyword">return</span> mutation<span class="token punctuation">.</span>type <span class="token operator">!==</span> <span class="token string">"aBlacklistedMutation"</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
transformer <span class="token punctuation">(</span>state<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// 로깅하기전 상태를 변이 하십시오.</span>
<span class="token comment" spellcheck="true">// 예를 들어 특정 하위 트리만 반환합니다.</span>
<span class="token keyword">return</span> state<span class="token punctuation">.</span>subTree
<span class="token punctuation">}</span><span class="token punctuation">,</span>
mutationTransformer <span class="token punctuation">(</span>mutation<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment" spellcheck="true">// 변이는 { type, payload }의 포맷으로 기록됩니다.</span>
<span class="token comment" spellcheck="true">// 원하는 포맷으로 변경할 수 있습니다.</span>
<span class="token keyword">return</span> mutation<span class="token punctuation">.</span>type
<span class="token punctuation">}</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span>
</code></pre>
<p>로거 파일은<code><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>script</span><span class="token punctuation">></span></span></code>태그를 통해 직접 포함될 수 있으며 <code>createVuexLogger</code> 함수를 전역적으로 노출합니다.</p>
<p>로거 플러그인은 상태 스냅샷을 사용하므로 개발용으로만 사용하십시오.</p>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</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="structure.html" class="navigation navigation-prev " aria-label="Previous page: 애플리케이션 구조">
<i class="fa fa-angle-left"></i>
</a>
<a href="strict.html" class="navigation navigation-next " aria-label="Next page: Strict 모드">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"플러그인","level":"1.9","depth":1,"next":{"title":"Strict 모드","level":"1.10","depth":1,"path":"strict.md","ref":"strict.md","articles":[]},"previous":{"title":"애플리케이션 구조","level":"1.8","depth":1,"path":"structure.md","ref":"structure.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":"kr","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":"2.x.x"},"file":{"path":"plugins.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":"kr"}});
});
</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>