compiler.build.javaPackage

MATLAB の外部でデプロイする Java パッケージの作成

R2021a 以降

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

構文

compiler.build.javaPackage(Files)
compiler.build.javaPackage(Files,Name,Value)
compiler.build.javaPackage(ClassMap)
compiler.build.javaPackage(ClassMap,Name,Value)
compiler.build.javaPackage(opts)
results = compiler.build.javaPackage(___)

説明

compiler.build.javaPackage(Files) は、Files で指定された MATLAB® 関数を使用して Java® パッケージを作成します。Java パッケージを作成する前に、Java パッケージの生成環境の構成を参照してください。

例

compiler.build.javaPackage(Files,Name,Value) は、名前と値の引数を 1 つ以上使用して追加オプションを指定して Java パッケージを作成します。オプションには、クラス名、出力ディレクトリ、含める追加ファイルなどがあります。

例

compiler.build.javaPackage(ClassMap) は、container.Map オブジェクト ClassMap を使用してクラス マッピングを指定して Java パッケージを作成します。

例

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

例

compiler.build.javaPackage(opts) は、compiler.build.JavaPackageOptions オブジェクト opts を使用してオプションを指定して Java パッケージを作成します。名前と値の引数を使用して他のオプションを指定することはできません。

例

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

例

例

すべて折りたたむ

魔方陣を生成する関数ファイルを使用して Java パッケージを作成します。

MATLAB で、Java パッケージとしてデプロイする MATLAB 関数を見つけます。この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。

appFile = which('magicsquare.m');

compiler.build.javaPackage コマンドを使用して、Java パッケージをビルドします。

compiler.build.javaPackage(appFile);

この構文により、現在の作業ディレクトリの magicsquarejavaPackage という名前のフォルダー内に以下が生成されます。

  • classes — Java クラス ファイルとデプロイ可能なアーカイブ ファイルが含まれるフォルダー。

  • doc — パッケージ内にあるすべてのクラスの HTML ドキュメンテーションが含まれるフォルダー。

  • examples — Java ソース コード ファイルが含まれるフォルダー。

  • GettingStarted.html — パッケージの統合に関する情報が含まれるファイル。

  • includedSupportPackages.txt — パッケージに含まれるすべてのサポート ファイルをリストしたテキスト ファイル。

  • magicsquare.jar — Java アーカイブ ファイル。

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

  • readme.txt — デプロイの前提条件に関する情報と、デプロイ用にパッケージ化するファイルのリストが含まれる Readme ファイル。

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

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

Java パッケージを作成し、名前と値の引数を使用してカスタマイズします。

この例では、matlabroot\extern\examples\compiler にあるファイル flames.m と flames.mat を使用します。

appFile = which('flames.m');
MATFile = which('flames.mat');

compiler.build.javaPackage コマンドを使用して、Java パッケージをビルドします。名前と値の引数を使用してパッケージ名を指定し、MAT ファイルを追加して、詳細な出力を有効にします。

compiler.build.javaPackage(appFile,'PackageName','JavaFlames', ...
'AdditionalFiles',MATFile,'Verbose','on');

クラス マップおよび複数の MATLAB 関数を使用して Java パッケージを作成します。

キーがクラス名で、値が関数ファイルの場所である containers.Map オブジェクトを作成します。

cmap = containers.Map;
cmap('Class1') = {'exampleFcn1.m','exampleFcn2.m'};
cmap('Class2') = {'exampleFcn3.m','exampleFcn4.m'};

compiler.build.javaPackage コマンドを使用して、Java パッケージをビルドします。

compiler.build.javaPackage(cmap);

Java パッケージのビルド時に名前と値の引数を使用してオプションを指定することもできます。

compiler.build.javaPackage(cmap, ...
'PackageName','ExamplePackage','Verbose','on');

Windows® システムで compiler.build.JavaPackageOptions オブジェクトを使用して共通の出力ディレクトリを指定し、デバッグ シンボルを使用し、詳細な出力を有効にして、複数の Java パッケージをカスタマイズします。

この例では、matlabroot\extern\examples\compiler にあるファイル magicsquare.m を使用します。

appFile = which('magicsquare.m');

名前と値の引数を使用して指定した追加オプションと appFile を使用して JavaPackageOptions オブジェクトを作成します。

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

  JavaPackageOptions with properties:

                 ClassMap: [1×1 containers.Map]
               DebugBuild: on
              PackageName: 'example.magicsquare'
    SampleGenerationFiles: {}
          AdditionalFiles: {}
      AutoDetectDataFiles: on
    ExternalEncryptionKey: [0×0 struct]
         ObfuscateArchive: off
          SecretsManifest: ''
          SupportPackages: {'autodetect'}
                  Verbose: on
                OutputDir: 'D:\Documents\MATLAB\work\JavaPackageBatch'

   Class Map Information
         magicsquareClass: {'C:\Program Files\MATLAB\R2025b\extern\examples\compiler\magicsquare.m'}

JavaPackageOptions オブジェクトを使用して Java パッケージをビルドします。

compiler.build.javaPackage(opts);

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

remove(opts.ClassMap, keys(opts.ClassMap));
opts.ClassMap('helloClass') = which('hello.m');
compiler.build.javaPackage(opts);

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

Java パッケージを作成し、ビルド タイプ、生成ファイル、含まれるサポート パッケージ、およびビルド オプションに関する情報を compiler.build.Results オブジェクトに保存します。

ファイル magicsquare.m を使用してコンパイルします。

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

  Results with properties:

              BuildType: 'javaPackage'
                  Files: {3×1 cell}
IncludedSupportPackages: {}
                Options: [1×1 compiler.build.JavaPackageOptions]
    RuntimeDependencies: [1×1 compiler.runtime.Dependencies]

Files プロパティには、以下へのパスが格納されます。

  • doc フォルダー

  • magicsquare.jar

  • GettingStarted.html

入力引数

すべて折りたたむ

MATLAB 関数を実装するファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。ファイル パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルの拡張子は .m、.p、.mlx、.mexa64 のいずれかである必要があります。

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

データ型: char | string | cell

クラス マップ。containers.Map オブジェクトとして指定します。マッピングのキーはクラス名であり、各値は対応するクラスにマッピングされるファイルのセットです。ファイルの拡張子は .m、.p、.mlx、.mexa64 のいずれかである必要があります。

例: cmap

Java パッケージのビルド オプション。compiler.build.JavaPackageOptions オブジェクトとして指定します。

名前と値の引数

すべて折りたたむ

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

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

例: 'Verbose','on'

Java パッケージに含める追加のファイルとフォルダー。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。

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

データ型: char | string | cell

データ ファイルを自動的に含めるためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) または 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

  • このプロパティを 'on' に設定した場合、特定の関数 (load や fopen など) の入力として指定されるデータ ファイルは自動的に Java パッケージに含められます。

  • このプロパティを 'off' に設定した場合、データ ファイルは AdditionalFiles プロパティを使用してパッケージに追加する必要があります。

例: 'AutoDetectDataFiles','off'

データ型: logical

Java クラスの名前。文字ベクトルまたは string スカラーとして指定します。ClassMap 入力を使用する場合、このオプションは指定できません。クラス名は Java のクラス名の要件を満たしている必要があります。

既定値は、Files 引数にリストされている最初のファイルの名前に Class を追加したものです。

例: 'ClassName','magicsquareClass'

データ型: char | string

デバッグ シンボルを有効にするためのフラグ。'on' または 'off'、もしくは数値または logical の 1 (true) か 0 (false) として指定します。'on' の値は true と等価であり、'off' の値は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は、matlab.lang.OnOffSwitchState 型の on/off の logical 値として保存されます。

  • このプロパティを 'on' に設定した場合、コンパイルされたアーティファクトにデバッグ シンボル情報が含まれます。このオプションによって、mbuild からシステム コンパイラに適切なデバッグ フラグも渡されます。このデバッグ オプションを使用すると、MATLAB Runtime の初期化、関数呼び出し、または終了ルーチンのいずれでエラーが発生したかを特定できる箇所まで戻ることができます。このオプションでは、外部デバッガーで MATLAB ファイルをデバッグすることはできません。

  • このプロパティを 'off' に設定した場合、デバッグ シンボルは含まれません。これは既定のオプションです。

例: 'DebugBuild','on'

データ型: 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 として指定します。値は、matlab.lang.onoffSwitchState 型の on/off の logical 値として保存されます。

このプロパティを '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 データ配列の C++ 共有ライブラリ)

  • アウトプロセスでの MEX ファイルの実行 (mexhost、feval、matlab.mex.MexHost)

  • R2023b より前: v7.3 以外の .mat ファイル

このオプションを有効にすることは、-j および -s を指定して mcc を使用するのと等価です。

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

例: 'ObfuscateArchive','on'

データ型: logical

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

ビルド フォルダーの既定の名前は、パッケージ名に javaPackage を追加したものです。

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

データ型: char | string

Java パッケージの名前。文字ベクトルまたは string スカラーとして指定します。'PackageName' を名前空間として指定します。これは、companyname.groupname.component のようにピリオドで区切られたリストです。生成されたパッケージの名前は、ピリオドで区切られたリストの最後のエントリに設定されます。名前は文字で始まり、英字とピリオドのみが含まれる必要があります。

例: 'PackageName','mathworks.javapackage.mymagic'

データ型: char | string

パッケージに含まれる関数のサンプル Java ドライバー ファイルを生成するために使用する MATLAB サンプル ファイル。文字ベクトル、string スカラー、string 配列、または文字ベクトルの cell 配列として指定します。パスは現在の作業ディレクトリを基準とした相対パス、または絶対パスにできます。ファイルには .m 拡張子が必要です。

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

データ型: char | string | cell

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 オブジェクトには以下が含まれています。

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

  • コンパイル済みファイルへのパス

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

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

  • 必須およびオプションの依存関係のリスト。Dependencies オブジェクトとして指定します。

バージョン履歴

R2021a で導入

すべて展開する

参考

|