compiler.build.webAppArchive

创建存档以部署到 MATLAB Web 应用服务器

全页折叠

语法

compiler.build.webAppArchive(AppFile)

compiler.build.webAppArchive(AppFile,Name,Value)

compiler.build.webAppArchive(opts)

results = compiler.build.webAppArchive(___)

说明

compiler.build.webAppArchive(AppFile) 使用 AppFile 指定的 MATLAB^® App 创建 Web App 存档。

示例

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

示例

compiler.build.webAppArchive(opts) 使用 compiler.build.WebAppArchiveOptions 对象 opts 指定的选项创建一个 Web App 存档。不能使用名称-值参量指定任何其他选项。

示例

results = compiler.build.webAppArchive(___) 使用以上语法中的任意参量组合以 compiler.build.Results 对象形式返回编译信息。构建信息包括构建类型、编译存档的路径和构建选项。

示例

全部折叠

创建 Web App 存档

从名为 Mortgage.mlapp 的 MATLAB App 创建 Web App 存档。

对于此示例，使用名为 Mortgage.mlapp 的 MATLAB App。

setupExample("matlab/MortgageCalculatorExample",pwd)
appFile = "Mortgage.mlapp";

使用 compiler.build.webAppArchive 命令构建一个 Web App 存档。

compiler.build.webAppArchive(appFile);

该编译函数会在当前工作目录中名为 MortgagewebAppArchive 的文件夹中生成以下文件：

includedSupportPackages.txt - 列出存档中包含的所有支持文件的文本文件。
Mortgage.ctf - 包含可部署存档的组件技术文件。
mccExcludedFiles.log - 包含 Web App 中未包含的任何工具箱函数列表的日志文件。有关不受支持的函数的详细信息，请参阅 MATLAB Compiler 限制。
requiredMCRProducts.txt - 包含 MATLAB Runtime 运行该 Web App 所需产品的产品 ID 的文本文件。
unresolvedSymbols.txt - 包含有关未解析符号的信息的文本文件。

有关部署 Web App 的信息，请参阅部署 Web App。

自定义 Web App 存档

创建一个 Web App 存档并使用名称-值参量对其进行自定义。

对于此示例，使用应用 Mortgage.mlapp。使用名称-值参量指定存档名称和输出目录，并在构建过程中显示进度信息。

setupExample("matlab/MortgageCalculatorExample",pwd)
appFile = "Mortgage.mlapp";
compiler.build.webAppArchive(appFile, ...
'ArchiveName','MyWebApp', ...
'OutputDir','D:\Documents\MATLAB\work\WebApps', ...
'Verbose','on')

该函数会在当前工作目录中名为 WebApps 的文件夹中生成以下文件：

includedSupportPackages.txt
Mortgage.ctf
mccExcludedFiles.log
requiredMCRProducts.txt
unresolvedSymbols.txt

使用选项对象自定义多个 Web App 存档

使用 compiler.build.WebAppArchiveOptions 对象创建多个 Web App 存档。

使用文件 Mortgage.mlapp 创建 WebAppArchiveOptions 对象。使用名称-值参量指定一个公共输出目录并禁用数据文件的自动检测。

setupExample("matlab/MortgageCalculatorExample",pwd)
appFile = "Mortgage.mlapp";
opts = compiler.build.WebAppArchiveOptions(appFile, ...
'OutputDir','D:\Documents\MATLAB\work\WebAppBatch', ...
'AutoDetectDataFiles','off')

opts = 
  WebAppArchiveOptions with properties:

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

使用 WebAppArchiveOptions 对象构建 Web App 存档。

compiler.build.webAppArchive(opts);

要使用具有相同选项的文件 ExampleApp2.mlapp 进行编译，请在再次运行构建函数之前使用点符号修改现有 WebAppArchiveOptions 对象的 AppFile。

opts.AppFile = 'ExampleApp2.m';

通过修改 AppFile 参量并重新编译，您可以使用相同的选项对象编译多个存档。

从 Web App 存档获取构建信息

创建一个 Web App 存档，并将有关构建类型、存档文件、包含的支持包和构建选项的信息保存到 compiler.build.Results 对象中。

使用文件 Mortgage.mlapp 进行编译。

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

results = 

  Results with properties:

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

Files 属性包含可部署存档文件 Mortgage.ctf 的路径。

输入参数

全部折叠

`AppFile` — 主文件路径
字符向量 | 字符串标量

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

示例: 'mywebapp.mlapp'

数据类型: char | string

`opts` — Web App 编译选项
`compiler.build.WebAppArchiveOptions` 对象

Web App 构建选项，指定为 compiler.build.WebAppArchiveOptions 对象。

名称-值参数

全部折叠

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

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

示例: 'Verbose','on'

`AdditionalFiles` — 其他文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

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

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

数据类型: char | string | cell

`ArchiveName` — Web App 存档的名称
字符向量 | 字符串标量

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

示例: 'ArchiveName','MyWebApp'

数据类型: char | string

`AutoDetectDataFiles` — 自动包含数据文件的标志
`'on'` (默认) | on/off 逻辑值

自动包含数据文件的标志，指定为 '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

`ExternalEncryptionKey` — 加密密钥和加载程序文件路径
标量结构体

自 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

`ObfuscateArchive` — 混淆处理可部署存档的标志
`'off'` (默认) | on/off 逻辑值

用于混淆处理可部署存档的标志，指定为 '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

`OutputDir` — 输出目录路径
字符向量 | 字符串标量

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

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

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

数据类型: char | string

`SecretsManifest` — JSON 清单文件路径
字符向量 | 字符串标量

自 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

`SupportPackages` — 支持包
`'autodetect'` (默认) | `'none'` | 字符串标量 | 字符向量元胞数组 | 字符串数组

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

'autodetect'（默认值）- 依赖关系分析过程会自动检测并包含所需的支持包。
'none' - 不包括任何支持包。使用此选项可能会导致运行时错误。
字符串标量、字符向量或字符向量元胞数组 - 仅包含指定的支持包。要列出已安装的支持包或特定文件使用的那些支持包，请参阅 compiler.codetools.deployableSupportPackages。

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

数据类型: char | string | cell

`Verbose` — 控制编译详细程度的标志
`'off'` (默认) | on/off 逻辑值

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

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

示例: 'Verbose','on'

数据类型: logical

输出参量

全部折叠

`results` — 编译结果
`compiler.build.Results` 对象

编译结果，以 compiler.build.Results 对象形式返回。Results 对象包含：

编译类型，即 'webAppArchive'
已编译的 Web 应用存档文件的路径
包含的支持包的列表
编译选项，指定为 WebAppArchiveOptions 对象

版本历史记录

在 R2020b 中推出

全部展开

R2024b: 指定加密密钥

使用 ExternalEncryptionKey 选项指定 256 位 AES 加密密钥和 MEX 文件加载程序接口，以在运行时检索解密密钥。此选项等效于 mcc -k 选项。

R2024b: 打包包含机密的代码

使用 SecretsManifest 选项包括一个 JSON 文件，该文件指定要嵌入可部署代码存档中的机密。此选项等效于 mcc -J 选项。

R2023a: 混淆文件结构和 MATLAB 代码

使用 ObfuscateArchive 选项混淆文件夹结构和文件名，并将 MATLAB 文件数据和用户代码放入存档内的用户包中。另外，所有 .m 文件在打包前会转换为 P 文件。此选项等效于在指定了 -j 和 -s 的情况下使用 mcc。

R2021b: 指定支持包

使用 SupportPackages 选项指定要包含在可部署代码存档中的支持包。

另请参阅

compiler.build.WebAppArchiveOptions | Web App 编译器 | mcc

compiler.build.webAppArchive

语法

说明

示例

创建 Web App 存档

自定义 Web App 存档

使用选项对象自定义多个 Web App 存档

从 Web App 存档获取构建信息

输入参数

AppFile — 主文件路径 字符向量 | 字符串标量

opts — Web App 编译选项 compiler.build.WebAppArchiveOptions 对象

名称-值参数

AdditionalFiles — 其他文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

ArchiveName — Web App 存档的名称 字符向量 | 字符串标量

AutoDetectDataFiles — 自动包含数据文件的标志 'on' (默认) | on/off 逻辑值

ExternalEncryptionKey — 加密密钥和加载程序文件路径 标量结构体

ObfuscateArchive — 混淆处理可部署存档的标志 'off' (默认) | on/off 逻辑值

OutputDir — 输出目录路径 字符向量 | 字符串标量

SecretsManifest — JSON 清单文件路径 字符向量 | 字符串标量

SupportPackages — 支持包 'autodetect' (默认) | 'none' | 字符串标量 | 字符向量元胞数组 | 字符串数组

Verbose — 控制编译详细程度的标志 'off' (默认) | on/off 逻辑值

输出参量

results — 编译结果 compiler.build.Results 对象

版本历史记录

R2024b: 指定加密密钥

R2024b: 打包包含机密的代码

R2023a: 混淆文件结构和 MATLAB 代码

R2021b: 指定支持包

另请参阅

主题

`AppFile` — 主文件路径
字符向量 | 字符串标量

`opts` — Web App 编译选项
`compiler.build.WebAppArchiveOptions` 对象

`AdditionalFiles` — 其他文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`ArchiveName` — Web App 存档的名称
字符向量 | 字符串标量

`AutoDetectDataFiles` — 自动包含数据文件的标志
`'on'` (默认) | on/off 逻辑值

`ExternalEncryptionKey` — 加密密钥和加载程序文件路径
标量结构体

`ObfuscateArchive` — 混淆处理可部署存档的标志
`'off'` (默认) | on/off 逻辑值

`OutputDir` — 输出目录路径
字符向量 | 字符串标量

`SecretsManifest` — JSON 清单文件路径
字符向量 | 字符串标量

`SupportPackages` — 支持包
`'autodetect'` (默认) | `'none'` | 字符串标量 | 字符向量元胞数组 | 字符串数组

`Verbose` — 控制编译详细程度的标志
`'off'` (默认) | on/off 逻辑值

`results` — 编译结果
`compiler.build.Results` 对象