1. Настройка проекта

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

Настройка среды разработки

Установите Jmix Studio и JDK, как описано в разделе Установка, если вы еще не сделали этого.

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

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

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

Создание проекта

Запустите IntelliJ IDEA с установленным плагином Jmix Studio, перейдите на вкладку Projects и нажмите New Project:

create project 1

На первом шаге мастера создания проекта выберите Jmix Project в списке и оставьте значения по умолчанию в полях Repository и Jmix version:

create project 2

В поле Project JDK выберите JDK версии 11 или 17. Если в поле отображается <No SDK>, выберите Download JDK в выпадающем списке и следуйте дальнейшим инструкциям, чтобы загрузить JDK.

Нажмите Next.

На следующем шаге мастера создания проекта выберите первый шаблон проекта из списка: Full-Stack Application (Java):

create project 3

Нажмите Next.

На последнем шаге мастера введите onboarding в поле Project name:

create project 4

Поле Base package определяет пакет Java, который будет содержать все классы и ресурсы проекта. Сохраните значение, предложенное мастером (com.company.onboarding), чтобы соответствовать коду в самоучителе.

Project id не требуется для приложения, поэтому оставьте поле пустым.

Нажмите кнопку Create.

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

IDE покажет ряд уведомлений, предлагающих загрузить "pre-built shared indexes" и установить дополнительные плагины. Вы можете смело отказаться от них.

Вход в учетную запись Jmix

После загрузки зависимостей и индексирования проекта в первый раз Studio покажет диалоговое окно Jmix Sign In. В этом диалоговом окне вам следует войти в свою учетную запись Jmix или зарегистрировать новую.

sign in dialog

Нажмите на кнопку Sign In / Register.

sign in your account dialog
  • Если у вас нет учетной записи Jmix, нажмите на ссылку Register. В регистрационной форме заполните поля First name, Last name, Email и Password, примите политику конфиденциальности и нажмите на кнопку Register.

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

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

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

    Вернитесь в IDE и нажмите на кнопку Log in в окне Email Verification.

  • Если у вас есть учетная запись Jmix, введите адрес электронной почты и пароль и нажмите на кнопку Sign In.

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

jmix subscription

Когда проект будет готов, IDE откроет окно инструментов Jmix в левой части экрана и страницу приветствия в рабочей области:

create project 5

Если все индикаторы прогресса пропали, но страница Welcome и окно инструментов Jmix не появились, выполните следующее:

  • Откройте окно инструментов Gradle, доступное на правой стороне IDE.

  • Нажмите кнопку Reload All Gradle Projects (refresh) в панели инструментов этого окна.

Изучение нового проекта

Окно инструментов Jmix отображает структурированный вид проекта. Давайте разберемся, что содержит вновь созданный проект.

  • В разделе Build Scripts вы можете увидеть файлы сборки Gradle:

    explore project 1
  • Раздел Configuration содержит файл application.properties, который определяет параметры подключения к базе данных, уровни логирования и другие свойства:

    explore project 2
  • В разделе Add-ons отображается список установленных дополнений Jmix:

    explore project 3

    Если вы дважды щелкните на разделе Add-ons, Studio откроет диалоговое окно для управления дополнениями в вашем проекте.

  • В разделе Data Stores отображается список используемых в проекте баз данных и их файлы Liquibase changelog:

    explore project 4

    В новом проекте по умолчанию используется HSQL - простая реляционная СУБД, хранящая данные в файлах подкаталога .jmix/hsqldb проекта.

    Liquibase changelogs - это XML-файлы, описывающие изменения схемы базы данных.

    Если дважды щелкнуть на подразделе Main Data Store, откроется диалоговое окно, содержащее параметры подключения к базе данных. Эти параметры хранятся в файле application.properties.

  • В разделе Data Model отображаются все сущности проекта. В новом проекте есть единственная сущность User:

    explore project 5
  • Раздел User Interface содержит экраны проекта, а также подраздел Message Bundle для быстрого доступа к локализованным сообщениям и Main Menu для открытия структуры меню:

    explore project 6

    Как вы можете видеть, проект уже содержит несколько экранов:

    • LoginScreen принимает имя пользователя и пароль для аутентификации пользователя.

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

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

  • В разделе Security показан список ролей. Новый проект содержит единственную роль полного доступа FullAccessRole, которая назначается пользователю admin:

    explore project 7
  • Если дважды щелкнуть на разделе Sources, Studio откроет окно инструментов Project с обычным видом исходного кода:

    explore project 8

Запуск приложения из IDE

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

Запуск приложения

run app 1

На главной панели инструментов найдите поле со значением Onboarding Jmix Application и нажмите кнопку Debug (start debugger) рядом с ним.

Если вы используете IntelliJ IDEA Ultimate, вы можете увидеть еще один элемент в раскрывающемся списке Run/Debug Configurations, который называется OnboardingApplication и имеет слева значок Spring Boot (spring boot). Он автоматически добавляется плагином Spring Boot, входящим в комплект поставки IDE. Не используйте его.

Для запуска Jmix приложения всегда используйте конфигурацию, отмеченную значком Gradle (gradle).

Studio покажет предупреждение о хранилище данных и непримененных файлах changelog:

run app 2

Что это означает?

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

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

На данный момент наша база данных пуста (на самом деле, в нашем случае файловой базы данных HSQL по умолчанию она вообще не существует), поэтому, чтобы сгенерировать diff changelog, Studio сначала необходимо создать базу данных и выполнить все существующие файлы changelog проекта. В диалоговом окне вы можете просмотреть существующие файлы changelog из зависимостей проекта (помечены как read only) и из самого проекта (010-init-user.xml).

Нажмите Execute and proceed.

Вы увидите выполнение Liquibase changelogs с помощью Studio в окне инструментов Run в нижней части экрана IDE:

run app 3

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

Сразу после проверки базы данных Studio создаст и запустит приложение. Вы увидите консольный вывод запущенного приложения в окне инструментов Debug в нижней части экрана IDE:

run app 4

Когда приложение будет готово к работе, вы увидите в консоли следующее сообщение: Application started at http://localhost:8080.

Вход в приложение

Откройте localhost:8080 в веб-браузере. Вы увидите экран логина вашего приложения:

run app 5

Учетные данные администратора (admin / admin) уже заданы в полях имени пользователя и пароля (вы можете удалить их позже), поэтому просто нажмите Submit.

В главном меню выберите ApplicationUsers:

run app 6

Это экран Users.browse, показывающий список сущностей User. Пока в этом списке есть только пользователь admin, созданный в базе данных согласно файлу changelog 010-init-user.xml.

Остановка приложения

Чтобы остановить запущенное приложение, нажмите кнопку Stop (suspend) на главной панели инструментов:

run app 7

В консоли Debug вы увидите следующие сообщения:

run app 8

Не волнуйтесь, на самом деле это не ошибка. Это ожидаемое поведение IDE.

Резюме

В этом разделе вы настроили среду разработки и создали новый проект в IDE.

Вы узнали, что:

  • Jmix Studio - это плагин для IntelliJ IDEA.

  • В самоучителе предполагается, что у вас есть коммерческая или пробная подписка для Jmix Studio. Пробная подписка активируется при первом входе в учетную запись Jmix.

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

  • Studio показывает структуру проекта в окне инструментов Jmix.

  • Новый проект содержит функциональность для входа в приложение и управления пользователями.

  • Новое приложение может быть запущено из IDE сразу после создания проекта.

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