17. Progetto [vuejs-15]: Utilizzo del plugin [Vuex]

Il progetto [vuejs-15] si basa sul progetto [vuejs-14] utilizzando un oggetto [session] reattivo generato da [Vuex]. La struttura del progetto è la seguente:

17.1. Installazione della dipendenza [vuex]

17.2. Lo script [./session.js]

L'oggetto [session] diventa il seguente:


// plugin Vuex
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex);
 
// la session est un store Vuex
const session = new Vuex.Store({
  state: {
    // le tableau des simulations
    lignes: []
  },
  mutations: {
    // génération de la liste des simulations
    generateLignes(state) {
      // eslint-disable-next-line no-console
      console.log("mutation generateLignes");
      // on initialise [state.lignes]
      state.lignes =
        [
          { id: 3, marié: "oui", enfants: 2, salaire: 35000, impôt: 1200 },
          { id: 5, marié: "non", enfants: 2, salaire: 35000, impôt: 1900 },
          { id: 7, marié: "non", enfants: 0, salaire: 30000, impôt: 2000 }
        ];
      // eslint-disable-next-line no-console
      console.log(state.lignes);
    },
    // suppression ligne n° index
    deleteLigne(state, index) {
      // eslint-disable-next-line no-console
      console.log("mutation deleteLigne");
      // on supprime la ligne n° [index]
      state.lignes.splice(index, 1);
    }
  }
});
// export de l'objet [session]
export default session;

Commenti

righe 2-4: integriamo il plugin [Vuex] nel framework [Vue];
riga 7: la sessione diventa un oggetto [Vuex.Store];
righe 8–11: la proprietà [state] contiene lo stato condiviso dell'applicazione [Vue]. Questa proprietà sarà accessibile a tutti i componenti dell'applicazione. Qui condividiamo l'array delle simulazioni [lines] (riga 10);
righe 12–35: la proprietà [mutations] contiene i metodi che modificano il contenuto dell'oggetto [state];
righe 14–26: la proprietà [generateLines] è una funzione che genera un valore iniziale per la proprietà [state.lines]. Qui, accetta [state] come parametro. Righe 18–23: la proprietà [state.lines] viene inizializzata;
righe 28–35: la proprietà [deleteLine] è una funzione che rimuove una riga dall'array [state.lines]. I suoi parametri sono:
- [state], che rappresenta l'oggetto delle righe 8–11;
- [index], che è il numero della riga da eliminare;
le funzioni della proprietà [mutations] accettano sempre come primo parametro un oggetto che rappresenta la proprietà [state] della riga 8. I parametri seguenti sono forniti dal codice che chiama la mutazione;
riga 37: viene esportato l'oggetto [session].

A differenza del progetto precedente [vuejs-13], qui non avremo un plugin per rendere la sessione accessibile ai componenti tramite un attributo [Vue.$session].

17.3. Lo script principale [./main.js]

Lo script principale si evolve come segue:


// imports
import Vue from 'vue'
import App from './App.vue'
 
// plugins
import BootstrapVue from 'bootstrap-vue'
Vue.use(BootstrapVue);
 
// bootstrap
import 'bootstrap/dist/css/bootstrap.css'
import 'bootstrap-vue/dist/bootstrap-vue.css'
 
// session
import session from './session';
 
// configuration
Vue.config.productionTip = false
 
// instanciation projet [App]
new Vue({
  name: "app",
  // utilisation store de Vuex
  store: session,
  render: h => h(App),
}).$mount('#app')

Commenti

riga 14: viene importata la sessione;
riga 23: viene passata alla vista principale in un attributo denominato [store] (questo è obbligatorio). Grazie al plugin [Vuex], questo attributo diventa quindi disponibile per tutti i componenti nell'attributo [Vue.$store]. Ci troviamo quindi in una configurazione molto simile a quella del progetto precedente: dove in un componente accedevamo alla sessione tramite la notazione [this.$session], ora vi accederemo tramite la notazione [this.$store];

17.4. La vista principale [App]

La schermata principale dell'[App] cambia come segue:


<template>
  <div class="container">
    <b-card>
      <!-- message -->
      <b-alert show variant="success" align="center">
        <h4>[vuejs-14] : utilisation du plugin [Vuex]</h4>
      </b-alert>
      <!-- table HTML -->
      <Table />
    </b-card>
  </div>
</template>
 
<script>
import Table from "./components/Table";
export default {
  // nom
  name: "app",
  // composants
  components: {
    Table
  },
  // cycle de vie
  created() {
    // génération du tableau des simulations
    this.$store.commit("generateLignes");
  }
};
</script>

Commenti

riga 9: la vista [App] utilizza il componente [Table] ma non riceve più eventi da esso, grazie al fatto che lo store [Vuex] è reattivo;
Righe 24–27: il metodo [created] viene eseguito immediatamente dopo la creazione del componente [App]. All'interno di questo metodo viene chiamata la funzione [generateLines], che genera un valore iniziale per l'array delle simulazioni. Si noti la sintassi specifica dell'istruzione. Si ricordi che la notazione [this.$store] fa riferimento alla proprietà [store] della vista istanziata in [main.js]:


// instanciation vue [App]
new Vue({
  name: "app",
  // utilisation store de Vuex
  store: session,
  render: h => h(App),
}).$mount('#app')

La notazione [this.$store] si riferisce quindi all'oggetto [session]. Scriviamo quindi [this.$store.commit("generateLines")] per eseguire la mutazione denominata [generateLines]. Questa mutazione è una funzione;

17.5. Il componente [Table]

Il componente [Table] si evolve come segue:


<template>
  <div>
    <!-- empty list -->
    <template v-if="lignes.length==0">
      <b-alert show variant="warning">
        <h4>Votre liste de simulations est vide</h4>
      </b-alert>
      <!-- reload button-->
      <b-button variant="primary" @click="rechargerListe">Recharger la liste</b-button>
    </template>
    <!-- non-empty list-->
    <template v-if="lignes.length!=0">
      <b-alert show variant="primary" v-if="lignes.length==0">
        <h4>Liste de vos simulations</h4>
      </b-alert>
      <!-- simulation table -->
      <b-table striped hover responsive :items="lignes" :fields="fields">
        <template v-slot:cell(action)="row">
          <b-button variant="link" @click="supprimerLigne(row.index)">Supprimer</b-button>
        </template>
      </b-table>
    </template>
  </div>
</template>
 
<script>
export default {
  // état calculé
  computed: {
    lignes() {
      return this.$store.state.lignes;
    }
  },
  // état interne
  data() {
    return {
      fields: [
        { label: "#", key: "id" },
        { label: "Marié", key: "marié" },
        { label: "Nombre d'enfants", key: "enfants" },
        { label: "Salaire", key: "salaire" },
        { label: "Impôt", key: "impôt" },
        { label: "", key: "action" }
      ]
    };
  },
  // méthodes
  methods: {
    supprimerLigne(index) {
      // eslint-disable-next-line
      console.log("Table supprimerLigne", index);
      // on supprime la ligne
      this.$store.commit("deleteLigne", index);
    },
    // rechargement de la liste affichée
    rechargerListe() {
      // eslint-disable-next-line
      console.log("Table rechargerListe");
      // on régènère la liste des simulations
      this.$store.commit("generateLignes");
    }
  }
};
</script>

Commenti

il [template] per le righe 1–24 rimane invariato;
righe 30–32: la proprietà calcolata [lignes] ora utilizza lo [store] di [Vuex];
righe 49-54: per rimuovere una riga dalla tabella HTML, utilizziamo la mutazione [deleteLigne] dello [store] di [Vuex]. Passiamo il numero [index] della riga da rimuovere come parametro (riga 53);
righe 56–61: per ricaricare la tabella HTML con un nuovo elenco, utilizziamo la mutazione [generateLines] dello [store] di [Vuex];

17.6. Conclusione

Gli attributi [Vue.$session] nel progetto [vuejs-13] e gli attributi [Vue.$store] nel progetto [vuejs-15] sono molto simili. Hanno lo stesso scopo: condividere informazioni tra le viste. Il vantaggio dell'oggetto [store] è che è reattivo, mentre l'oggetto [session] non lo è. Tuttavia, il progetto [vuejs-14] ha dimostrato che è facile rendere reattivo l'oggetto [session] duplicandolo nelle proprietà reattive delle viste.