Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

vue-router creates always a new Component instance

I found an issue in vue-router which triggers me a lot. Always when I switch between my routes, a new instance of the component is created. Further the old instances are not deleted and are running in background!

I would expect that when I open a route, the old components will be destroyed or stop running.

Is there a workaround to fix that issue?

Here is a fiddle: https://jsfiddle.net/4xfa2f19/5885/

let foo = {
    template: '<div>Foo</div>',
    mounted() {
        console.log('Mount Foo with uid: ' + this._uid);
        setInterval(() => {console.log('Instance ' + this._uid + ' of Foo is running')}, 500);
    }
};

let bar = {
    template: '<div>Bar</div>',
    mounted() {
        console.log('Mount Bar with uid: ' + this._uid);
        setInterval(() => {console.log('Instance ' + this._uid + ' of Bar is running')}, 500);
    }
};


const router = new VueRouter({
    routes: [
        { path: '/user/foo', component: foo },
        { path: '/user/bar', component: bar }
    ]
});


const app = new Vue({ router }).$mount('#app');
like image 586
luggi Avatar asked Mar 22 '18 09:03

luggi


2 Answers

There are 2 ways to solve this problem:

Properly cleaning up in the destroy hook

If you use any outside event listeners, like setInterval, addEventListener, etc you also need to deregister them when your component gets destroyed, example:

{
    name: '...',
    template: '...',
    data() {
        return {
            interval: undefined,
            timeout: undefined
        };
    },
    mounted() {
        interval = setInterval(() => {console.log('Instance ' + this._uid + ' of myself is running')}, 500);
        timeout = setTimeout(() => {console.log('Instance ' + this._uid + ' of myself is running')}, 500);
        document.addEventListener('click', this.onOutsideClick);
    },
    beforeDestroy() {
        // Cleanup interval
        clearInterval(interval);
        // Cleanup any pending timeouts
        clearTimeout(timeout);
        // Cleanup any event listeners outside the root of the element
        document.removeEventListener('click', this.onOutsideClick);
    },
    methods: {
        onOutsideClick() {
            ...
        }
    }
}

Using keep-alive to keep the component alive

When using keepalive, Vue caches your component, and keeps it alive in the background, this means that only one instance will ever exists. This can potentially consume more memory if you have a large amount of routes

<keep-alive>
    <router-view></router-view>
</keep-alive>
like image 132
Ferrybig Avatar answered Sep 22 '22 09:09

Ferrybig


Always when I switch between my routes, a new instance of the component is created.

That's expected. you can keep instanes alive and re-use them with the <keep-alive> component, but that's usually not necessary and if so, requires special attention to re-initiate all local state of re-used components where necesseray.

Creating a fresh instance is much cleaner and therefore the default behaviour.

Further the old instances are not deleted and are running in background!

That's not expected. Previous instances are destroyed.

setInterval(() => {console.log('Instance ' + this._uid + ' of Foo is running')}, 500);

Well, since this intervall callback contains a reference to the component instance, it can't be garbage collected by the browser, So you are keeping them alive, not Vue.

Without that intervall, I woudl expect the instance to be garbage collected after the router destroyed them.

like image 39
Linus Borg Avatar answered Sep 23 '22 09:09

Linus Borg