Обзор литературы по существующим системам (методам) разработки 5

ВВЕДЕНИЕ 3

1. 
   ОСНОВНАЯ ЧАСТЬ 5
   
   1. 
      Обзор литературы по существующим системам (методам) разработки 5
      
      1. 
         Изучение методов тестирования 6
         
      2. 
         Изучение тестирования в .NET 7
         
      3. 
         Изучение тестирования через TDD 8
         
      4. 
         Изучение тестирования пользовательского интерфейса 8
         
      5. 
         Изучение тестирования базы данных 9
         
   2. 
      Обоснование выбора программного обеспечения 10
      
   3. 
      Разработка нового программного обеспечения 13
      
   4. 
      Составление технического задания на разработку программного обеспечения 14
      
      1. 
         Технологические требования 14
         
      2. 
         Структура и описание системы 15
         
      3. 
         Функционал продукта 15
         

ВВЕДЕНИЕ

Преддипломная практика проходила в период с 13 марта по 5 мая в компании ИП «А-Транс».
Цели преддипломной практики:

1. 
   формирование и развитие практических навыков и компетенций бакалавра, приобретение опыта самостоятельной профессиональной деятельности;
   
2. 
   приобретение студентом инженерно-технических навыков по проектированию и эксплуатации современных информационных систем и технологий;
   
3. 
   углубление, систематизация и закрепление теоретических знаний, полученных при изучении специальных дисциплин;
   
4. 
   приобретение практических навыков инженерной деятельности;
   
5. 
   применение теоретических знаний для решения конкретных практических задач, связанных с процессами передачи, хранения, поиска, обработки и представления информации;
   
6. 
   подбор, систематизация и анализ информационных материалов и подготовка исходных данных для выпускной квалификационной работы;
   
7. 
   проверка профессиональной готовности будущего специалиста к самостоятельной трудовой деятельности.
   

1. 
   сбор практического материала для написания выпускной работы по утвержденной тематике кафедры;
   
2. 
   приобретений навыков устных публичных выступлений (посредством участия в конференциях);
   
3. 
   подготовка выпускной работы бакалавра;
   
4. 
   закрепление и расширение знаний по специальным дисциплинам;
   
5. 
   приобретение студентом практических навыков работы в организации или предприятии по специальности;
   
6. 
   изучение современных методов разработки информационных систем;
   
7. 
   освоение принципов организации и функционирования компьютерных сетей;
   
8. 
   изучение проектных, эксплуатационных материалов и технологических процессов по охране труда на предприятии;
   

1. 
   ОСНОВНАЯ ЧАСТЬ
   

1. 
   Обзор литературы по существующим системам (методам) разработки
   

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

• 
  Методология Agile. Компания использует Agile-методологии разработки ПО, такие как Scrum и Kanban для разработки ПО. Эта методология позволяет быстро и гибко реагировать на изменения в проекте и требованиях заказчика.
  
• 
  Docker используется для управления контейнерами и развертывания приложений. Это позволяет быстро и легко создавать, разворачивать и масштабировать приложения.
  
• 
  Kubernetes используется для оркестрации и управления контейнерами Docker. Это позволяет автоматизировать процесс развертывания и управления масштабированием приложений.
  
• 
  Git используется для управления версиями кода, а также средства непрерывной интеграции и развертывания ПО (CI/CD). Это позволяет командам разработчиков эффективно сотрудничать, отслеживать изменения и управлять кодом.
  
• 
  RabbitMQ используется для обмена сообщениями между различными компонентами приложений. Это обеспечивает гибкую и масштабируемую архитектуру приложений.
  
• 
  TypeScript используется для разработки приложений на JavaScript. TypeScript добавляет статическую типизацию в JavaScript, что повышает удобство и безопасность разработки.
  
• 
  Elasticsearch и Kibana использутся для обработки и анализа больших объемов данных.
  
• 
  .NET является фреймворком для разработки приложений на языках C# и VB.NET, и широко используется во многих компаниях. .NET используется для разработки back-end приложений, API и сервисов, а также для разработки платформы для интеграции платежных методов в веб-сайты и мобильные приложения.
  
• 
  MongoDB является NoSQL базой данных, которая используется для хранения различных типов данных, включая транзакционные данные платежной системы, аналитические данные и данные по производительности. MongoDB является гибкой и масштабируемой базой данных, которая позволяет компании обрабатывать большие объемы данных и быстро реагировать на изменения в условиях рынка.
  

1. 
   Изучение методов тестирования
   

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

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

2. 
   Изучение тестирования в .NET
   

1. 
   Для тестирования в .NET чаще всего используется NUnit фреймворк. NUnit был использован в дипломном проекте в качестве инструмента для тестирования. Данный фреймворк предоставляет множество функций для написания и запуска тестов. Для определения тестируемых методов в NUnit используются атрибуты или аннотации. Каждый тестируемый метод помечается атрибутом [Test]. Классы помечаются атрибутом [TestFixture]. Тестовые значения, передаваемые в метод тестирования помечаются атрибутом [TestCase]. Для части Assert, которая описана ниже, используется готовый класс Assert и его методы. А для набора данных, которые могут быть как в свойстве класса, так и сгенерированы методом, существует атрибут [TestCaseSource].
   
2. 
   В .NET существует негласное правило при написании тестов придерживаться принципа «Arrange-Act-Assert», что значит arrange – подготовка, act – выполнение, assert – проверка.
   
3. 
   В части теста Arrange происходит подготовка тестируемых объектов и данных, здесь инициализируются объекты, сервисы, контроллеры.
   
4. 
   В части Act происходит выполнение тестируемого действия. Здесь вызывается метод, который должен быть протестирован.
   
5. 
   Части Assert служит для проверки полученного результата. В этой части сравнивается значение, полученное из метода, вызванного в Act, и ожидаемое значение. Также могут сравниваться только свойства объектов или даже целые списки объектов.
   
6. 
   Такой принцип помогает проще и понятнее писать тесты, которые в дальнейшем будут легко читаться другими разработчиками. Такой код будет четко структурирован и разбит на понятные компоненты. С первого взгляда на тест будет понятно, что конкретно тестируется.
   

3. 
   Изучение тестирования через TDD
   

Существует подход написания тестов, когда разработка происходит на основании тестов. Такая методология называется TDD (Test-Driven Development) – процесс написания кода через тестирование. То есть сначала пишутся тесты, а уже потом код. Разработчик пишет тесты, которые проверяют всю функциональность системы, после чего разрабатывается код, который должен проходить данные тесты. Процесс разработки начинается с написания тестов, с соблюдением требований, который будет выполнять программа. Затем такие тесты запускаются, они не отработают и завершаться ошибкой, так как код, который необходимо протестировать, еще не существует. Далее разрабатывается минимальный код, который будет удовлетворять тест, но такой код не обязан иметь полный функционал. На данном этапе тест должен заканчиваться без ошибки. Далее код дорабатывается и снова запускается тест, чтобы убедиться в правильности написанного кода.

4. 
   Изучение тестирования пользовательского интерфейса
   

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

5. 
   Изучение тестирования базы данных
   

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

2. 
   Обоснование выбора программного обеспечения
   

Необходимо было создать стабильный монолитный проект, с двумя базами данных, одну для редко изменяемых небольших объектов и другую для постоянно изменяемых, больших объектов. Так был выбран MS SQL Server и MongoDb. Так как команда была не большая, то был выбран подход MVC, с не сложным HTML и CSS, а также фреймворк Bootstrap. Позже был подключен KnockoutJS для удобства отправки данных со специфичных полей и лучшего отображения без перезагрузки страницы. Должно было быть тестирование, так как бизнес код быстро разрастался, и без тестирования было бы просто невозможно проверять весь проект на количество ошибок. Требования были выставлены на основе потребностей проекта:

1. 
   Язык программирования - C#, платформа - .NET framework 4.6;
   
2. 
   Использование проверенных подходов и паттернов;
   
3. 
   REST-архитектура через протокол HTTP;
   
4. 
   Nosql база данных – MongoDb;
   
5. 
   Sql база данных - MS SQL Server;
   
6. 
   Интерфейс - Bootstrap, HTML, CSS;
   
7. 
   Js бибилиотека – KnockoutJS;
   
8. 
   Тестирование (Unit, Integration).
   

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

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

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

• 
  GET – получение данных, чаще всего для отображения списка, карточки и прочего;
  
• 
  POST – отправка данных, обычно это создание или обновление данных в базе данных;
  
• 
  DELETE – удаление данных, удаление данных из базы данных;
  
• 
  PUT – обновление данных, почти тоже что и POST, в основном такие запросы — это обновление данных в базе данных.
  

3. 
   Разработка нового программного обеспечения
   

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

1. 
   Создавать пользователей администраторов
   
2. 
   Создавать пользователей мерчантов
   
3. 
   Создавать сайты для мерчантов
   
4. 
   Настраивать шлюзы (тестовый и боевой)
   
5. 
   Заполнять комиссии для сайтов по шлюзам
   
6. 
   Выгружать историю комиссий
   
7. 
   Создавать пользователей менеджеров
   
8. 
   Закреплять менеджеров за определенными мерчантами и их сайтами, а также распределять доли прибыли от продаж
   
9. 
   Создавать организацию для мерчанта
   
10. 
    Просматривать платежи
    
11. 
    Формировать акты по платежам
    

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

4. 
   Составление технического задания на разработку программного обеспечения
   

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

1. 
   Технологические требования
   

1. 
   Язык программирования - C#, платформа - .NET framework 4.6;
   
2. 
   Использование проверенных подходов и паттернов;
   
3. 
   REST-архитектура через протокол HTTP;
   
4. 
   Nosql база данных – MongoDb;
   
5. 
   Sql база данных - MS SQL Server;
   
6. 
   Интерфейс - Bootstrap, HTML, CSS;
   
7. 
   Js бибилиотека – KnockoutJS;
   
8. 
   Тестирование (Unit, Integration).
   

2. 
   Структура и описание системы
   

Личный кабинет состоит из разделов, каждый из которых выполняет определенный функционал. Разделены перечислены ниже:

• 
  Транзакции – раздел, предоставляющий информацию по транзакциям;
  
• 
  Мерчанты – раздел для работы с данными мерчантов;
  
• 
  Сайты – раздел для работы с данными сайтов мерчантов;
  
• 
  Менеджеры – раздел для настройки менеджеров;
  
• 
  Организации – раздел для настройки организаций;
  
• 
  Акты – раздел для создания актов.
  

3. 
   Функционал продукта
   

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

1. 
   «Транзакция» - отображает основные данные о транзакции;
   
2. 
   «Комиссии» - отображает комиссии, которые были взять с платежа;
   
3. 
   «Json» - отображает json-файл транзакции.
   

1. 
   «Информация» - отображает основные данные о мерчанте и позволяет настроить разные параметры для него, ниже расположены сайты мерчанта и приложения;
   
2. 
   «Организации» - отображает список организаций, закрепленных за мерчантом, и позволяет создать новую;
   
3. 
   «Пользователи» - отображает информацию об учетной записи мерчанта, нажатие на логин открывает карточку пользователя мерчанта, где можно изменить данные об этом пользователе.
   

1. 
   «Информация» - отображает основные данные о сайте, менеджеров сайта и комиссии на шлюзах;
   
2. 
   «Уведомления» - отображает и позволяет настроить отправку уведомлений для сайта;
   
3. 
   «Шлюз 1» - отображает и позволяет настроить шлюз и комиссии для шлюза, данный шлюз является тестовым;
   
4. 
   «Шлюз 2» - отображает и позволяет настроить шлюз и комиссии для шлюза, данный шлюз является боевым.
   

ЗАКЛЮЧЕНИЕ

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

Преддипломная практика в компании ИП "А-Транс" позволила получить ценный опыт и подготовиться к самостоятельной трудовой деятельности в области информационных технологий.

1. 
   Документация по .NET - https://learn.microsoft.com/ru-ru/dotnet/
   
2. 
   Документация по C# - https://learn.microsoft.com/ru-ru/dotnet/csharp/
   
3. 
   Документация MongoDB - https://www.mongodb.com/
   
4. 
   Документация по MS SQL - https://learn.microsoft.com/en-us/sql/?view=sql-server-ver16
   
5. 
   Wikipedia - https://en.wikipedia.org
   
6. 
   Рефакторинг, паттерны, принципы SOLID - https://refactoring.guru/ru
   
7. 
   Сайт по программированию - https://habr.com/
   
8. 
   Документация Bootstrap - https://getbootstrap.com/docs/5.3/getting-started/introduction/
   
9. 
   Сайт о программировании - https://www.w3schools.com/
   
10. 
    Документация Knockout.js - https://knockoutjs.com/
    
11. 
    Мартин Р. С. Чистый код: создание, анализ и рефакторинг., Пер.с англ. – Спб.: изд. Питер,- 2019. – 464 с.
    
12. 
    Документация по ASP.NET - https://dotnet.microsoft.com/en-us/apps/aspnet/mvc
    
13. 
    Мартин Р. С. Принципы, паттерны и методики гибкой разработки на языке C#., Пер.с англ. – Спб.: Символ Плюс,- 2017. – 768 с.
    
14. 
    В.А. Полежаев, А.И. Андрианов, А.С. Хританков Проектирование на UML. Сборник задач. 3-е изд., стер. – М.; Берлин, - 2018. – 240 с.
    
15. 
    Леоненков А. В. Самоучитель UML 2. 2-е изд. – СПб.: БХВ-Петербург, - 2016. – 576 с
    
16. 
    Сайт о программировании - https://metanit.com/sharp/
    
17. 
    Практическое руководство по созданию UML-диаграмм - https://flexberry.github.io/ru/gpg_practical-guides-uml.html
    
18. 
    Тидвелл Дженифер, Брюэр Чарли, Валенсия Эйнн. Разработка интерфейсов. Паттерны проектирования. 3-е изд. – СПб.: Питер, - 2022. – 560 с.
    
19. 
    Гриффитс Иэн. Программируем на C# 8.0. Разработка приложений. – СПб: Питер, - 2021. - 944 с.
    
20. 
    Кэмпбелл Лейн, Мейджорс Черити. Базы данных. Инжиниринг надежности. – СПб.: Питер, - 2020. – 304 с.