exponenta event banner

compiler.build.webAppArchive

Создание архива для развертывания на сервере веб-приложений MATLAB

Описание

пример

compiler.build.webAppArchive(AppFile) создает архив веб-приложения с помощью приложения MATLAB ®, указанного AppFile.

пример

compiler.build.webAppArchive(AppFile,Name,Value) создает архив веб-приложения с параметрами, заданными с помощью одного или нескольких аргументов значения имени. Параметры включают имя архива, дополнительные файлы для включения и каталог вывода.

пример

compiler.build.webAppArchive(opts) создает архив веб-приложения с параметрами, заданными с помощью compiler.build.WebAppArchiveOptions объект opts. Другие параметры нельзя задать с помощью аргументов «имя-значение».

results = compiler.build.webAppArchive(___) возвращает информацию о построении в виде compiler.build.Results с использованием любой из комбинаций аргументов в предыдущих синтаксисах. Сведения о построении состоят из типа построения, пути к скомпилированному архиву и параметров построения.

Примеры

свернуть все

Создание архива веб-приложения из приложения MATLAB с именем Mortgage.mlapp.

Для этого примера выполните компиляцию с помощью файла Mortgage.mlapp расположен в matlabroot\examples\matlab\main.

appFile = fullfile(matlabroot,'examples','matlab','main','Mortgage.mlapp');

Создайте архив веб-приложения с помощью compiler.build.webAppArchive команда.

compiler.build.webAppArchive(appFile);

Функция построения создает следующие файлы в папке с именем MortgagewebAppArchive в текущей рабочей папке:

  • Mortgage.ctf - файл технологии компонентов, содержащий развертываемый архив.

  • mccExcludedFiles.log - Файл журнала, содержащий список всех функций панели инструментов, которые не были включены в веб-приложение. Дополнительные сведения о неподдерживаемых функциях см. в разделе Ограничения компилятора MATLAB.

  • requiredMCRProducts.txt - текстовый файл, содержащий идентификаторы продуктов, необходимых для выполнения приложения MATLAB Runtime.

  • unresolvedSymbols.txt - текстовый файл, содержащий информацию о неразрешенных символах.

Сведения о развертывании веб-приложений см. в разделе Развертывание веб-приложений.

Создайте архив веб-приложения и настройте его с помощью аргументов «имя-значение».

Для этого примера выполните компиляцию с помощью приложения Mortgage.mlapp. Используйте аргументы «имя-значение» для указания имени архива и выходного каталога, а также отображения информации о ходе построения.

compiler.build.webAppArchive('Mortgage.mlapp',...
    'ArchiveName','MyWebApp',...
    'OutputDir','D:\Documents\MATLAB\work\WebApps',...
    'Verbose','on')

Функция создает следующие файлы в папке с именем WebApps в текущей рабочей папке:

  • Mortgage.ctf

  • mccExcludedFiles.log

  • requiredMCRProducts.txt

  • unresolvedSymbols.txt

Создание нескольких архивов веб-приложений с помощью compiler.build.WebAppArchiveOptions объект.

Создать WebAppArchiveOptions объект с использованием файла example1.mlapp. Используйте аргументы «имя-значение», чтобы указать общий выходной каталог, включить MAT-файл, содержащий переменные рабочей области, и отключить автоматическое обнаружение файлов данных.

opts = compiler.build.WebAppArchiveOptions('example1.mlapp',...
    'AdditionalFiles','myvars.mat',...    
    'OutputDir','D:\Documents\MATLAB\work\WebAppBatch',...
    'AutoDetectDataFiles','off',...)
opts = 

  WebAppArchiveOptions with properties:

            ArchiveName: 'example1'
                AppFile: 'D:\Documents\MATLAB\work\example1.mlapp'
        AdditionalFiles: {'D:\Documents\MATLAB\work\myvars.mat'}
    AutoDetectDataFiles: off
              OutputDir: 'D:\Documents\MATLAB\work\WebAppBatch'
                Verbose: off

Создайте архив веб-приложения с помощью WebAppArchiveOptions объект.

compiler.build.webAppArchive(opts);

Компиляция с использованием файла example2.mlapp с теми же опциями, используйте точечную нотацию для изменения AppFile существующих WebAppArchiveOptions перед повторным запуском функции построения.

opts.AppFile = 'example2.m';

Путем изменения AppFile argument и recompiling, можно скомпилировать несколько архивов, используя один и тот же объект options.

Создание архива веб-приложения и сохранение информации о типе построения, архивном файле и параметрах построения в compiler.build.Results объект.

Компиляция с помощью файла Mortgage.mlapp расположен в matlabroot\examples\matlab\main.

results = compiler.build.webAppArchive('Mortgage.mlapp')
results = 

  Results with properties:

    BuildType: 'webAppArchive'
        Files: {'D:\Documents\MATLAB\work\MortgagewebAppArchive\Mortgage.ctf'}
      Options: [1×1 compiler.build.WebAppArchiveOptions]

Files содержит путь к развертываемому архивному файлу Mortgage.ctf.

Входные аргументы

свернуть все

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

Пример: 'mywebapp.mlapp'

Типы данных: char | string

Параметры построения веб-приложения, указанные как compiler.build.WebAppArchiveOptions объект.

Аргументы пары «имя-значение»

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

Пример: 'Verbose','on'

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

Пример: 'AdditionalFiles',["myvars.mat","myfunc.m"]

Типы данных: char | string | cell

Имя архива веб-приложения, указанное как вектор символов или скаляр строки. Значением по умолчанию является имя файла AppFile.

Пример: 'ArchiveName','MyWebApp'

Типы данных: char | string

Флажок для автоматического включения файлов данных, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on', то файлы данных, которые вы предоставляете в качестве входных данных для определенных функций (таких как load и fopen) автоматически включаются в архив веб-приложения.

  • Если для этого свойства задано значение 'off', то необходимо добавить файлы данных в архив с помощью AdditionalFiles собственность.

Пример: 'AutoDetectDataFiles','Off'

Типы данных: logical

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

Именем по умолчанию папки построения является имя архива, добавленное с webAppArchive.

Пример: 'OutputDir','D:\Documents\MATLAB\work\mymagicwebAppArchive'

Типы данных: char | string

Флаг для управления подробностью построения, указанный как 'on' или 'off'или как числовое или логическое 1 (true) или 0 (false). Значение 'on' эквивалентно true, и 'off' эквивалентно false. Таким образом, можно использовать значение этого свойства в качестве логического значения. Значение сохраняется как логическое значение типа вкл/выкл matlab.lang.OnOffSwitchState.

  • Если для этого свойства задано значение 'on'затем в окне команд MATLAB отображается информация о ходе выполнения, указывающая на вывод компилятора в процессе построения.

  • Если для этого свойства задано значение 'off', то командное окно не отображает информацию о ходе выполнения.

Пример: 'Verbose','On'

Типы данных: logical

Выходные аргументы

свернуть все

Результаты построения, возвращенные как compiler.build.Results объект. Results объект содержит:

  • Тип построения, который является 'webAppArchive'

  • Путь к архивному файлу скомпилированного веб-приложения

  • Параметры построения, указанные как WebAppArchiveOptions объект

Представлен в R2020b