本文介绍使用 Microsoft 应用创建"Graph Toolkit"应用并连接到应用应用的分Microsoft 365。 完成这些步骤后,你将拥有一个"展示"应用,该应用显示当前登录用户即将从 Microsoft 365。
创建一个"时价"应用
通过克隆 显示快速启动类型代码存储库来创建新的一个 "显示"应用。 这将使用 TypeScript 创建一个新的"显示"应用,这将帮助你编写更可靠的代码并避免运行时错误。
git clone https://github.com/electron/electron-quick-start-typescript
将工作目录更改为新创建的应用并安装所有依赖项。
cd electron-quick-start-typescript
npm install
安装"@microsoft/mgt-components"程序包,其中包含所有 Microsoft Graph连接的 Web 组件。
npm i @microsoft/mgt-components
同时安装 @microsoft/mgt-electron-provider 和 @microsoft/mgt-element npm 包。 这将允许你使用 MSAL 为应用提供身份验证,并使用 Microsoft Graph Toolkit组件。
npm i @microsoft/mgt-element @microsoft/mgt-electron-provider
确认你可以运行该应用。
npm start
创建应用/客户端 ID
在客户端中添加新Azure AD以获取客户端 ID
若要在应用程序Azure Active Directory (Azure AD) ,需要添加新的应用程序注册,然后配置应用名称和重定向 URI。
若要在应用中创建Azure AD:
- 转到“Azure 门户”。
- 从菜单中,选择"Azure Active Directory "。
- 从"Azure Active Directory"菜单中,选择"应用注册 "。
- 从顶部菜单中,选择"新建 注册" 按钮。
- 输入应用的名称;例如,
My Electron-App。 - 对于受支持的帐户类型 类型,选择任何组织目录中的帐户 (任何 Azure AD 目录 - 多租户 ) 和个人 Microsoft 帐户 (例如 Skype、Xbox)。
- In the Redirect URI field, in the dropdown, select Public client/native (mobile & desktop), and in the URL field, enter
msal://redirect. - 通过选择"注册" 按钮确认 更改。
- 转到应用程序注册。
- 验证是否位于"概述 " 页上。
- 从 Essentials 部分,复制 Application (客户端) ID 属性的值。
配置 Microsoft Graph Toolkit身份验证提供程序
在呈现器进程中初始化一个显示器Provider
负责 ElectronProvider 与 ElectronAuthenticator 主进程中 (用户通信) 请求访问令牌,并接收有关 mgt 组件正常工作所需的登录状态的信息。
若要初始化 , ElectronProvider请向 src/renderer.ts 文件添加以下 代码。
import {Providers} from '@microsoft/mgt-element';
import {ElectronProvider} from '@microsoft/mgt-electron-provider/dist/Provider';
// import the mgt components so we can use them in our html
import '@microsoft/mgt-components';
// initialize the auth provider globally
Providers.globalProvider = new ElectronProvider();
在主进程中初始化一个使用Authenticator
ElectronAuthenticator负责为 MSAL 身份验证设置配置变量、获取访问令牌并与 通信ElectronProvider。 在主 ElectronAuthenticator 进程中初始化 ,并设置配置变量,如客户端 ID 和所需作用域。
首先,打开 src/main.ts ,从 ElectronAuthenticator MsalElectronConfig @microsoft/mgt-electron-provider 页面顶部导入 和 。
import { ElectronAuthenticator, MsalElectronConfig } from '@microsoft/mgt-electron-provider/dist/Authenticator';
接下来,在 函数中添加 createWindow() 这些代码行,以初始化在 声明位置之后的一部分。 mainWindow 。 将 <your_client_id> 替换为应用注册中的客户端 ID。
const config: MsalElectronConfig = {
clientId: '<your_client_id>',
mainWindow: mainWindow, //This is the BrowserWindow instance that requires authentication
scopes: [
'user.read',
'user.read',
'people.read',
'user.readbasic.all',
'contacts.read',
'presence.read.all',
'presence.read',
'user.read.all',
'calendars.read'
],
};
ElectronAuthenticator.initialize(config);
将 nodeIntegration 设置为 true
在创建 BrowserWindow nodeIntegration true 的新实例的 main.ts 中,请确保在 webPreferences 下设置为 。 如果跳过此步骤,则可能会遇到 Uncaught ReferenceError: require is not defined 错误。 若要保持简单,请删除任何预加载脚本。
const mainWindow = new BrowserWindow({
height: 600,
webPreferences: {
nodeIntegration: true //Set this to true
},
width: 800
});
将组件添加到 HTML 页面
向应用添加一些内容。 现在,可以在 Graph页面中使用 Microsoft index.html工具包组件,并显示用户议程。 将 页面index.html替换为 以下内容。
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<title>Sample Electron-MGT App</title>
</head>
<body>
<mgt-login></mgt-login>
<mgt-agenda group-by-day></mgt-agenda>
<script type="module" src="./dist/renderer.js"></script>
</body>
</html>
注意: 如果将其复制到现有文件,请删除任何 Content-Security-Policy
meta响应标头或标记。
使用 webpack 捆绑应用
在运行应用之前,你需要捆绑代码,以确保所有模块化依赖项都包含在最终负载中。 如果你已经绑定应用代码,可以跳过此步骤。
安装 webpack
npm install webpack webpack-cli ts-loader --save-dev
webpack.config.js
在项目的 webpack.config.js 文件夹中创建一个新的项目文件,并粘贴以下配置。
const path = require('path');
module.exports = [
{
mode: 'development',
entry: './src/renderer.ts',
target: 'electron-renderer',
module: {
rules: [
{
test: /\.ts$/,
include: [/src/],
use: [{ loader: 'ts-loader' }]
}
]
},
output: {
path: __dirname + '/dist',
filename: 'renderer.js'
},
resolve: {
extensions: ['.ts', '.js'],
modules: ['node_modules', path.resolve(__dirname + 'src')]
}
},
{
mode: 'development',
entry: './src/main.ts',
target: 'electron-main',
module: {
rules: [
{
test: /\.ts$/,
include: [/src/],
use: [{ loader: 'ts-loader' }]
}
]
},
output: {
path: __dirname + '/dist',
filename: 'main.js'
},
resolve: {
extensions: ['.ts', '.js'],
modules: ['node_modules', path.resolve(__dirname + 'src')]
}
}
];
如你所见,前端 (呈现器) 和后端 (进程) 单独捆绑。 这是因为在"在 In一页"中,呈现器进程在浏览器上下文中运行,而主进程在节点上下文中运行。
将 webpacking 脚本添加到 package.json
在 中添加以下 scripts 代码 package.json。
"scripts": {
"webpack": "webpack",
"start": "npm run webpack && electron dist/main.js"
}
运行应用
npm start
向应用添加令牌缓存功能,并启用无提示登录 (高级)
MSAL 节点默认支持内存中缓存,并提供 ICachePlugin 接口来执行缓存序列化,但不提供将令牌缓存存储到磁盘的默认方法。 如果需要永久缓存存储来启用无提示登录或跨平台缓存,我们建议使用 MSAL Node 提供的默认实现作为 扩展。 你可以导入此插件,在初始化 时传递缓存插件的实例 ElectronAuthenticator。
let config: MsalElectronConfig = {
...
cachePlugin: new PersistenceCachePlugin(filePersistence) //filePersistence is the instance of type IPersistence that you will need to create
};
若要详细了解如何实现此操作,请参阅 microsoft-authentication-library-for-js 示例。
后续步骤
- 在样本中试用组件。
- 在 Microsoft 问答中&问题。
- 在 GitHub 上报告 bug 或提出功能请求。
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
