compiler.build.webAppArchive

MATLAB Web App Server にデプロイするアーカイブの作成

ページ内をすべて折りたたむ

構文

compiler.build.webAppArchive(AppFile)
compiler.build.webAppArchive(AppFile,Name,Value)
compiler.build.webAppArchive(opts)
results = compiler.build.webAppArchive(___)

説明

compiler.build.webAppArchive(AppFile) は、AppFile で指定された MATLAB® アプリを使用して Web アプリ アーカイブを作成します。

例

compiler.build.webAppArchive(AppFile,Name,Value) は、名前と値の引数を 1 つ以上使用してオプションが指定された Web アプリ アーカイブを作成します。オプションには、アーカイブ名、含める追加ファイル、出力ディレクトリなどがあります。

例

compiler.build.webAppArchive(opts) は、compiler.build.WebAppArchiveOptions オブジェクト opts を使用してオプションが指定された Web アプリ アーカイブを作成します。名前と値の引数を使用して他のオプションを指定することはできません。

例

results = compiler.build.webAppArchive(___) は、前述の構文にある引数の任意の組み合わせを使用して、ビルド情報を compiler.build.Results オブジェクトとして返します。ビルド情報は、ビルド タイプ、コンパイル済みアーカイブへのパス、およびビルド オプションで構成されます。

例

例

すべて折りたたむ

Mortgage.mlapp という名前の MATLAB アプリを使用して Web アプリ アーカイブを作成します。

この例では、Mortgage.mlapp という名前の MATLAB アプリを使用します。

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

compiler.build.webAppArchive を使用して Web アプリ アーカイブをビルドします。

compiler.build.webAppArchive(appFile);

ビルド関数により、現在の作業ディレクトリの MortgagewebAppArchive という名前のフォルダー内に以下のファイルが生成されます。

  • includedSupportPackages.txt — アーカイブに含まれている、すべてのサポートされるファイルをリストしたテキスト ファイル。

  • Mortgage.ctf — デプロイ可能なアーカイブが含まれるコンポーネント テクノロジー ファイル。

  • mccExcludedFiles.log — Web アプリに含まれていないすべてのツールボックス関数のリストが含まれるログ ファイル。サポートされていない関数の詳細については、MATLAB Compiler の制限を参照してください。

  • requiredMCRProducts.txt — MATLAB Runtime が Web アプリを実行するために必要な製品の製品 ID が含まれるテキスト ファイル。

  • unresolvedSymbols.txt — 未解決のシンボルに関する情報が含まれるテキスト ファイル。

Web アプリのデプロイに関する詳細については、Web アプリのデプロイを参照してください。

Web アプリ アーカイブを作成し、名前と値の引数を使用してカスタマイズします。

この例では、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

compiler.build.WebAppArchiveOptions オブジェクトを使用して、複数の Web アプリ アーカイブを作成します。

ファイル 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 アプリ アーカイブをビルドします。

compiler.build.webAppArchive(opts);

同じオプションをもつファイル ExampleApp2.mlapp を使用してコンパイルするには、ビルド関数を再度実行する前に、ドット表記を使用して既存の WebAppArchiveOptions オブジェクトの AppFile を変更します。

opts.AppFile = 'ExampleApp2.m';

AppFile 引数を変更して再コンパイルすることにより、同じオプション オブジェクトを使用して複数のアーカイブをコンパイルできます。

Web アプリ アーカイブを作成し、ビルド タイプ、アーカイブ ファイル、含まれるサポート パッケージ、およびビルド オプションに関する情報を 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 へのパスが格納されます。

入力引数

すべて折りたたむ

メイン ファイルへのパス。行の文字ベクトルまたは string スカラーとして指定します。ファイルは、拡張子が .mlapp である MATLAB アプリである必要があります。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

例: 'mywebapp.mlapp'

データ型: char | string

Web アプリのビルド オプション。compiler.build.WebAppArchiveOptions オブジェクトとして指定します。

名前と値の引数

すべて折りたたむ

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

例: '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' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

  • このプロパティを 'on' に設定した場合、デプロイ可能なアーカイブのフォルダー構造およびファイル名はエンド ユーザーに対して難読化され、MATLAB ファイルに含まれているユーザー コードおよびデータはアーカイブ内のユーザー パッケージに配置されます。また、すべての .m ファイルがパッケージ化の前に P ファイルに変換されます。このオプションは、-j および -s を指定して mcc を使用するのと等価です。

  • このプロパティを 'off' に設定した場合、デプロイ可能なアーカイブは難読化されません。これは既定の動作です。

例: 'ObfuscateArchive','on'

データ型: logical

ビルド ファイルが保存される出力ディレクトリへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

ビルド フォルダーの既定の名前は、アーカイブ名に webAppArchive を追加したものです。

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

データ型: char | string

R2024b 以降

デプロイ可能なアーカイブに組み込む秘密鍵を指定する secret マニフェスト JSON ファイルへのパス。文字ベクトルまたは string スカラーとして指定します。このパスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

MATLAB コードで関数 getSecret、getSecretMetadata、または isSecret を呼び出す場合、デプロイ可能なアーカイブに組み込む秘密鍵を JSON secret マニフェスト ファイルで指定しなければなりません。コードで getSecret を呼び出す場合に SecretsManifest オプションが指定されていないと、MATLAB Compiler™ は警告を発行し、<component_name>_secrets_manifest.json という名前の出力フォルダーにテンプレート JSON ファイルを生成します。"Embedded" フィールドで秘密鍵の名前を指定して、このファイルを修正します。

関数 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

出力引数

すべて折りたたむ

ビルド結果。compiler.build.Results オブジェクトとして返されます。Results オブジェクトには以下が含まれています。

  • 'webAppArchive' であるビルド タイプ

  • コンパイル済み Web アプリ アーカイブ ファイルへのパス

  • 含まれているサポート パッケージのリスト

  • ビルド オプション。WebAppArchiveOptions オブジェクトとして指定

バージョン履歴

R2020b で導入

すべて展開する

参考

| |

トピック