本页采用了机器翻译。点击此处可查看最新英文版本。

compiler.build.WebAppArchiveOptions

构建 Web App 存档的选项

全页折叠

语法

opts = compiler.build.WebAppArchiveOptions(AppFile)
opts = compiler.build.WebAppArchiveOptions(AppFile,Name,Value)

说明

opts = compiler.build.WebAppArchiveOptions(AppFile) 使用通过 AppFile 指定的 MATLAB® App 创建 WebAppArchiveOptions 对象。使用 WebAppArchiveOptions 对象作为 compiler.build.webAppArchive 函数的输入。

示例

opts = compiler.build.WebAppArchiveOptions(AppFile,Name,Value) 使用一个或多个名称-值参量指定选项来创建一个 WebAppArchiveOptions 对象。选项包括存档名称、要包含的附加文件和输出目录。

示例

示例

全部折叠

从名为 Mortgage.mlapp 的 MATLAB App 创建 WebAppArchiveOptions 对象。

对于此示例，通过执行以下命令将 MATLAB App 文件 Mortgage.mlapp 下载到您当前的工作目录：

setupExample("matlab/MortgageCalculatorExample",pwd)

使用 compiler.build.WebAppArchiveOptions 命令创建 Web App 选项对象。

opts = compiler.build.WebAppArchiveOptions('Mortgage.mlapp')
opts = 

  WebAppArchiveOptions with properties:

                  AppFile: 'Mortgage.mlapp'
              ArchiveName: 'Mortgage'
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: '.\MortgagewebAppArchive'

使用 WebAppArchiveOptions 对象作为 compiler.build.webAppArchive 函数的输入来构建 Web App 存档。

buildResults = compiler.build.webAppArchive(opts);

使用名称-值参量创建 WebAppArchiveOptions 对象。

使用函数文件 Mortgage.mlapp 创建一个 WebAppArchiveOptions 对象。使用名称-值参量指定存档名称和输出目录，添加 MAT 文件，并禁用数据文件的自动检测。

opts = compiler.build.WebAppArchiveOptions('Mortgage.mlapp', ...
'ArchiveName','MyWebApp', ...
'OutputDir','D:\Documents\MATLAB\work\WebApps', ...
'AdditionalFiles','myvars.mat', ...
'AutoDetectDataFiles','off')
opts = 

  WebAppArchiveOptions with properties:

                  AppFile: 'D:\Documents\MATLAB\work\Mortgage.mlapp'
              ArchiveName: 'MyWebApp'
          AdditionalFiles: {D:\Documents\MATLAB\work\myvars.mat}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: off
                OutputDir: 'D:\Documents\MATLAB\work\WebApps'

您可以使用点符号修改现有 WebAppArchiveOptions 对象的属性值。例如，启用详尽输出。

opts.Verbose = 'on';

使用 WebAppArchiveOptions 对象作为 compiler.build.webAppArchive 函数的输入来构建 Web App 存档。

buildResults = compiler.build.webAppArchive(opts);

输入参数

全部折叠

主文件的路径，指定为行字符向量或字符串标量。该文件必须是具有 .mlapp 扩展名的 MATLAB App。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

示例: 'mywebapp.mlapp'

数据类型: char | string

名称-值参数

全部折叠

以 Name1=Value1,...,NameN=ValueN 的形式指定可选参量对组，其中 Name 是参量名称，Value 是对应的值。名称-值参量必须出现在其他参量之后，但对各个参量对组的顺序没有要求。

如果使用的是 R2021a 之前的版本，请使用逗号分隔每个名称和值，并用引号将 Name 引起来。

示例: 'Verbose','on'

要包含在 Web App 存档中的其他文件和文件夹，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。路径可以是相对于当前工作目录的路径，也可以是绝对路径。

示例: 'AdditionalFiles',["myvars.mat","myfunc.m"]

数据类型: char | string | cell

Web App 存档的名称，指定为字符向量或字符串标量。默认值是 AppFile 的文件名。

示例: 'ArchiveName','MyWebApp'

数据类型: char | string

自动包含数据文件的标志，指定为 'on' 或 'off'，或者指定为数值或逻辑 1 (true) 或 0 (false)。值 'on' 等效于 true，值 'off' 等效于 false。因此，可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 如果将此属性设置为 'on'，则您作为某些函数（例如 load 和 fopen）的输入提供的数据文件将自动包含在 Web App 存档中。

  • 如果将此属性设置为 'off'，则必须使用 AdditionalFiles 属性将数据文件添加到存档中。

示例: 'AutoDetectDataFiles','Off'

数据类型: logical

自 R2024b 起

外部 AES 加密密钥和 MEX 密钥加载程序文件的路径，指定为标量结构体，其中恰好有两个分别名为 EncryptionKeyFile 和 RuntimeKeyLoaderFile 的行字符向量或字符串标量字段。两个结构体字段都是必需的。文件路径可以是相对于当前工作目录的路径，也可以是绝对路径。

例如，使用结构体 keyValueStruct 将加密密钥指定为 encrypt.key，将加载程序文件指定为 loader.mexw64。

keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'

加密密钥文件必须采用以下受支持的格式之一：

  • 二进制 256 位 AES 密钥，文件大小为 32 字节

  • 十六进制编码的 AES 密钥，文件大小为 64 字节

MEX 文件加载程序在运行时检索解密密钥，并且必须是具有以下参量的接口：

  • prhs[0] - 输入，指定为静态值 'get' 的字符数组

  • prhs[1] - 输入，指定为 CTF 组件 UUID 的字符数组

  • plhs[0] - 输出，32 字节 UINT8 数字数组或 64 字节十六进制编码字符数组，具体取决于密钥格式

请勿在多个 CTF 之间共享同一个密钥。

示例: 'ExternalEncryptionKey',keyValueStruct

数据类型: struct

用于混淆处理可部署存档的标志，指定为 'on' 或 'off'，或者指定为数字或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，值 'off' 等效于 false。因此，可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 如果将此属性设置为 'on'，则可部署存档中的文件夹结构和文件名将对最终用户进行混淆，并且 MATLAB 文件中包含的用户代码和数据将放入存档内的用户包中。另外，所有 .m 文件在打包前会转换为 P 文件。此选项等效于在指定了 -j 和 -s 的情况下使用 mcc。

  • 如果将此属性设置为 'off'，则不会混淆可部署存档。这是默认行为。

示例: 'ObfuscateArchive','on'

数据类型: logical

保存编译文件的输出目录的路径，指定为字符向量或字符串标量。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

构建文件夹的默认名称是存档名称加上 webAppArchive。

示例: 'OutputDir','D:\Documents\MATLAB\work\mymagicwebAppArchive'

数据类型: char | string

自 R2024b 起

机密清单 JSON 文件的路径，该文件指定要嵌入在可部署存档中的密钥，指定为字符向量或字符串标量。该路径可以是相对于当前工作目录的路径，也可以是绝对路径。

如果您的 MATLAB 代码调用 getSecret、getSecretMetadata 或 isSecret 函数，您必须在 JSON 机密清单文件中指定要嵌入可部署存档的密钥。如果您的代码调用 getSecret 并且您未指定 SecretsManifest 选项，则 MATLABCompiler™ 会发出警告，并在名为 <component_name>_secrets_manifest.json 的输出文件夹中生成一个模板 JSON 文件。通过在嵌入字段中指定密钥名称来修改此文件。

setSecret 函数不可部署。要将密钥嵌入在可部署存档中，您必须在构建存档之前在 MATLAB 中调用 setSecret。

有关使用密钥进行部署的详细信息，请参阅处理已部署 App 中的敏感信息。

示例: 'SecretsManifest','D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'

数据类型: char | string

要包含的支持包，指定为以下选项之一：

  • 'autodetect'（默认值）- 依赖关系分析过程会自动检测并包含所需的支持包。

  • 'none' - 不包括任何支持包。使用此选项可能会导致运行时错误。

  • 字符串标量、字符向量或字符向量元胞数组 - 仅包含指定的支持包。要列出已安装的支持包或特定文件使用的那些支持包，请参阅 compiler.codetools.deployableSupportPackages。

示例: 'SupportPackages',{'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}

数据类型: char | string | cell

控制编译详细程度的标志，指定为 'on' 或 'off'，或者指定为数值或逻辑 1 (true) 或 0 (false)。值 'on' 等效于 true，值 'off' 等效于 false。因此，可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

  • 如果将此属性设置为 'on'，则 MATLAB 命令行窗口会显示进度信息，指示编译过程期间的编译器输出。

  • 如果将此属性设置为 'off'，则命令行窗口不会显示进度信息。

示例: 'Verbose','on'

数据类型: logical

输出参量

全部折叠

Web App 存档构建选项，作为 WebAppArchiveOptions 对象返回。

版本历史记录

在 R2020b 中推出

全部展开

另请参阅

|

主题