1. Примерна задача

Да се създаде възможност JavaFX приложението DeveloperApp да бъде пакетирано като изпълним файл.

Крайният резултат трябва да бъде папка:

destination/DeveloperApp/

В нея трябва да има стартиращ файл:

DeveloperApp.exe

или съответния изпълним файл за операционната система.


2. Настройки в pom.xml

Основна информация за проекта

<groupId>bg.tu_varna.sit.ps</groupId>
<artifactId>lab7</artifactId>
<version>1.0</version>

Това определя:

  • организацията - groupId;
  • името на проекта - artifactId;
  • версията - version. SNAPSHOT в номера на версията означава, че това все още е версия в разработка.

Maven ще създаде:

lab7-1.0.jar

3. Build Plugins

Maven Compiler Plugin

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <!--...-->
            <configuration>
                <source>21</source>
                <target>21</target>
            </configuration>
        </plugin>

        <!--...-->
    </plugins>
</build>

Предназначение

Компилира Java кода.


Java Version

<source>21</source>
<target>21</target>

Проектът използва Java 21.


JavaFX Maven Plugin

<build>
    <plugins>
        <!--...-->

        <plugin>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-maven-plugin</artifactId>
            <!--...-->
        </plugin>
    </plugins>
</build>

Предназначение

Позволява приложението да се стартира чрез Maven.


Стартиране

./mvnw clean javafx:run

Резултата трябва да е:

Error: JAVA_HOME not found in your environment.

Please set the JAVA_HOME variable in your environment to match the location of your Java installation.

Това означава, че в операционната система не е инстанцирана виртуална машина за изпълнение на Java приложения.

Инициализация през Java SDK в IntelliJ

В IntelliJ Отворете Меню -> File -> Project Structure

В отворилия се прозорец изберете Platform Settings -> SDKs, това е списък с версиите на Java SDK инсталирани в IntelliJ

Избирате версията с която е създаден проекта openjdk-21

В JDK home path се зе покаже пътя до Java SDK

C:\Users\OOP\.jdks\openjdk-21 - копирайте го.

Създаване на системна променлива JAVA_HOME

В windows search въведете: edit environment variables for your account

В отворения прозорец:

image

Трябва да се попълни User variables for ... с бутона New

Variable name: JAVA_HOME Variable value: C:\Users\OOP.jdks\openjdk-21

Когато е създадена променливата на средата JAVA_HOME.

Трябва да се дефинира пътя до изпълнимия файл на JRE:

Променливата Path се отваря в Edit

image

Създава се нов пър с бутона New:

Пътя трябва да е %JAVA_HOME%\bin

Записвате промените в променливата Path и в Enviroment Variables.

Следващата стъпка е рестартиране на IntelliJ за да може терминала в IntelliJ да прочете новите променливи.

Стартиране отново

./mvnw clean javafx:run

Резултата трябва да е стартирано приложение, това кое приложение ще се изпълни зависи от pom.xml конфигурацията <mainClass>


Main Class

<mainClass>
    bg.tu_varna.sit.ps.lab7.HelloApplication
</mainClass>

Това е началният клас на приложението. Сменете го с класа, който стартира приложението DeveloperApplication.


Maven Dependency Plugin

Създаването на изпълним файл изисква добавянето на няколко плъгина. Един от тях е maven-dependency-plugin:

<build>
    <plugins>
        <!--...-->

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <version>3.8.1</version>

            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>
                            ${project.build.directory}
                        </outputDirectory>
                        <includeScope>runtime</includeScope>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Предназначение

Копира runtime зависимостите в папката:

target/

Важна конфигурация

<plugin>
    <artifactId>maven-dependency-plugin</artifactId>
    <!--...-->

    <executions>
        <execution>
            <phase>package</phase>
            <!--...-->
        </execution>
    </executions>
</plugin>

Plugin-ът се изпълнява при:

./mvnw clean package

jpackage Maven Plugin

Следващият плъгин е jpackage-maven-plugin:

<build>
    <plugins>
        <!--...-->

        <plugin>
            <groupId>org.panteleyev</groupId>
            <artifactId>jpackage-maven-plugin</artifactId>
            <version>1.6.6</version>

            <configuration>
                <name>DeveloperApp</name>

                <input>${project.build.directory}</input>

                <mainJar>lab7-1.0.jar</mainJar>

                <mainClass>
                    bg.tu_varna.sit.ps.lab7.task1.Launcher
                </mainClass>

                <type>APP_IMAGE</type>

                <destination>
                    ${project.basedir}/destination
                </destination>

                <winConsole>false</winConsole>

                <javaOptions>
                    <option>--module-path</option>
                    <option>$APPDIR</option>

                    <option>--add-modules</option>

                    <option>
                        javafx.controls,javafx.fxml
                    </option>
                </javaOptions>
            </configuration>

            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>jpackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Предназначение

Създава изпълнимо приложение.


Име на приложението

<name>DeveloperApp</name>

Входна папка

<input>${project.build.directory}</input>

Използва:

target/

Main JAR

<mainJar>lab7-1.0.jar</mainJar>

Основният .jar файл. Файла тряба да отговаря на дефинираното име и версия в

<artifactId>lab7</artifactId>
<version>1.0</version>

Тип на приложението

<type>APP_IMAGE</type>

Създава папка с готово приложение.


Destination

<destination>${project.basedir}/destination</destination>

Крайният резултат се записва в:

destination/

winConsole

<winConsole>false</winConsole>

Скрива конзолния прозорец при Windows.


Java Options

<javaOptions>
    <option>--module-path</option>
    <option>$APPDIR</option>

    <option>--add-modules</option>

    <option>
        javafx.controls,javafx.fxml
    </option>
</javaOptions>

Module Path

<option>--module-path</option>
<option>$APPDIR</option>

Казва къде се намират JavaFX модулите.


Add Modules

<option>--add-modules</option>

<option>
    javafx.controls,javafx.fxml
</option>

Зарежда JavaFX модулите.


4. Стартиране на приложението

Стартиране от Maven

./mvnw clean javafx:run

5. Създаване на изпълним файл

Команда

./mvnw clean package

6. Очакван резултат

След изпълнение на командата трябва да се появи:

destination/DeveloperApp/

Вътре трябва да има:

DeveloperApp.exe

или съответния изпълним файл за операционната система.


7. Краен резултат на pom.xml

Пълен pom.xml файл

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>bg.tu_varna.sit.ps</groupId>
    <artifactId>lab7</artifactId>
    <version>1.0</version>
    <name>lab7</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <junit.version>5.12.1</junit.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <version>2.4.240</version>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-controls</artifactId>
            <version>21.0.6</version>
        </dependency>
        <dependency>
            <groupId>org.openjfx</groupId>
            <artifactId>javafx-fxml</artifactId>
            <version>21.0.6</version>
        </dependency>

        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-api</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-engine</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.13.0</version>
                <configuration>
                    <source>21</source>
                    <target>21</target>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.openjfx</groupId>
                <artifactId>javafx-maven-plugin</artifactId>
                <version>0.0.8</version>
                <executions>
                    <execution>
                        <id>default-cli</id>
                        <configuration>
                            <mainClass>
                                bg.tu_varna.sit.ps.lab7.HelloApplication
                            </mainClass>
                            <options>
                                <option>--add-opens</option>
                                <option>java.base/java.lang=ALL-UNNAMED</option>
                            </options>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>3.8.1</version>

                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>package</phase>
                        <goals>
                            <goal>copy-dependencies</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>
                                ${project.build.directory}
                            </outputDirectory>
                            <includeScope>runtime</includeScope>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>org.panteleyev</groupId>
                <artifactId>jpackage-maven-plugin</artifactId>
                <version>1.6.6</version>

                <configuration>
                    <name>DeveloperApp</name>

                    <input>${project.build.directory}</input>

                    <mainJar>lab7-1.0.jar</mainJar>

                    <mainClass>
                        bg.tu_varna.sit.ps.lab7.task1.Launcher
                    </mainClass>

                    <type>APP_IMAGE</type>

                    <destination>
                        ${project.basedir}/destination
                    </destination>

                    <winConsole>false</winConsole>

                    <javaOptions>
                        <option>--module-path</option>
                        <option>$APPDIR</option>

                        <option>--add-modules</option>

                        <option>
                            javafx.controls,javafx.fxml
                        </option>
                    </javaOptions>
                </configuration>

                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>jpackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

This site uses Just the Docs, a documentation theme for Jekyll.