electron-dll-sample

Electron のアプリから electron-edge-js を使用して、 C# の DLL を呼び出すサンプル。 Electron で C# の DLL を実行する の確認当時のソースは https://github.com/nakamurakko/electron-dll-sample/tree/blog-posted を参照。

確認済み開発環境

1. Visual Studio Code
2. Visual Studio 2022 または Build Tools for Visual Studio 2022
   • ワークロードは下記を選択する。
     • C++ によるデスクトップ開発
     • .NET デスクトップ ビルド ツール
3. Node.js 22.1.0
4. Python 3.12.3

EXE の実行を確認した環境

1. Windows 11 で確認。
2. Visual C++ 再頒布可能パッケージ (64ビット)
   • 再頒布可能パッケージの最新のサポートされているダウンロードをMicrosoft Visual C++する または https://my.visualstudio.com/ からダウンロードする。
3. .NET 8 SDK (64ビット)
   • .NET 8.0 のダウンロード からダウンロードする。
4. .NET Framework 4.6 Runtime が必要になる可能性あり。
   • Edge.js.CSharp の動作を見る限り使用している可能性はあるが、 Windows 10、 Windows 11 には .NET Framework 4、 .NET Framework 4.8 がデフォルトでインストールされているため、要否を判断できない。エラーが発生する環境があれば .NET Framework 4.6 Runtime をチェックする。

注意点

• System.Reflection.TypeExtensions.dll は Edge.js.CSharp が使用するバージョンで上書きする。そのため、自作 DLL 側が新しい .NET バージョンの際に Reflection を使えない可能性がある。
• C:\Users\<実行中のユーザー>\.nuget ディレクトリーにダウンロード済み NuGet パッケージが存在すると、ビルドした EXE に DLL が取り込まれていない状態でも .nuget にある DLL を参照して実行出来てしまうため、ビルド環境で EXE の実行を確認する場合は、 .nuget ディレクトリーを参照できない状態で確認する。 (最終的にはビルド環境以外で確認した方が良い。)

準備

• 初回は install-npm.bat を実行する。バッチの内容は下記の通り。
  • npm install -g node-gyp を実行する。
  • electron-app ディレクトリーで npm install を実行する。
• 初回や DLL を修正した場合、 publish-dll.bat を実行する。バッチの内容は下記の通り。
  • SampleLib.dll を発行し、 electron-app\Libraries に DLL を出力する。
    • electron-app\Libraries に生成された下記ファイルを、 electron-app\node_modules\electron-edge-js\lib\bootstrap\bin\Release ディレクトリーにを作成してコピーする。
      • System.Diagnostics.FileVersionInfo.dll (electron-app\Libraries\refs ディレクトリーに存在。)
      • System.Text.Encoding.CodePages.dll (electron-app\Libraries\refs ディレクトリーに存在。)
      • Microsoft.DotNet.InternalAbstractions.dll
    • electron-app\Libraries\refs に生成されたファイルを、 electron-app\node_modules\electron-edge-js\lib\bootstrap\bin\Release ディレクトリーにコピーする。
    • electron-app\Libraries に生成されたファイルを、 electron-app\node_modules\electron-edge-js\lib\bootstrap\bin\Release ディレクトリーにコピーする。 (SampleLib* はコピーしないため、 CopyExcludedFiles.txt (除外一覧)に記載。)
  • EdgeJsCSharpSharedLib.dll を発行し、 electron-app\SharedLibraries に DLL を出力する。
    • SharedLibraries\Edge.js.CSharp.dll を、 electron-app\node_modules\electron-edge-js\lib\bootstrap\bin\Release ディレクトリーにコピーする。
    • SharedLibraries\System.Reflection.TypeExtensions.dll を、 electron-app\node_modules\electron-edge-js\lib\bootstrap\bin\Release ディレクトリーにコピーする。
    • SharedLibraries\System.Text.Json.dll を、 electron-app\node_modules\electron-edge-js\lib\bootstrap\bin\Release ディレクトリーにコピーする。
• EXE を作成する場合、 build-executable.bat を実行する。

実行

• デバッグは、 electron-app ディレクトリーを Visual Studio Code で開いてデバッグを開始する。
• EXE を作成する場合は、
  • electron-app ディレクトリー以下で、 npm run build-portable を実行する。
  • electron-app\executableFile ディレクトリー以下にある EXE を実行する。

SampleLib(DLL)の構成

• TargetFramework は .NET 8 を指定。
• プロジェクトファイル(csproj) > PropertyGroup に、下記2つを追記する。(edge-js で指定あり。)
  • <PreserveCompilationContext>true</PreserveCompilationContext>
  • <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
• 追加した NuGet パッケージは下記の通り。

  パッケージ名
  Microsoft.CodeAnalysis
  Microsoft.CSharp
  Microsoft.DotNet.InternalAbstractions
  Microsoft.DotNet.PlatformAbstractions
  Microsoft.Extensions.DependencyModel
  Microsoft.NETCore.DotNetHost
  Microsoft.NETCore.DotNetHostPolicy
  System.Collections.NonGeneric
  System.Collections.Specialized
  System.Data.Common
  System.Xml.ReaderWriter
  System.Xml.XmlSerializer
  System.Xml.XPath.XmlDocument

EdgeJsCSharpSharedLib(DLL)の構成

• TargetFramework は .NET Standard 2.1 を指定。(Edge.js.CSharp の指定バージョンは .NET Standard 1.6。問題が発生する場合はバージョンの違いも調査観点に含める。)
  • System.Reflection.TypeExtensions.dll は EdgeJsCSharpSharedLib が参照している DLL を使用する。
  • System.Text.Json を参照しているため、コピー対象としてパッケージに追加する。
• 追加した NuGet パッケージは下記の通り。

  パッケージ名
  Edge.js.CSharp
  System.Text.Json