Англійська для розробників Fastify

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

Ключовий словник

** Додаток (додаток прискорення) ** Інкапсулюваний об’ єкт функціональності — маршрути, декоратори, гачки — зареєстрований у екземплярі Fastify, з власною сферою дії, яка не протікає до додатків- сестер, якщо вони не є спільними.

• Приклад: « Ми закріпили логіку автентифікації у власному додатку, щоб вона залишалася інкапсульованою і не випадково не реєструвала маршрути, видимі для не пов’ язаних частин програми. » *

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

• Приклад: « Цей декоратор не видимий поза його додатком через інкапсуляцію — якщо нам потрібен глобально, нам потрібно зареєструвати його у кореневому екземплярі замість цього. » *

** Схема (перевірка схеми JSON) ** Визначення схеми JSON, що прив’ язано до маршруту, який Fastify використовує для перевірки вхідних запитів і послідовного перетворення вихідних відповідей, як для перевірки правильності, так і для швидкодії. Приклад: «Додання схеми відповіді тут не лише про перевірку — Fastify використовує її для створення набагато швидшого серіалізатора для тіла відповіді.»

** Гачок (гачок життєвого циклу) ** Функція, яка виконується в певній точці життєвого циклу запит/відповідь, наприклад onRequest або preHandler, використовується для перетинаючих проблем, таких як автентифікація або ведення журналу. Приклад: «Ми перевіряємо токен аутентифікації в гачку preHandler, тому кожен маршрут під цим додатком отримує перевірку без повторення логіки.»

Декоратор Спосіб додавання нетипових властивостей або методів до об’ єктів запитів, відповідей або екземплярів сервера Fastify, що робить спільні інструменти доступними без їхнього окремого імпортування у кожний обробник. Приклад: “Ми прикрасили об’єкт запиту властивістю currentUser, встановленою в попередньому гачку, тому обробники можуть просто читати request.currentUser безпосередньо.”

** Серіалізація ** Процес перетворення об’ єкта JavaScript у рядок JSON для відповіді, який Fastify може значно прискорити за допомогою компіляції серіалізатора зі схеми відповіді маршруту. Приклад: «Вік серіалізації значно знизився після того, як ми додали явні схеми відповідей — Fastify може пропустити багато загальних JSON.stringify таким чином.»

** Пропускна здатність ** Кількість запитів, які сервер може обробляти за одиницю часу, часто первинна метрика, яку вказують при порівнянні продуктивності Fastify з іншими фреймворками Node.js.

• Приклад: « Ми побачили значне поліпшення пропускної здатності після міграції цієї служби, переважно від серіалізації на основі схеми, а не змін маршрутизації. » *

Звичайні фрази

** В обзорах коду: **

• «Цей маршрут не має схеми відповіді, тому ми пропускаємо прискорення серіалізації і втрачаємо шар перевірки виводу.»
• «Цей декоратор реєструється на кореневому екземплярі, але він використовується тільки одним плагіном — чи повинні ми обмежити його, щоб інкапсуляція насправді захищає нас тут?»
• «Ми дублюємо цю перевірку автентичності в кожному обробнику під цим плагіном — давайте перенесемо її в спільний preHandler гачок замість цього»

В стоячих позах:

• «Вчора я додав схеми відповіді до наших найбільш завантажених маршрутів; сьогодні я випробовую прискорення серіалізації, перш ніж ми розгорнемо її далі»
• «Я заблокований на проблемі інкапсуляції плагіна — декоратор, який мені потрібен, не видимий з сестренного плагіна, тому мені потрібно зареєструвати його вище в дереві»
• «Я закінчив перенесення нашої аутентифікації в preHandler-гачок, який вилучив близько десятка дублюючих блоків через маршрутні обробники»

** У обговореннях архітектури: **

• Модель інкапсуляції плагінів Fastify добре відображає межі модулів нашого сервісу, тому маршрути кожної команди залишаються ізольованими за замовчуванням
• «Збільшення пропускної здатності тут в основному походить від серіалізації на основі схеми, а не від маршрутизації — тому ми повинні спочатку приоритизувати додавання схем до гарячих шляхів»
• «Ми використовуємо гачки для крос-секційних питань, таких як ведення журналу та аутентификация, тому маршрутизатори зосереджені на бізнес-логіці»

Фрази, яких слід уникати

Сказати “це швидко” без назви механізму. Замість цього скажіть: «серіалізація на основі схеми пропускає багато загальних накладних витрат на перетворення JSON» — це реальна, конкретна причина, чому Fastify має тенденцію перевершувати фреймворки без вбудованої перевірки схеми, і це більш переконливо в технічній дискусії.

** Сказати « додаток не працює » для проблеми з інкапсуляцією. ** Замість цього скажіть: « цей декоратор не видимий поза додатком, у якому він був зареєстрований, що є очікуваною поведінкою інкапсулювання » — це функція дизайну, а не помилка, і правильна назва дозволить уникнути марного часу на зневадження.

** Нечітко вимовляти « додавати перевірку », коли ви маєте на увазі схему. ** Замість цього скажіть: « додайте схему JSON до цього маршруту для перевірки запитів і серіалізації відповідей » — схеми у Fastify виконують подвійну функцію, а нечітка мова приховує, що сторона відповіді також має переваги швидкодії.

Краткий справочник

Term	How to use it
plugin	”Authentication logic is encapsulated in its own plugin.”
encapsulation	”Decorators don’t leak outside the plugin they’re registered in.”
schema	”A response schema speeds up serialization and validates output.”
hook	”The preHandler hook checks auth before the route handler runs.”
decorator	”We decorated the request with a currentUser property.”
throughput	”Schema-based serialization improved throughput noticeably.”

Ключеві моменти

• Назвемо конкретний механізм, що стоїть за швидкістю Fastify — серіалізація на основі схеми — а не нечітке твердження «це швидко».
• Розумійте, що інкапсулювання є типовою, навмисною поведінкою Fastify, а не вада, коли декоратор не видимий у неочікуваному місці.
• Використовувати гачки для вирішення таких проблем, як автентифікація і ведення журналу, зберігаючи обробників маршрутів зосередженими на бізнес- логіці.
• Пам’ ятайте, що схеми виконують подвійну функцію — перевірки запиту і прискорення серіалізації відповідей — коли рекомендується їх додавання.
• Відрізняти декоратори рівня додатка від декораторів кореневого рівня під час зневадження проблем з видимістю у додатках.

Професійна англійська мова для ненароджених мовців (англ. Professional English for Non-Native Speakers)

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

Однією з поширених перешкод є розуміння зворотнього зв’язку під час перегляду коду. Припустимо, що старший розробник коментує: « Налаштування цього додатка здається надто довгим; чи не могли б ми спростити його, скориставшись більш спрощеним підходом? » Негайний переклад може бути складним — « надто довгим » не зовсім відповідає наміченій пропозиції щодо оптимізації. Замість цього, скористайтеся такими фразами: « Я ціную ретельність цих налаштувань, але, можливо, дослідження альтернативних налаштувань з меншою кількістю параметрів покращить читабельність і підтримку ». Зауважте, що використання таких слів, як « спрощено », « читабельність » і « підтримка » додає шар професійного контексту. Аналогічно, опис змін продуктивності вимагає точності: замість того, щоб сказати «це швидше», ви можете сказати: «Переглянутий процес перевірки схеми демонстративно зменшив затримку під час обробки запитів»

Інший поширений сценарій виникає при обговоренні запитів на завантаження. Під час додавання нового додатка до вашого проекту, опис PR повинен бути більшим за просто описування * того, що * він робить. Вона повинна сформулювати * чому * це додавання є цінним і як воно інтегрується з існуючою системою. Хороший приклад: «Ця публікація вводить плагін lodash-validator для покращеної перевірки схеми в наших кінцевих точках API. Це вирішує попередні проблеми щодо цілісності даних, надаючи надійний, налаштовуваний перевіряючий, покращуючи безпеку проти недійсних запитів - зокрема, запобігаючи вразливостям введення, пов’ язаним з неправильно сформованими вхідними даними. Ключовим тут є використання точної мови, наприклад, « цілісність даних », « надійний », і явне згадування переваги (безпеки).

Нарешті, при обговоренні пропускної здатності або показників продуктивності, важливо використовувати встановлену термінологію. Не просто скажіть, що ваш API « швидкий ». Замість цього, ви описуєте « API досягнув середнього часу відповіді 120 мс під навантаженням, що на 15% краще, ніж у попередньої ітерації ». Використання цифр і порівняльної мови — наприклад, « поліпшення » — додає довіри і демонструє розуміння показників продуктивності.

# Example using Fastify's `body_parser` plugin with schema validation:
fastify.register(require('fastify-body-parser'), {
  schema: {
    body: {
      type: 'object',
      properties: {
        name: { type: 'string' },
        age: { type: 'integer', min: 0 }
      },
      required: ['name']
    }
  }
})

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