使用 Microsoft Graph 生成 Go 应用
本教程介绍如何生成使用 Microsoft Graph API 代表用户访问数据的 Go 控制台应用。
注意
若要了解如何使用 Microsoft Graph 通过仅限应用的身份验证访问数据，请参阅此 仅限应用的身份验证教程。
在本教程中，你将：
- 获取已登录用户
- 列出用户的收件箱邮件
- "发送电子邮件"
提示
作为本教程的替代方法，可以通过 快速启动 工具下载完成的代码，该工具可自动执行应用注册和配置。 下载的代码无需进行任何修改即可正常工作。
还可以下载或克隆 GitHub 存储库 ，并按照 README 中的说明注册应用程序并配置项目。
先决条件
在开始本教程之前，应在开发计算机上安装 Go 。
还应该有一个包含 Exchange Online 邮箱Microsoft工作或学校帐户。 如果没有 Microsoft 365 租户，则可以通过 Microsoft 365 开发人员计划获得租户;有关详细信息，请参阅 常见问题解答。 或者，可以 注册 1 个月的免费试用版或购买 Microsoft 365 计划。
注意
本教程使用 Go 版本 1.19.3 编写。 本指南中的步骤可能适用于其他版本，但尚未测试。
在门户中注册该应用
在本练习中，你将在 Azure Active Directory 中注册一个新应用程序以启用 用户身份验证。 可以使用 Microsoft Entra 管理中心或使用 Microsoft Graph PowerShell SDK 注册应用程序。
注册应用程序进行用户身份验证
在本部分中，你将注册一个支持使用 设备代码流进行用户身份验证的应用程序。
打开浏览器，导航到 Microsoft Entra 管理中心 ，并使用全局管理员帐户登录。
在左侧导航栏中选择“Microsoft Entra ID”，依次展开“标识”、“应用程序”和“应用注册”。
选择“新注册”。 输入应用程序的名称，例如
Graph User Auth Tutorial。根据需要设置 支持的帐户类型 。 选项包括：
选项 谁可以登录？ 仅限此组织目录中的帐户 仅限 Microsoft 365 组织中的用户 任何组织目录中的帐户 任何Microsoft 365 组织中的用户 (工作或学校帐户) 任何组织目录中的帐户...和个人Microsoft帐户 任何Microsoft 365 组织中的用户 (工作或学校帐户) 和个人Microsoft帐户 保留“重定向 URI”为空。
选择“注册”。 在应用程序的 “概述 ”页上，复制 “应用程序 (客户端) ID ”的值并保存它，下一步将需要它。 如果 为此组织目录中的“帐户”选择“仅 支持 帐户类型”，则还要复制 “目录 (租户) ID 并保存它。
选择“管理”下的“身份验证”。 找到 “高级设置” 部分，将 “允许公共客户端流” 切换开关更改为 “是”，然后选择“ 保存”。
注意
请注意，你未对应用注册配置任何 Microsoft Graph 权限。 这是因为此示例使用 动态同意 请求用户身份验证的特定权限。
创建 Go 控制台应用
首先使用 Go CLI 初始化新的 Go 模块。 在要在其中创建项目的目录中打开命令行界面 (CLI) 。 运行以下命令：
go mod init graphtutorial
安装依赖项
在继续操作之前，请添加稍后将使用的一些其他依赖项。
- 适用于 Go 的 Azure 标识客户端模块 ，用于对用户进行身份验证并获取访问令牌。
- Microsoft Graph SDK for Go 调用 Microsoft Graph。
- 用于从 .env 文件读取环境变量的 GoDotEnv。
在 CLI 中运行以下命令以安装依赖项。
go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/microsoftgraph/msgraph-sdk-go
go get github.com/joho/godotenv
加载应用程序设置
在本部分中，你将向项目添加应用注册的详细信息。
在 go.mod 的同一目录中创建名为 .env 的文件，并添加以下代码。
CLIENT_ID=YOUR_CLIENT_ID_HERE TENANT_ID=common GRAPH_USER_SCOPES=user.read,mail.read,mail.send根据下表更新值。
设置 值 CLIENT_ID应用注册的客户端 ID TENANT_ID如果选择了仅允许组织中的用户登录的选项，请将此值更改为租户 ID。 否则保留为 common。提示
（可选）可以在名为 .env.local 的单独文件中设置这些值。
设计应用
在本部分中，你将创建一个基于控制台的简单菜单。
在 与 go.mod 相同的目录中创建名为 graphhelper 的新目录。
在 graphhelper 目录中添加名为 graphhelper.go 的新文件，并添加以下代码。
package graphhelper import ( "context" "fmt" "os" "strings" "github.com/Azure/azure-sdk-for-go/sdk/azcore/policy" "github.com/Azure/azure-sdk-for-go/sdk/azidentity" auth "github.com/microsoft/kiota-authentication-azure-go" msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go" "github.com/microsoftgraph/msgraph-sdk-go/models" "github.com/microsoftgraph/msgraph-sdk-go/users" ) type GraphHelper struct { deviceCodeCredential *azidentity.DeviceCodeCredential userClient *msgraphsdk.GraphServiceClient graphUserScopes []string } func NewGraphHelper() *GraphHelper { g := &GraphHelper{} return g }这将创建一个基本 GraphHelper 类型，稍后将扩展该类型以使用 Microsoft Graph。
在 go.mod 的同一目录中创建名为 graphtutorial.go 的文件。 添加以下代码。
package main import ( "fmt" "graphtutorial/graphhelper" "log" "time" "github.com/joho/godotenv" ) func main() { fmt.Println("Go Graph Tutorial") fmt.Println() // Load .env files // .env.local takes precedence (if present) godotenv.Load(".env.local") err := godotenv.Load() if err != nil { log.Fatal("Error loading .env") } graphHelper := graphhelper.NewGraphHelper() initializeGraph(graphHelper) greetUser(graphHelper) var choice int64 = -1 for { fmt.Println("Please choose one of the following options:") fmt.Println("0. Exit") fmt.Println("1. Display access token") fmt.Println("2. List my inbox") fmt.Println("3. Send mail") fmt.Println("4. Make a Graph call") _, err = fmt.Scanf("%d", &choice) if err != nil { choice = -1 } switch choice { case 0: // Exit the program fmt.Println("Goodbye...") case 1: // Display access token displayAccessToken(graphHelper) case 2: // List emails from user's inbox listInbox(graphHelper) case 3: // Send an email message sendMail(graphHelper) case 4: // Run any Graph code makeGraphCall(graphHelper) default: fmt.Println("Invalid choice! Please try again.") } if choice == 0 { break } } }在文件末尾添加以下占位符方法。 你将在后面的步骤中实现它们。
func initializeGraph(graphHelper *graphhelper.GraphHelper) { // TODO } func greetUser(graphHelper *graphhelper.GraphHelper) { // TODO } func displayAccessToken(graphHelper *graphhelper.GraphHelper) { // TODO } func listInbox(graphHelper *graphhelper.GraphHelper) { // TODO } func sendMail(graphHelper *graphhelper.GraphHelper) { // TODO } func makeGraphCall(graphHelper *graphhelper.GraphHelper) { // TODO }
这将实现基本菜单，并从命令行读取用户的选择。
添加用户身份验证
在本部分中，将扩展上一练习中的应用程序，以支持使用 Azure AD 进行身份验证。 这是获取调用 Microsoft Graph 所需的 OAuth 访问令牌所必需的。 在此步骤中，你将 将适用于 Go 的 Azure 标识客户端模块 集成到应用程序中，并为 Microsoft Graph SDK for Go 配置身份验证。
Azure 标识库提供了许多 TokenCredential 实现 OAuth2 令牌流的类。 Microsoft Graph 客户端库使用这些类对 Microsoft Graph 的调用进行身份验证。
配置 Graph 客户端以用于用户身份验证
在本部分中， DeviceCodeCredential 你将使用 类通过 设备代码流请求访问令牌。
将以下函数添加到 ./graphhelper/graphhelper.go。
func (g *GraphHelper) InitializeGraphForUserAuth() error { clientId := os.Getenv("CLIENT_ID") tenantId := os.Getenv("TENANT_ID") scopes := os.Getenv("GRAPH_USER_SCOPES") g.graphUserScopes = strings.Split(scopes, ",") // Create the device code credential credential, err := azidentity.NewDeviceCodeCredential(&azidentity.DeviceCodeCredentialOptions{ ClientID: clientId, TenantID: tenantId, UserPrompt: func(ctx context.Context, message azidentity.DeviceCodeMessage) error { fmt.Println(message.Message) return nil }, }) if err != nil { return err } g.deviceCodeCredential = credential // Create an auth provider using the credential authProvider, err := auth.NewAzureIdentityAuthenticationProviderWithScopes(credential, g.graphUserScopes) if err != nil { return err } // Create a request adapter using the auth provider adapter, err := msgraphsdk.NewGraphRequestAdapter(authProvider) if err != nil { return err } // Create a Graph client using request adapter client := msgraphsdk.NewGraphServiceClient(adapter) g.userClient = client return nil }提示
如果使用 goimports，则在保存时，某些模块可能已从
importgraphhelper.go 中的语句中自动删除。 可能需要重新添加要生成的模块。将 graphtutorial.go 中的空
initializeGraph函数替换为以下内容。func initializeGraph(graphHelper *graphhelper.GraphHelper) { err := graphHelper.InitializeGraphForUserAuth() if err != nil { log.Panicf("Error initializing Graph for user auth: %v\n", err) } }
此代码初始化两个 DeviceCodeCredential 属性：对象和 GraphServiceClient 对象。 函数 InitializeGraphForUserAuth 创建 的新实例 DeviceCodeCredential，然后使用该实例创建 的新 GraphServiceClient实例。 每次通过 userClient进行 API 调用以Microsoft Graph 时，都会使用提供的凭据来获取访问令牌。
测试 DeviceCodeCredential
接下来，添加代码以从 DeviceCodeCredential获取访问令牌。
将以下函数添加到 ./graphhelper/graphhelper.go。
func (g *GraphHelper) GetUserToken() (*string, error) { token, err := g.deviceCodeCredential.GetToken(context.Background(), policy.TokenRequestOptions{ Scopes: g.graphUserScopes, }) if err != nil { return nil, err } return &token.Token, nil }将 graphtutorial.go 中的空
displayAccessToken函数替换为以下内容。func displayAccessToken(graphHelper *graphhelper.GraphHelper) { token, err := graphHelper.GetUserToken() if err != nil { log.Panicf("Error getting user token: %v\n", err) } fmt.Printf("User token: %s", *token) fmt.Println() }通过运行 生成并运行
go run graphtutorial应用。 当系统提示输入选项时，请输入1。 应用程序显示 URL 和设备代码。Go Graph Tutorial Please choose one of the following options: 0. Exit 1. Display access token 2. List my inbox 3. Send mail 4. Make a Graph call 1 To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code RB2RUD56D to authenticate.打开浏览器并浏览到显示的 URL。 输入提供的代码并登录。
重要
请注意浏览到
https://microsoft.com/devicelogin时登录到浏览器的任何现有Microsoft 365 个帐户。 使用浏览器功能（如配置文件、来宾模式或专用模式）确保作为要用于测试的帐户进行身份验证。完成后，返回到应用程序以查看访问令牌。
提示
仅出于验证和调试目的，只能) 使用 Microsoft 的联机令牌分析程序在 中https://jwt.ms解码工作或学校帐户的用户访问令牌 (。 如果在调用 Microsoft Graph 时遇到令牌错误，这很有用。 例如，验证令牌中的声明是否
scp包含预期的 Microsoft Graph 权限范围。
获取用户
在本部分中，你将将 Microsoft Graph 合并到应用程序中。 对于此应用程序，你将使用 Microsoft Graph SDK for Go 调用 Microsoft Graph。
将以下函数添加到 ./graphhelper/graphhelper.go。
func (g *GraphHelper) GetUser() (models.Userable, error) { query := users.UserItemRequestBuilderGetQueryParameters{ // Only request specific properties Select: []string{"displayName", "mail", "userPrincipalName"}, } return g.userClient.Me().Get(context.Background(), &users.UserItemRequestBuilderGetRequestConfiguration{ QueryParameters: &query, }) }将 graphtutorial.go 中的空
greetUser函数替换为以下内容。func greetUser(graphHelper *graphhelper.GraphHelper) { user, err := graphHelper.GetUser() if err != nil { log.Panicf("Error getting user: %v\n", err) } fmt.Printf("Hello, %s!\n", *user.GetDisplayName()) // For Work/school accounts, email is in Mail property // Personal accounts, email is in UserPrincipalName email := user.GetMail() if email == nil { email = user.GetUserPrincipalName() } fmt.Printf("Email: %s\n", *email) fmt.Println() }
如果立即运行应用，则登录后应用将按名称欢迎你。
Hello, Megan Bowen!
Email: MeganB@contoso.com
代码说明
请考虑 函数中的 getUser 代码。 这只是几行，但有一些关键细节需要注意。
访问“me”
函数使用 userClient.Me 请求生成器，该生成器生成对 Get 用户 API 的请求。 可通过两种方式访问此 API：
GET /me
GET /users/{user-id}
在这种情况下，代码将调用 GET /me API 终结点。 这是获取经过身份验证的用户而不了解其用户 ID 的快捷方式。
注意
GET /me由于 API 终结点获取经过身份验证的用户，因此它仅适用于使用用户身份验证的应用。 仅限应用的身份验证应用无法访问此终结点。
请求特定属性
函数使用 Select 请求的查询参数中的 属性来指定它所需的属性集。 这会将 $select 查询参数 添加到 API 调用。
强类型返回类型
函数从 API 的 JSON 响应返回 Userable 反序列化的对象。 由于代码使用 Select，因此只有请求的属性在返回 Userable 的 对象中具有值。 所有其他属性将具有默认值。
列出收件箱
在本部分中，你将添加在用户的电子邮件收件箱中列出邮件的功能。
将以下函数添加到 ./graphhelper/graphhelper.go。
func (g *GraphHelper) GetInbox() (models.MessageCollectionResponseable, error) { var topValue int32 = 25 query := users.ItemMailFoldersItemMessagesRequestBuilderGetQueryParameters{ // Only request specific properties Select: []string{"from", "isRead", "receivedDateTime", "subject"}, // Get at most 25 results Top: &topValue, // Sort by received time, newest first Orderby: []string{"receivedDateTime DESC"}, } return g.userClient.Me().MailFolders(). ByMailFolderId("inbox"). Messages(). Get(context.Background(), &users.ItemMailFoldersItemMessagesRequestBuilderGetRequestConfiguration{ QueryParameters: &query, }) }将 graphtutorial.go 中的空
listInbox函数替换为以下内容。func listInbox(graphHelper *graphhelper.GraphHelper) { messages, err := graphHelper.GetInbox() if err != nil { log.Panicf("Error getting user's inbox: %v", err) } // Load local time zone // Dates returned by Graph are in UTC, use this // to convert to local location, err := time.LoadLocation("Local") if err != nil { log.Panicf("Error getting local timezone: %v", err) } // Output each message's details for _, message := range messages.GetValue() { fmt.Printf("Message: %s\n", *message.GetSubject()) fmt.Printf(" From: %s\n", *message.GetFrom().GetEmailAddress().GetName()) status := "Unknown" if *message.GetIsRead() { status = "Read" } else { status = "Unread" } fmt.Printf(" Status: %s\n", status) fmt.Printf(" Received: %s\n", (*message.GetReceivedDateTime()).In(location)) } // If GetOdataNextLink does not return nil, // there are more messages available on the server nextLink := messages.GetOdataNextLink() fmt.Println() fmt.Printf("More messages available? %t\n", nextLink != nil) fmt.Println() }运行应用，登录，然后选择选项 2 列出收件箱。
Please choose one of the following options: 0. Exit 1. Display access token 2. List my inbox 3. Send mail 4. Make a Graph call 2 Message: Updates from Ask HR and other communities From: Contoso Demo on Yammer Status: Read Received: 2021-12-30 04:54:54 -0500 EST Message: Employee Initiative Thoughts From: Patti Fernandez Status: Read Received: 2021-12-28 17:01:10 -0500 EST Message: Voice Mail (11 seconds) From: Alex Wilber Status: Unread Received: 2021-12-28 17:00:46 -0500 EST Message: Our Spring Blog Update From: Alex Wilber Status: Unread Received: 2021-12-28 16:49:46 -0500 EST Message: Atlanta Flight Reservation From: Alex Wilber Status: Unread Received: 2021-12-28 16:35:42 -0500 EST Message: Atlanta Trip Itinerary - down time From: Alex Wilber Status: Unread Received: 2021-12-28 16:22:04 -0500 EST ... More messages available? True
代码说明
请考虑 函数中的 GetInbox 代码。
访问已知邮件文件夹
函数使用 userClient.Me().MailFolders.ByMailFolderId("inbox").Messages() 请求生成器，该生成器生成对 列表消息 API 的请求。 由于它包含 ByMailFolderId("inbox") 请求生成器，API 将仅返回所请求邮件文件夹中的邮件。 在这种情况下，由于收件箱是用户邮箱中默认的已知文件夹，因此可通过其已知名称访问该文件夹。 非默认文件夹的访问方式相同，方法是将已知名称替换为邮件文件夹的 ID 属性。 有关可用已知文件夹名称的详细信息，请参阅 mailFolder 资源类型。
访问集合
与上一 GetUser 部分中返回单个 对象的函数不同，此方法返回消息集合。 Microsoft Graph 中返回集合的大多数 API 不会在单个响应中返回所有可用结果。 相反，它们使用 分页 返回部分结果，同时为客户端提供请求下一个“页面”的方法。
默认页面大小
使用分页的 API 实现默认页面大小。 对于消息，默认值为 10。 客户端可以使用 $top 查询参数请求更多 (或更少的 ) 。 在 中 GetInbox，这是使用 Top 查询参数中的 属性完成的。
注意
传入的值 Top 是上限，而不是显式数字。 API 返回一些 消息，最多返回 指定值。
获取后续页面
如果服务器上有更多可用的结果，则集合响应将包含一个 @odata.nextLink 具有 API URL 的属性，用于访问下一页。 Go SDK 将此公开为 GetOdataNextLink 集合页对象上的 方法。 如果此方法返回非 nil，则有更多可用的结果。
集合排序
函数使用 OrderBy 查询参数中的 属性请求按接收消息的时间排序的结果， (receivedDateTime 属性) 。 它包含 DESC 关键字，以便首先列出最近收到的消息。 这会将 $orderby 查询参数 添加到 API 调用。
发送邮件
在本部分中，你将添加以经过身份验证的用户身份发送电子邮件的功能。
将以下函数添加到 ./graphhelper/graphhelper.go。
func (g *GraphHelper) SendMail(subject *string, body *string, recipient *string) error { // Create a new message message := models.NewMessage() message.SetSubject(subject) messageBody := models.NewItemBody() messageBody.SetContent(body) contentType := models.TEXT_BODYTYPE messageBody.SetContentType(&contentType) message.SetBody(messageBody) toRecipient := models.NewRecipient() emailAddress := models.NewEmailAddress() emailAddress.SetAddress(recipient) toRecipient.SetEmailAddress(emailAddress) message.SetToRecipients([]models.Recipientable{ toRecipient, }) sendMailBody := users.NewItemSendMailPostRequestBody() sendMailBody.SetMessage(message) // Send the message return g.userClient.Me().SendMail().Post(context.Background(), sendMailBody, nil) }将 graphtutorial.go 中的空
sendMail函数替换为以下内容。func sendMail(graphHelper *graphhelper.GraphHelper) { // Send mail to the signed-in user // Get the user for their email address user, err := graphHelper.GetUser() if err != nil { log.Panicf("Error getting user: %v", err) } // For Work/school accounts, email is in Mail property // Personal accounts, email is in UserPrincipalName email := user.GetMail() if email == nil { email = user.GetUserPrincipalName() } subject := "Testing Microsoft Graph" body := "Hello world!" err = graphHelper.SendMail(&subject, &body, email) if err != nil { log.Panicf("Error sending mail: %v", err) } fmt.Println("Mail sent.") fmt.Println() }运行应用，登录并选择选项 3 以向自己发送电子邮件。
Please choose one of the following options: 0. Exit 1. Display access token 2. List my inbox 3. Send mail 4. Make a Graph call 3 Mail sent.注意
如果使用 Microsoft 365 开发人员计划中的开发人员租户进行测试，则发送的电子邮件可能未送达，并且可能会收到未送达报告。 如果发生这种情况，请通过 Microsoft 365 管理中心联系支持人员。
若要验证是否已收到邮件，请选择选项 2 列出收件箱。
代码说明
请考虑 函数中的 SendMail 代码。
发送邮件
函数使用 userClient.Me().SendMail() 请求生成器，该生成器生成对 发送邮件 API 的请求。 请求生成器采用表示 Message 要发送的消息的 对象。
创建对象
与以前调用 Microsoft Graph（仅读取数据）不同，此调用会创建数据。 若要使用客户端库执行此操作，请创建表示数据 (的类的实例，在这种情况下， models.Message) ，设置所需的属性，然后在 API 调用中发送它。 由于调用正在发送数据，因此使用 Post 方法而不是 Get。
可选：添加自己的代码
在本部分中，将向应用程序添加自己的 Microsoft Graph 功能。 这可能是Microsoft Graph 文档 或 Graph 资源管理器中的代码片段，也可以是你创建的代码片段。 此部分是可选的。
更新应用
将以下函数添加到 ./graphhelper/graphhelper.go。
func (g *GraphHelper) MakeGraphCall() error { // INSERT YOUR CODE HERE return nil }将 graphtutorial.go 中的空
makeGraphCall函数替换为以下内容。func makeGraphCall(graphHelper *graphhelper.GraphHelper) { err := graphHelper.MakeGraphCall() if err != nil { log.Panicf("Error making Graph call: %v", err) } }
选择 API
在 Microsoft Graph 中查找想要尝试的 API。 例如， 创建事件 API。 可以使用 API 文档中的示例之一，也可以在 Graph 资源管理器中自定义 API 请求并使用生成的代码片段。
配置权限
查看所选 API 的参考文档 的“权限” 部分，了解支持哪些身份验证方法。 例如，某些 API 不支持仅限应用或个人Microsoft帐户。
- 若要调用具有用户身份验证 (API（如果 API 支持用户 (委托) 身份验证) ），请在 .env (或 .env.local) 中添加所需的权限范围。
- 若要使用仅应用身份验证调用 API，请参阅 仅限应用的身份验证 教程。
添加代码
将代码复制到 MakeGraphCallgraphhelper.go 中的函数中。 如果要从文档或 Graph 资源管理器复制代码片段，请务必将 重命名 GraphServiceClient 为 userClient。
恭喜！
你已完成 Go Microsoft Graph 教程。 现在，你已有一个可调用 Microsoft Graph 的工作应用，可以试验和添加新功能。
- 了解如何将 仅限应用的身份验证 与 Microsoft Graph SDK for Go 配合使用。
- 访问 Microsoft Graph 概述 ，查看可以使用 Microsoft Graph 访问的所有数据。
你有关于此部分的问题？ 如果有，请向我们提供反馈，以便我们对此部分作出改进。