Стандарты разработки в нашей компании

Сегодня мы решили поделиться материалом из нашей Базы Знаний (БЗ). Каждый разработчик в нашей компании должен изучить эту статью и сдать зачет техническому директору. На самом деле, конечно, никаких зачетов не проводится, но, как правило, после 1-2 проектов любой новый сотрудник уже действует в соответствии со стандартами, поскольку все руководители направлений принимают работу именно по ним.

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

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

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

Общие стандарты

Кодирование и стиль

• Google Style Guide, Airbnb JavaScript Style Guide, PEP 8 (для Python): Эти руководства по стилю кода определяют единые правила форматирования и написания кода для конкретных языков программирования. Соблюдение единого стиля делает код более читабельным, понятным и легким в поддержке.

Преимущества:

• Улучшенная читаемость кода: Единый стиль делает код более последовательным и легким для восприятия.
• Упрощение поддержки: Код, написанный в едином стиле, легче понимать и изменять другим разработчикам.
• Снижение вероятности ошибок: Некоторые правила стиля направлены на предотвращение распространенных ошибок в коде.

Контроль версий и управление кодом

• Git (git-scm.com): Распределенная система контроля версий, ставшая стандартом де-факто в современной разработке. Git позволяет отслеживать изменения в коде, возвращаться к предыдущим версиям, работать над проектом командой и многое другое.

Преимущества:

• Упрощение командной работы: Git позволяет разработчикам работать над одним проектом одновременно, не мешая друг другу.
• История изменений и откат: Git хранит полную историю изменений кода, что позволяет легко откатываться к предыдущим версиям в случае ошибок.
• Распределенность: Git не требует центрального сервера, что повышает надежность и гибкость работы.

Frontend: Интерфейс, понятный пользователю и браузеру

HTTP: Основа взаимодействия в сети

• RFC 7234 (HTTP Caching): Описывает механизмы кэширования HTTP, позволяя браузерам и серверам эффективно использовать сохраненные копии ресурсов, что ускоряет загрузку страниц и снижает нагрузку на сервер.
• RFC 7309 (The Hypertext Transfer Protocol (HTTP) Range Header Field for Fragmented Responses): Определяет, как клиенты могут запрашивать частичные ресурсы, а серверы - предоставлять их. Это особенно полезно для работы с большими файлами, такими как видео или аудио, позволяя загружать и отображать их по частям.
• RFC 2396 (Uniform Resource Identifiers (URI): Generic Syntax): Определяет синтаксис URI, которые используются для идентификации и доступа к ресурсам в сети. Соблюдение этого стандарта гарантирует, что ссылки, запросы и другие взаимодействия с ресурсами будут обрабатываться корректно.
• RFC 2216 (Hypertext Transfer Protocol -- HTTP/1.1): Определяет протокол HTTP/1.1, который долгое время являлся основным протоколом для взаимодействия в сети. Хотя на смену ему приходит HTTP/2, важно понимать принципы HTTP/1.1, так как многие системы все еще его используют.

Преимущества:

• Улучшенная производительность: Кэширование и частичная загрузка ресурсов ускоряют загрузку страниц.
• Оптимизация использования ресурсов: Эффективное использование кэша снижает нагрузку на сервер и экономит трафик.
• Улучшенная совместимость: Корректное использование URI обеспечивает корректную обработку ссылок и запросов разными браузерами и серверами.

W3C: Стандарты для открытой сети

• HTML (HyperText Markup Language): Язык разметки для создания структуры и контента веб-страниц. Стандарты W3C для HTML гарантируют, что страницы будут корректно отображаться в разных браузерах.
• CSS (Cascading Style Sheets): Язык стилей, используемый для оформления внешнего вида веб-страниц. Стандарты W3C для CSS позволяют создавать привлекательный и адаптивный дизайн, работающий на различных устройствах.
• Jav * aScript: Язык программирования, используемый для создания интерактивных элементов на веб-страницах. Стандарты W3C для JavaScript (ECMAScript) обеспечивают совместимость кода с разными браузерами.

Преимущества:

• Кроссбраузерная совместимость: Соблюдение стандартов W3C гарантирует, что веб-страницы будут корректно отображаться в разных браузерах и на разных устройствах.
• Доступность: Стандарты W3C способствуют созданию доступных веб-страниц, которыми могут пользоваться люди с ограниченными возможностями.
• Семантическая корректность: Использование правильных HTML-тегов улучшает SEO и делает код более понятным для разработчиков.

Web Performance Optimization (WPO): Скорость и отзывчивость

Web Performance Optimization (WPO) - это комплекс методик и практик, направленных на повышение скорости загрузки, отзывчивости и общей производительности веб-сайтов и приложений.

Ключевые практики WPO:

• Оптимизация изображений: Использование современных форматов изображений (WebP), сжатие без потерь и адаптивная загрузка изображений.
• Минификация и объединение файлов (HTML, CSS, JavaScript): Уменьшение размера файлов путем удаления ненужных символов и объединения нескольких файлов в один.
• Кэширование: Хранение статических файлов в кэше браузера для ускорения последующих загрузок.
• Ленивая загрузка (Lazy Loading): Загрузка контента (изображений, видео) только при необходимости, например, при прокрутке страницы до нужного элемента.

Разместите
тендер бесплатно

Наша система сама подберет вам исполнителей на услуги, связанные с разработкой сайта или приложения, поисковой оптимизацией, контекстной рекламой, маркетингом, SMM и PR.

Заполнить заявку 12254 тендера
проведено за восемь лет работы нашего сайта.

Преимущества:

• Улучшенный пользовательский опыт: Быстрые, отзывчивые веб-страницы повышают удовлетворенность пользователей.
• Повышение конверсии: Быстрые сайты имеют более высокие показатели конверсии.

Backend: Надежный и масштабируемый фундамент

Backend-разработка, отвечающая за "невидимую" часть веб-приложений, также опирается на ряд важных стандартов, обеспечивающих надежность, безопасность и эффективность обработки данных.

HTTP: Фундамент клиент-серверного взаимодействия

• RFC 7230 (HTTP/1.1: Message Syntax and Routing): Описывает синтаксис и правила форматирования HTTP-сообщений, которыми обмениваются клиент и сервер. Четкое следование этому стандарту гарантирует, что запросы и ответы будут корректно интерпретированы обеими сторонами.
• RFC 7231 (HTTP/1.1: Semantics and Content): Детально описывает семантику HTTP-методов (GET, POST, PUT, DELETE и др.), коды состояния (200 OK, 404 Not Found и т.д.) и другие аспекты протокола, определяющие, как клиент и сервер взаимодействуют друг с другом.
• RFC 7235 (HTTP/1.1: Authentication): Определяет механизмы аутентификации в HTTP, позволяя серверам запрашивать аутентификационные данные у клиентов и ограничивать доступ к защищенным ресурсам.

Преимущества:

• Надежное взаимодействие: Четкое следование стандартам HTTP обеспечивает безошибочное взаимодействие между клиентом и сервером.
• Масштабируемость: Стандартизированный протокол упрощает интеграцию с различными клиентами, серверами и сервисами.
• Безопасность: RFC 7235 предоставляет механизмы для защиты ресурсов от несанкционированного доступа.

Обработка ошибок и обмен данными

• RFC 7807 (Problem Details for HTTP APIs): Определяет стандартизированный формат для сообщений об ошибках, возвращаемых веб-API. Это позволяет клиентам, написанным на разных языках программирования, легко понимать и обрабатывать ошибки.
• RFC 6585 (HTTP Cache-Control Extensions for Stale Content): Расширяет механизмы кэширования HTTP, позволяя клиентам использовать устаревшие копии ресурсов в условиях ограниченного подключения, что повышает отказоустойчивость и скорость загрузки.
• RFC 7159 (The JavaScript Object Notation (JSON) Data Interchange Format): Описывает JSON - популярный текстовый формат обмена данными, используемый для передачи информации между клиентом и сервером.
• RFC 8259 (The JavaScript Object Notation (JSON) Data Interchange Format): Обновляет RFC 7159, уточняя некоторые аспекты формата JSON.
• RFC 2045, RFC 2046, RFC 2047, RFC 2048, RFC 2049 (MIME): Описывают стандарт MIME (Multipurpose Internet Mail Extensions), который определяет форматы файлов и других данных, передаваемых по сети, включая электронную почту и веб-контент. Соблюдение стандартов MIME гарантирует, что клиенты и серверы смогут корректно интерпретировать и обрабатывать различные типы данных.

Преимущества:

• Упрощенная обработка ошибок: Стандартный формат сообщений об ошибках ускоряет отладку и повышает отказоустойчивость приложений.
• Эффективный обмен данными: JSON - легкий и удобный формат для обмена данными между клиентом и сервером.
• Универсальность и совместимость: MIME позволяет передавать различные типы данных по сети, обеспечивая совместимость между различными клиентами и серверами.

Безопасность и идентификация

• RFC 6066 (Uniform Resource Identifier (URI): Generic Syntax): Определяет правила формирования URI, которые используются для идентификации ресурсов в сети. Соблюдение этого стандарта гарантирует, что URI будут уникальными и корректно интерпретироваться различными системами.
• RFC 2818 (HTTP Over TLS): Описывает использование HTTPS, который обеспечивает безопасное соединение между клиентом и сервером с помощью протокола TLS/SSL, шифруя передаваемые данные и защищая их от перехвата.
• RFC 2246 (The TLS Protocol Version 1.0): Описывает протокол TLS 1.0, предшественник TLS/SSL, который также обеспечивает безопасность соединений. Важно знать об этом протоколе, хотя он уже считается устаревшим и не рекомендуется к использованию.

Преимущества:

• Повышенная безопасность: Использование TLS и HTTPS защищает данные, передаваемые между клиентом и сервером, от несанкционированного доступа и модификации.
• Уникальность идентификации: RFC 6066 гарантирует, что URI будут уникальными и корректно обрабатываться различными системами.

DevOps: Автоматизация и непрерывное совершенствование

DevOps, нацеленный на объединение разработки и эксплуатации ПО, также опирается на стандарты для обеспечения безопасности, уникальности идентификации и эффективности сетевых коммуникаций.

Настройка и оптимизация серверов

• RFC 7540 (Hypertext Transfer Protocol/2 (HTTP/2)): Описывает протокол HTTP/2, который позволяет устанавливать одно соединение между клиентом и сервером для передачи нескольких запросов параллельно, что ускоряет загрузку веб-страниц и повышает эффективность использования сетевых ресурсов.

Преимущества:

• Повышенная производительность: HTTP/2 ускоряет загрузку веб-страниц и снижает нагрузку на сервер.

Безопасность данных

• ORM (Object-Relational Mapping): Технология, позволяющая работать с данными из базы данных через объекты программирования. Использование ORM с поддержкой параметризованных запросов помогает предотвратить SQL-инъекции, один из распространенных видов уязвимостей.
• Кодирование символов согласно RFC 2231: Предотвращает некорректную интерпретацию специальных символов в URI, что также может привести к уязвимостям.

Преимущества:

• Повышенная безопасность: Предотвращение SQL-инъекций и других уязвимостей, связанных с обработкой данных.
• Упрощение работы с данными: ORM делает код более читабельным и понятным при взаимодействии с базой данных.