compiler.build.productionServerArchive

创建存档以部署到 MATLAB Production Server 或 Docker

全页折叠

语法

compiler.build.productionServerArchive(FunctionFiles)

compiler.build.productionServerArchive(FunctionFiles,Name,Value)

compiler.build.productionServerArchive(opts)

results = compiler.build.productionServerArchive(___)

说明

compiler.build.productionServerArchive(FunctionFiles) 使用 FunctionFiles 指定的 MATLAB^® 函数创建可部署的存档。

示例

compiler.build.productionServerArchive(FunctionFiles,Name,Value) 使用一个或多个名称-值参量指定附加选项，从而创建一个可部署的存档。选项包括存档名称、JSON 函数签名和输出目录。

示例

compiler.build.productionServerArchive(opts) 使用 compiler.build.ProductionServerArchiveOptions 对象 opts 指定选项，创建可部署的存档。不能使用名称-值参量指定任何其他选项。

示例

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

示例

全部折叠

创建 MATLAB Production Server 存档

创建可部署的服务器存档。

在 MATLAB 中，定位您想要作为存档部署的 MATLAB 函数。对于此示例，使用 matlabroot\extern\examples\compiler 中的文件 magicsquare.m。

appFile = which('magicsquare.m');

使用 compiler.build.productionServerArchive 命令构建生产服务器存档。

compiler.build.productionServerArchive(appFile);

此语法会在当前工作目录中名为 mymagicproductionServerArchive 的文件夹下生成以下文件：

includedSupportPackages.txt - 列出存档中包含的所有支持文件的文本文件。
mymagic.ctf - 可部署的生产服务器存档文件。
mccExcludedFiles.log - 包含应用程序中未包含的任何工具箱函数列表的日志文件。有关不支持的函数的信息，请参阅 MATLAB Compiler 限制。
readme.txt - 包含有关部署前提条件的信息以及要打包以进行部署的文件列表的自述文件。
requiredMCRProducts.txt - 包含 MATLAB Runtime 运行应用程序所需产品的产品 ID 的文本文件。

自定义生产服务器存档

创建生产服务器存档并使用名称-值参量对其进行自定义。

对于此示例，使用 matlabroot\extern\examples\compiler 中的文件 addmatrix.m 和 subtractmatrix.mat。

addFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','addmatrix.m');
subFile = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','subtractmatrix.m');

使用 compiler.build.productionServerArchive 命令构建生产服务器存档。使用名称-值参量指定存档名称并启用详尽输出。

compiler.build.productionServerArchive({addFile,subFile}, ...
'ArchiveName','MatrixArchive', ...
'Verbose','on');

此语法会在当前工作目录中名为 MatrixArchiveproductionServerArchive 的文件夹下生成以下文件：

includedSupportPackages.txt - 列出存档中包含的所有支持文件的文本文件。
MatrixArchive.ctf - 可部署的生产服务器存档文件。
mccExcludedFiles.log - 包含应用程序中未包含的任何工具箱函数列表的日志文件。有关不支持的函数的信息，请参阅 MATLAB Compiler 限制。
readme.txt - 包含有关部署前提条件的信息以及要打包以进行部署的文件列表的自述文件。
requiredMCRProducts.txt - 包含 MATLAB Runtime 运行应用程序所需产品的产品 ID 的文本文件。

使用选项对象创建多个生产服务器存档

使用 compiler.build.ProductionServerArchiveOptions 对象自定义多个生产服务器存档。

对于此示例，使用 matlabroot\extern\examples\compiler 中的文件 hello.m。

functionFile = which('hello.m');

创建一个 ProductionServerArchiveOptions 对象。使用名称-值参量指定一个公共输出目录，禁用数据文件的自动包含，并启用详尽输出。

opts = compiler.build.ProductionServerArchiveOptions(functionFile, ...    
'OutputDir','D:\Documents\MATLAB\work\ProductionServerBatch', ...
'AutoDetectDataFiles','off', ...
'Verbose','on')

opts = 

  ProductionServerArchiveOptions with properties:

              ArchiveName: 'hello'
            FunctionFiles: {'C:\Program Files\MATLAB\R2025a\extern\examples\compiler\hello.m'}
       FunctionSignatures: ''
               RoutesFile: ''
          AdditionalFiles: {}
      AutoDetectDataFiles: off
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\ProductionServerBatch'

使用 ProductionServerArchiveOptions 对象构建生产服务器存档。

compiler.build.productionServerArchive(opts);

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

opts.FunctionFiles = which('houdini.m');
compiler.build.productionServerArchive(opts);

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

使用结果创建微服务 Docker 映像

使用在 Docker^® 系统上构建生产服务器存档的结果创建微服务 Linux^® 映像。

在您的系统上安装并配置 Docker。

使用 magicsquare.m 创建生产服务器存档并将构建结果保存到 compiler.build.Results 对象。

appFile = which('magicsquare.m');
buildResults = compiler.build.productionServerArchive(appFile);

将 Results 对象作为输入传递给 compiler.package.microserviceDockerImage 函数来构建 Docker 映像。

compiler.package.microserviceDockerImage(buildResults);

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

applicationFilesForMATLABCompiler/magicsquare.ctf - 可部署存档文件。
Dockerfile - 指定 Docker Runtime 选项的 Docker 文件。
GettingStarted.txt - 包含部署信息的文本文件。

有关详细信息，请参阅创建微服务 Docker 镜像。

从生产服务器存档获取构建信息

创建生产服务器存档并将有关构建类型、存档文件、包含的支持包和构建选项的信息保存到 compiler.build.Results 对象中。

使用文件 magicsquare.m 进行编译。

results = compiler.build.productionServerArchive('magicsquare.m')

results = 

  Results with properties:

                  BuildType: 'productionServerArchive'
                      Files: {'D:\Documents\MATLAB\work\magicsquareproductionServerArchive\magicsquare.ctf'}
    IncludedSupportPackages: {}
                    Options: [1×1 compiler.build.ProductionServerArchiveOptions]
        RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

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

输入参数

全部折叠

`FunctionFiles` — 实现 MATLAB 函数的文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

实现 MATLAB 函数的文件，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。文件路径可以是相对于当前工作目录的路径，也可以是绝对路径。文件必须具有以下扩展名之一：.m、.p、.mlx 或 .mexa64。

示例: ["myfunc1.m","myfunc2.m"]

数据类型: char | string | cell

`opts` — 生产服务器选项对象
`compiler.build.ProductionServerArchiveOptions` 对象

生产服务器存档构建选项，指定为 compiler.build.ProductionServerArchiveOptions 对象。

名称-值参数

全部折叠

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

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

示例: 'Verbose','on'

`AdditionalFiles` — 可部署存档中包含的文件和文件夹
字符向量 | 字符串标量

生产服务器存档中要包含的文件和文件夹列表。

示例: 'AdditionalFiles','MyFile.txt'

数据类型: char | string | cellstr vector

`ArchiveName` — 可部署存档的名称
字符向量 | 字符串标量

可部署存档的名称，指定为字符向量或字符串标量。生成的存档的默认名称是 FunctionFiles 参量的第一个条目。

示例: 'ArchiveName','MyMagic'

数据类型: char | string

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

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

如果将此属性设置为 'on'，则您作为某些函数（例如 load 和 fopen）的输入提供的数据文件将自动包含在生产服务器存档中。
如果将此属性设置为 '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

`FunctionSignatures` — JSON 文件的路径
字符向量 | 字符串标量

详细说明 FunctionFiles 中列出的所有函数签名的 JSON 文件的路径，指定为字符向量或字符串标量。有关指定函数签名的信息，请参阅JSON 中的 MATLAB 函数签名 (MATLAB Production Server)。

示例: 'FunctionSignatures','D:\Documents\MATLAB\work\magicapp\signatures.json'

数据类型: char | string

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

混淆可部署存档的标志，指定为 'on'/1/true 或 'off'/0/false。该值存储为 matlab.lang.onoffSwitchState 类型的 on/off 逻辑值。

如果将此属性设置为 'on'，则会对最终用户混淆可部署存档中的文件夹结构和文件名，并且 .m、.mlapp、.p、.mat、MLX 文件、SFX 文件和 MEX 文件中包含的用户代码和数据将被放入存档内的用户包中。另外，所有 .m 文件在打包前会转换为 P 文件。

在运行时，系统会从用户包直接解密和加载 MATLAB 代码和数据，而不是将其提取到文件系统。在加载之前，系统会从用户包中临时提取 MEX 文件。

要在用户包中手动包含其他文件类型，请将每种文件类型以单独的扩展标记的形式添加到文件 matlabroot/toolbox/compiler/advanced_package_supported_files.xml 中。

以下内容不受支持：

ver 函数
调用外部库，例如 DLL
进程外 MATLAB Runtime（用于 MATLAB Data Array 的 C++ 共享库）
进程外 MEX 文件执行（mexhost、feval、matlab.mex.MexHost）
在 R2023b 之前的版本中: v7.3 之外的 .mat 文件

启用此选项等效于在指定了 -j 和 -s 的情况下使用 mcc。

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

示例: 'ObfuscateArchive','on'

数据类型: logical

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

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

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

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

`RoutesFile` — JSON 文件的路径
`''` (默认) | 字符向量 | 字符串标量

自 R2024a 起

指定服务器上的自定义 URL 路由的 JSON 文件的路径，指定为字符向量或字符串标量。

示例: RoutesFile,'routes.json'

数据类型: 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','off'

数据类型: logical

输出参量

全部折叠

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

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

编译类型，即 'productionServerArchive'
可部署存档文件的路径
包含的支持包的列表
编译选项，指定为 ProductionServerArchiveOptions 对象
必需和可选依赖项的列表，指定为 Dependencies 对象

限制

在 R2024a 之前的版本中，compiler.build.ProductionServerArchive 不支持打包特定于存档的路由 JSON 文件以将 URL 请求映射到存档内的 Web 处理程序函数。在 routes-file (MATLAB Production Server) 配置属性指定的 JSON 文件中定义路由，或者使用 mcc 将路由 JSON 文件打包到存档中。

版本历史记录

在 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.ProductionServerArchiveOptions | compiler.build.Results | compiler.package.microserviceDockerImage

App

Production Server 存档编译器

compiler.build.productionServerArchive

语法

说明

示例

创建 MATLAB Production Server 存档

自定义生产服务器存档

使用选项对象创建多个生产服务器存档

使用结果创建微服务 Docker 映像

从生产服务器存档获取构建信息

输入参数

FunctionFiles — 实现 MATLAB 函数的文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

opts — 生产服务器选项对象 compiler.build.ProductionServerArchiveOptions 对象

名称-值参数

AdditionalFiles — 可部署存档中包含的文件和文件夹 字符向量 | 字符串标量

ArchiveName — 可部署存档的名称 字符向量 | 字符串标量

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

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

FunctionSignatures — JSON 文件的路径 字符向量 | 字符串标量

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

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

RoutesFile — JSON 文件的路径 '' (默认) | 字符向量 | 字符串标量

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

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

Verbose — 构建详细程度 'off' (默认) | on/off 逻辑值

输出参量

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

限制

版本历史记录

R2024b: 指定加密密钥

R2024b: 打包包含机密的代码

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

R2021b: 指定支持包

另请参阅

函数

App

`FunctionFiles` — 实现 MATLAB 函数的文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

`opts` — 生产服务器选项对象
`compiler.build.ProductionServerArchiveOptions` 对象

`AdditionalFiles` — 可部署存档中包含的文件和文件夹
字符向量 | 字符串标量

`ArchiveName` — 可部署存档的名称
字符向量 | 字符串标量

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

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

`FunctionSignatures` — JSON 文件的路径
字符向量 | 字符串标量

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

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

`RoutesFile` — JSON 文件的路径
`''` (默认) | 字符向量 | 字符串标量

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

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

`Verbose` — 构建详细程度
`'off'` (默认) | on/off 逻辑值

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