Елегантні візерунки в сучасному JavaScript: Ice Factory

Я працюю з JavaScript і вмикаю його з кінця дев'яностих. Спочатку мені це не дуже сподобалось, але після введення ES2015 (він же ES6) я почав цінувати JavaScript як видатну, динамічну мову програмування з величезною виразною силою.

З часом я прийняв кілька моделей кодування, які призвели до більш чистого, більш перевіряемого, виразнішого коду. Зараз я ділюся з вами цими зразками.

Про перший зразок - “RORO” - я писав у статті нижче. Не хвилюйтеся, якщо ви не читали його, ви можете прочитати їх у будь-якому порядку.

Елегантні візерунки в сучасному JavaScript: RORO

Я написав свої перші рядки JavaScript незабаром після винайдення мови. Якби ви тоді сказали мені, що я ... medium.freecodecamp.org

Сьогодні я хотів би познайомити вас із зразком «Фабрика льоду».

Фабрика льоду - це лише функція, яка створює та повертає заморожений об'єкт . Ми розпакуємо це твердження за мить, але спочатку давайте дослідимо, чому цей шаблон такий потужний.

Класи JavaScript не такі стильні

Часто має сенс згрупувати пов'язані функції в один об'єкт. Наприклад, у програмі електронної комерції ми можемо мати cartоб’єкт, який виставляє addProductфункцію та removeProductфункцію. Потім ми могли б викликати ці функції за допомогою cart.addProduct()та cart.removeProduct().

Якщо ви походите з орієнтованої на клас, об’єктно-орієнтованої мови програмування, як Java або C #, це, мабуть, відчувається цілком природно.

Якщо ви новачок у програмуванні - тепер ви бачите твердження типу cart.addProduct(). Я підозрюю, що ідея групувати функції під одним об’єктом виглядає досить добре.

То як би ми створили цей приємний маленький cartпредмет? Вашим першим інстинктом сучасного JavaScript може бути використання class. Щось на зразок:

// 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})
Примітка : dbДля простоти я використовую масив як параметр. У реальному коді це буде щось на зразок Моделі чи Репо, що взаємодіє з фактичною базою даних.

На жаль - хоча це виглядає приємно - класи в JavaScript поводяться зовсім інакше, ніж можна очікувати.

Класи JavaScript вас вкусять, якщо ви не будете обережні.

Наприклад, об’єкти, створені за допомогою newключового слова, можна змінювати. Отже, ви можете фактично перепризначити метод:

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?

Навіть гірше, об’єкти, створені за допомогою newключового слова, успадковують prototypeте, classщо було використано для їх створення. Отже, зміни до класу ' prototypeвпливають на всі об’єкти, створені з цього class- навіть якщо зміни вносяться після створення об’єкта!

Подивись на це:

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!"

Тоді є той факт, що thisв JavaScript динамічно пов'язані. Отже, якщо ми передамо методи нашого cartоб’єкта, ми можемо втратити посилання на this. Це дуже інтуїтивно зрозуміло, і це може спричинити нам багато неприємностей.

Загальна пастка - це присвоєння методу екземпляра обробнику подій.

Розглянемо наш cart.emptyметод.

empty () { this.db = [] }

Якщо ми призначимо цей метод безпосередньо clickподії кнопки на нашій веб-сторінці ...

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

… Коли користувачі клацають порожнім button, їхні дані cartзалишатимуться повними.

Це не вдається мовчки, тому що thisтепер буде посилатися на buttonзамість cart. Отже, наш cart.emptyметод закінчується присвоєнням нового властивості нашому buttonвикликаному dbта встановленням цього властивості []замість того, щоб впливати на cartоб’єкт db.

Це така помилка, яка зведе вас з розуму, оскільки в консолі немає помилок, і ваш здоровий глузд підкаже, що це має працювати, але це не так.

Щоб це працювало, нам потрібно зробити:

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

Або:

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

Я думаю, що Маттіас Петтер Йоханссон сказав це найкраще:

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.

Але замість того, щоб розширювати наші об’єкти шляхом успадкування Списку товарів, ми можемо замість цього застосувати позачасовий принцип, запропонований в одній з найвпливовіших книг програмування, коли-небудь написаних:

"Надавайте перевагу композиції об'єкта перед успадкуванням класу."

- Шаблони дизайну: Елементи багаторазового об'єктно-орієнтованого програмного забезпечення.

Фактично, автори цієї книги - у розмовній формі "Банда чотирьох" - продовжують говорити:

"... наш досвід полягає в тому, що дизайнери зловживають спадкоємством як технікою повторного використання, і дизайни часто робляться більш багаторазовими (і простішими), залежачи більше від композиції об'єкта".

Отже, ось наш список продуктів:

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

І ось наш кошик для покупок:

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

І тепер ми можемо просто ввести наш Список продуктів у наш кошик, наприклад:

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

І скористайтеся списком товарів через властивість `items`. Люблю:

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.

If you’ve found this article useful, please smash that applause icon a bunch of times to help spread the word. And if you want to learn more stuff like this, please sign up for my Dev Mastery newsletter below. Thanks!

UPDATE 2019: Here’s a video where I use this pattern, a lot!