Аннотация
Данное руководство является частью документации банковской системы «Colvir Banking System (CBS-3plus)» и содержит сведения для организации рабочего места разработчика прикладных модулей.
Документ соответствует состоянию Системы на Июль 2014 года.
ОГЛАВЛЕНИЕ
Общие сведения
Разработка прикладного модуля выполняется на виртуальной машине, на которой установлено все необходимое ПО.
Создание прикладных модулей подчиняется архитектурным и технологическим правилам компании Colvir и осуществляется с использованием приложения CBS для разработки и тестирования.
Состав ПО
Рабочее место для разработки модульных приложений состоит из следующего ПО:
- Среда разработки приложений Java Eclipse;
- Виртуальная машина Java;
- Сервер приложений Apache Geronimo 3.0;
- Система управления версиями Mercurial;
- Сборщик проектов Maven;
- Редактор отчетов iReport.
Порядок организации рабочего места
- Получить стандартный доступ к сетевым ресурсам компании (Настройка VPN подключения для соединения с удаленным рабочим столом в WIndows XP);
- Получить доступ к виртуальной машине;
- Зайти на виртуальную машину под своим логином;
- На виртуальной машине запустить сервер приложений;
- Обновить систему до актуального состояния;
- Проверить правильность установки сервера приложений;
- Настроить рабочее место для работы с системой управления версиями Mercurial (FAQ по Mercurial);
- Скопировать проект (модуль) из Mercurial или сгенерировать проект с помощью maven archetype;
- Запустить IDE для разработки модуля.
Виртуальная машина разработчика
Получение виртуальной машины
Реестр виртуальных машин ведется в файле: "L:\Ресурсы\Оборудование-CBS-4.xlsx" (вкладка «Виртуальные машины»). Файл содержит список виртуальных машин, с указанием их профиля и ФИО сотрудника за которым она закреплена.
Профиль виртуальной машины описывает, для каких нужд создавалась и настраивалась VM.
Если:
- Требуется новая VM, то необходимо:
- найти VM нужного вам профиля со статусом «Готова к использованию» и без ФИО (означает, что свободна). Если ни одной подходящей машины нет, то обратиться к Ю. Химонину или А. Тетеневу с просьбой в подготовке новой машины;
- вписать свои ФИО и сменить статус на «Используется»;
- попросить Ю. Химонина или А. Тетенева дать к ней доступ (добавить вашу учетную запись в список разрешенных).
- VM больше не требуется, то необходимо стереть свой ФИО и указать в статусе либо «готова к использованию» (если вы считаете ее пригодной к работе) либо «Требуется восстановление» (сигнал, что ее надо восстановить).
- Требуется восстановить VM, то следует обратиться к Ю.Химонину или в технический отдел.
Запуск виртуальной машины
- На панели задач Windows выберите Пуск → Подключение к удаленному рабочему столу. Откроется окно, в которое надо ввести IP адрес виртуальной машины.
2. Введите свой логин и пароль (совпадает с учетной записью Windows).
Сервер приложений
Более подробно о настройках сервера приложения можно узнать из статьи Инструкция по использованию OSGi.
Запуск сервера
В директории geronimo зайти в папку bin. Запуск осуществляется командой
Работа с сервером приложений
- Для просмотра начальной страницы введите в адресную строку http://localhost:8080/. Откроется окно сервера приложений Apache Geronimo 3.0.
2. Для просмотра страницы административной консоли выберите пункт меню Console или введите в браузере http://localhost:8080/console.
В окне авторизации введите следующие значения:
- Имя пользователя по умолчанию – system.
- Пароль по умолчанию – manager.
3. Откроется окно Administrative Console.
Описание функций административной консоли смотри на http://geronimo.apache.org/GMOxDOC30/extensible-administration-console.html.
Проверка установки сервера
Для того, чтобы убедиться в правильности установки сервера, необходимо выполнить следующие действия:
- Настроить пулы данных;
- Выполнить обновление системы;
- Перестартовать сервер;
- Открыть приложение CBS для разработчика.
В том случае, если в приложении CBS открываются директории, то все сделано верно.
Остановка сервера
- Зайдите с помощью браузера на страницу http://localhost:8080/console, где localhost — настроенное имя хоста сервера.
- Войдите с помощью настроенного имени администратора сервера (по умолчанию – system) и пароля (по умолчанию – password).
- В области навигации щелкните на ссылке Shutdown в категории Application Server.
- Подтвердите намерение, нажав кнопку Shutdown.
Пакет программ сервера приложений Apache Geronimo находится в директории c:\geronimo.
Приложение CBS-3plus для разработчиков
Локальный адрес приложения CBS:
Введите в адресной строке браузера адрес, перейдите по нему и авторизуйтесь в приложении.
В открывшемся окне приложения проверьте доступность всех пунктов меню слева.
Организация проектов mercurial
Список и структура проектов
При разработке CBS-3plus и CBS-4 будет использоваться несколько проектов mercurial, вместо одного общего, как это было в CBS.
Отдельные проекты создаются на ядро системы (сейчас это cbs4/draft) и на группы модулей. Список и состав проектов (какие модули, в какую группу попадают и, соответственно, в каком проекте mercurial хранятся) определяет Главный Конструктор.
Проекты, предназначенные для хранения прикладных модулей, имеют следующую структуру папок:
- activiti − папка для размещения сценариев Activiti.
- doc − папка для размещения документации. Внутренняя структура в соответствии с функциональной классификацией.
- java − папка для размещения сервисов на java. В корне папки должен размещаться общий pom-файл для сборки всех сервисов модуля. Вложенная структура папок определяется соответствующим проектом java.
- srv − папка содержит серверные настройки. Настройки хранятся в иерархии папок, соответствующей функциональной классификации. Выгружать объекты необходимо с помощью CFGSETUP для правильного автоматического размещения файлов.
- vld − папка для размещения клиентских валидирующих скриптов.
Веток (branches) проекта, соответствующих, банкам и странам, не предусматривается. Локализованные и кастомизированные настройки хранятся в отдельных папках в подпапке srv и имеют отличные от базовых файлов имена.
Экспорт настроек в файлы
При использовании утилиты экспорта http://src.colvir.ru/hg/tech/cfg4/ путь к экспортируемому файлу формируется следующим образом:
ПАПКА_ДЛЯ_ЭКСПОРТА\ПРОЕКТ\SRV\КОД1\КОД2\файл.xml,
где:
- ПАПКА_ДЛЯ_ЭКСПОРТА — папка, указанная в диалоговом окне CFGSETUP;
- ПРОЕКТ — имя проекта mercurial. Это имя указывается для верхнего узла в классификаторе функциональности;
- КОД* — коды иерархии классификатора функциональности.
Cреда для разработки Java-приложений
Разработка может осуществляться в любой Free IDE Community Edition для разработки Java-приложений (такие как Eclipse, NetBeans, IntelliJ IDEA). В целом, привязки к среде разработки нет, кроме тех случаев, когда надо отредактировать Activiti. Выбранная среда должна поддерживать интеграцию с maven и должны быть настроены наши правила форматирования (Есть ли стандарты форматирования кода и как они обеспечиваются?).
В дальнейшем, вполне возможно, что редактирование диаграм Activiti будет происходить через веб-интерфейс, и тогда выбор будет полностью свободным.
В том случае, если разработчик хочет использовать отличную от IDE Java Eclipse среду, то устанавливать и продумывать все настройки должен он сам.
Eclipse
Если Eclipse только что установлена, то необходимо настроить работу с репозитарием Maven.
Прежде всего следует проверить не стоит ли уже интеграция с Maven в Eclipse (в последних версиях интеграция часто уже есть). Для установки расширения eclipse для maven необходимо:
- Зайти в пункт меню Help → Install New Software...
- Выбрать Maven Integration for Eclipse Update Site - http://m2eclipse.sonatype.org/sites/m2e, установить. В контекстном меню появится пункт меню Maven.
Для настройки работы с репозитарием нужно выполнить следующие действия:
- Зайти в пункт меню Windows → Preferences.
- Найти в появившемся диалоге раздел Maven\User settings.
- В поле User settings (openfile) указать путь к файлу конфигурации Maven (для разработчиков модулей кампании Colvir значение C:\maven\conf\settings.xml). При этом обновится поле Local repository.
- Нажать кнопку Reindex.
Для разработчика также будет полезен плагин Activiti Eclipse BPMN 2.0 Designer. Его установка заключается в следующем:
- Зайти в пункт меню Help → Install New Software...
- Заполнить имя Activiti BPMN 2.0 designer, путь http://activiti.org/designer/update/, установить.
Также необходимо провести следующие настройки:
- Настройка среды выполнения - Java\Installed JREs - значение в поле name должно быть равно ibm jdk.
- Установка кодировки по умолчанию - General\Workspace:
- группа Text file encoding - значение = Other (UTF-8);
- группа New line text delimeter - значение = Other (UNIX).
Войти в среду Java Eclipse можно с помощью запуска eclipse.exe.
Рис. Среда Java Eclipse
NetBeans
Очень удобным редактором является NetBeans (https://netbeans.org/) - свободная интегрированная среда разработки приложений, в том числе Java-приложений.
Поддержка интеграции с Maven простая - опция открытия maven проектов (не нужно делать импорт в отличие от eclipse).
Поддержки Activiti в NetBeans нет. Поэтому при необходимости редактировать диаграммы Activiti придется использовать Eclipse.
Настройка окружения
В случае использования виртуальной машины разработчику не нужно ничего настраивать, достаточно обновить систему и установить соединение с БД.
Обновление версии системы
Для обновления версии платформы (артефактов развертывания и ядра CBS-4) на сервере приложений предназначена утилита refresh_release.bat.
Релизные артефакты хранятся в репозитории maven (http://maven.colvir.ru/archiva/).
При разработчике модулей, а также при тестировании релиза CBS запускать refresh_release.bat следует с параметрами - с указанием номера релиза ядра: refresh_release.bat -v номер_версии. В этом случае артефакты скачиваются с maven.colvir.ru и разворачиваются на сервере приложения (все эти действия также можно выполнить вручную).
При выполнении скрипта с указанием релиза ядра все ранее развернутые артефакты должны удаляться.
При разработке и тестировании платформы CBS-4 необходимо запускать refresh_release.bat без параметров. В этом случае разворачивается последняя успешная версия ядра - последние собранные артефакты с диска m (то есть, которые туда отправились при последнем пуше в default).
Самостоятельно свежую версию артефактов для ветки default можно взять на удаленном рабочем столе m:\FreshHG\cbs4-draft\default\номер_последней_сборки\. Номера сборок идут в порядке возрастания. Номер последней сборки можно узнать по содержимому файла m:\FreshHG\cbs4-draft\default\lastbuild. При обновлении артефактов вручную необходимо заменить их в папке c:\cbs4-draft\artifacts.
В командной строке Total Comander наберите с:\refresh_release\refresh_release.bat.
Информация об обновлении будет выведена на экран.
Обновление клиента необходимо производить самостоятельно путем копирования папки application из директории m:\FreshHG\cbs4-draft\r07\, если разработка происходит на базе релиза 0.7.0, или m:\FreshHG\cbs4-draft\default\номер_последней_сборки\ при использовании последней версии ядра.
Подключение к БД
Подключение к базам данных описано в статьях Разворачивание пулов и в Параметрах настройки пулов (FAQ по CBS-4)
Настройка внешних сервисов
(Шлюз, платформа, ProFix)
Работа по релизам
Работа по релизам (доработки в Feature Branches - релиз модулей, релиз ядра, релиз общих модулей) выполняется по технологии выпуска релизов, описанной в документе "Процесс выпуска релизов CBS-3plus. Общее описание".
Для возможности одновременного запуска различных версий системы (или, например, при одновременном развертывании приложений одной версии, но с разными билдами) может быть использована работа с различными серверами приложений (WebSphere, находящимися на различных портах хоста)
В документе "Подготовка к работе сервера IBM® WebSphere® Application Server Community Edition на Ubuntu Server 12.04 LTS" приведено описание установки и одновременного запуска двух WebSphere Application Server (в разделе "Инстанцирование (instances)".
Запуск нескольких серверов приложений требует большого ресурса, особенно оперативной памяти. В дальнейшем при переходе на OSGi (Инструкция по использованию OSGi) работа с несколькими версиями приложений будет существенно облегчена (единственная проблема - это развертывание пулов).
Комментариев нет:
Отправить комментарий