桌面应用程序,在我这篇文章的语境中,我是特指在Windows桌面上面直接运行的.NET应用程序,包括Console Application,WPF Application,Windows Forms Application, UWP Application,并且限于篇幅,我只会以Console Application作为演示,因为无论表现形式如何不同,它们从本质上是类似的。
本文所附带示例代码可以通过
https://github.com/chenxizhang/office365dev/tree/master/samples/graph-consoleapplicationsample访问,这是由Visual Studio 2017编写,开发语言为C#,在Windows 10 Enterprise
上面测试通过。请注意,作为演示目的,我尽可能在范例代码中仅包含最必要的代码。
注册Microsoft Graph应用程序
要进行具体的编程之前,你需要注册Microsfot Graph应用程序。本系列文章约定,针对国际版我将采用Azure AD 2.0这种方式进行注册,而针对中国版将采用Azure AD 1.0这种方式。这两种方式的详细操作步骤,以及我注册好的范例应用程序,请参考。
注册Azure AD 2.0 应用程序
注册中国版Microsoft Graph应用程序
创建Console Application
不要问我怎么做这个事情,你应该知道的。
考虑安全认证功能
关键是,接下来你该如何考虑呢?有的人会联想到OAuth,这是一个很好的想法。我在此前已经提到过如何分三个步骤实现Microsoft Graph应用开发,第一步是注册应用程序,第二步是实现身份认证,第三步就是该怎么调用你就怎么调用。
下图介绍了在Azure AD 2.0中支持的OAuth认证流程
简单地说,OAuth认证一般会有三个步骤
-
客户端代表用户发起认证请求(通常是/authorize 这个地址),这个会跳转到Office 365的登录页面,让用户输入账号和密码
-
如果用户提供了正确的账号和密码,并确认授权,Azure AD会向我们在注册应用程序时提供的回调地址(redirectUrl)POST一个请求过来,附上一个code,然后我们的应用需要继续用这个code去发起一个请求,申请访问令牌(通常是/token这个地址)
-
客户端得到令牌(Access_Token),就可以代表用户访问Microsoft Graph的资源(通常是放在请求的头部里面)。这里需要注意的是,通常令牌都是会一定时间过期的,Micrsoft Graph的令牌默认为1小时有效。过期前可以通过一定的方式刷新令牌。
你当然可以在了解上述原理马上开始编写代码,但这里要请你了解,为了降低开发人员在这块的工作量,并且尽量进行标准化,Microsoft Graph针对不同的平台和语言都有对应的SDK。请参考
https://developer.microsoft.com/zh-cn/graph/docs/get-started/get-started
具体到我们本篇文章的目标,如果Office 365是国际版,你可以使用Microsoft Graph Client Library
https://www.nuget.org/packages/Microsoft.Graph/
和 Microsoft Authentication
Library
https://www.nuget.org/packages/Microsoft.Identity.Client/1.0.304142221-alpha
目前这个 Microsoft Authentication Library 的状态是Preview,但是很值得期待,因为它还有针对.NET Core的版本
而如果是用中国版,你也可以使用 Active Directory Authentication Library .NET
https://msdn.microsoft.com/library/en-us/Mt417579.aspx
实现国际版Microsoft Graph调用
首先,运行下面的命令安装上面提到的两个Library,并且进行更新
Install-Package Microsoft.Graph
Install-Package Microsoft.Identity.Client -IncludePrerelease
Update-Package
接下来,我们需要编写一个方法,封装一下Graph Authentication这个步骤.
备注,我认为这里还有可以改进的空间,最好是连这一步都可以省略掉。产品组是还没有完全想好,日后应该会加上这块实现。
class GraphAuthenticator : IAuthenticationProvider
{
static string token;
static DateTimeOffset Expiration;
public async Task AuthenticateRequestAsync(HttpRequestMessage request)
{
string clientID = "45aa2ecc-5e57-4c91-86c1-b93064800c39";//这个ID是我创建的一个临时App的ID,请替换为自己的
string[] scopes = { "user.read", "mail.read", "mail.send"};
var app = new PublicClientApplication(clientID);
AuthenticationResult result = null;
try
{
result = await app.AcquireTokenSilentAsync(scopes);
token = result.Token;
}
catch (Exception)
{
if (string.IsNullOrEmpty(token) || Expiration <= DateTimeOffset.UtcNow.AddMinutes(5))
{
result = await app.AcquireTokenAsync(scopes);
Expiration = result.ExpiresOn;
token = result.Token;
}
}
request.Headers.Add("Authorization", $"Bearer {token}");
}
}
有了这个类,接下来我们要调用Microsoft Graph简直可以说是易如反掌,请参考下面的代码
var client = new GraphServiceClient(new GraphAuthenticator());//创建客户端代理
var user = client.Me.Request().GetAsync().Result;//获取当前用户信息
Console.WriteLine(user.DisplayName);
var messages = client.Me.Messages.Request().GetAsync().Result;//获取用户的前十封邮件
foreach (var item in messages)
{
Console.WriteLine(item.Subject);
}
client.Me.SendMail(new Message() //发送邮件
{
Subject = "调用Microsoft Graph发出的邮件",
Body = new ItemBody()
{
ContentType = BodyType.Text,
Content = "这是一封调用了Microsoft Graph服务发出的邮件,范例参考 https://github.com/chenxizhang/office365dev"
},
ToRecipients = new[]
{
new Recipient()
{
EmailAddress = new EmailAddress(){ Address ="[email protected]"}
}
}
}, true).Request().PostAsync();
Console.Read();
完整代码,请参考
https://github.com/chenxizhang/office365dev/blob/master/samples/graph-consoleapplicationsample/graph-consoleapplicationsample/Program.cs