OpenIddict在ASP.NET Identity中优化外部登录提供者显示名称的实现方案

背景介绍

OpenIddict是一个流行的开源OpenID Connect服务器和身份验证库，广泛应用于.NET生态系统中。在实际开发中，我们经常需要集成多种外部身份提供者（如Microsoft、GitHub等）来实现第三方登录功能。然而，在ASP.NET Identity（非Core版本）中，开发者可能会遇到外部登录提供者显示名称不友好的问题。

问题现象

当使用OpenIddict的WebProviders功能集成外部登录时，特别是在ASP.NET Identity（非Core版本）中，开发者可能会遇到两个主要显示问题：

1. 登录页面上的外部提供者按钮显示的是技术性的ProviderName而非用户友好的ProviderDisplayName
2. 在回调页面（如/Account/ExternalLoginCallback）中，当需要用户确认创建账户时，系统会显示完整的登录URL而非友好的提供者名称

这种显示方式不仅不美观，还可能让终端用户感到困惑，影响用户体验。

技术原理分析

这一问题的根源在于ASP.NET Identity与ASP.NET Core Identity处理外部登录提供者名称的方式不同：

• ASP.NET Core Identity会优先使用ProviderDisplayName
• 传统ASP.NET Identity则使用Claim.Issuer属性中的值作为显示名称

由于OpenIddict和IdentityModel等库默认使用颁发者URI（Issuer URI）作为声明颁发者，这就导致了在UI中显示的是技术性的URI而非友好的名称。

解决方案

1. 使用OpenIddict 6.0 RC2及更高版本

最新版本的OpenIddict已经引入了新的声明颁发者选项，可以更好地控制外部提供者的显示名称。开发者可以配置：

options.UseWebProviders()
    .AddMicrosoft(options =>
    {
        options.SetClientId("your-client-id")
               .SetClientSecret("your-client-secret")
               .SetRedirectUri("/callback/login/microsoft")
               .SetClaimsIssuer("Microsoft"); // 设置友好的声明颁发者名称
    });

2. 手动处理回调视图

对于暂时无法升级的项目，可以在回调控制器中手动处理显示名称：

public async Task<ActionResult> ExternalLoginCallback(string returnUrl)
{
    var loginInfo = await AuthenticationManager.GetExternalLoginInfoAsync();
    if (loginInfo == null)
    {
        return RedirectToAction("Login");
    }

    // 尝试从声明中获取友好名称
    var friendlyName = loginInfo.ExternalIdentity.Claims
        .FirstOrDefault(c => c.Type == "oi_prvd_name")?.Value;

    ViewBag.LoginProvider = friendlyName ?? "Microsoft"; // 使用友好名称或默认值
    return View("ExternalLoginConfirmation", new ExternalLoginConfirmationViewModel 
    { 
        Email = loginInfo.Email 
    });
}

3. 视图层优化

在视图层，可以添加逻辑来显示更友好的名称：

<h4>关联您的 @ViewBag.LoginProvider 账户</h4>
<p class="text-info">
    您已成功通过 <strong>@ViewBag.LoginProvider</strong> 进行身份验证。
    请在下面输入此站点的用户名，然后单击注册按钮完成登录。
</p>

最佳实践建议

1. 统一命名策略：为所有外部提供者设置一致的命名规则，确保用户体验一致
2. 多语言支持：考虑将提供者名称存储在资源文件中，便于国际化
3. 日志记录：在调试阶段记录完整的登录信息，便于排查问题
4. 用户测试：对普通用户进行可用性测试，确保显示名称直观易懂

总结

OpenIddict提供了强大的外部身份验证集成能力，但在ASP.NET Identity中需要注意显示名称的处理。通过合理配置和少量自定义代码，开发者可以显著改善用户体验，使第三方登录流程更加专业和友好。随着OpenIddict 6.0的发布，这一问题将得到更优雅的解决方案。