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

Как следовать этому руководству

Я хочу, чтобы это руководство было максимально простым для понимания всеми, будь вы опытным программистом или новичком в программировании.Концепцию шаблона дизайна не совсем легко понять, и сокращение кривой обучения, когда вы начинаете путешествие, всегда является главным приоритетом. Поэтому в дополнение к этой статье с диаграммами и фрагментами кода я также создал репозиторий GitHub, который вы можете клонировать и запускать, чтобы самостоятельно реализовать три шаблона проектирования. Вы также можете следить за следующим видео на YouTube, которое я создал.

Предварительные требования

Если вы просто хотите получить представление о шаблонах проектирования в целом, вам не нужно клонировать образец проекта или устанавливать какие-либо инструменты.Однако для запуска примера кода вам необходимо установить следующее:

• Java Development Kit (JDK): Я настоятельно рекомендую OpenJDK.
• Apache Maven: Пример проекта построен с использованием Apache Maven; К счастью, многие IDE поставляются с установленным Maven.
• Интерактивный редактор разработки (IDE): Я использую IntelliJ Community Edition, но вы можете использовать Eclipse IDE или любую другую Java IDE по вашему выбору
• Git: Если вы хотите клонировать проект, вам понадобится клиент Git.

Чтобы клонировать проект и следовать его указаниям, выполните следующую команду после установки Git:

  git clone https://github.com/bryantson/OpensourceDotComDemos.git  

Затем в вашей любимой среде IDE вы можете импортировать код из репозитория TopDesignPatterns как проект Apache Maven.

Я использую Java, но вы можете реализовать шаблон проектирования, используя любой язык программирования, поддерживающий принцип абстракции.

Шаблон Singleton: Избегайте создания объекта каждый раз

Шаблон singleton — очень популярный шаблон проектирования, который также относительно просто реализовать, поскольку вам нужен только один класс.Однако многие разработчики спорят о том, опережают ли преимущества одноэлементного шаблона проектирования его проблемы, потому что он не имеет явных преимуществ и им легко злоупотреблять. Немногие разработчики реализуют синглтон напрямую; вместо этого такие фреймворки программирования, как Spring Framework и Google Guice, имеют встроенные функции одноэлементного шаблона проектирования.

Но знание синглтона по-прежнему чрезвычайно полезно. Шаблон singleton гарантирует, что класс создается только один раз, и обеспечивает глобальную точку доступа к нему.

Шаблон Singleton: Обеспечивает создание только одного экземпляра и предотвращает создание нескольких экземпляров одного и того же объекта.

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

На следующей диаграмме объект создается с использованием одноэлементного шаблона. Здесь конструктор вызывается только тогда, когда объект запрашивается в первый раз с помощью назначенного метода getInstance (). Обычно это делается путем проверки нулевого значения, и объект сохраняется внутри одноэлементного класса как частное значение поля.В следующий раз, когда вызывается getInstance (), класс возвращает объект, который был создан в первый раз. Новый объект не создается; он просто возвращает старую.

Следующий сценарий показывает простейший способ создания одноэлементного шаблона:

 пакет org.opensource.demo.singleton; 
 открытый класс OpensourceSingleton {
 
 частный статический OpensourceSingleton uniqueInstance; 
 
 private OpensourceSingleton () {
} 
 
 public static OpensourceSingleton getInstance () {
 if (uniqueInstance == null) {
 uniqueInstance = new OpensourceSingleton (); 
} 
 return uniqueInstance; 
} 
 
} 
 

На вызывающей стороне вот как будет вызываться одноэлементный класс для получения объекта:

 
 Открытый исходный код newObject = Открытый исходный код.getInstance (); 
 

Этот код демонстрирует идею одноэлементной скважины:

1. Когда вызывается getInstance (), он проверяет, был ли уже создан объект, проверяя нулевое значение.
2. Если значение равно нулю, он создает новый объект, сохраняет его в частном поле и возвращает объект вызывающей стороне. В противном случае он возвращает объект, который был создан ранее.

Основная проблема с этой одноэлементной реализацией — игнорирование параллельных процессов.Когда несколько процессов, использующих потоки, обращаются к ресурсу одновременно, возникает проблема. Есть одно решение этой проблемы, и это называется блокировка с двойной проверкой для многопоточной безопасности, которая показана здесь:

 пакет org.opensource.demo.singleton; 
 открытый класс ImprovedOpensourceSingleton {
 
 частный изменчивый статический ImprovedOpensourceSingleton uniqueInstance; 
 
 private ImprovedOpensourceSingleton () {} 
 
 public static ImprovedOpensourceSingleton getInstance () {
 if (uniqueInstance == null) {
 synchronized (ImprovedOpensourceSingleton.class) {
 if (uniqueInstance == null) {
 uniqueInstance = new ImprovedOpensourceSingleton (); 
} 
} 
} 
 return uniqueInstance; 
} 
 
} 
 

Чтобы подчеркнуть предыдущий момент, убедитесь, что вы реализуете свой синглтон напрямую, только если вы считаете, что это безопасный вариант. Лучше всего использовать функцию синглтона с помощью хорошо продуманной среды программирования.

Фабричный шаблон: делегируйте создание объекта классу фабрики, чтобы скрыть логику создания

Заводской шаблон — еще один хорошо известный шаблон проектирования, но он немного сложнее. Есть несколько способов реализовать фабричный шаблон, но следующий пример кода демонстрирует самый простой из возможных способов. Шаблон фабрики определяет интерфейс для создания объекта, но позволяет подклассам решать, какой класс создать.

Фабричный шаблон: Делегирует создание объекта классу фабрики, поэтому он скрывает логику создания.

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

Вместо того, чтобы напрямую вызывать создание объекта, клиент запрашивает у фабричного класса определенный объект, тип x. В зависимости от типа шаблон фабрики решает, какой объект создать, а какой вернуть.

В этом примере кода OpensourceFactory — это реализация фабричного класса, которая берет тип от вызывающей стороны и решает, какой объект создать на основе этого входного значения:

 пакет орг.opensource.demo.factory; 
 открытый класс OpensourceFactory {
 
 общедоступные OpensourceJVMServers getServerByVendor (String name) {
 if (name.equals ("Apache")) {
 return new Tomcat (); 
} 
 else if (name.equals ("Eclipse")) {
 return new Jetty (); 
} 
 else if (name.equals ("RedHat")) {
 return new WildFly (); 
} 
 else {
 return null; 
} 
} 
} 
 

И OpenSourceJVMServer — это класс 100% абстракции (или класс интерфейса), который указывает, что реализовать, а не как:

 пакет орг.opensource.demo.factory; 
 общедоступный интерфейс OpensourceJVMServers {
 public void startServer (); 
 public void stopServer (); 
 общедоступная строка getName (); 
} 
 

Вот пример класса реализации для OpensourceJVMServers. Когда «RedHat» передается в качестве типа в фабричный класс, создается сервер WildFly:

 пакет org.opensource.demo.factory; 
 открытый класс WildFly реализует OpensourceJVMServers {
 public void startServer () {
 System.out.println ("Запуск сервера WildFly ..."); 
} 
 
 public void stopServer () {
 System.out.println ("Завершение работы сервера WildFly ..."); 
} 
 
 public String getName () {
 return "WildFly"; 
} 
} 
 

Шаблон наблюдателя: подпишитесь на темы и получайте уведомления об обновлениях

Наконец, есть шаблон наблюдателя . Как и в случае с одноэлементным шаблоном, некоторые профессиональные программисты реализуют шаблон наблюдателя напрямую.Однако многие реализации очередей обмена сообщениями и служб данных заимствуют концепцию шаблона наблюдателя. Шаблон наблюдателя определяет зависимости «один ко многим» между объектами, так что, когда один объект меняет состояние, все его зависимые объекты автоматически уведомляются и обновляются.

Шаблон наблюдателя: Подпишитесь на темы / темы, в которых клиент может быть уведомлен об обновлении.

Самый простой способ представить себе шаблон наблюдателя — это представить список рассылки, в котором вы можете подписаться на любую тему, будь то открытый исходный код, технологии, знаменитости, кулинария или что-то еще, что вас интересует.Каждая тема ведет список своих подписчиков, который эквивалентен «наблюдателю» в шаблоне наблюдателя. Когда тема обновляется, все ее подписчики (наблюдатели) уведомляются об изменениях. А подписчик всегда может отказаться от подписки на тему.

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

Давайте посмотрим на пример кода для шаблона наблюдателя, начиная с предметного / тематического класса:

 пакет org.opensource.demo.observer; 
 общедоступный интерфейс Тема {
 
 public void addObserver (наблюдатель-наблюдатель); 
 public void deleteObserver (наблюдатель-наблюдатель); 
 public void notifyObservers (); 
} 
 

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

Вот пример реализации темы:

 пакет org.opensource.demo.observer; 
 import java.util.List; 
 import java.util.ArrayList; 
 
 Public class Conference реализует тему {
 private List  listObservers; 
 частных int totalAttendees; 
 частных int totalSpeakers; 
 частная строка nameEvent; 
 
 общедоступная конференция () {
 listObservers = new ArrayList  (); 
} 
 
 public void addObserver (наблюдатель-наблюдатель) {
 listObservers.добавить (наблюдатель); 
} 
 
 public void deleteObserver (наблюдатель-наблюдатель) {
 int i = listObservers.indexOf (наблюдатель); 
 if (i> = 0) {
 listObservers.remove (i); 
} 
} 
 
 public void notifyObservers () {
 for (int i = 0, nObservers = listObservers.size (); i  Observer Observer = listObservers.get (i); 
 Observer.update (totalAttendees, totalSpeakers, nameEvent); 
} 
} 
 
 public void setConferenceDetails (int totalAttendees, int totalSpeakers, String nameEvent) {
 this.totalAttendees = totalAttendees; 
 this.totalSpeakers = totalSpeakers; 
 this.nameEvent = nameEvent; 
 notifyObservers (); 
} 
} 
 

Этот класс определяет реализацию определенной темы. Когда происходит изменение, именно эта реализация вызывается. Обратите внимание, что для этого требуется количество наблюдателей, которое хранится в виде списка, и может как уведомлять, так и поддерживать наблюдателей.

Вот класс наблюдателя:

 пакет орг.opensource.demo.observer; 
 общедоступный интерфейс Observer {
 общедоступное обновление void (int totalAttendees, int totalSpeakers, String nameEvent); 
} 
 

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

Например, реализация наблюдателя может распечатать количество участников и докладчиков на конференции:

 пакет org.opensource.demo.observer; 
 открытый класс MonitorConferenceAttendees реализует Observer {
 private int totalAttendees; 
 частных int totalSpeakers; 
 частная строка nameEvent; 
 тема в частной теме; 
 
 public MonitorConferenceAttendees (Тема тема) {
 this.topic = тема; 
 topic.addObserver (это); 
} 
 
 общедоступное обновление void (int totalAttendees, int totalSpeakers, String nameEvent) {
 this.totalAttendees = totalAttendees; 
 this.totalSpeakers = totalSpeakers; 
 this.nameEvent = nameEvent; 
 printConferenceInfo (); 
} 
 
 public void printConferenceInfo () {
 System.out.println (this.nameEvent + "имеет" + totalSpeakers + "выступающих и" + totalAttendees + "посетителей"); 
} 
} 
 

Куда идти дальше?

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

Однако я считаю, что лучше сначала отточить свои навыки, внедряя эти шаблоны проектирования в свои побочные проекты или просто в качестве практики. Вы даже можете задуматься о том, как применить эти шаблоны проектирования в своих реальных проектах. Затем я настоятельно рекомендую ознакомиться с твердыми принципами ООП. После этого вы будете готовы изучить другие шаблоны проектирования.

Разработка и моделирование программного обеспечения | SEA

Проектирование программного обеспечения — это процесс определения методов, функций, объектов программного обеспечения, а также общей структуры и взаимодействия вашего кода, чтобы конечная функциональность удовлетворяла требованиям ваших пользователей. См. Нашу страницу требований, чтобы узнать, как писать требования. Существует множество различных способов разработки программного обеспечения, почти все из которых включают в себя создание первоначального дизайна и его доработку по мере необходимости. Разные разработчики предпочитают разный объем проектирования на начальном этапе или на этапе реализации.Как правило, общий дизайн должен быть хорошо продуман и проанализирован до начала написания кода. Обратитесь к нашему разделу «Обзоры дизайна», чтобы узнать, как проверить свой дизайн. Легче опробовать различные проекты заранее и обнаружить проблемы на ранних этапах цикла разработки, чем вносить серьезные изменения в дизайн после того, как большая часть кода написана.
Дизайн вашего программного обеспечения должен включать описание общей архитектуры. Это должно включать оборудование, базы данных и сторонние платформы, которые ваше программное обеспечение будет использовать или с которыми будет взаимодействовать.Это общая картина того, что работает, где и как все части будут взаимодействовать.
Дизайн вашего программного обеспечения должен включать все интерфейсы прикладного программирования (API), которые используются вашим кодом или внешним кодом, который вызывает ваш код. Правильное определение этих API-интерфейсов очень важно, потому что после того, как они согласованы и используются, их будет чрезвычайно сложно изменить, не нарушая код других людей. Эта ссылка описывает, как разработать хороший API.

• http: // www.infoq.com/news/2006/11/joshua-bloch-API-design
  Один из крайних подходов к разработке программного обеспечения состоит в том, чтобы придумать упрощенный дизайн и реализацию, а также постепенно расширять / реорганизовать его, чтобы включить больше требований. Это решение требует значительного рефакторинга и иногда может затруднить отслеживание общей картины. Это, как правило, дает начальное решение, которое работает для ограниченного набора требований.
  Другой крайний подход — попытаться спроектировать как можно больше перед реализацией.Этот подход требует достаточно полного понимания требований, но имеет тенденцию к созданию решения, которое соответствует потребностям всей системы, а не потребностям каждого подкомпонента.
  Между этими двумя крайностями есть много хороших вариантов. Постарайтесь заранее подумать об общих серьезных проблемах и создать дизайн, который решает эти проблемы. Когда вы начнете реализовывать свой дизайн, вы можете обнаружить новые проблемы, которые изменяют или добавляют в ваш дизайн, и вам, возможно, придется реорганизовать код, чтобы учесть эти изменения, однако эти изменения должны быть небольшими.Помните, что цель разработки программного обеспечения до начала кодирования — убедиться, что все работают вместе и создают одно и то же.

  Что такое программное моделирование?

  Под программным моделированием мы не подразумеваем выражение научной теории или алгоритма в программном обеспечении. Это то, что ученые традиционно называют программной моделью. Под программным моделированием мы подразумеваем нечто большее, чем алгоритм или единственный метод. Моделирование программного обеспечения должно охватывать весь проект программного обеспечения, включая интерфейсы, взаимодействие с другим программным обеспечением и все методы программного обеспечения.
  Программные модели — это способы выражения дизайна программного обеспечения. Обычно для выражения дизайна программного обеспечения используется какой-то абстрактный язык или изображения. Для объектно-ориентированного программного обеспечения язык объектного моделирования, такой как UML, используется для разработки и выражения дизайна программного обеспечения. Есть несколько инструментов, которые вы можете использовать для разработки своего UML-дизайна.
  Практически во всех случаях язык моделирования используется для разработки проекта, а не только для того, чтобы зафиксировать его после его завершения. Это позволяет дизайнеру пробовать разные дизайны и решать, какой из них лучше всего подходит для окончательного решения.Думайте о проектировании своего программного обеспечения, как о доме. Вы начинаете с чернового наброска плана этажа и расположения комнат и этажей. Чертеж — это ваш язык моделирования, а получившийся чертеж будет моделью вашего окончательного дизайна. Вы будете продолжать изменять свои чертежи, пока не получите проект, отвечающий всем вашим требованиям. Только после этого можно начинать резать доски или писать код.
  Опять же, преимущество разработки программного обеспечения с использованием языка моделирования состоит в том, что вы обнаруживаете проблемы на ранней стадии и исправляете их без рефакторинга кода.
  Как разные методологии обрабатывают проектирование и моделирование программного обеспечения?
  Прочтите следующее:
  [Рациональный унифицированный процесс (RUP)]
  [Agile]

  Ссылки

• UML Distilled: краткое руководство по стандартному языку моделирования объектов
  Мартина Фаулера
• UML 2.0 в двух словах , Дэн Пилон
• Шаблоны проектирования: элементы объектно-ориентированного программного обеспечения многократного использования Ричард Хелм, Ральф Джонсон и Джон Влиссидес

Как создавать документы проектирования программного обеспечения

Представьте себе: Вы ‘ Вы отправляетесь в долгое путешествие, но вместо того, чтобы использовать карту, вы просто начинаете движение в общем направлении к месту назначения.Конечно, в конце концов вы можете туда добраться. Или вы можете в конечном итоге безнадежно заблудиться. В любом случае вы зря потратили драгоценное время — время, которое можно было бы сэкономить, если бы вы использовали карту.

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

Если вы новичок в документации по разработке программного обеспечения, не волнуйтесь — этот пост охватывает все, от основ до передовых практик и профессиональных советов! И даже если вы старый профессионал, никогда не помешает освежить свои знания в области SDD, верно?

Что такое проектная документация программного обеспечения?

Документ о разработке программного обеспечения, иногда называемый спецификацией разработки программного обеспечения, представляет собой подробный план разработки части программного обеспечения.В SDD должны быть описаны функциональные возможности (спецификации) готового программного обеспечения и планы вашей команды по его созданию (сроки, цели и т. Д.).

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

Документация по проектированию программного обеспечения раскрывает почти все аспекты проекта разработки программного обеспечения: какую проблему решит программное обеспечение? Как будет выглядеть конечный продукт? Как работает внутренняя архитектура? (Мы подробно рассмотрим, что включать в SDD позже.)

Почему важны SDD?

Если вы разработчик, возможно, вы бывали здесь раньше: вы написали тысячи строк кода только для того, чтобы понять, что у вас и вашего клиента совершенно разные взгляды на проект.Это тысячи строк кода — и кто знает, сколько часов работы — вам, возможно, придется выбросить.

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

также помогают упростить процесс кодирования. Чтобы создать SDD, вы должны продумать всю архитектуру вашей системы, прежде чем писать какой-либо код.Это позволяет вам предвидеть любые препятствия и препятствия и планировать их решение. По мере того как различные члены команды работают над созданием своих соответствующих частей программного обеспечения, существует централизованный документ, в котором описываются функции, зависимости и другая полезная информация.

Что включать в документацию по разработке программного обеспечения

Теперь, когда мы получили общий обзор, пора перейти к мельчайшим деталям. Как на самом деле выглядит проектный документ программного обеспечения?

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

Название, авторы и рецензенты

Это может показаться очевидным, но мы включили его на всякий случай — вы будете удивлены тем, что люди забывают. В начале SDD не забудьте указать название вашего проекта, авторов (документа, а не программного обеспечения) и рецензентов (обычно заинтересованных сторон, не связанных с разработкой).

Функциональное описание

В этом разделе вы пытаетесь ответить на простой вопрос: что делает программа? Конечно, чтобы полностью ответить на этот вопрос, вам нужно копнуть немного глубже.В функциональном описании вы должны указать обработку ошибок, процедуры однократного запуска, ограничения пользователей и другие подобные детали.

Пользовательский интерфейс

Есть большая вероятность, что ваш проект кодирования будет приложением, а это значит, что у него будет пользовательский интерфейс. (Если ваш проект представляет собой библиотеку или что-то подобное, интерфейса не будет.) Когда клиенты, дизайнеры UX и программисты обсуждают и планируют пользовательский интерфейс, границы легко пересечь. Если клиент неадекватно передает свое видение, ваши команды могут создавать пользовательский интерфейс только для того, чтобы разрушить дизайн.

Вот и хорошие новости: этих неудач по большей части можно полностью избежать. Вам просто нужно обсудить с клиентом несколько вопросов, прежде чем начинать разработку. Меняются ли некоторые элементы интерфейса (анимация)? Какие элементы являются кнопками? На сколько уникальных экранов может перейти пользователь? И, конечно же, как все это на самом деле выглядит?

И еще одна хорошая новость: каркасные диаграммы могут помочь вам ответить на все эти вопросы! По мере того как ваш клиент делится своим видением пользовательского интерфейса (возможно, отправляет грубые наброски), ваши команды должны создавать каркасные диаграммы.

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

Узнайте, как создать в Lucidchart каркас с низкой точностью и включить его в проектный документ программного обеспечения.

См. Наш учебник

Цели и вехи

Вместо того, чтобы рассматривать свой проект как единый длительный процесс, вы можете счесть полезным разбить его на более управляемые части. (Это верно как для графика проекта, так и для самого кода.На самом макроуровне у вас есть общая цель: какую проблему решает ваше программное обеспечение? Кто будет им пользоваться?

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

Приоритизация

Когда вы начнете разбивать проект на более мелкие функции и пользовательские истории, вы захотите расположить их по приоритету. Для этого нанесите каждую функцию на матрицу приоритетов, четырехквадрантный график, который поможет вам отсортировать функции по срочности и влиянию. Горизонтальная ось проходит от низкой к высокой срочности; вертикальная ось проходит от слабого до сильного удара.

На основании квадранта, в который попадает каждая функция, решите, следует ли включать ее в свой минимально жизнеспособный продукт (MVP).Функции в правом верхнем квадранте (высокая срочность, высокая эффективность) должны быть включены в ваш MVP. Имея функции в нижнем правом (высокая срочность, низкая эффективность) и верхнем левом (низкая срочность, высокая эффективность) квадрантах, используйте свое усмотрение, чтобы решить, являются ли они частью вашего MVP. Функции в нижнем левом квадранте (низкая срочность, слабое воздействие) не должны включаться в ваш минимально жизнеспособный продукт.

Текущие и предлагаемые решения

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

Вам не нужно вдаваться в мелкие детали, но следует хотя бы написать историю пользователя: как пользователь взаимодействует с этим решением? Как обрабатываются данные?

Затем вам нужно добавить раздел с описанием предлагаемого решения. Если уже существует существующее решение, зачем вам предлагаемое решение? Теперь у вас есть шанс оправдать проект. Вы захотите объяснить это как можно подробнее с технической точки зрения — после прочтения этого раздела другой инженер должен иметь возможность построить ваше предлагаемое решение или что-то в этом роде без каких-либо предварительных знаний о проекте.

Хронология

В разделе «Основные этапы» вашего SDD должны быть указаны общие временные рамки для заинтересованных сторон, не связанных с инженерными разработками. Этот раздел гораздо более подробный и предназначен в основном для ваших инженерных команд. В график укажите конкретные задачи и сроки, а также команды или отдельных лиц, которым они назначены.

Pro советы по созданию проектной документации программного обеспечения

Тот факт, что вы создаете проектную документацию программного обеспечения и включаете в нее каждый из вышеупомянутых разделов, не означает, что он будет эффективным.Конечно, это только начало, но чтобы получить максимальную отдачу от SDD, помните об этих советах.

Говорите простым языком

Когда дело доходит до проектной документации программного обеспечения, ясность является ключевым моментом. Нет необходимости в цветистом языке и длинных, извилистых предложениях — делайте предложения короткими и точными. При необходимости включите маркированный список или нумерованные списки.

Включить визуальные эффекты

Вернитесь к разделу пользовательского интерфейса. Используя каркасы, вы можете точно передать дизайн, который практически невозможно описать в письменной форме.Вы можете найти диаграммы классов, временные шкалы и другие диаграммы, столь же полезные в вашем SDD.

Получить обратную связь пораньше

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

Обновите SDD

После того, как вы написали проект программного обеспечения и получили одобрение заинтересованных сторон, не запирайте его в пыльном ящике (или другом другом цифровом эквиваленте).По мере продвижения вашего проекта члены команды должны постоянно ссылаться на SDD. Если есть задержка, обновите график. Если рассматривать SDD как живой документ, он станет бесценным единственным источником истины.

Оцените преимущества документирования дизайна вашего программного обеспечения. Начните прямо сейчас с нашим шаблоном.

Попробовать

Сравнение дизайна программного обеспечения и требований к программному обеспечению

Если вы новичок в создании программного обеспечения, вы, вероятно, слышали, как часто встречаются слова дизайн и требования.Это одно и то же? Они разные? А какой вам нужен?

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

Требования к программному обеспечению четко определяют «что» должна делать ваша система. По сути, это контрольный список, который ваши дизайнеры, разработчики и тестировщики будут использовать, чтобы убедиться, что вы получите желаемую систему.

Определение твердых требований — это первый этап успешного программного проекта. На этом этапе вы определяете проблему, будущее видение и цель, а также детали решения.

включают:

• Кто пользователи вашей системы
• Какова каждая задача, которую ваш пользователь должен выполнить с помощью системы
• Каковы ключевые этапы каждого процесса
• Что происходит, если задача не выполняется в соответствии с планом
• Сколько пользователей система должна поддерживать
• Сколько транзакций в день / минуту / секунду необходимо обрабатывать системе
• Какие виды обработки происходят за кадром
• Какие требования безопасности и соответствия должны соблюдаться
• Какое оборудование / инфраструктура должно работать с решением?
• Какие технологические предпочтения следует учитывать при решении
• Какие сторонние системы необходимы для получения данных в этом программном обеспечении или из него?

Лучше, чтобы требования к программному обеспечению были подробными, а не расплывчатыми.На этом этапе вы не зацикливаетесь на том, «как» система выполнит все пункты контрольного списка. Вы по-прежнему сосредоточены на том, «что» система должна делать, чтобы добиться успеха.

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

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

Все эти документы помогают описать на бумаге, как система должна выглядеть и работать, чтобы:

• Вы можете быть уверены, что нужная система будет построена
• Ваша команда разработчиков точно знает, как это построить

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

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

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

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

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

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

Чтобы выяснить это заранее, нужны дисциплина и согласованные усилия мышления и анализа. Это не так весело, как прыгнуть в код и сразу увидеть систему. Но наличие требований и дизайна означает наличие дорожной карты для желаемого приложения. Без дорожной карты вы вынуждены ехать в общем направлении и надеяться, что доберетесь туда. Вы можете блуждать, дрейфовать и испытывать трудности с пониманием того, действительно ли вы на правильном пути.

Почему бы не потратить время на то, чтобы заранее определить свои требования и дизайн? Почему бы не дать вашей команде четкое представление о том, что вы хотите, чтобы они построили? Почему бы не дать себе возможность узнать, придерживается ли ваша команда поставленных целей и предоставляет программное обеспечение, которое вам нужно и нужно, сравнив их работу с дизайном?

Подробнее о требованиях читайте в нашем блоге Почему бизнес-цели не совпадают с требованиями к программному обеспечению.

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

Вы можете взять копию этого контрольного списка ниже и поделиться им со своей командой!

Системный дизайн в разработке программного обеспечения | Дидакус Одхиамбо | Andela Way

Проектирование системы — это процесс проектирования элементов системы, таких как архитектура, модули и компоненты, различные интерфейсы этих компонентов и данные, которые проходят через эту систему.

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

Целью процесса проектирования системы является предоставление достаточно подробных данных и информации о системе и ее системных элементах, чтобы обеспечить реализацию, согласованную с архитектурными объектами, как определено в моделях и представлениях архитектуры системы.

• Архитектура — это концептуальная модель, которая определяет структуру, поведение и другие представления системы.Мы можем использовать блок-схемы для представления и иллюстрации архитектуры.
• Модули — Это компоненты, которые выполняют одну конкретную задачу в системе. Комбинация модулей составляет систему.
• Компоненты — Предоставляет определенную функцию или группу связанных функций. Они состоят из модулей.
• Интерфейсы — Это общая граница, через которую компоненты системы обмениваются информацией и взаимодействуют.
• Данные — Это управление информацией и потоками данных.

1. Инициализация определения проекта

• Планирование и определение технологий, которые будут составлять и реализовывать элементы системы и их физические интерфейсы.
• Определите, какие технологии и элементы системы могут устареть или развиваться на этапе эксплуатации системы. Спланируйте их возможную замену.
• Задокументируйте стратегию определения проекта, включая необходимость и требования к любым системам, продуктам или услугам, обеспечивающим выполнение проекта.

2. Определите проектные характеристики

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

3. Оцените альтернативы для получения элементов системы

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

4. Управляйте дизайном

• Сохраняйте и поддерживайте обоснование для всех вариантов выбора и решений по дизайну, характеристикам архитектуры.
• Оценивать и контролировать изменение проектных характеристик.

Факторы, влияющие на технологические компромиссы при проектировании системы

Масштаб продукта

• Например, компании-разработчики корпоративного программного обеспечения, которые создают программное обеспечение системного уровня, отдают приоритет надежности, потому что клиенты должны их использовать. Каждое изменение необходимо тщательно тестировать и часто утверждать, прежде чем оно может быть выпущено.
• Между тем, потребительские интернет-компании тратят время и деньги на то, чтобы сделать свой UX привлекательным, чтобы люди захотели им пользоваться.Надежность — это то, чем они готовы пожертвовать. Поскольку многие из них являются веб-приложениями, они могут быстро выполнять итерацию и часто выпускать изменения.

Время

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

Стоимость

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

Эффективность

• Технологические компромиссы также принимаются в зависимости от того, какая технология более эффективна, например, выбор между ReactJs или AngularJs для внешнего приложения.

Взаимодействие с пользователем и поддержка

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

Ремонтопригодность

• Ремонтопригодность в данном случае — это легкость, с которой продукт может сопровождаться для исправления ошибок, исправления ошибок и добавления дополнительных функций.Решения о компромиссах будут приниматься на основе ремонтопригодности Технологии

Надежность

• В этом случае компромиссы принимаются на основе Технологии, которая стабильно работает и последовательно обновляется до более эффективных версий.

Масштабируемость

• Технологические компромиссы также основаны на технологиях, которые являются более масштабируемыми и способны эффективно справляться с возрастающими нагрузками без снижения эффективности системы.

Шаблон проектирования Model View Controller (MVC) определяет, что приложение состоит из модели данных, информации представления и информации управления.

MVC в основном относится к уровню пользовательского интерфейса / взаимодействия приложения.

В шаблоне MVC пользователь видит View , который обновляется моделью , которая, в свою очередь, управляется контроллером .

• Модель содержит только чистые данные приложения, она не содержит логики, описывающей, как представить данные пользователю.Они являются частями приложения, реализующими логику области данных приложения. Они извлекают и сохраняют состояние модели в базе данных.
• View представляет данные модели пользователю. Представление можно использовать только для доступа к данным модели. Это компоненты, отображающие пользовательский интерфейс (UI) приложения.
• Контроллер находится между представлением и моделью. Он слушает события, запускаемые представлением, и выполняет соответствующие команды.Это компоненты, которые обрабатывают взаимодействие с пользователем, работают с моделью и в конечном итоге выбирают представление для визуализации, отображающее пользовательский интерфейс.

Преимущества шаблона проектирования MVC

• Несколько разработчиков могут одновременно работать над моделью, контроллером и представлениями.
• MVC позволяет логически группировать связанные действия на контроллере вместе. Виды для конкретной модели также группируются.
• Низкая связь. Сама природа инфраструктуры MVC такова, что существует низкая степень связи между моделями, представлениями или контроллерами.
• Модели могут иметь несколько представлений.
• Простота модификации — из-за разделения ответственности дальнейшая разработка или модификация проще

Недостатки

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

Ниже приведен пример проектирования системы

Как написать документ проектирования программного обеспечения (SDD)

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

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

Что такое проектный документ программного обеспечения?

IEEE определяет документацию по проектированию программного обеспечения как «описание программного обеспечения, созданного для облегчения анализа, планирования, реализации и принятия решений».По сути, проект программного обеспечения (SDD) объясняет, как программный продукт или функция будут построены для удовлетворения набора технических требований. Если документ с требованиями описывает «что» вашего проекта, то в проектном документе основное внимание уделяется тому, «как».

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

По мере развития методологии разработки программного обеспечения документация по проектированию программного обеспечения вызывала сильный скептицизм. «У нас нет времени на проектную документацию», — это то, что вы, возможно, слышали часто. Многие считают конструкторскую документацию устаревшей, пережитком давно ушедшей эпохи разработки программного обеспечения, которой нет места в гибкой документации.

Зачем писать проектную документацию по программному обеспечению?

Документ о разработке программного обеспечения в его первоначальной форме может действительно сегодня не иметь значения.Жесткий, длинный документ MS Word, который устаревает в момент написания и никогда не читается никем, не имеет места в современной разработке программного обеспечения.

Наши рабочие процессы эволюционировали, как и концепция проектного документа.

Хотя важной функцией документации по проектированию программного обеспечения является передача технических деталей планируемого решения вашей команде, это не единственная причина, по которой она написана. Цель больше не в том, чтобы создать подробный, фиксированный план вашего дизайна и впоследствии служить документацией.Это поможет вам организовать свои мысли, прежде чем тратить кучу времени на неправильное решение или решение неправильной проблемы. Это совместное упражнение для всей вашей команды.

По словам Анжелы Чжан, технического менеджера Plaid, подробный и тщательный проектный документ остается «самым полезным инструментом для обеспечения правильного выполнения работы».

Если вы работаете в качестве разработчика-фрилансера, проектный документ может также избавить вас от многих проблем в будущем, помогая избежать потенциальных разногласий с вашими клиентами и добавляя ясности в согласованные цели.«Без этого документа вы попадете в петлю язвительной двусмысленности: клиенты будут оспаривать то, что они сказали вам или что вы им сказали, гневно посылая вырезки из предыдущих сообщений, интерпретируя и спорив до тех пор, пока не придет время, когда клиент требует, чтобы вы внесли изменения », — предупреждает Кристофер Дж. Фокс, внештатный инженер-программист с более чем 30-летним опытом.

Анатомия документа по разработке программного обеспечения

Документ по разработке программного обеспечения описывает решение проблемы.Естественно, поскольку все проблемы индивидуальны, универсального шаблона быть не может. Нет двух одинаковых документов по разработке программного обеспечения.

Вот как может выглядеть проектный документ программного обеспечения в Nuclino, инструменте совместной документации для команд:

Хотя вашему проекту может потребоваться структура нестандартной проектной документации, вы можете рассмотреть возможность включения некоторых из следующих часто используемых разделов:

Обзор и заинтересованные стороны

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

Контекст и цели

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

Предлагаемое решение

Конкретное подробное предложение по новой технической архитектуре.

Временная шкала

Разбивка того, как и когда вы планируете выполнять каждую часть проекта.

Конечно, не существует такого понятия, как окончательный шаблон проектной документации. Было предложено много альтернатив, некоторые более простые, некоторые более подробные. Выбор будет сильно зависеть от масштабов проекта и размера вашей команды. Как бы вы ни решили структурировать свой SDD, важно найти формат, который работает для вас и вашей команды, и постоянно его итерировать.

Как написать отличный документ по разработке программного обеспечения

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

Сделайте это совместным и предложите обратную связь

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

Существует множество инструментов для совместной работы с документами, которые могут облегчить такие рабочие процессы, включая Nuclino.«Важно, чтобы члены вашей команды могли комментировать документ и указывать на ошибки и упущения», — сказал Дэвид «Талин» Джойнер, программист игр и бывший разработчик программного обеспечения в Google+.

Сделайте это наглядным с помощью диаграмм и диаграмм

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

Будьте внимательны

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

Не пишите в Word

Как упоминалось ранее, разработка программного обеспечения — это совместный процесс, и для успешного результата критически важны циклы обратной связи и обзоры. Word — отличный инструмент, у которого есть свои приложения, но он также жесткий и закрытый по своей природе.Написание дизайнерского документа в Word фактически гарантирует, что его никто не прочитает, не говоря уже о том, чтобы обновлять его.

Идеальный инструмент для написания SDD — открытый, совместный и организованный — Nuclino стремится быть таким инструментом. Сохраняйте документы по дизайну легкодоступными для всех заинтересованных сторон, храня их на общем диске или в своей внутренней базе знаний, делая их легко обнаруживаемыми и доступными для поиска.

Не делайте его слишком длинным или сложным

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

«Не позволяйте своему желанию показать, насколько вы умны, не отвлекает вас», — рекомендует Джоунер.

Не позволяйте ему устареть

« Дизайн будет развиваться, и изменения должны быть отражены в вашем документе .За мой 25-летний опыт работы я ни разу не работал над проектом, где бы этого не происходило. Даже тогда я создал проектный документ с подробными спецификациями и при необходимости скорректировал его », — объяснил Кристофер Дж. Фокс, бывший старший инженер Microsoft и RealNetworks.

Ваш дизайн будет развиваться, как и ваш документ. Чтобы все заинтересованные стороны были на одной странице, вам нужно обновлять документ каждый раз, когда вы вносите изменения в исходное решение или обновляете объем или временную шкалу вашего проекта.Чтобы привлечь внимание заинтересованных сторон к конкретному обновлению в Nuclino, просто отметьте их @, и они получат мгновенное уведомление. Отслеживайте эволюцию вашего проектного документа и при необходимости восстанавливайте более ранние версии, используя историю версий.

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

Nuclino: единый источник правды для вашей команды

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

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

• Общайтесь с помощью вдумчивых подробных описаний и тратите меньше времени на душераздирающие встречи и хаотичные каналы Slack.