Руководство пользователя
ainova base
Приведенные в настоящем руководстве пользователя названия и программные продукты могут содержать в себе зарегистрированные товарные знаки своих владельцев.
Информация, приведённая в настоящем руководстве пользователя, может быть изменена без предварительного уведомления.





Настоящее руководство пользователя содержит всю необходимую информацию для использования программного обеспечения ainova base производства компании АО «Софит».
Руководство пользователя предназначено для ознакомления специалистами, которые осуществляют работу с приложениями, написанными на программном языке Java. Программное обеспечение ainova base предназначен для безопасной разработки, наладки и запуска Java приложений.




1    Введение
 
1.1 Назначение руководство пользователя
Настоящее руководство пользователя предоставляет полную информацию о характеристиках, способах установки и функциях программного обеспечения ainova base производства АО «Софит».
Руководство предназначено для ознакомления IT-специалистами, которые занимаются разработкой, наладкой и запуском Java приложений.

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

1.3 Уровень подготовки пользователей
Пользователь, осуществляющий работу с программным обеспечением ainova base производства компании АО «Софит» должен обладать знаниями и умением работы с персональным компьютером (ЭВМ), а также осведомлён о правилах безопасности его эксплуатации.
Для использования программного обеспечения в полной мере, пользователь должен обладать навыками работы с терминалом и программным языком Java.


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

Программное обеспечение ainova base производства компании АО «Софит» предлагает пользователю безопасную и доверенную среду для разработки, наладки и запуска Java приложений.
Программное обеспечение ainova base начинает свою работу по запросу пользователю и предъявляет специальные требования к операционной системе (Таблица 1).
Таблица 1 - Совместимые Платформы
Программное обеспечение ainova base состоит из двух частей:
-    специальные инструменты, позволяющие производить разработку программ;
-    средства позволяющие осуществлять запуск программ.
3    Требование к вспомогательному оборудованию
Для работы с программным обеспечением ainova base не требуется специального оборудования.
Программное обеспечение позволяет осуществлять работу в облачных решениях и микросервисах.

Поддерживаемые виртуальные среды:
·    Docker;
·    KVM;
·    VirtualBox.

Поддерживаемые облачные сервисы:
·    Yandex Cloud;
·    Cloud Ru.

4    Работа с программным обеспечением
4.1 Функции
В таблице представлен базовый синтаксис для работы с программным обеспечением ainova base.

Функция

Описание

Примечание

java

Запуск Java-приложений.

Утилита java используется для запуска Java-приложений. Она загружает и запускает класс, определяющий метод main.

 

Синтаксис:

Java [options] class [arguments]

 

Получение помощи:

Java -help

 

Опции:

- `-cp <путь>` или `-classpath <путь>`: устанавливает путь поиска классов и библиотек.

- `-D<имя>=<значение>`: устанавливает системное свойство.

- `-version`: выводит версию Java и завершает работу.

- `-verbose[:class|gc|jni]`: выводит подробную информацию о загрузке классов, сборке мусора или JNI-методах.

- `-X<option>`: нестандартные опции.

 

Пример:

Java -cp .:lib/* MyApplication arg1 arg2

 

javac

Компиляция Java-файлов.

Обеспечивает компиляцию исходного кода Java (.java) в байт-код и файлы классов (.class). Инструмент предназначен для преобразования исходных текстов в промежуточное представление, исполняемое виртуальной машиной Java (JVM)

 

Синтаксис:

javac [options] sourcefiles

 

Получение помощи:

javac -help

 

Опции:

- `-d <путь>`: указывает каталог для сохранения сгенерированных файлов class.

- `-cp <путь>` или `-classpath <путь>`: устанавливает путь поиска классов и библиотек.

- `-sourcepath <путь>`: устанавливает путь поиска исходных файлов.

- `-g`: генерирует отладочную информацию.

- `-Xlint:<опция>`: включает предупреждения компилятора.

 

Пример:

javac -d out src/MyClass.java

 

javadoc

Генерация документов.

Обеспечивает автоматическое формирование документации в формате HTML путем извлечения данных из комментариев файлов Java

Синтаксис:

javadoc [options] sourcefiles [@optionsfiles]

 

Получение помощи:

javadoc -help

 

Опции:

- `-d <путь>`: указывает каталог для сохранения сгенерированных HTML-файлов.

- `-cp <путь>` или `-classpath <путь>`: устанавливает путь поиска классов и библиотек.

- `-overview <файл>`: использует указанный файл для описания обзора.

- `-author`: включает в документацию информацию об авторах.

- `-version`: включает в документацию информацию о версиях.

 

Пример:

javadoc -d docsrc/MyClass.java

 

jcmd

Отправка команд диагностики.

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

 

Синтаксис:

jcmd <pid> <command> [arguments]

 

Получение помощи:

jcmd -help

 

Команды:

- `VM.version`: выводит версию JVM.

- `VM.flags`: выводит флаги JVM.

- `GC.run`: запускает сборку мусора.

- `Thread.print`: выводит информацию о потоках.

- `Thread.dump`: выводит дамп потоков.

- `PerfCounter.print`: выводит счетчики производительности.

 

Пример:

jcmd 123456 VM.version

 

jconsole

Графический мониторинг.

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

 

Синтаксис:

jconsole [pid]

 

Получение помощи:

jconsole -help

 

Пример:

jconsole

jdb

Отладка Java-приложений.

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

 

Синтаксис:

jdb [options] [classname [arguments]]

 

Получение помощи:

jdb -help

 

Команды:

- `-classpath <путь>`: устанавливает путь поиска классов и библиотек.

- `-connect`: подключается к запущенному процессу.

- `-attach <pid>`: присоединяется к процессу с указанным PID.

 

Пример:

Jdb MyClass

 

jfr

Анализ файлов Flight Recorder.

Инструмент для разбора и вывода содержимого файлов Flight Recorder. Собирает данные о производительности и состоянии Java-приложения и позволяет анализировать эти данные для диагностики проблем.

 

Синтаксис:

jfr <command> [options]

 

Получение помощи:

jfr -help

 

Команды:

- `print`: выводит содержимое файла.

- `info`: выводит информацию о файле.

- `stacktrace`: выводит трассировку стека.

 

Пример:

jfr print myfile.jfr







5    Установка программного обеспечения ainova base

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

Во всех командах замените <package> на фактическое имя файла.


5.1 Установка на ОС Linux
5.1.1 Установка через пакетный менеджер RPM

1. Для установки ainova base, воспользуйтесь терминалом и введите следующую команду:

sudo rpm -i <package> -<version>.rpm

2. После установки, проверьте наличие установленной версии ainova base в списке доступных альтернатив java и выберите ее в качестве версии по умолчанию в случае необходимости:

 

sudo update-alternatives –config java

3. Для установки значений переменных окружения PATH и JAVA_HOME необходимо модифицировать один из файлов `~/.bashrc` или `~/.profile`. Для этого добавьте в них следующие строки:

export PATH=/usr/lib/jvm/<package> -<version>/bin/:$PATH

export JAVA_HOME=/usr/lib/jvm/<package>-<<version>

 

 

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

source ~/.bashrc


5. Для проверки корректности установки ПО необходимо сделать следующее:
А. Убедитесь, что установлена корректная версия ainova base и выполните следующую команду:

 java -version


Команда должна отработать без ошибки, в терминал выведется информация об установленной версии.

Б. Проверьте, что переменная окружения JAVA_HOME имеет корректное значение:

echo $JAVA_HOME

5.1.2 Установка через пакетный менеджер dpkg

1. Для установки ainova base, воспользуйтесь терминалом и введите следующие команды:

sudo dpkg -i <package> -<version>.deb


2. После установки, проверьте наличие установленной версии ainova base в списке доступных альтернатив java и выберите ее в качестве версии по умолчанию в случае необходимости:

 

sudo update-alternatives –config java


3. Для установки значений переменных окружения PATH и JAVA_HOME необходимо модифицировать один из файлов `~/.bashrc` или `~/.profile`. Для этого добавьте в них следующие строки:

export PATH=/usr/lib/jvm/<package> -<version>/bin/:$PATH

export JAVA_HOME=/usr/lib/jvm/<package>-<<version>

 


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

source ~/.bashrc


5. Для проверки корректности установки ПО необходимо сделать следующее:
А. Убедитесь, что установлена корректная версия ainova base и выполните следующую команду:

java -version


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

echo $JAVA_HOME

5.1.3 Установка из архива TAR


1.    Создайте директорию, в которую будет разворачиваться ainova base:

sudo mkdir -p /usr/lib/jvm


2. Разархивируйте скачанный .tar.gz файл:

 

sudo tar xzf <package>-<version>.tar.gz -C  /usr/lib/jvm



3. Проверьте целостность дистрибутива. Для получения контрольной суммы дистрибутива используете утилиту sha256sum:

sha256sum <package> -<version>.tar.gz

cbad90b5db2d7af604e3ecfc372606ebd63ba372a8ba3e20381e037abe7133a9 <package> -<version>.tar.gz 


4. Для установки значений переменных окружения PATH и JAVA_HOME необходимо модифицировать один из файлов `~/.bashrc` или `~/.profile`. Для этого добавьте в них следующие строки:

export PATH=/usr/lib/jvm/<package> -<version>/bin/:$PATH

export JAVA_HOME=/usr/lib/jvm/<package>-<<version>

 


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

 

source ~/.bashrc


6. Для проверки корректности установки ПО необходимо сделать следующее:
А. Убедитесь, что установлена корректная версия ainova base и выполните следующую команду:

java -version


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

echo $JAVA_HOME

5.2 Установка на SberOS

Процедура установки ainova base на операционную систему SberOS, осуществляется с использованием DEB-пакета.
Подробные инструкции по данному методу установки изложены в п. 4.1.2 настоящего руководства пользователя.
5.3 Установка на Windows

Для установки программного продукта запустите терминал, в котором будут исполняться необходимые для установки команды.
Установка программного обеспечения ainova base на Windows осуществляется через консоль администратора.

1. Проверьте целостность дистрибутива. Для получения контрольной суммы дистрибутива используете утилиту certUtil:

certUtil -hashfile <package>-<version>.zip SHA256

Хэш SHA256 <package> -<version>.zip:

1fb19c521b42790d206ef6e3e8b9a3b59514229096d264e057e4482378ff17da

CertUtil: -hashfile — команда успешно выполнена.


2. Создайте директорию, в которую будет разворачиваться ainova base (например, "C:\Program Files\ ainova base "):

mkdir "C:\Program Files\ainova base\"


3. Разархивируйте в данную директорию содержимое дистрибутива ainova base -<version>.zip:

tar xzf <package>-<version>.zip -C "C:\Program Files\<package>\"


4. Установку значений переменных окружения PATH и JAVA_HOME выполните через терминал, введя следующие команды:

setx PATH "C:\Program Files\<package>\bin;%PATH%"

setx JAVA_HOME "C:\Program Files\<package>\"


5. Для проверки корректности установки ПО необходимо сделать следующее:
А. Запустите новый экземпляр ПО:

C:\tmp>where java


Ожидаемый результат:

c:\Program Files\<package>\bin\java.exe


Б. Убедитесь, что установлена корректная версия ainova base и выполните следующую команду:

java -version


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

echo %JAVA_HOME%

5.4 Установка на macOS

1. Для установки ainova base, используйте следующую команду:

tar xzf <package>-<version>.tar.gz -C /Library/Java/JavaVirtualMachines/


2. Для установки значений переменных окружения PATH и JAVA_HOME необходимо пройти следующее:
Откройте терминал и выполните команду, которая позволит получить путь к ainova base.

/usr/libexec/java_home

 

Отредактируйте файл конфигурации вашей командной оболочки (~/.zshrc для Zsh или ~/.bash_profile для Bash) и добавьте следующую строку:

 

export JAVA_HOME=$(/usr/libexec/java_home)


Сохраните файл и примените изменения командой в зависимости от командной оболочки:

source ~/.zshrc или source ~/.bash_profile

 

6. Для проверки корректности установки ПО необходимо сделать следующее:
А. Убедитесь, что установлена корректная версия ainova base и выполните следующую команду:

java -version


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

echo $JAVA_HOME

Made on
Tilda