Microsoft Graph Toolkit 是一组 Web 组件,可简化连接到 Microsoft Graph并让你专注于应用程序。 Microsoft Graph Toolkit作为通过 @microsoft/mgt npm 包分发的一组通用 Web 组件提供。
如果你使用 @microsoft/mgt-reactReact 生成应用,可以使用程序包,它将 Microsoft Graph Toolkit Web 组件包装在 React 组件中,并更轻松地传递复杂数据。
本文介绍使用 Microsoft Graph Toolkit创建应用并React应用并连接到Microsoft 365。 完成这些步骤后,你将拥有一个React应用,该应用显示当前登录用户即将从 Microsoft 365。
Tip: 还可以按照本教程作为交互式代码教程。 有关详细信息,请参阅GitHub初学者项目存储库。
先决条件
若要按照本文中的步骤操作,你需要一个Microsoft 365和一些工具。 有关详细信息,请参阅 入门。
创建React应用
通过运行React新建一个应用。 这将使用 TypeScript React应用,这将帮助您编写更可靠的代码并避免运行时错误。
npx create-react-app my-m365-app --template typescript --use-npm
将工作目录更改为新创建的应用。
cd my-m365-app
接下来,安装 mgt-react npm 包,其中包含 Microsoft Graph Toolkit React组件。
npm i @microsoft/mgt-react
同时安装 mgt-msal2-provider 和 mgt-element npm 包,其中包含 MSAL2 身份验证提供程序。
npm i @microsoft/mgt-element @microsoft/mgt-msal2-provider
确认你可以运行该应用。
npm start
你应该能够通过 在浏览器中打开你的应用 http://localhost:3000。
创建 Azure Active Directory 应用
Microsoft Graph是一种用于连接到 Microsoft 365 的 API,它使用 OAuth 2.0 进行保护。 为了将应用连接到 Microsoft 365,你需要在 Azure Active Directory (Azure AD) 中创建一个应用,并授权此应用程序代表使用你的应用的用户访问特定资源。
按照创建应用应用Azure Active Directory中的步骤创建新的Azure AD应用。
连接 React应用Microsoft 365
现在,你已使用 Azure Active Directory (Azure AD) 注册应用程序,你可以将React连接到Microsoft 365。 首先,允许用户使用其 Microsoft 帐户登录应用。
复制Azure AD注册 ID
- 在 Azure 门户中,转到应用程序注册。
- 验证是否位于"概述 " 页上。
- 从 Essentials 部分,复制 Application (client) ID 属性的值
配置 Microsoft Graph Toolkit身份验证提供程序
接下来,配置 Microsoft Graph Toolkit使用的身份验证提供程序。 在这种情况下,你将使用 MSAL,这是生成独立应用程序的好默认值。 如果使用扩展点中的任意扩展点Microsoft 365,Teams或SharePoint提供程序。
Note: 如果当前使用的是 MSAL 提供程序,并且要更新到 MSAL2 提供程序,请按照 MSAL2 提供程序文章中的步骤 操作。
-
在代码编辑器中,打开 src/index.tsx 文件,并添加到导入列表,添加:
import { Providers } from '@microsoft/mgt-element'; import { Msal2Provider } from '@microsoft/mgt-msal2-provider'; -
最后一个
import语句之后,使用 MSAL Graph Toolkit Microsoft 应用程序。Providers.globalProvider = new Msal2Provider({ clientId: 'REPLACE_WITH_CLIENTID' });将 属性的值
clientId替换为之前Application (client) ID在 Azure 门户中复制的属性的值。
通过这些更改, src/index.tsx 文件将如下所示。
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';
import './index.css';
import * as serviceWorker from './serviceWorker';
import { Providers } from '@microsoft/mgt-element';
import { Msal2Provider } from '@microsoft/mgt-msal2-provider';
Providers.globalProvider = new Msal2Provider({
clientId: 'REPLACE_WITH_CLIENTID'
});
ReactDOM.render(
<React.StrictMode>
<App />
</React.StrictMode>,
document.getElementById('root')
);
// If you want your app to work offline and load faster, you can change
// unregister() to register() below. Note this comes with some pitfalls.
// Learn more about service workers: https://bit.ly/CRA-PWA
serviceWorker.unregister();
添加"登录"按钮
添加 登录 Microsoft Graph Toolkit React组件,该组件将显示"登录"按钮,用户可以使用它的 Microsoft 帐户登录你的应用。
-
在代码编辑器中,打开 src/App.tsx 文件,并添加到导入列表添加:
import { Login } from '@microsoft/mgt-react'; -
在 函数
App中,将return子句的内容替换为基本结构,包括 Microsoft Graph Toolkit Login 组件:<div className="App"> <header> <Login /> </header> </div>
通过这些更改, src/App.tsx 文件将如下所示。
import { Login } from '@microsoft/mgt-react';
import React from 'react';
import './App.css';
function App() {
return (
<div className="App">
<header>
<Login />
</header>
</div>
);
}
export default App;
测试应用程序登录
你现在应该能够使用 Microsoft 帐户登录应用程序。
- 返回运行你的应用的React浏览器。 现在应该会看到" 登录" 按钮。
- 单击" 登录 "按钮时,系统将提示你使用 Microsoft 帐户登录 (可以使用与使用) 访问 Azure 门户的帐户相同的帐户。
- 因为这是你首次使用此应用程序Azure AD,你需要同意在组织中使用它。
- 登录后,你将被重定向到React应用。 请注意,"登录"按钮已更改,以显示你的用户名React显示使用 Microsoft Microsoft 365 检索到的用户Graph Toolkit。
从服务器加载Microsoft 365
Microsoft Graph Toolkit不仅简化了对 Microsoft 365 的身份验证,还加载了数据。 本示例中,将显示登录人的日历。
指定应用程序所需的权限
您必须先指定Microsoft 365访问用户数据的权限范围列表,然后才能从应用程序加载数据。 这些范围因要显示的信息类型不同而不同。 在这种情况下,您需要访问人员日历,以及访问日历中也显示的人的信息的基本访问权限。 可以在 Microsoft 应用文档中找到每个 API 所需的图形 API范围。
-
在代码编辑器中,打开 src/index.tsx 文件,并更新提供程序初始化代码。
Providers.globalProvider = new Msal2Provider({ clientId: 'REPLACE_WITH_CLIENTID', scopes: ['calendars.read', 'user.read', 'openid', 'profile', 'people.read', 'user.readbasic.all'] });
登录后显示用户数据
接下来,扩展应用程序以显示来自用户日历的数据。 只有在用户登录后,才能访问此信息。 为此,你需要跟踪用户的登录状态,在用户使用其 Microsoft 帐户登录后显示日历数据。
跟踪用户的登录状态
若要跟踪应用程序中的用户登录 useState useEffect状态,你需要将 React 和挂钩与提供程序事件处理程序结合使用。
-
在代码编辑器中,打开 src/App.tsx 文件并扩展现有 React
import语句。import React, { useState, useEffect } from 'react'; -
通过将 和
ProviderProviderState类型添加到导入mgt-element,从 导入 。import { Providers, ProviderState } from '@microsoft/mgt-element'; -
添加名为 的
useIsSignedIn自定义函数,以在应用程序中跟踪用户的登录状态。function useIsSignedIn(): [boolean] { const [isSignedIn, setIsSignedIn] = useState(false); useEffect(() => { const updateState = () => { const provider = Providers.globalProvider; setIsSignedIn(provider && provider.state === ProviderState.SignedIn); }; Providers.onProviderUpdated(updateState); updateState(); return () => { Providers.removeProviderUpdatedListener(updateState); } }, []); return [isSignedIn]; }
此函数执行两项操作。 首先,使用ReactuseState挂钩,它可以在组件内启用跟踪状态。 只要状态发生更改,React将重新呈现组件。 其次,使用 React useEffect 挂钩,它通过跟踪 Microsoft Graph Toolkit 提供程序中的更改并在必要时更新组件来扩展组件的生命周期。
如果用户已登录,则加载用户的日历
现在,在应用程序中跟踪用户的登录状态,可以在用户登录后显示其日历。
-
在代码编辑器中,打开 src/App.tsx
import文件,然后使用"议程"组件扩展 组件 语句。import { Agenda, Login } from '@microsoft/mgt-react'; -
接下来,在 App 函数内,添加:
const [isSignedIn] = useIsSignedIn();这将定义一个布尔
isSignedIn常量,该常量可用于确定用户当前是否已登录到您的应用程序。 -
使用附加和
returnMicrosoft Graph Toolkitdiv组件扩展子句的内容。<div> {isSignedIn && <Agenda />} </div>
通过这些更改, src/App.tsx 文件应如下所示。
import { Providers, ProviderState } from '@microsoft/mgt-element';
import { Agenda, Login } from '@microsoft/mgt-react';
import React, { useState, useEffect } from 'react';
import './App.css';
function useIsSignedIn(): [boolean] {
const [isSignedIn, setIsSignedIn] = useState(false);
useEffect(() => {
const updateState = () => {
const provider = Providers.globalProvider;
setIsSignedIn(provider && provider.state === ProviderState.SignedIn);
};
Providers.onProviderUpdated(updateState);
updateState();
return () => {
Providers.removeProviderUpdatedListener(updateState);
}
}, []);
return [isSignedIn];
}
function App() {
const [isSignedIn] = useIsSignedIn();
return (
<div className="App">
<header>
<Login />
</header>
<div>
{isSignedIn &&
<Agenda />}
</div>
</div>
);
}
export default App;
在用户登录后显示用户日历的测试
通过这些更改,使用 Microsoft 帐户登录应用程序后,应该可以看到日历。
- To see the changes, close the browser and open it again, and go to
http://localhost:3000. 这样做是因为您更改了 属性的值scopes,这会影响从应用程序请求的访问Azure AD。 - 选择 "登录" 按钮,然后使用你的 Microsoft 帐户登录。 请注意同意提示中请求的权限列表的新增内容。 这是因为在 属性中包含了其他
scope权限。 - 同意使用应用程序后,应看到有关当前用户及其日历的信息。
已完成的应用
后续步骤
- 查看 Microsoft Graph Toolkit。
- 在样本中试用组件。
- 在 Stack Overflow 上提问。
- 在 GitHub 上报告 bug 或提出功能请求。
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 sebastienlevert)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
