CODEWITHSUNDEEP
javascriptcircular-reference
Knorcedger
Knorcedger

Reputation: 263

Is circular reference between objects a bad practice?

I have a Model that will "carry" (Model.validator) a validator instance with it, and I need the Validator to have access to the Model's attributes. So, what I have come up with is the following

var Validator = function(model) {
    this.model = model;
};

var Model = function() {
    this._attributes = {};
    this.validator = new Validator(this);
};

var model = new Model();

This code creates a circular reference between those 2 objects. Is this a bad practice that will cause memory leaks? Any other ideas on how to implement it?

P.S. I have seen such circular references between objects in Angular.js scopes.

Upvotes: 26

Views: 5251

Answers (3)

Jon
Jon

Reputation: 437454

This kind of code will not cause memory leaks with today's browsers; as mentioned on MDN all major browsers have been shipping with mark-and-sweep GCs (that can handle cycles just fine) for some time now (e.g. Firefox itself has had a cycle collector since version 3).

From an architectural standpoint, this kind of code introduces moderately tight coupling between the two objects (if one changes in even a minor way, the other needs to be reviewed to determine if it needs to change as well) and should consequently be avoided if possible. But there is nothing inherently wrong with it.

Upvotes: 23

Willem Mulder
Willem Mulder

Reputation: 13994

It will not be a problem for garbage collection: any new Garbage Collector (>IE6) will handle circular references just fine!

It might be a problem though if you are doing recursive functions, or printing the object.

So the answer is: it is no problem unless you screw up yourselves :-)

Upvotes: 4

Sergey Metlov
Sergey Metlov

Reputation: 26301

There will not be any problems I'm sure. The most browsers' JS parsers can work with cycle dependecnies while garbage collecting. No more potential issues here.

Upvotes: 3

Related Questions