4 шаблони дизайну, які ви повинні знати для веб-розробки: спостерігач, синглтон, стратегія та декоратор

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

Існує стільки різних мов програмування, архітектур та інших проблем, що буває важко зрозуміти, з чого почати. Ось тут і з’являються шаблони дизайну.

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

І ви та ваша команда вирішуєте, який набір найкращих практик є найбільш корисним для вашого проекту. Виходячи з обраного вами шаблону дизайну, ви всі почнете сподіватися на те, що повинен робити код і який словник ви всі будете використовувати.

Шаблони проектування програмування можуть бути використані на всіх мовах програмування та можуть бути використані для відповідності будь-якому проекту, оскільки вони дають лише загальний контур рішення.

Існує 23 офіційні зразки з книги « Шаблони дизайну - елементи багаторазового об’єктно-орієнтованого програмного забезпечення» , яка вважається однією з найвпливовіших книг з об’єктно-орієнтованої теорії та розробки програмного забезпечення.

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

Шаблон дизайну Сінглтон

Шаблон одного елемента дозволяє лише класу або об'єкту мати один екземпляр, і він використовує глобальну змінну для зберігання цього екземпляра. Ви можете використовувати ліниве завантаження, щоб переконатися, що існує лише один екземпляр класу, оскільки він створить клас лише тоді, коли вам це потрібно.

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

Прикладом синглтона, яким ви, мабуть, постійно користуєтесь, є ваш реєстратор.

Якщо ви працюєте з деякими інтерфейсними фреймворками, такими як React або Angular, ви знаєте все про те, наскільки складним може бути обробка журналів, що надходять з декількох компонентів. Це чудовий приклад одиночних дій, оскільки ви ніколи не хочете більше одного екземпляра об'єкта реєстратора, особливо якщо ви використовуєте якийсь інструмент відстеження помилок.

class FoodLogger { constructor() { this.foodLog = [] } log(order) { this.foodLog.push(order.foodItem) // do fancy code to send this log somewhere } } // this is the singleton class FoodLoggerSingleton { constructor() { if (!FoodLoggerSingleton.instance) { FoodLoggerSingleton.instance = new FoodLogger() } } getFoodLoggerInstance() { return FoodLoggerSingleton.instance } } module.exports = FoodLoggerSingleton

Тепер вам не доведеться турбуватися про втрату журналів з декількох екземплярів, оскільки у вашому проекті є лише один. Отже, коли ви хочете реєструвати замовлене харчування, ви можете використовувати один і той же екземпляр FoodLogger у декількох файлах або компонентах.

const FoodLogger = require('./FoodLogger') const foodLogger = new FoodLogger().getFoodLoggerInstance() class Customer { constructor(order) { this.price = order.price this.food = order.foodItem foodLogger.log(order) } // other cool stuff happening for the customer } module.exports = Customer
const FoodLogger = require('./FoodLogger') const foodLogger = new FoodLogger().getFoodLoggerInstance() class Restaurant { constructor(inventory) { this.quantity = inventory.count this.food = inventory.foodItem foodLogger.log(inventory) } // other cool stuff happening at the restaurant } module.exports = Restaurant

З цим одиночним шаблоном на місці вам не доведеться турбуватися про те, щоб просто отримати журнали з основного файлу програми. Ви можете отримати їх з будь-якої точки бази коду, і всі вони перейдуть до того самого екземпляра реєстратора, що означає, що жоден з ваших журналів не повинен загубитися через нові екземпляри.

Шаблон дизайну стратегії

Ця стратегія є схожою на вдосконалену версію оператора if else. В основному це те, де ви робите інтерфейс для методу, який є у вас у базовому класі. Потім цей інтерфейс використовується для пошуку правильної реалізації того методу, який слід використовувати у похідному класі. У цьому випадку впровадження буде вирішуватися під час виконання на основі клієнта.

Цей шаблон надзвичайно корисний у ситуаціях, коли вам потрібні та необов’язкові методи для занять. Деякі екземпляри цього класу не потребуватимуть додаткових методів, і це спричиняє проблему для рішень для успадкування. Ви можете використовувати інтерфейси для необов’язкових методів, але тоді вам доведеться писати реалізацію кожного разу, коли ви використовуєте цей клас, оскільки реалізації за замовчуванням не буде.

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

У вас може бути кошик для покупок, який дозволяє клієнтам лише оплатити свої кредитні картки, але ви втратите клієнтів, які хочуть використовувати інші способи оплати.

Шаблон розробки стратегії дозволяє нам відокремити способи оплати від процесу оформлення замовлення, що означає, що ми можемо додавати або оновлювати стратегії, не змінюючи жодного коду в кошику покупок або в процесі оформлення замовлення.

Ось приклад реалізації шаблону стратегії на прикладі методу оплати.

class PaymentMethodStrategy { const customerInfoType = { country: string emailAddress: string name: string accountNumber?: number address?: string cardNumber?: number city?: string routingNumber?: number state?: string } static BankAccount(customerInfo: customerInfoType) { const { name, accountNumber, routingNumber } = customerInfo // do stuff to get payment } static BitCoin(customerInfo: customerInfoType) { const { emailAddress, accountNumber } = customerInfo // do stuff to get payment } static CreditCard(customerInfo: customerInfoType) { const { name, cardNumber, emailAddress } = customerInfo // do stuff to get payment } static MailIn(customerInfo: customerInfoType) { const { name, address, city, state, country } = customerInfo // do stuff to get payment } static PayPal(customerInfo: customerInfoType) { const { emailAddress } = customerInfo // do stuff to get payment } }

Для реалізації нашої стратегії способу оплати ми створили єдиний клас із декількома статичними методами. Кожен метод приймає однаковий параметр customerInfo , і цей параметр має визначений тип customerInfoType . (Привіт всім розробникам TypeScript! ??) Зверніть увагу, що кожен метод має свою реалізацію і використовує різні значення від customerInfo .

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

Ви також можете встановити реалізацію за замовчуванням у простому файлі config.json таким чином:

{ "paymentMethod": { "strategy": "PayPal" } }

Щоразу, коли клієнт починає проходити процедуру оформлення замовлення на вашому веб-сайті, методом оплати за замовчуванням, з яким вони стикаються, буде реалізація PayPal, яка надходить із config.json . Це може бути легко оновлено, якщо клієнт вибере інший спосіб оплати.

Тепер ми створимо файл для нашого процесу оформлення замовлення.

const PaymentMethodStrategy = require('./PaymentMethodStrategy') const config = require('./config') class Checkout { constructor(strategy='CreditCard') { this.strategy = PaymentMethodStrategy[strategy] } // do some fancy code here and get user input and payment method changeStrategy(newStrategy) { this.strategy = PaymentMethodStrategy[newStrategy] } const userInput = { name: 'Malcolm', cardNumber: 3910000034581941, emailAddress: '[email protected]', country: 'US' } const selectedStrategy = 'Bitcoin' changeStrategy(selectedStrategy) postPayment(userInput) { this.strategy(userInput) } } module.exports = new Checkout(config.paymentMethod.strategy)

Цей клас Checkout - це місце, де шаблон стратегії демонструється. Ми імпортуємо пару файлів, щоб мати доступні стратегії способу оплати та стратегію за замовчуванням із конфігурації .

Потім ми створюємо клас із конструктором та резервним значенням для стратегії за замовчуванням, якщо в конфігурі не було встановленого . Далі ми призначаємо значення стратегії локальній змінній стану.

Важливим методом, який нам потрібно застосувати у нашому класі Checkout, є можливість зміни стратегії оплати. Клієнт може змінити спосіб оплати, який він хоче використовувати, і ви повинні мати змогу впоратися з цим. Саме для цього призначений метод changeStrategy .

After you've done some fancy coding and gotten all of the inputs from a customer, then you can update the payment strategy immediately based on their input and it dynamically sets the strategy before the payment is sent for processing.

At some point you might need to add more payment methods to your shopping cart and all you'll have to do is add it to the PaymentMethodStrategy class. It'll instantly be available anywhere that class is used.

The strategy design pattern is a powerful one when you are dealing with methods that have multiple implementations. It might feel like you're using an interface, but you don't have to write an implementation for the method every time you call it in a different class. It gives you more flexibility than interfaces.

The Observer Design Pattern

If you've ever used the MVC pattern, you've already used the observer design pattern. The Model part is like a subject and the View part is like an observer of that subject. Your subject holds all of the data and the state of that data. Then you have observers, like different components, that will get that data from the subject when the data has been updated.

The goal of the observer design pattern is to create this one-to-many relationship between the subject and all of the observers waiting for data so they can be updated. So anytime the state of the subject changes, all of the observers will be notified and updated instantly.

Some examples of when you would use this pattern include: sending user notifications, updating, filters, and handling subscribers.

Say you have a single page application that has three feature dropdown lists that are dependent on the selection of a category from a higher level dropdown. This is common on many shopping sites, like Home Depot. You have a bunch of filters on the page that are dependent on the value of a top-level filter.

The code for the top-level dropdown might look something like this:

class CategoryDropdown { constructor() { this.categories = ['appliances', 'doors', 'tools'] this.subscriber = [] } // pretend there's some fancy code here subscribe(observer) { this.subscriber.push(observer) } onChange(selectedCategory) { this.subscriber.forEach(observer => observer.update(selectedCategory)) } }

This CategoryDropdown file is a simple class with a constructor that initializes the category options we have available for in the dropdown. This is the file you would handle retrieving a list from the back-end or any kind of sorting you want to do before the user sees the options.

The subscribe method is how each filter created with this class will receive updates about the state of the observer.

The onChange method is how we send out notification to all of the subscribers that a state change has happened in the observer they're watching. We just loop through all of the subscribers and call their update method with the selectedCategory.

The code for the other filters might look something like this:

class FilterDropdown { constructor(filterType) { this.filterType = filterType this.items = [] } // more fancy code here; maybe make that API call to get items list based on filterType update(category) { fetch('//example.com') .then(res => this.items(res)) } }

This FilterDropdown file is another simple class that represents all of the potential dropdowns we might use on a page. When a new instance of this class is created, it needs to be passed a filterType. This could be used to make specific API calls to get the list of items.

The update method is an implementation of what you can do with the new category once it has been sent from the observer.

Now we'll take a look at what it means to use these files with the observer pattern:

const CategoryDropdown = require('./CategoryDropdown') const FilterDropdown = require('./FilterDropdown') const categoryDropdown = new CategoryDropdown() const colorsDropdown = new FilterDropdown('colors') const priceDropdown = new FilterDropdown('price') const brandDropdown = new FilterDropdown('brand') categoryDropdown.subscribe(colorsDropdown) categoryDropdown.subscribe(priceDropdown) categoryDropdown.subscribe(brandDropdown)

What this file shows us is that we have 3 drop-downs that are subscribers to the category drop-down observable. Then we subscribe each of those drop-downs to the observer. Whenever the category of the observer is updated, it will send out the value to every subscriber which will update the individual drop-down lists instantly.

The Decorator Design Pattern

Using the decorator design pattern is fairly simple. You can have a base class with methods and properties that are present when you make a new object with the class. Now say you have some instances of the class that need methods or properties that didn't come from the base class.

You can add those extra methods and properties to the base class, but that could mess up your other instances. You could even make sub-classes to hold specific methods and properties you need that you can't put in your base class.

Either of those approaches will solve your problem, but they are clunky and inefficient. That's where the decorator pattern steps in. Instead of making your code base ugly just to add a few things to an object instance, you can tack on those specific things directly to the instance.

So if you need to add a new property that holds the price for an object, you can use the decorator pattern to add it directly to that particular object instance and it won't affect any other instances of that class object.

Have you ever ordered food online? Then you've probably encountered the decorator pattern. If you're getting a sandwich and you want to add special toppings, the website isn't adding those toppings to every instance of sandwich current users are trying to order.

Here's an example of a customer class:

class Customer { constructor(balance=20) { this.balance = balance this.foodItems = [] } buy(food) { if (food.price) < this.balance { console.log('you should get it') this.balance -= food.price this.foodItems.push(food) } else { console.log('maybe you should get something else') } } } module.exports = Customer

And here's an example of a sandwich class:

class Sandwich { constructor(type, price) { this.type = type this.price = price } order() { console.log(`You ordered a ${this.type} sandwich for $ ${this.price}.`) } } class DeluxeSandwich { constructor(baseSandwich) { this.type = `Deluxe ${baseSandwich.type}` this.price = baseSandwich.price + 1.75 } } class ExquisiteSandwich { constructor(baseSandwich) { this.type = `Exquisite ${baseSandwich.type}` this.price = baseSandwich.price + 10.75 } order() { console.log(`You ordered an ${this.type} sandwich. It's got everything you need to be happy for days.`) } } module.exports = { Sandwich, DeluxeSandwich, ExquisiteSandwich }

This sandwich class is where the decorator pattern is used. We have a Sandwich base class that sets the rules for what happens when a regular sandwich is ordered. Customers might want to upgrade sandwiches and that just means an ingredient and price change.

You just wanted to add the functionality to increase the price and update the type of sandwich for the DeluxeSandwich without changing how it's ordered. Although you might need a different order method for an ExquisiteSandwich because there is a drastic change in the quality of ingredients.

The decorator pattern lets you dynamically change the base class without affecting it or any other classes. You don't have to worry about implementing functions you don't know, like with interfaces, and you don't have to include properties you won't use in every class.

Now if we'll go over an example where this class is instantiated as if a customer was placing a sandwich order.

const { Sandwich, DeluxeSandwich, ExquisiteSandwich } = require('./Sandwich') const Customer = require('./Customer') const cust1 = new Customer(57) const turkeySandwich = new Sandwich('Turkey', 6.49) const bltSandwich = new Sandwich('BLT', 7.55) const deluxeBltSandwich = new DeluxeSandwich(bltSandwich) const exquisiteTurkeySandwich = new ExquisiteSandwich(turkeySandwich) cust1.buy(turkeySandwich) cust1.buy(bltSandwich)

Final Thoughts

I used to think that design patterns were these crazy, far-out software development guidelines. Then I found out I use them all the time!

A few of the patterns I covered are used in so many applications that it would blow your mind. They are just theory at the end of the day. It's up to us as developers to use that theory in ways that make our applications easy to implement and maintain.

Have you used any of the other design patterns for your projects? Most places usually pick a design pattern for their projects and stick with it so I'd like to hear from you all about what you use.

Thanks for reading. You should follow me on Twitter because I usually post useful/entertaining stuff: @FlippedCoding