compiler.build.cppSharedLibrary

创建 C++ 共享库

自 R2021a 起

全页折叠

语法

compiler.build.cppSharedLibrary(FunctionFiles)

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

compiler.build.cppSharedLibrary(opts)

results = compiler.build.cppSharedLibrary(___)

说明

compiler.build.cppSharedLibrary(FunctionFiles) 使用由 FunctionFiles 指定的 MATLAB^® 文件创建 C++ 共享库。使用此函数之前，请安装受支持的 C++ 编译器。

示例

compiler.build.cppSharedLibrary(FunctionFiles,Name,Value) 使用由一个或多个名称-值参量指定的选项创建 C++ 共享库。选项包括接口 API、库名称和输出目录。

示例

compiler.build.cppSharedLibrary(opts) 使用由 compiler.build.CppSharedLibraryOptions 对象 opts 指定的选项创建 C++ 共享库。不能使用名称-值参量指定任何其他选项。

示例

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

示例

全部折叠

创建 C++ 库

使用将两个矩阵相加的函数文件创建一个 C++ 共享库。

在 MATLAB 中，找到要部署为 C++ 库的 MATLAB 函数。对于此示例，使用 matlabroot\extern\examples\compilersdk\c_cpp\matrix 中的文件 addmatrix.m。

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

使用 compiler.build.cppSharedLibrary 命令编译 C++ 库。

compiler.build.cppSharedLibrary(appFile);

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

GettingStarted.html - 包含有关集成您共享库的信息的 HTML 文件。
includedSupportPackages.txt - 列出库中包含的所有支持文件的文本文件。
mccExcludedFiles.log - 包含应用程序中未包含的任何工具箱函数列表的日志文件。有关不支持的函数的信息，请参阅 MATLAB Compiler 限制。
readme.txt - 包含有关部署前提条件的信息以及要打包以进行部署的文件列表的自述文件。
requiredMCRProducts.txt - 包含 MATLAB Runtime 运行应用程序所需产品的产品 ID 的文本文件。
unresolvedSymbols.txt - 包含有关未解析符号的信息的文本文件。
v2\generic_interface\readme.txt - 包含有关部署前提条件的信息以及要打包以进行部署的文件列表的自述文件。
v2\generic_interface\magicsquare.ctf - 包含可部署存档的组件技术文件。

要实现共享库，请参阅使用示例应用程序实现 C++ MATLAB Data API 共享库。

自定义 C++ 库

创建一个 C++ 库并使用名称-值参量对它进行自定义。

对于此示例，使用 matlabroot\extern\examples\compilersdk\c_cpp\matrix 中的文件 addmatrix.m。

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

将以下代码保存在名为 addmatrixSample1.m 的示例文件中：

a1 = [1 4 7; 2 5 8; 3 6 9];
a2 = a1;
a = addmatrix(a1, a2);

使用 compiler.build.cppSharedLibrary 命令编译 C++ 库。使用名称-值参量指定库名称，添加一个示例文件，并使用 mwArray 接口。

compiler.build.cppSharedLibrary(appFile,'LibraryName','mwa_addmatrix', ...
'SampleGenerationFiles','addmatrixSample1.m', ...
'Interface','mwarray');

该编译函数会在当前工作目录中名为 mwa_addmatrixcppSharedLibrary 的文件夹中创建以下文件：

samples\addmatrixSample1_mwarray.cpp - C++ 示例应用程序。
GettingStarted.html - 包含有关集成您共享库的信息的文件。
includedSupportPackages.txt - 列出库中包含的所有支持文件的文本文件。
mwa_addmatrix.cpp - C++ 源代码文件。
mwa_addmatrix.def - 为链接器提供模块信息的模块定义文件。
mwa_addmatrix.dll - 动态链接库文件。
mwa_addmatrix.exports - 包含所有非静态函数名称的导出文件。
mwa_addmatrix.h - C++ 头文件。
mwa_addmatrix.lib - 导入库文件。
mccExcludedFiles.log - 包含应用程序中未包含的任何工具箱函数列表的日志文件。有关不支持的函数的信息，请参阅 MATLAB Compiler 限制。
readme.txt - 包含有关部署前提条件的信息以及要打包以进行部署的文件列表的自述文件。
requiredMCRProducts.txt - 包含 MATLAB Runtime 运行应用程序所需产品的产品 ID 的文本文件。
unresolvedSymbols.txt - 包含有关未解析符号的信息的文本文件。

要实现共享库，请参阅使用 C++ 示例应用程序实现 C++ mwArray API 共享库。

使用选项对象创建多个库

使用 compiler.build.CppSharedLibraryOptions 对象创建多个 C++ 库。

对于此示例，使用 matlabroot\extern\examples\compilersdk\c_cpp\matrix 中的文件 addmatrix.m。

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

使用 appFile 创建一个 CppSharedLibraryOptions 对象。使用名称-值参量指定一个共用输出目录，启用调试符号，并启用详尽输出。

opts = compiler.build.CppSharedLibraryOptions(appFile, ...
'OutputDir','D:\Documents\MATLAB\work\CppLibraryBatch', ...
'DebugBuild','on','Verbose','on')

opts = 

  CppSharedLibraryOptions with properties:

                Interface: 'matlab-data'
           LibraryVersion: '1.0.0.0'
    SampleGenerationFiles: {}
            FunctionFiles: {'C:\Program Files\MATLAB\R2025b\extern\examples\compilersdk\c_cpp\addmatrix.m'}
               DebugBuild: on
              LibraryName: 'magicsquare'
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\CppLibraryBatch'

使用 CppSharedLibraryOptions 对象编译 C++ 共享库。

compiler.build.cppSharedLibrary(opts);

要使用具有相同选项的函数文件 subtractmatrix.m 来创建新库，请在再次运行编译函数之前，使用圆点表示法修改现有 CppSharedLibrary 对象的 FunctionFiles 参量。

opts.FunctionFiles = fullfile(matlabroot,'extern','examples','compilersdk','c_cpp','matrix','subtractmatrix.m');
compiler.build.cppSharedLibrary(opts);

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

从 C++ 库获取编译信息

创建一个 C++ 库，并将有关编译类型、编译的文件、支持包和编译选项的信息保存到 compiler.build.Results 对象中。

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

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

results = 

  Results with properties:

              BuildType: 'cppSharedLibrary'
                  Files: {2×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.CppSharedLibraryOptions]
    RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

Files 属性包含 v2 文件夹和 GettingStarted.html 的路径。

输入参数

全部折叠

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

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

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

数据类型: char | string | cell

`opts` — C++ 库编译选项
`compiler.build.CppSharedLibraryOptions` 对象

C++ 库编译选项，指定为 compiler.build.CppSharedLibraryOptions 对象。

名称-值参数

全部折叠

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

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

示例: 'Verbose','on'

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

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

示例: 'AdditionalFiles',["myvars.mat","data.txt"]

数据类型: char | string | cell

`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

`DebugBuild` — 启用调试符号的标志
`'off'` (默认) | on/off 逻辑值

启用调试符号的标志，指定为 'on' 或 'off'，或者指定为数值或逻辑值 1 (true) 或 0 (false)。值 'on' 等效于 true，值 'off' 等效于 false。因此，可以将此属性的值用作逻辑值。该值存储为 matlab.lang.OnOffSwitchState 类型的 on/off 逻辑值。

如果将此属性设置为 'on'，则调试符号信息将包含在编译的工件中。此选项还会使 mbuild 将相应的调试标志传递到系统编译器。通过调试选项，您可以回溯到能够确定故障是发生在 MATLAB Runtime 初始化、函数调用还是终止例程中的时间点。此选项不允许您使用外部调试器调试 MATLAB 文件。
如果将此属性设置为 'off'，则不会包含调试符号。这是默认选项。

示例: 'DebugBuild','on'

数据类型: logical

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

自 R2024b 起

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

对于 C++ 共享库，除了在编译时指定密钥和 MEX 加载程序之外，您还可以仅指定加密密钥并将 RuntimeKeyLoaderFile 设置为空字符串。然后，在运行时，您在 C++ 应用程序中提供十六进制编码的 64 字节解密密钥，作为使用 MATLAB Data API 的 initMATLABLibrary 函数或使用 MWArray API 的 <library>InitializeWithKey 函数的参量。

例如，使用结构体 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

`Interface` — 接口 API
`'matlab-data'` (默认) | `'mwarray'`

接口 API，指定为以下选项之一：

'matlab-data' - 使用 MATLAB Data API 生成共享库。
'mwarray' - 使用 mwArray API 生成共享库。

有关详细信息，请参阅MATLAB Compiler SDK C++ API 摘要。

示例: 'Interface','mwarray'

`LibraryName` — C++ 共享库的名称
字符向量 | 字符串标量

C++ 共享库的名称，指定为字符向量或字符串标量。生成的库的默认名称是 FunctionFiles 参量的第一个条目。

示例: 'LibraryName','mymagic'

数据类型: 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` — 输出目录路径
字符向量 | 字符串标量

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

编译文件夹的默认名称是库名称后跟 cppSharedLibrary。

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

数据类型: char | string

`SampleGenerationFiles` — MATLAB 示例文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

用于为库中包含的函数生成 C++ 示例库文件的 MATLAB 示例文件，指定为字符向量、字符串标量、字符串数组或字符向量元胞数组。路径可以是相对于当前工作目录的路径，也可以是绝对路径。文件必须具有 .m 扩展名。有关详细信息和限制，请参阅创建示例代码来调用导出函数。

示例: 'SampleGenerationFiles',["sample1.m","sample2.m"]

数据类型: char | string | cell

`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 对象包含：

编译类型，即 'cppSharedLibrary'
以下各项的路径：
- GettingStarted.html
- v2 文件夹（仅限 matlab-data 接口）
- LibraryName.dll（仅限 mwArray 接口）
- LibraryName.lib（仅限 mwArray 接口）
- LibraryName.h（仅限 mwArray 接口）
包含的支持包的列表
编译选项，指定为 CppSharedLibraryOptions 对象
必需和可选依赖项的列表，指定为 Dependencies 对象

版本历史记录

在 R2021a 中推出

全部展开

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.CppSharedLibraryOptions | compiler.build.Results

compiler.build.cppSharedLibrary

语法

说明

示例

创建 C++ 库

自定义 C++ 库

使用选项对象创建多个库

从 C++ 库获取编译信息

输入参数

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

opts — C++ 库编译选项 compiler.build.CppSharedLibraryOptions 对象

名称-值参数

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

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

DebugBuild — 启用调试符号的标志 'off' (默认) | on/off 逻辑值

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

Interface — 接口 API 'matlab-data' (默认) | 'mwarray'

LibraryName — C++ 共享库的名称 字符向量 | 字符串标量

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

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

SampleGenerationFiles — MATLAB 示例文件 字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

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

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

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

输出参量

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

版本历史记录

R2024b: 指定加密密钥

R2024b: 打包包含机密的代码

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

R2021b: 指定支持包

另请参阅

主题

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

`opts` — C++ 库编译选项
`compiler.build.CppSharedLibraryOptions` 对象

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

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

`DebugBuild` — 启用调试符号的标志
`'off'` (默认) | on/off 逻辑值

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

`Interface` — 接口 API
`'matlab-data'` (默认) | `'mwarray'`

`LibraryName` — C++ 共享库的名称
字符向量 | 字符串标量

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

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

`SampleGenerationFiles` — MATLAB 示例文件
字符向量 | 字符串标量 | 字符向量元胞数组 | 字符串数组

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

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

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

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