Elegante mønstre i moderne JavaScript: Ice Factory

Jeg har jobbet med JavaScript på og av siden slutten av nittitallet. Jeg likte det egentlig ikke først, men etter introduksjonen av ES2015 (aka ES6) begynte jeg å sette pris på JavaScript som et enestående, dynamisk programmeringsspråk med enorm, uttrykksfull kraft.

Over tid har jeg tatt i bruk flere kodemønstre som har ført til renere, mer testbar, mer ekspressiv kode. Nå deler jeg disse mønstrene med deg.

Jeg skrev om det første mønsteret - “RORO” - i artikkelen nedenfor. Ikke bekymre deg hvis du ikke har lest den, du kan lese disse i hvilken som helst rekkefølge.

Elegante mønstre i moderne JavaScript: RORO

Jeg skrev de første linjene mine med JavaScript ikke lenge etter at språket ble oppfunnet. Hvis du fortalte meg den gangen at jeg ... medium.freecodecamp.org

I dag vil jeg introdusere deg for “Ice Factory” -mønsteret.

En isfabrikk er bare en funksjon som lager og returnerer et frossent objekt . Vi pakker ut dette utsagnet om et øyeblikk, men la oss først undersøke hvorfor dette mønsteret er så kraftig.

JavaScript-klasser er ikke så stilige

Det er ofte fornuftig å gruppere relaterte funksjoner i et enkelt objekt. I en e-handelsapp kan vi for eksempel ha et cartobjekt som avslører en addProductfunksjon og en removeProductfunksjon. Vi kunne da påkalle disse funksjonene med cart.addProduct()og cart.removeProduct().

Hvis du kommer fra et klassesentrisk, objektorientert programmeringsspråk som Java eller C #, føles dette sannsynligvis ganske naturlig.

Hvis du er ny innen programmering - nå som du har sett en uttalelse som cart.addProduct(). Jeg mistenker at ideen om å gruppere funksjoner under et enkelt objekt ser ganske bra ut.

Så hvordan skulle vi lage dette fine lille cartobjektet? Det første instinktet ditt med moderne JavaScript kan være å bruke en class. Noe som:

// ShoppingCart.js
export default class ShoppingCart { constructor({db}) { this.db = db } addProduct (product) { this.db.push(product) } empty () { this.db = [] }
 get products () { return Object .freeze([...this.db]) }
 removeProduct (id) { // remove a product }
 // other methods
}
// someOtherModule.js
const db = [] const cart = new ShoppingCart({db})cart.addProduct({ name: 'foo', price: 9.99})
Merk : Jeg bruker en matrise for dbparameteren for enkelhets skyld. I ekte kode vil dette være noe som en modell eller repo som samhandler med en faktisk database.

Dessverre - selv om dette ser bra ut - oppfører klasser i JavaScript seg ganske annerledes enn hva du forventer.

JavaScript-klasser vil bite deg hvis du ikke er forsiktig.

For eksempel er objekter som er opprettet ved hjelp av newnøkkelordet, foranderlige. Så du kan faktisk tildele en metode på nytt:

const db = []const cart = new ShoppingCart({db})
cart.addProduct = () => 'nope!' // No Error on the line above!
cart.addProduct({ name: 'foo', price: 9.99}) // output: "nope!" FTW?

Enda verre, objekter opprettet ved hjelp av newnøkkelordet arver prototypedet classsom ble brukt til å lage dem. Så, endringer i en klasse prototypepåvirker alle objekter opprettet av det class- selv om en endring blir gjort etter at objektet ble opprettet!

Se på dette:

const cart = new ShoppingCart({db: []})const other = new ShoppingCart({db: []})
ShoppingCart.prototype .addProduct = () => ‘nope!’// No Error on the line above!
cart.addProduct({ name: 'foo', price: 9.99}) // output: "nope!"
other.addProduct({ name: 'bar', price: 8.88}) // output: "nope!"

Så er det det faktum at thisIn JavaScript er dynamisk bundet. Så hvis vi går rundt metodene til cartobjektet vårt , kan vi miste referansen til this. Det er veldig kontraintuitivt, og det kan gi oss mange problemer.

En vanlig felle er å tildele en forekomstmetode til en hendelsesbehandler.

Tenk på cart.emptymetoden vår .

empty () { this.db = [] }

Hvis vi tilordner denne metoden direkte til clickhendelsen til en knapp på websiden vår ...

 Empty cart
---
document .querySelector('#empty') .addEventListener( 'click', cart.empty )

... når brukerne klikker på det tomme button, cartvil de forbli fulle.

Det mislykkes stille fordi thisvil nå referere til buttonstedet for cart. Så, cart.emptymetoden vår ender opp med å tildele en ny eiendom til vår buttonringte dbog sette den egenskapen til i []stedet for å påvirke cartobjektets db.

Dette er den typen feil som vil gjøre deg gal fordi det ikke er noen feil i konsollen, og sunn fornuft vil fortelle deg at det skal fungere, men det gjør det ikke.

For å få det til å fungere må vi gjøre:

document .querySelector("#empty") .addEventListener( "click", () => cart.empty() )

Eller:

document .querySelector("#empty") .addEventListener( "click", cart.empty.bind(cart) )

Jeg tror Mattias Petter Johansson sa det best:

new and this [in JavaScript] are some kind of unintuitive, weird, cloud rainbow trap.”

Ice Factory to the rescue

As I said earlier, an Ice Factory is just a function that creates and returns a frozen object. With an Ice Factory our shopping cart example looks like this:

// makeShoppingCart.js
export default function makeShoppingCart({ db}) { return Object.freeze({ addProduct, empty, getProducts, removeProduct, // others })
 function addProduct (product) { db.push(product) } function empty () { db = [] }
 function getProducts () { return Object .freeze([...db]) }
 function removeProduct (id) { // remove a product }
 // other functions}
// someOtherModule.js
const db = []const cart = makeShoppingCart({ db })cart.addProduct({ name: 'foo', price: 9.99})

Notice our “weird, cloud rainbow traps” are gone:

  • We no longer need new.

    We just invoke a plain old JavaScript function to create our cart object.

  • We no longer need this.

    We can access the db object directly from our member functions.

  • Our cart object is completely immutable.

    Object.freeze() freezes the cart object so that new properties can’t be added to it, existing properties can’t be removed or changed, and the prototype can’t be changed either. Just remember that Object.freeze() is shallow, so if the object we return contains an array or another object we must make sure to Object.freeze() them as well. Also, if you’re using a frozen object outside of an ES Module, you need to be in strict mode to make sure that re-assignments cause an error rather than just failing silently.

A little privacy please

Another advantage of Ice Factories is that they can have private members. For example:

function makeThing(spec) { const secret = 'shhh!'
 return Object.freeze({ doStuff })
 function doStuff () { // We can use both spec // and secret in here }}
// secret is not accessible out here
const thing = makeThing()thing.secret // undefined

This is made possible because of Closures in JavaScript, which you can read more about on MDN.

A little acknowledgement please

Although Factory Functions have been around JavaScript forever, the Ice Factory pattern was heavily inspired by some code that Douglas Crockford showed in this video.

Here’s Crockford demonstrating object creation with a function he calls “constructor”:

My Ice Factory version of the Crockford example above would look like this:

function makeSomething({ member }) { const { other } = makeSomethingElse() return Object.freeze({ other, method }) 
 function method () { // code that uses "member" }}

I took advantage of function hoisting to put my return statement near the top, so that readers would have a nice little summary of what’s going on before diving into the details.

I also used destructuring on the spec parameter. And I renamed the pattern to “Ice Factory” so that it’s more memorable and less easily confused with the constructor function from a JavaScript class. But it’s basically the same thing.

So, credit where credit is due, thank you Mr. Crockford.

Note: It’s probably worth mentioning that Crockford considers function “hoisting” a “bad part” of JavaScript and would likely consider my version heresy. I discussed my feelings on this in a previous article and more specifically, this comment.

What about inheritance?

If we tick along building out our little e-commerce app, we might soon realize that the concept of adding and removing products keeps cropping up again and again all over the place.

Along with our Shopping Cart, we probably have a Catalog object and an Order object. And all of these probably expose some version of `addProduct` and `removeProduct`.

We know that duplication is bad, so we’ll eventually be tempted to create something like a Product List object that our cart, catalog, and order can all inherit from.

Men i stedet for å utvide objektene våre ved å arve en produktliste, kan vi i stedet vedta det tidløse prinsippet som tilbys i en av de mest innflytelsesrike programmeringsbøkene som noensinne er skrevet:

"Favoriser objektsammensetning fremfor klassearv."

- Designmønstre: Elementer av gjenbrukbar objektorientert programvare.

Faktisk fortsetter forfatterne av den boken - i folkemunne kjent som "The Gang of Four":

"... vår erfaring er at designere overforbruk arv som en gjenbruksteknikk, og design blir ofte gjort mer gjenbrukbare (og enklere) ved å avhenge mer av objektsammensetningen."

Så her er produktlisten vår:

function makeProductList({ productDb }) { return Object.freeze({ addProduct, empty, getProducts, removeProduct, // others )} // definitions for // addProduct, etc…}

Og her er handlekurven vår:

function makeShoppingCart(productList) { return Object.freeze({ items: productList, someCartSpecificMethod, // …)}
function someCartSpecificMethod () { // code }}

Og nå kan vi bare injisere produktlisten vår i handlekurven, slik:

const productDb = []const productList = makeProductList({ productDb })
const cart = makeShoppingCart(productList)

Og bruk produktlisten via "items" -egenskapen. Som:

cart.items.addProduct()

It may be tempting to subsume the entire Product List by incorporating its methods directly into the shopping cart object, like so:

function makeShoppingCart({ addProduct, empty, getProducts, removeProduct, …others}) { return Object.freeze({ addProduct, empty, getProducts, removeProduct, someOtherMethod, …others)}
function someOtherMethod () { // code }}

In fact, in an earlier version of this article, I did just that. But then it was pointed out to me that this is a bit dangerous (as explained here). So, we’re better off sticking with proper object composition.

Awesome. I’m Sold!

Whenever we’re learning something new, especially something as complex as software architecture and design, we tend to want hard and fast rules. We want to hear thing like “always do this” and “ never do that.”

The longer I spend working with this stuff, the more I realize that there’s no such thing as always and never. It’s about choices and trade-offs.

Making objects with an Ice Factory is slower and takes up more memory than using a class.

In the types of use case I’ve described, this won’t matter. Even though they are slower than classes, Ice Factories are still quite fast.

If you find yourself needing to create hundreds of thousands of objects in one shot, or if you’re in a situation where memory and processing power is at an extreme premium you might need a class instead.

Just remember, profile your app first and don’t prematurely optimize. Most of the time, object creation is not going to be the bottleneck.

Despite my earlier rant, Classes are not always terrible. You shouldn’t throw out a framework or library just because it uses classes. In fact, Dan Abramov wrote pretty eloquently about this in his article, How to use Classes and Sleep at Night.

Finally, I need to acknowledge that I’ve made a bunch of opinionated style choices in the code samples I’ve presented to you:

  • I use function statements instead of function expressions.
  • I put my return statement near the top (this is made possible by my use of function statements, see above).
  • I name my factory function, makeX instead of createX or buildX or something else.
  • My factory function takes a single, destructured, parameter object.
  • I don’t use semi-colons (Crockford would also NOT approve of that)
  • and so on…

You may make different style choices, and that’s okay! The style is not the pattern.

The Ice Factory pattern is just: use a function to create and return a frozen object. Exactly how you write that function is up to you.

Hvis du har funnet denne artikkelen nyttig, kan du knuse applausikonet en rekke ganger for å spre ordet. Og hvis du vil lære flere ting som dette, kan du registrere deg for mitt nyhetsbrev for Dev Mastery nedenfor. Takk!

OPPDATERING 2019: Her er en video der jeg bruker dette mønsteret, mye!