compiler.build.WebAppArchiveOptions
R2026bWeb アプリ アーカイブのビルド オプション
構文
説明
は、opts = compiler.build.WebAppArchiveOptions(AppFile)AppFile で指定した MATLAB® アプリを使用して WebAppArchiveOptions オブジェクトを作成します。WebAppArchiveOptions オブジェクトを関数 compiler.build.webAppArchive への入力として使用します。
は、名前と値の引数を 1 つ以上使用してオプションが指定された opts = compiler.build.WebAppArchiveOptions(AppFile,Name=Value)WebAppArchiveOptions オブジェクトを作成します。オプションには、アーカイブ名、含める追加ファイル、出力ディレクトリなどがあります。
例
Mortgage.mlapp という名前の MATLAB アプリから WebAppArchiveOptions オブジェクトを作成します。
この例では、以下を実行して、MATLAB アプリ ファイル Mortgage.mlapp を現在の作業ディレクトリにダウンロードします。
setupExample("matlab/MortgageCalculatorExample",pwd)compiler.build.WebAppArchiveOptions コマンドを使用して Web アプリ オプション オブジェクトを作成します。
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 アプリ アーカイブをビルドします。
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 アプリ アーカイブをビルドします。
buildResults = compiler.build.webAppArchive(opts);
入力引数
メイン ファイルへのパス。行の文字ベクトルまたは string スカラーとして指定します。ファイルは、バイナリ形式 (.mlapp) の MATLAB アプリ、またはプレーン テキスト形式のアプリのアプリ コード ファイル (.m) でなければなりません。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
例: 'mywebapp.mlapp'
データ型: char | string
名前と値の引数
オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。
例: Verbose='on'
Web アプリ アーカイブに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
例: AdditionalFiles=["myvars.mat","myfunc.m"]
データ型: char | string | cell
Web アプリ アーカイブの名前。文字ベクトルまたは string スカラーとして指定します。既定値は AppFile のファイル名です。
例: ArchiveName='MyWebApp'
データ型: char | string
データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを
'on'に設定した場合、特定の関数 (loadやfopenなど) の入力として指定するデータ ファイルは自動的に Web アプリ アーカイブに含められます。このプロパティを
'off'に設定した場合、データ ファイルはAdditionalFilesプロパティを使用してアーカイブに追加しなければなりません。
例: AutoDetectDataFiles='Off'
データ型: logical
R2024b 以降
外部の AES 暗号化キー ファイルおよび MEX キー ローダー ファイルへのパス。char 行ベクトルまたは string スカラーの正確に 2 つのフィールドをもつスカラー struct として指定します。フィールド名はそれぞれ EncryptionKeyFile と RuntimeKeyLoaderFile です。struct のフィールドはどちらも必須です。ファイル パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
たとえば、struct keyValueStruct を使用して暗号化キーを encrypt.key、ローダー ファイルを loader.mexw64 と指定します。
keyValueStruct.EncryptionKeyFile='encrypt.key'; keyValueStruct.RuntimeKeyLoaderFile='loader.mexw64'
暗号化キー ファイルは、サポートされている次のいずれかの形式でなければなりません。
バイナリ 256 ビットの AES キー、32 バイトのファイル サイズ
16 進数でエンコードされた AES キー、64 バイトのファイル サイズ
MEX ファイル ローダーは実行時に復号化キーを取得します。これは次の引数をもつインターフェイスでなければなりません。
prhs[0]— 入力、固定値'get'として指定される char 配列prhs[1]— 入力、CTF コンポーネント UUID として指定される char 配列plhs[0]— 出力、キーの形式に応じて 32 バイトの UINT8 数値配列または 64 バイトの 16 進数でエンコードされた char 配列
複数の CTF で同じキーを共有することは避けてください。
例: ExternalEncryptionKey=keyValueStruct
データ型: struct
デプロイ可能なアーカイブを難読化するためのフラグ。'on'/1/true または 'off'/0/false として指定します。R2026b 以降では、含めるファイルおよびフォルダーを制御するための JSON ルール ファイルを指定できます。
このプロパティを
'off'に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。このプロパティを
'on'に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンド ユーザーに対して難読化され、.m、.mlapp、.p、.mat、MLX、SFX、および MEX ファイルに含まれているユーザー コードおよびデータはアーカイブ内のユーザー パッケージに配置されます。また、すべての.mファイルがパッケージ化の前に P ファイルに変換されます。このオプションを有効にすることは、-jおよび-sを指定してmccを使用するのと等価です。このプロパティを JSON ルール ファイルに設定すると、難読化が有効になります。ルール ファイルを使用すると、追加のファイル形式を含めたり、ユーザー パッケージからファイルまたはフォルダーを除外したりできます。詳細については、
mcc -sを参照してください。 (R2026b 以降)
実行時に、MATLAB コードとデータはファイル システムに抽出されるのではなく、ユーザー パッケージから直接復号化されて読み込まれます。MEX ファイルは、一時的にユーザー パッケージから抽出されてから、読み込まれます。
以下はサポートされて "いません"。
ver関数DLL などの外部ライブラリの呼び出し
アウトプロセスの MATLAB Runtime (MATLAB データ配列の C++ 共有ライブラリ)
アウトプロセスでの MEX ファイルの実行 (
mexhost、feval、matlab.mex.MexHost)R2023b より前: v7.3 以外の
.matファイル
例: ObfuscateArchive="component_user_package_rules.json"
データ型: logical | char | string
ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
ビルド フォルダーの既定の名前は、アーカイブ名に webAppArchive を追加したものです。
例: OutputDir='D:\Documents\MATLAB\work\mymagicwebAppArchive'
データ型: char | string
R2024b 以降
デプロイ可能なアーカイブに組み込む秘密鍵を指定する secret マニフェスト JSON ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。
MATLAB コードで関数 getSecret、getSecretMetadata、または isSecret を呼び出す場合、デプロイ可能なアーカイブに組み込む秘密鍵を JSON secret マニフェスト ファイルで指定しなければなりません。コードで getSecret を呼び出す場合に SecretsManifest オプションが指定されていないと、MATLAB Compiler™ は警告を発行し、 という名前の出力フォルダーにテンプレート JSON ファイルを生成します。"Embedded" フィールドで秘密鍵の名前を指定して、このファイルを修正します。<component_name>_secrets_manifest.json
関数 setSecret はデプロイ可能ではありません。デプロイ可能なアーカイブに秘密鍵を組み込むには、アーカイブをビルドする前に MATLAB で setSecret を呼び出す必要があります。
シークレットを使用したデプロイの詳細については、Handle Sensitive Information in Deployed Applicationsを参照してください。
例: SecretsManifest='D:\Documents\MATLAB\work\mycomponent\mycomponent_secrets_manifest.json'
データ型: char | string
含めるサポート パッケージ。次のオプションのいずれかとして指定します。
'autodetect'(既定) — 依存関係の分析プロセスにより、必要なサポート パッケージが自動的に検出され、含められます。'none'— サポート パッケージは含められません。このオプションを使用すると、ランタイム エラーの原因となる可能性があります。string スカラー、文字ベクトル、または文字ベクトルの cell 配列 — 指定されたサポート パッケージのみが含められます。インストールされている、または特定のファイルで使用されるサポート パッケージのリストを表示するには、
compiler.codetools.deployableSupportPackagesを参照してください。
例: SupportPackages={'Deep Learning Toolbox Converter for TensorFlow Models','Deep Learning Toolbox Model for Places365-GoogLeNet Network'}
データ型: char | string | cell
ビルドの詳細を制御するためのフラグ。'on' または 'off'、もしくは数値または logical 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。
このプロパティを
'on'に設定した場合、MATLAB コマンド ウィンドウには、ビルド プロセス中のコンパイラ出力を示す進行状況情報が表示されます。このプロパティを
'off'に設定した場合、コマンド ウィンドウには進行状況の情報は表示されません。
例: Verbose='on'
データ型: logical
出力引数
Web アプリ アーカイブのビルド オプション。WebAppArchiveOptions オブジェクトとして返されます。
バージョン履歴
R2020b で導入ObfuscateArchive オプションを使用して JSON ルール ファイルを指定します。ルール ファイルを使用すると、追加のファイル形式を含めたり、ユーザー パッケージからファイルまたはフォルダーを除外したりできます。
ExternalEncryptionKey オプションを使用して、256 ビットの AES 暗号化キーと、実行時に復号化キーを取得するための MEX ファイルのローダー インターフェイスを指定します。このオプションは、mcc -k オプションと等価です。
SecretsManifest オプションを使用して、デプロイ可能なコード アーカイブ内部に組み込むシークレットを指定する JSON ファイルを含めます。このオプションは、mcc -J オプションと等価です。
SupportPackages オプションを使用して、デプロイ可能なコード アーカイブに含めるサポート パッケージを指定します。
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Web サイトの選択
Web サイトを選択すると、翻訳されたコンテンツにアクセスし、地域のイベントやサービスを確認できます。現在の位置情報に基づき、次のサイトの選択を推奨します:
また、以下のリストから Web サイトを選択することもできます。
最適なサイトパフォーマンスの取得方法
中国のサイト (中国語または英語) を選択することで、最適なサイトパフォーマンスが得られます。その他の国の MathWorks のサイトは、お客様の地域からのアクセスが最適化されていません。
南北アメリカ
- América Latina (Español)
- Canada (English)
- United States (English)
ヨーロッパ
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)