Actions
Надо сделать #163
closed
Доработка и улучшения
Status:
Закрыта
Priority:
Нормальный
Assignee:
Category:
Прочее
Target version:
Tags:
Issue closed :
11/19/2019
Description
Выполнить различные доработки и улучшения согласно списку задач. Данный список будет пополняться по мере необходимости.
- Вынести настройки базы данных PostgreSQL во внешний файл - для более гибкой настройки желательно вынести настройки подключения к БД во внешний файл и подгружать его во время запуска программы.
- Режимы запуска программы:
- Режим demo - в данном режиме программа запускается со встроенное БД H2 с заранее инициализированным набором данных. Данный режим предоставляет возможность ознакомиться с работой программы.
- Режим production - в данном режиме программе необходим доступ к БД PostgreSQL, для этого нужно указать параметры подключения к БД.
- Отладочный режим - в данном режиме будет выводиться более подробная информация по совершаемым действиям в программе. Этот режим является опцией для основных режимов demo и production.
- Доработать веб-страницу - доработать главную веб страницу.
- Добавить описание работы программы.
- Добавить информацию о возможных REST запросах, формате входных и выходных данных, примеры запросов.
- Проинспектировать код, добавить комментарии где это необходимо.
- Настроить логирование в зависимости от выбранного профиля - необходимо более тонко настроить работу логирования. Пройтись по коду и определить что нужно помещать в лог.
- Дополнить информацию в wiki
- Добавить недостающие обработчики ошибок возникающие в контроллерах
- Переделать скрипты запуска программы - данные скрипты создаются во время автоматической сборки. Есть два варианта запуска скриптов под linux и windows
Checklist
- Вынести настройки базы данных PostgreSQL во внешний файл
- Режимы запуска программы
- Доработать веб-страницу
- Проинспектировать код, добавить комментарии где это необходимо
- Настроить логирование в зависимости от выбранного профиля
- Дополнить информацию в wiki
- Добавить недостающие обработчики ошибок возникающие в контроллерах
- Переделать скрипты запуска программы
Updated by Александр Александров about 5 years ago
- Status changed from Новая to В работе
Updated by Александр Александров about 5 years ago
Промежуточные итоги:
- Режимы запуска программы:
- DEMO - в данном режиме используется встроенная база данных H2, она инициализирована и заполнена тестовыми данными. Этот режим полезен для демонстрации возможности работы программы.
- PRODUCTION - в данном режиме для работы программы нужен PostgreSQL. Для удобства настройки подключения к БД были вынесены во внешний файл, который пользователь может самостоятельно настроить.
- TEST - используется для юнит-тестов.
- Так же к основным режимам программы есть опциональный - это отладочный режим. В данном режиме в лог выводится более расширенная информация, в том числе sql запросы и метрика выполнения запросов к БД.
- Был проинспектирован код, добавлены недостающие комментарии к коду, удалены лишние.
- Так же в зависимости от выбранного профиля используется разный уровень логгирования.
- Для POST запросов создания графа в целом, вершины или ребра графа был изменён путь. Например было POST .../rest/v1/graph стало POST .../rest/v1/graph/create
- Для gitlab ci на стадии сборки был расширен функционал. Теперь артефакт представляет собой не одиночный файл, каталог в котором помимо основной программы находится файл настройки подключения к БД и ряд скрпитов для запуска программы в различных режимах и под различные платформы (windows и linux).
- linkchecker.jar - сама программа
- application-production.properties - внешний файл настройки для подключения к БД, в файле необходимо только внести данные по подключению к БД
- linkchecker_linux_demo.sh, linkchecker_linux_demo_debug.sh - скрипты для запуска программ под linux в демо-режиме в обычном и отладочном режиме.
- linkchecker_linux_production.sh, linkchecker_linux_production_debug.sh - запуск программы в режиме работы с PostgreSQL, для этого необходимо заполнить файл настроек для подключения к БД.
- linkchecker_win_*.bat - скрипты по для работы с windows, режимы запуска как linux.
Updated by Александр Александров about 5 years ago
Полезные ссылки:
- How to load external property files into Spring Boot application?
- [SOF] Spring boot external configuration of property file
- 24.3 Application property files
- Advanced Bash-Scripting Guide Искусство программирования на языке сценариев командной оболочки
- Как вывести многострочную строку в Bash?
- CASE — Оператор Выбора в Bash [Пример]
- Получение данных, вводимых пользователем
- CMD/BAT - Расширение возможностей Echo
- Командная оболочка bat/cmd
- Windows Batch Scripting
- Batch File Command Скрыть Пароль
- Batch file – Programming tutorial
- Guide to Windows Batch Scripting
- Spring Boot - Using ErrorAttributes in our custom ErrorController
- Exception Handling in Spring MVC
- Spring Boot REST API – обработка исключений
Updated by Александр Александров about 5 years ago
- Status changed from В работе to Закрыта
Updated by Александр Александров about 5 years ago
Итоги
- Программа работает в двух режимах - это DEMO и PRODUCTION + возможность вывода отладочной информации для этих двух режимов если использовать ключ DEBUG режима.
- Файл конфигурации для подключения к БД PostgreSQL в режиме работы программы PRODUCTION вынесен во внешний файл.
- Были переработаны скрипты запуска программы, теперь их всего два один под linux linkchecker_linux.sh, второй под windows linkchecker_win.bat. Скрипты можно запустить со следующими ключами:
- --demo - запуск программы в DEMO режиме.
- --production - запуск программы в PRODUCTION режиме.
- --debug - дополнительный ключ для запуска программы в отладочном режиме.
- --help - вывод информационного сообщения.
- Была доработана стартовая веб-страница в которой выводится информация по тестовому заданию. Так же создана дополнительная страница, которая выводит сообщение в случае неправильного запроса.
Actions
Go to top