安装与配置

本节将指导您在应用程序中安装和配置 OSI。

安装

1. 安装 OSI 本地版包

使用 npm 安装 OSI 本地版包：

npm install osi.onpremises

2. 添加 TypeScript 配置

在 tsconfig.json 中添加以下内容：

{
  "compilerOptions": {
    "types": ["osi.onpremises"]
  }
}

配置

Node.js 环境

1. 基本设置

在主文件（例如 index.ts）中，导入并初始化 OSI：

import { fs, Process, EventWatcher, os, db } from 'osi.onpremises';

// 小写字母命名的模块会自动初始化为单例，无需手动初始化。其他模块则不是。

2. TypeScript 配置

确保 tsconfig.json 包含必要的编译器选项：

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

Electron 环境

1. 主进程设置

在主进程文件（例如 main/index.ts）中，导入并初始化 OSI：

import { fs, Process, EventWatcher, os, db } from 'osi.onpremises';

// 小写字母命名的模块会自动初始化为单例，无需手动初始化。其他模块则不是。

2. TypeScript 配置

确保 tsconfig.json 包含必要的编译器选项：

{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  }
}

3. Electron 配置

更新 Electron 主进程配置以确保正确的安全设置：

import { app, BrowserWindow } from 'electron';

app.whenReady().then(() => {
  const win = new BrowserWindow({
    webPreferences: {
      nodeIntegration: false,
      contextIsolation: true,
      preload: path.join(__dirname, 'preload.js')
    }
  });
});

安全注意事项

1. 主进程使用（仅限 Electron）

   • OSI 模块应仅在主进程中使用
   • 切勿直接向渲染进程暴露 OSI

2. IPC 通信（仅限 Electron）

   • 使用 IPC（进程间通信）在渲染进程和主进程之间通信
   • 对所有 IPC 消息实施适当的验证

3. 错误处理

   • 为所有 OSI 操作实施适当的错误处理
   • 对异步操作使用 try-catch 块

下一步

现在您已经安装并配置了 OSI，请继续阅读第一个应用部分，了解如何在项目中使用 OSI。