Разработка веб-приложения для построения списка источников

Размещено на http://www.allbest.ru/

• Содержание
• Введение
• 1. Аналитическая часть

1.1 Характеристика предметной области

1.2 Обзор аналогов

2. Проектная часть

2.1 Формирование технического задания на разработку веб-приложения по формированию списка литературы

2.2 Проектирование веб-сервиса по составлению списка источников

2.3 Проектирование базы данных

3. Практическая часть

3.1 Инструменты разработки

3.2 Разработка приложения

3.3 Руководство пользователя

Заключение

Список использованных источников

Приложение

Введение

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

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

Объектом выпускной квалификационной работы является процесс формирования списка источников. Предметом - автоматизация процесса по формированию источников. Цель работы: разработка веб-приложения для построения списка источников.

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

1. Провести анализ предметной области.

2. Сделать обзор существующих сервисов и программных продуктов для построения списка источников.

3. Спроектировать веб-приложение для формирования списка источников.

4. Спроектировать базу данных для приложения.

5. Разработать веб-приложение с использованием фреимворка Laravel и базу данных.

6. Протестировать работоспособность приложения.

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

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

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

1. Аналитическая часть

1.1 Характеристика предметной области

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

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

Согласно статистическим данным за 2016-2019 годы, научными исследованиями в России занимаются порядка семисот тысяч человек, в высших учебных заведениях и средне специальных учебных заведениях обучаются порядка пяти миллионов человек. Всем указанным людям необходимо в ходе своей учебной или научной деятельности оформлять списки источников к работам.

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

Пример библиографической записи для монографии: Дейт, Кр. Дж. Введение в системы баз данных / Кр. Дж. Дейт. - М.: Вильямс, 2019. - 1328 с. - ISBN 978-5-907144-17-0. - Текст: непосредственный. Характеристика составляющих частей библиографической записи приведена в таблице 1.

Таблица 1 - Характеристика библиографической записи

Часть записи	Пример
Заголовок	Дейт, Кр. Дж.
Основное заглавие	Введение в системы баз данных
Сведения, относящиеся к заглавию	-
Первые сведения об ответственности	Кр. Дж. Дейт.
Место публикации	М.
Имя издателя	Вильямс
Дата	2019
Объем	1328
Международный стандартный номер	ISBN 978-5-907144-17-0
Вид содержания	Текст
Средство доступа	непосредственный

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

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

1.2 Обзор аналогов

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

SNOSKA.INFO - веб-сервис, позволяющий оформлять библиографические ссылки. Помимо раздела с непосредственным оформлением источников, ресурс содержит ссылки на ГОСТы, раздел с ответами на вопросы, статьи на тему оформления списка источников. Внешний вид ресурса представлен на рисунке 6.

Рисунок 6 - SNOSKA.INFO, заполнение анкеты

Для оформления источника с помощью SNOSKA.INFO необходимо ответить на вопросы, разделенные на два блока. Вопросы из первого блока являются обязательными и позволяют получить информацию о типе источника, количестве авторов, предназначении источника (ссылка, пункт списка литературы).

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

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

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

Сервис SPISOK.XYZ разделяет оформляемые источники на следующие группы изданий:

- книги от одного до трех авторов;

- книги от четырех авторов;

- статьи, количество авторов от одного до трех

- статьи с четырьмя и более авторами

- электронные ресурсы.

Внешний вид сервиса показан на рисунке 7.

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



Рисунок 7 - Сервис SPISOK.XYZ

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

Zotero - свободно распространяемое настольное программное обеспечение для оформления ссылок. Внешний вид приведен на рисунке 8.

Рисунок 8 - Интерфейс Zotero

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

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

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

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

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

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



Рисунок 9 - Веб-сервис Mendeley.com, распознавание данных книги

MS Office Word позволяет создавать ссылки на источники, писки литературы в документах. Работа со списками источников осуществляется через пункт меню «Ссылки» (рисунок 10).

Рисунок 10 - MS Office Word, создание списка источников

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

1.3 Выбор модели жизненного цикла программного обеспечения

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

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

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

- Модель кодирования и устранения ошибок - наименее гибкая модель, применима только для простейших программ.

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

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

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

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

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

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

- Традиционные;

- Гибкие.

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

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

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

2. Проектная часть

2.1 Формирование технического задания на разработку веб-приложения по формированию списка литературы

Процесс разработки программного обеспечения регламентируется с помощью технического задания - документа, в котором указано [1-5]:

- назначение разрабатываемого продукта;

- функции, которые программа должна выполнять;

- список требований к программному продукту;

- регламент по внедрению программного продукта;

- требования к документированию этапов проектирования и разработки программного продукта.

Полный состав технического задания определяет ГОСТ 34.601-90. Для формирования списка требований к программному продукту необходимо построить модель процесса, который будет автоматизирован с помощью разрабатываемого программного обеспечения.

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

Для моделирования процессов используются CASE (Computer-Aided Software Engineering)-средства [5-9] - специальное программное обеспечение, предназначенное для проектирования программных продуктов, процессов и т.д. В данной работе, для моделирования процесса по формированию списка источников использован ERWIN Process Modeler [9-14].

Для построения модели использована структурная методология IDEF0, позволяющая представить процесс в виде иерархической системы диаграмм. На верхнем уровне иерархии расположена контекстная диаграмма нулевого уровня, отображающая процесс как единое целое, взаимодействующее с окружающей средой [15-19].

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

Контекстная диаграмма нулевого уровня для процесса «построение списка источников» показана на рисунке 1.

Рисунок 1 - Контекстная диаграмма нулевого уровня

В левой части диаграммы расположены входные данные [20-24], к которым относятся сведения об источнике, к которым относятся автор, название, издательство, место публикации, объем, тип источника и т.д.

В правой части - выходные данные [25-30] - результат обработки входных данных. Сверху располагается управление - нормативные документы, регламентирующие ход выполнения работ процесса, объем списка. Внизу расположены механизмы - персонал, выполняющий работы моделируемого процесса и используемые ими инструменты.

Детализация контекстной диаграммы нулевого уровня показана на рисунке 2.

Рисунок 2 - Детализация контекстной диаграммы нулевого уровня

Как видно из рисунка 2, моделируемый процесс состоит из следующих работ:

- выбор источников - определение перечня источников, содержащих информацию по исследуемой проблеме;

- изучение ГОСТов;

- формирование списка источников согласно требованиям из ГОСТов.

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



Рисунок 3 - Детализация подпроцесса «Выбор источников»

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

На рисунке 4 показана детализация для подпроцесса «Формирование списка источников». Указанный подпроцесс заключается в получении данных об источнике (автор, название, издательство, год издания, количество страниц, тип и т.д.) и последующего оформления согласно ГОСТам.

Как видно из рисунка 4, формирование списка состоит из получения данных по источникам и их оформления согласно шаблону из ГОСТов.

Программный продукт для составления списка источников должен быть реализован в виде веб-приложения. Работа с веб-приложением должна осуществляться через браузер.

В приложении должны быть реализованы следующие функции:

- просмотр источников, хранящихся в базе данных;

- поиск по ключевым словам среди источников;

- добавление нового источника;

- оформление источника согласно шаблону;

Рисунок 4 - Детализация для подпроцесса «Формирование списка источников»

- транслитерация информации об источнике;

- формирование собственного списка из источников, хранящихся в базе данных.

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

Необходимо создать две роли пользователей: «Гость» и «Администратор». Гостевому пользователю доступны поиск данных, просмотр и формирование собственного списка. Администратору - редактирование и удаление источников.

Страницы веб-приложения должны корректно отображаться в современных браузерах: Google Chrome, Mozilla Firefox, Edge, IE10+, Opera, Safari [31-33].

Структура веб-приложения должна быть построена с использованием паттерна MVC, фреимворка Laravel 5x. При построении интерфейса необходимо использовать типовые элементы (кнопки, текстовые поля, выпадающие списки, ссылки и т.д.) со стандартным назначением.

2.2 Проектирование веб-сервиса по составлению списка источников

Для проектирования веб-приложения использованы диаграммы объектно-ориентированного языка моделирования UML (Unified Modelling Language) [34-38]. UML-диаграммы позволяют построить модель любого процесса или системы, охарактеризовав деятельность и структуру моделируемого объекта.

В данной работе выбран объектно-ориентированный подход при моделировании веб-приложения, так как данный подход позволяет строить модели, максимально близкие к сущностям реального мира. Данные и методы, используемые при их обработке, объединяются в единую сущность (класс), что позволяет создавать легко воспринимаемую структуру проектируемой системы. Одна из основных концепций ООП - инкапсуляция - позволяет управлять доступом к объектам системы, обеспечивая их безопасность и согласованность работы.

Диаграмма классов [38-44] отображает структуру проектируемого программного обеспечения на уровне классов. На диаграмме отображаются атрибуты и методы классов связи между классами. Диаграмма классов для веб-сервиса по формированию списка источников приведена на рисунке 5.

Как видно из рисунка, проектируемая система содержит следующие классы:

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

- Author - автор источника;

- Attribute - атрибут источника, перечень атрибутов зависит от типа источника;



Рисунок 5 - Диаграмма классов

- SourceType - тип источника (книга, журнальная статья и т.д.);

- OfficialSource - источник публикации (используется для нормативных документов: законы, постановления и т.д.).

Веб-приложение предполагает работу следующих ролей пользователей:

- Гость;

- Администратор.

На рисунке 6 приведена диаграмма вариантов использования, показывающая функции приложения для роли «Гость».

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

Администратор редактирует данные источников, удаляет источники из базы данных системы, при необходимости. Для доступа к личному кабинету администратора необходимо пройти авторизацию. Для открытия формы авторизации администратору необходимо указать название страницы с формой авторизации в адресной строке браузера (рисунок 7).



Рисунок 6 - Диаграмма вариантов использования (гостевой пользователь)

Рисунок 7 - Диаграмма вариантов использования (администратор)

Так как авторизация используется только для администраторов, создавать ссылку на нее в общедоступном интерфейсе (доступном для гостевых пользователей) нецелесообразно.

Для описания алгоритмов, по которым пользователи взаимодействуют с приложением, использованы диаграммы активности [45-48]. Диаграммы активности, демонстрирующие работу гостевого пользователя и администратора приведены на рисунках 8 и 9 соответственно.

Рисунок 8 - Диаграмма активности (работа гостевого пользователя)



Рисунок 9 - Диаграмма активности (работа администратора)

Для отображения взаимодействия физических компонент разрабатываемого веб-приложения с внешними пользователями используется UML-диаграмма развертывания (рисунок 10).

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

Рисунок 10 - Диаграмма развертывания

2.3 Проектирование базы данных

Проектирование структуры базы данных происходит в два этапа [17, 48-50]:

- построение концептуальной модели;

- построение логической модели.

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

Для построения концептуальной модели использована нотация Чена. Использование нотации Чена позволяет отобразить модель данных в абстрактном виде без привязки к определенным инструментам разработки, типам баз данных. Модель, построенная с помощью нотации Чена [21, 24] позволяет наглядно отобразить связи между сущностями предметной области, для ее понимания не нужны специализированные знания.

Концептуальная модель для базы данных веб-приложения по формированию списка источников приведена на рисунке 11.

Рисунок 11 - Концептуальная модель предметной области

Как видно из рисунка 11, основными сущностями предметной области являются:

- Источник - пункт списка литературы в работе;

- Тип источника - книга, статья в журнале, электронный ресурс и другие типы, к которым может быть отнесен источник;

- Автор - автор источника выделен в отдельную сущность, так как авторов может быть несколько, а также, один автор может создать несколько источников;

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

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

Логическая модель базы данных приведена на рисунке 12.

Рисунок 12 - Логическая модель базы данных

Как видно из рисунка 12, на логической модели разделены связи типа «многие-ко-многим» с помощью создания дополнительных сущностей. Для хранения данных об источниках публикации нормативных актов добавлена таблица-справочник OfficialSources. Для разработки базы данных будет использована реляционная СУБД MySQL 8. Характеристики атрибутов, представленных на логической модели, приведены в таблицах 1-7.

Таблица SourceAuthors используется для разделения связи «многие-ко-многим» между таблицами Sources и Authors, так как у источника может быть несколько авторов, один автор может относится к нескольким источникам.

Таблица 1 - Authors (Авторы)

Название столбца	Тип данных	Описание
AuthorID	Int(10)	Идентификатор автора, первичный ключ
Lastname	Varchar(80)	Фамилия автора
Name	Varchar(80)	Имя автора
Patronymic	Varchar(80)	Отчество автора

Таблица 2 - Sources (Источники)

Название столбца	Тип данных	Описание
SourceID	Int(10)	Идентификатор источника, первичный ключ
Title	Varchar(255)	Название источника
TypeID	Int(10)	Номер типа источника, внешний ключ
OSID	Int(10)	Номер официального источника публикации (СМИ), внешний ключ

Таблица 3 - SourceAuthors (Авторы источника)

Название столбца	Тип данных	Описание
AuthorID	Int(10)	Номер автора, внешний ключ, часть составного первичного ключа
SourceID	Int(10)	Номер источника, внешний ключ, часть составного первичного ключа

Таблица 4 - OfficialSources (Официальные средства публикации (СМИ))

Название столбца	Тип данных	Описание
OSID	Int(10)	Идентификатор средства публикации, первичный ключ
OSTitle	Varchar(80)	Название средства публикации

Таблица 5 - SourceTypes (Типы источников)

Название столбца	Тип данных	Описание
TypeID	Int(10)	Идентификатор типа, первичный ключ
TypeTitle	Varchar(100)	Название типа источника (книга, статья и т.д.)

Таблица 6 - SourceAttributes (Характеристики источника)

Название столбца	Тип данных	Описание
AttrID	Int(10)	Номер характеристики, внешний ключ, часть составного первичного ключа
SourceID	Int(10)	Номер источника, внешний ключ, часть составного первичного ключа

Таблица SourceAttributes используется для разделения связи типа «многие-ко-многим» между Sources и Attributes: один источник может обладать несколькими атрибутами, один атрибут соответствует нескольким источникам. Перечень атрибутов источника зависит от его типа.

Таблица 7 - Attributes (Характеристики)

Название столбца	Тип данных	Описание
AttrID	Int(10)	Идентификатор характеристики, первичный ключ
Year	Int(10)	Год публикации источника
Place	Varchar(100)	Место публикации
Link	Varchar(300)	Ссылка на электронный источник
Journal	Varchar(300)	Название журнала
Publishing	Varchar(100)	Издательство
JournalNumber	Varchar(20)	Номер журнала
Volume	TinyInt(3)	Том журнала
Pages	Varchar(20)	Страницы (количество или диапазон)
PublishingYear	Int(10)	Год публикации СМИ с источником
OSNumber	Varchar(20)	Номер средства публикации
OSArticleNumber	Int(10)	Номер статьи в средстве публикации
TitleKnowledge	Varchar(80)	Сведения, относящиеся к заглавию
ISBN	Varchar(40)	Международный стандартный номер
Access	Varchar(40)	Средство доступа

3. Практическая часть

3.1 Инструменты разработки

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

Для настройки элементов для тегов указываются атрибуты. Атрибуты бывают общими - используются для всех тегов, и частными - используются только для определенных тегов [19, 22].

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

Для ускорения процесса создания стилей оформления используются препроцессоры. Препроцессор SASS позволяет создавать переменные для хранения значений размеров, цветов и т.д., создавать миксины для повторного использования кода и т.д. Код, написанный с помощью препроцессора, компилируется в CSS-стили, которые уже подключаются к файлу со структурой страницы [16, 37].

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

При разработке приложений, как правило, не используют исключительно средства языка программирования. Для ускорения процесса разработки используют различные библиотеки и фреимворки. В данной работе использован фреимворк Laravel. Laravel - свободно распространяемый фреимворк, позволяющий строить веб-приложения по структуре MVC, подключать различные компоненты, взаимодействовать с базой данных, оптимизировать загрузку подключаемых файлов [29, 35].

Структурный паттерн MVC (рисунок 12) - Model-View-Controller - позволяет разделять код веб-приложения на следующие компоненты:

- Model - модель, содержит данные, которые обрабатываются в приложении, также может содержать ограничения на данные;

- View - представление, графический интерфейс пользователя, как правило, веб-интерфейс;

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

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

Использование MVC позволяет разделять код на независимые модули, благодаря чему возможна модернизация одного из модулей, не затрагивающая остальные части приложения [1, 18].



Рисунок 12 - Структура MVC

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

Классы создаются разработчиками на основе сущностей предметной области. Класс может быть построен на основе уже существующего с помощью наследования. Класс-наследник обладает всеми методами и полями родительского и, при необходимости, дополняет функциональность родительского класса собственными методами и полями. Наследование позволяет избежать дублирования кода [34, 47].

Для управления доступом к содержимому классов используются специальные модификаторы, позволяющие скрывать (инкапсулировать) поля или методы от других объектов. Инкапсуляция позволяет обеспечить безопасность для хранимых данных, скрыть детали реализации объекта.

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

3.2 Разработка приложения

Разработка веб-приложения начинается с установки Laravel выбранной версии в каталог проекта. Для установки компонентов Laravel используется менеджер пакетов для PHP - Composer. Работа с Composer осуществляется через командную строку. Для создания Laravel-проекта необходимо перейти в каталог на веб-сервере, предназначенный для файлов веб-приложений и выполнить следующую команду:

Composer create-project -prefer-dist Laravel/Laravel Links 5.4.23

В результате выполнения указанной команды создается каталог с названием Links (каталог проекта) и в него устанавливаются компоненты Laravel. Выбранная версия Laravel: 5.4.23.

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

Выбор контроллера, который должен использоваться для обработки запроса, осуществляет маршрутизатор (route). Маршрутизатор представляет собой php-файл, в котором прописаны зависимости для url-адресов и соответствующих им контроллеров. В Laravel 5.4 маршрутизатор имеет название web.php, располагается в корне каталога routes. Фрагмент web.php приведен в листинге 1:

Листинг 1: фрагмент web.php

Route::get('/about', 'PagesController@about');

Route::get('/services', 'PagesController@services');

Route::get('/', 'PagesController@index');

Route::resource('sources', 'SourcesController');

Для установки соответствия между url-адресом и контроллером используется класс Route. В зависимости от типа запроса (get, post) для установки соответствия используются методы get или post. Метод resource позволяет сгенерировать базовые зависимости для контроллера без необходимости указания маршрута с использованием get или post для каждого метода контроллера.

Строка «'/about', 'PagesController@about'», указанная в качестве списка параметров методов get (а также post) означает, что при переходе по url-адресу «/about» будет выполнен метод about контроллера PagesController. Для resource указывается только имя контроллера, так как маршруты будут автоматически сгенерированы для всех методов контроллера.

Контроллеры проекта располагаются в каталоге app/http/controllers. Все создаваемые контроллеры должны является наследниками от класса Controller, создаваемого при установке Laravel, для доступа ко всем возможностям, предоставляемым Laravel контроллерам. Количество контроллеров, а также создаваемые в них методы, определяются решаемой задачей. Существует соглашение по именованию классов-контроллеров. Согласно которому в конце имени каждого контроллера должно указываться слово «Controller».

Для создания контроллеров целесообразно использовать командный интерфейс artisan, включенный в Laravel. Команда для создания контроллера PagesController с помощью artisan выглядит следующим образом: php artisan make:controller PagesController

Запуск команд artisan осуществляется через командную строку.

Контроллер содержит методы, которые вызываются при обращении к url-адресу, связанному с данным методом. Метод about контроллера PagesController, открывающий главную страницу веб-приложения, приведен в листинге 2.

Листинг 2 - Метод, открывающий страницу с описанием работы сайта

Public function about() {

$title = 'Как работает сервис';

return view('pages.about')->with('title', $title);

}

Метод about вызывает представление about, расположенное в каталоге resources/views/pages и передает параметр title, содержащий заголовок страницы.

Источником данных, передаваемых контроллерами представлениям, являются модели. Модели располагаются в корне каталога app. Модель представляет собой класс, предназначенный для взаимодействия с соответствующей таблицей базы данных. Для создания моделей используется artisan: php artisan make:model Source -m

Source -имя модели, ключ -m позволяет вместе с классом модели создать миграцию - php-скрипт, позволяющий создать таблицу в базе данных. Использование миграций позволяет работать с базой данных напрямую из редактора кода, без обращения к клиенту СУБД. Каждая миграция вносит определенные изменения в структуру текущей базы данных. В случае совершения ошибки, миграция может быть отменена. Миграция содержит методы up и down, позволяющие выполнить или откатить миграцию соответственно. Методы up и down для миграции, создающей таблицу Sources, приведены в листинге 3.

Листинг 3 - Миграция для создания таблицы Sources

public function up() {

Schema::create('sources', function (Blueprint $table) {

$table->increments('id');

$table->string('title');

$table->timestamps();

});

}

Public function down() {

Schema::dropIfExists('sources');

}

В методе create указываются поля таблицы и их типы данных, название таблицы, включаются/отключаются временные метки и т.д. Для того, чтобы указать связь с другой таблицей, необходимо в классе модели создать метод, указывающий на связываемую таблицу, а также кратность связи. Методы, предназначенные для установления связи «один-ко-многим» между таблицами sourcetypes и sources соответственно, приведены в листинге 4.

Листинг 4 - Методы для установления связи между таблицами sourcetypes и sources

// расположен в модели SourceType

public function source() {

return $this->belongsTo('App\Source');

}

// расположен в модели Source

public function sourcetype() {

return $this-> hasMany('App\SourceType');

}

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

- DB_CONNECTION - поставщик драйвера для работы с СУБД, в данном случае, mysql;

- DB_HOST - адрес хоста, на котором расположен сайт;

- DB_PORT - номер порта для СУБД, значение для MySQL: 3306;

- DB_DATABASE - имя базы данных, в данном случае: links;

- DB_USERNAME - имя пользователя для подключения к базе данных;

- DB_PASSWORD - пароль для пользователя СУБД.

Команда artisan, предназначенная для запуска миграций, выглядит следующим образом:

php artisan migrate

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

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

Код функции сохранения данных в файл приведен в листинге 5.

Листинг 5 - Сохранение в файл

public function save_file_list($data) {

$file = 'list.txt'; // имя файла

$items = serialize($data); // сериализация - строковое представление данных

file_put_contents($file, $items); //запись в файл list.txt

}

Сформированный пользователем список передается функции save_file_list в виде параметра $data. Название файла задается в теле функции с помощью переменной $file.

Код, отвечающий за работу функции поиска, приведен в листинге 6.

Листинг 6 - Поиск данных

public function search($search) {

$sources = DB::table('sources')

->selectRaw('title * ? || author * ? || publishing * ? || source_type * ?', [$search])

->get();

return view('sources.index')->with('sources', $sources);

}

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

В листинге 6 приведен фрагмент функции, отвечающей за оформление пункта списка источников, по шаблону.

Листинг 6 - Шаблоны

switch ($item) {

case 0:

// монография с одним автором

echo $author.” “.$title.” : “.$titleinf.” /“.$respons.”. - ”.$place.”: “.$publishing.”, “.$year.”. - “.$pages.” . - ”.$ISBN.” “.$type.” “.$val;

break;

//диссертация

case 1:

echo $author.” “.$title.” : “.$spec.” диссертация на соискание ученой степени”;

break;

// статья из журнала

case 2:

echo $author.” “.$title.” : “.$titleinf.” /“.$respons.”. “.$type.” “.$val.” //“.$journal “.$year.” “.$volume.”. - “.$pages.”;

break;

Данные для заполнения шаблонов указываются пользователем при заполнении формы. Данные проходят предварительную проверку.

3.3 Руководство пользователя

При открытии веб-приложения по формированию списка источников, пользователь попадает на главную страницу (рисунок 13).

Рисунок 13 - Главная страница приложения

Главная страница содержит навигационную панель, краткое описание сервиса и кнопку «Начать», при нажатии на которую пользователь перемещается на страницу со списком источников, находящихся в базе данных на текущий момент (рисунок 14).

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

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



Рисунок 14 - Страница с источниками

Кнопка «Сохранить файл» позволяет создать текстовый файл с выбранными источниками и, при необходимости, провести транслитерацию.

После сохранения файла со списком, пользователь видит следующее сообщение (рисунок 15):

Рисунок 15 - Сохранение файла

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

Форма для добавления книги приведена на рисунке 16.



Рисунок 16 - Форма для добавления книги

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

Рисунок 17 - Форма обратной связи

Страница с описанием работы с сервисом приведена на рисунке 18.

Рисунок 18 - Инструкция по работе с сервисом

На рисунке 19 показан личный кабинет администратора сервиса. Задача администратора - поддержание базы данных в актуальном состоянии.

Рисунок 19 - ЛК администратора сервиса

Как видно из рисунка 19, помимо поиска и просмотра данных, администратору доступны удаление и редактирование данных источников для сохранения актуальности и достоверности данных в базе.

Заключение

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

В данной выпускной квалификационной работе проведена разработка веб-приложения для формирования списка источников. Для разработки использованы следующие инструменты:

- язык разметки HTML;

- каскадные таблицы стилей CSS, фреимворк Bootstrap 4;

- язык программирования PHP;

- фреимворк Laravel, версия 5.4;

- структурный паттерн MVC;

- СУБД MySQL.

В ходе выполнения выпускной квалификационной работы решены следующие задачи:

1. Проведен анализ предметной области.

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

3. Спроектировано веб-приложение для формирования списка источников и база данных.

4. Разработано веб-приложение с использованием фреимворка Laravel, паттерна MVC.

5. Продемонстрирована работоспособность веб-приложения.

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

Список использованных источников

1. Ташков П. Веб-мастеринг HTML, CSS, JavaScript, PHP, CMS, AJAX, раскрутка / П. Ташков. - М.: Книга по Требованию, 2014. - 512 c.

2. Кьоу Дж. Объектно-ориентированное программирование / Дж. Кьоу, М. Джеанини. - М.: Питер, 2015. - 240 c.

3. Макдональд М. Веб-разработка. Исчерпывающее руководство. / М. Макдональд - СПб.: Питер, 2017. - 640 с.

4. Веллинг Л. Разработка веб-приложений с помощью PHP+MySql. / Л. Веллинг - М.: Вильямс, 2016. - 848 с.

5. Дакетт Дж. Javascript и JQuery. Интерактивная веб-разработка. / Дж. Дакетт - М.: Эксмо, 2017. - 640 с.

6. Зандстра М. PHP. Объекты, шаблоны и методики программирования / М. Зандстра/ - М.: Вильямс, 2016. - 576 с.

7. Котеров Д. PHP 5. / Д. Котеров - СПб.: БХВ-Петербург, 2016. - 1104 с.

8. Локхарт Дж. Современный PHP. Новые возможности и передовой опыт. / Дж. Локхарт - М.: ДМК Пресс, 2016. - 305 с.

9. Маклафлин Б. PHP и MySql. Исчерпывающее руководство. / Б. Маклафлин - СПб.: Питер, 2016. - 544 с.

10. Никсон Р. Создаем динамические веб-сайты с помощью PHP, MySQL, JavaScript, CSS и HTML5. / Р. Никсон - СПб.: Питер, 2016. - 688 с.

11. Рассел Дж. Веб-разработка. / Дж. Рассел - М.: Книга по Требованию, 2016. - 98 с.

12. Фленаган Д. JavaScript. Карманный справочник. / Д. Фленаган - М.: Вильямс, 2015. - 320 с.

13. Хоган Б. HTML5 и CSS3. Веб-разработка по стандартам нового поколения. / Б. Хоган - СПб.: Питер, 2015. - 272 с.

14. Христосенко М. Бизнес-сайт. / М. Христосенко - СПб.: Питер, 2015. - 176 с.

15. Чаффер Дж. Изучаем JQuery. Эффективная веб-разработка на JavaScript. / Дж. Чаффер - М.: Символ-Плюс, 2015. - 448 с.

16. Атре Ш. Структурный подход к организации баз данных. / Ш. Атре - М.: Финансы и статистика, 2015. - 320 с.

17. Бадд Т. Объектно-ориентированное программирование в действии / Т. Бадд М.: Питер. 2016. - 400 c.

18. Конолли Т. Базы данных. Проектирование, реализация и сопровождение. Теория и практика. / Т. Конолли, К. Бегг - М.: Вильямс, 2017. - 1440 с.

19. Грабер М. Введение в SQL. / М. Грабер - М.: Лори, 2014. - 379 с.

20. Mysql Documentation

21. Дейт К. Введение в системы баз данных / К. Дейт - М.: Юрайт, 2014. - 784 с.

22. Боуман Д., Практическое руководство по SQL./ Д. Боуман, С. Эмерсон, М. Дарновски - М.: Мир, 2015. - 328 с.

23. Ховард М. Как написать безопасный код на С++, Java, Perl, PHP, ASP. NET. / М. Ховард, Д. Лебланк, Дж. Виега - ДМК Пресс - М., 2014. - 288 c.

24. Дронов В.А. Laravel. Быстрая разработка современных динамических Web-сайтов на PHP, MySQL, HTML и CSS / Дронов В.А. - М.: БХВ-Петербург, 2018. - 160 c.

25. Никсон Р. Создаем динамические веб-сайты с помощью PHP, MySQL, JavaScript, CSS и HTML5 / Р. Никсон. - М.: Питер, 2015. - 447 c.

26. Никсон Робин Создаем динамические веб-сайты с помощью PHP, MySQL, JavaScript, CSS и HTML5 / Робин Никсон. - М.: Питер, 2016. - 768 c.

27. Бардзелл Дж. Macromedia Dreamweaver MX 2004 с ASP, ColdFusion и PHP. Из первых рук (+ CD-ROM) / Дж. Бардзелл - Эком - М., 2016. - 560 c.

28. Бенкен Е. PHP, MySQL, XML. Программирование для Интернета / Е. Бенкен. - БХВ-Петербург - М., 2017. - 336 c.

29. Гизберт Д. PHP и MySQL / Д. Гизберт. - НТ Пресс - М.: 2016. - 569 c.

30. Дронов В. PHP, MySQL и Dreamweaver. Разработка интерактивных Web-сайтов / В. Дронов. - БХВ-Петербург - М.: 2016. - 480 c.

31. Дунаев В.В. HTML, скрипты и стили / В.В. Дунаев. - БХВ-Петербург - М.: 2017. - 527 c.

32. Жадаев А. PHP для начинающих / А. Жадаев. - Питер - М.: 2016. - 768 c.

33. Колисниченко Д. PHP и MySQL. Разработка Web-приложений / Д. Колисниченко. - БХВ-Петербург - М., 2017. - 560 c.

34. Кузнецов М. PHP 5. Практика создания Web-сайтов / М. Кузнецов. - БХВ-Петербург - М.: 2017. - 960 c.

35. Кузнецов М. Самоучитель PHP 5/ М. Кузнецов. - БХВ-Петербург - М., 2017. - 560 c.

36. Кузнецов М. Самоучитель PHP 5/6/ М. Кузнецов. - БХВ-Петербург - М.: 2017. - 972 c.

37. Локхарт Дж. Современный PHP. Новые возможности и передовой опыт / Дж. Локхарт. - ДМК Пресс - М.: 2016. - 304 c.

38. Ляпин Д.А. PHP -- это просто. Начинаем с видеоуроков (+ CD-ROM) / Д.А. Ляпин. - БХВ-Петербург - М.: 2017. - 881 c.

39. Никсон Р. Создаем динамические веб-сайты с помощью PHP, MySQL, JavaScript и CSS / Р. Никсон. - Питер - М.: 2017. - 204 c.

40. Сафронов М. Разработка веб-приложений в Yii 2 / М. Сафронов. - ДМК Пресс - М.: 2016. - 392 c.

41. Скляр Д. PHP. Рецепты программирования / Д. Скляр. - Питер - М.: 2017. - 784 c.

42. Фленов М. PHP глазами хакера / М. Фленов. - БХВ-Петербург - М., 2016. - 991 c.

43. Хадсон П. PHP. Справочник / П. Хадсон. - КУДИЦ-Пресс - М.: 2016. - 448 c.

44. Харрис Э. PHP/MySQL для начинающих / Э. Харрис. - КУДИЦ-Образ - М.: 2016. - 384 c.

45. Гудман Д. JavaScript и DHTML. Сборник рецептов. Для профессионалов / Д. Гудман. - М.: Питер, 2015. - 523 c.

46. Квинт И. Создаем сайты с помощью HTML, XHTML и CSS / И. Квинт. - М.: Питер, 2014. - 448 c.

47. Лазаро И. Полный справочник по HTML, CSS и JavaScript / И. Лазаро. - М.: ЭКОМ Паблишерз, 2014. - 938 c.

48. Титтел Э. HTML, XHTML и CSS для чайников / Э. Титтел. - М.: Диалектика, 2013. - 400 c.

49. Фримен Э. Изучаем HTML, XHTML и CSS / Э. Фримен. - М.: Питер, 2016. - 720 c.

50. Шафер С. HTML, XHTML и CSS. Библия пользователя / С. Шафер. - Москва: СИНТЕГ, 2015. - 656 c.

программный фреимворк веб приложение

Приложение А

Исходный код

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class BooksController extends Controller

...