10 советов, как стать лучшим разработчиком узлов в 2017 году

10 советов, как стать лучшим разработчиком узлов в 2017 году, от гостевого автора Азата Мардана . Гостевые посты SitePoint нацелены на привлечение интересного контента от известных писателей и докладчиков веб-сообщества.

Примечание: оригинальное название этой статьи было «Лучшие практики узлов от Гуру Платформы». В статье рассматриваются настоящие, проверенные и проверенные шаблоны, а не новые и лучшие 2017 года. Хотя некоторые из старых добрых практик от Node gurus будут по-прежнему применяться в 2017 и 2018 годах и даже в 2019 году, новые передовые функции, такие как async / подождите, обещания здесь не рассматриваются. Это связано с тем, что эти новые функции отсутствуют ни в коде ядра Node, ни в популярных проектах, таких как npm, Express и т. Д. Вторая часть эссе будет отражать правильную природу контента.

Эта статья включена в нашу антологию, современный JavaScript . Если вы хотите, чтобы все в одном месте было в курсе современного JavaScript, зарегистрируйтесь в SitePoint Premium и загрузите себе копию.

Я начал работать с Node на полную ставку в 2012 году, когда присоединился к Storify. С тех пор я никогда не оглядывался назад и не чувствовал, что мне не хватает Python, Ruby, Java или PHP — языков, с которыми я работал в течение предыдущего десятилетия веб-разработки.

Storify была для меня интересной работой, потому что, в отличие от многих других компаний, Storify запускала (и, возможно, все еще делает) все на JavaScript. Видите ли, большинство компаний, особенно крупных, таких как PayPal, Walmart или Capital One, используют Node только для определенных частей своего стека. Обычно они используют его в качестве шлюза API или уровня оркестровки. Замечательно. Но для разработчика программного обеспечения ничто не сравнится с полным погружением в среду Node.

В этой статье я опишу десять советов, которые помогут вам стать лучшим разработчиком Node в 2017 году. Эти советы приходят от меня, который видел и изучал их в окопах, а также от людей, которые написали самые популярные модули Node и npm. Вот что мы будем освещать:

1. Избегайте сложности — организуйте свой код в наименьшие куски, пока они не станут слишком маленькими, а затем сделайте их еще меньше.
2. Используйте асинхронный код — избегайте синхронного кода, например чумы.
3. Избегайте блокировки require — поместите ВСЕ ваши операторы require в верхнюю часть файла, потому что они синхронны и будут блокировать выполнение.
4. Знайте, что require кешируется — это может быть функция или ошибка в вашем коде.
5. Всегда проверяйте на ошибки — ошибки не футбольные мячи. Никогда не выбрасывайте ошибки и никогда не пропускайте проверку ошибок.
6. Используйте try … catch только в коде синхронизации — try...catch бесполезен для асинхронного кода, плюс V8 не может оптимизировать код в try...catch и обычный код.
7. Возвратите обратные вызовы или используйте if… else — просто чтобы быть уверенным, верните обратный вызов, чтобы предотвратить продолжение выполнения.
8. Прослушивание событий ошибок. Почти все классы / объекты Node расширяют источник событий (шаблон наблюдателя) и генерируют событие error . Обязательно послушайте это.
9. Знайте свой npm — Установите модули с -S или -D вместо --save или --save-dev
10. Используйте точные версии в package.json : npm по умолчанию тупо добавляет символ вставки при использовании -S , поэтому избавьтесь от них вручную, чтобы заблокировать версии. Никогда не доверяйте semver в ваших приложениях, но делайте это в открытых модулях.
11. Бонус — используйте разные зависимости. Поместите вещи, в которых нуждается ваш проект, только в devDependencies а затем используйте npm i --production . Чем больше у вас ненужных зависимостей, тем выше риск уязвимости.

Итак, давайте рассмотрим и рассмотрим каждый из них в отдельности. А не ___ ли нам?

И не забывайте: как упоминалось выше, это первая часть. Вы можете найти еще десять советов во второй части .

Избегайте сложности

Взгляните на некоторые модули, написанные Исааком З. Шлютером, создателем npm. Например, use-strict обеспечивает строгий режим JavaScript для модулей, и это всего лишь три строки кода:

 var module = require('module') module.wrapper[0] += '"use strict";' Object.freeze(module.wrap) 

Так почему бы избежать сложности? Известная фраза, которая возникла в военно-морском флоте США в соответствии с одной из легенд, гласит: «ПРОДОЛЖАЙТЕ ЭТО ПРОСТО ГЛУПО» (или это «Держите это простым, глупым» ?). Это по причине. Человеческий мозг может хранить только пять-семь элементов в своей рабочей памяти одновременно. Это просто факт.

Сохраняя свой код модульным на более мелкие части, вы и другие разработчики сможете лучше понять и обдумать это. Вы также можете проверить это лучше. Рассмотрим этот пример,

 app.use(function(req, res, next) { if (req.session.admin === true) return next() else return next(new Error('Not authorized')) }, function(req, res, next) { req.db = db next() }) 

Или этот код:

 const auth = require('./middleware/auth.js') const db = require('./middleware/db.js')(db) app.use(auth, db) 

Я уверен, что большинство из вас предпочтут второй пример, особенно когда имена говорят сами за себя. Конечно, когда вы пишете код, вы можете подумать, что понимаете, как он работает. Может быть, вы даже хотите показать, насколько вы умны, объединяя несколько методов в одну строку. Пожалуйста, код для тупой версии вас. Код для вас, который не просматривал этот код в течение шести месяцев, или для вас, чтобы попробовать или выпить версию. Если вы пишете код на пике своих умственных способностей, вам будет сложнее понять его позже, не говоря уже о ваших коллегах, которые даже не знакомы с тонкостями алгоритма. Сохранение простоты особенно актуально для Node, который использует асинхронный способ.

 let data = fs.readFileSync('./acconts.json') db.collection('accounts').insert(data, (results))=>{ fs.writeFileSync('./accountIDs.json', results, ()=>{process.exit(1)}) }) 

 app.use('/seed/:name', (req, res) => { let data = fs.readFile(`./${req.params.name}.json`, ()=>{ db.collection(req.params.name).insert(data, (results))=>{ fs.writeFile(`./${req.params.name}IDs.json`, results, ()={res.status(201).send()}) }) }) }) 

 const react = require('react') 

 app.post('/connect', (req, res) => { const axios = require('axios') axios.post('/api/authorize', req.body.auth) .then((response)=>res.send(response)) }) 

 const axios = require('axios') const express = require('express') app = express() app.post('/connect', (req, res) => { axios.post('/api/authorize', req.body.auth) .then((response)=>res.send(response)) }) 

 console.log('I will not be cached and only run once, the first time') module.exports = () => { console.log('I will be cached and will run every time this module is invoked') } 

 try { request.get('/accounts', (error, response)=>{ data = JSON.parse(response) }) } catch(error) { // Will NOT be called console.error(error) } 

 request.get('/accounts', (error, response)=>{ try { data = JSON.parse(response) } catch(error) { // Will be called console.error(error) } }) 

 request.get('/accounts', (error, response)=>{ if (error) return console.error(error) try { data = JSON.parse(response) } catch(error) { console.error(error) } }) 

 var ok = require('okay') request.get('/accounts', ok(console.error, (response)=>{ try { data = JSON.parse(response) } catch(error) { console.error(error) } })) 

 let error = true if (error) return callback(error) console.log('I will never run - good.') 

 let error = true if (error) callback(error) console.log('I will run. Not good!') 

 var req = http.request(options, (res) => { if (('' + res.statusCode).match(/^2\d\d$/)) { // Success, process response } else if (('' + res.statusCode).match(/^5\d\d$/)) // Server error, not the same as req error. Req was ok. } }) req.on('error', (error) => { // Can't even make a request: general error, eg ECONNRESET, ECONNREFUSED, HPE_INVALID_VERSION console.log(error) })