如何使用UserManager在IdentityUser上加载导航属性

Question

我已经扩展了IdentityUser，将用户地址作为导航属性包含在内。但是当使用UserManager.FindByEmailAsync获取用户时，导航属性没有填充。ASP.NET Identity Core是否有像Entity Framework的Include()一样填充导航属性的方法，还是我需要手动完成？

我是这样设置导航属性的：

public class MyUser : IdentityUser
{
    public int? AddressId { get; set; }

    [ForeignKey(nameof(AddressId))]
    public virtual Address Address { get; set; }
}

public class Address
{
    [Key]
    public int Id { get; set; }
    public string Street { get; set; }
    public string Town { get; set; }
    public string Country { get; set; }
}

- Mourndark

---

据我所知，没有内置的方法，你需要手动完成。至少当我遇到同样的问题时，我没有找到一个内置的方法。如果确实有一种方法，我很乐意接受更正。 - Christoph Fink

顺便提一下：由于约定优于配置，[ForeignKey(nameof(AddressId))] 不是必需的。 - Camilo Terevinto

@CamiloTerevinto：它不是必需的，确实如此。但是，我总是添加属性只是为了明确表达。我不喜欢依赖于"魔法"约定，这也使代码更容易理解。 - Chris Pratt

同样地，对于那些可能不熟悉EF Core及其约定的人来说，这一点尤为重要。 - Mourndark

啊！我已经苦思冥想很久了，但即使在Core 3.1中仍然无法正常工作。文档似乎表明这应该可以工作-请参见https://learn.microsoft.com/en-us/aspnet/core/security/authentication/customize-identity-model?view=aspnetcore-3.0#add-all-navigation-properties-但实际上并没有。 - Jedidja

Answer 1

很遗憾，您必须手动执行此操作或创建自己的IUserStore<IdentityUser>，在FindByEmailAsync方法中加载相关数据：

public class MyStore : IUserStore<IdentityUser>, // the rest of the interfaces
{
    // ... implement the dozens of methods
    public async Task<IdentityUser> FindByEmailAsync(string normalizedEmail, CancellationToken token)
    {
        return await context.Users
            .Include(x => x.Address)
            .SingleAsync(x => x.Email == normalizedEmail);
    }
}

当然，仅为此实现整个存储并不是最佳选择。

但是，您也可以直接查询存储：

UserManager<IdentityUser> userManager; // DI injected

var user = await userManager.Users
    .Include(x => x.Address)
    .SingleAsync(x => x.NormalizedEmail == email);

- Camilo Terevinto

---

使用 SingleOrDefaultAsync 而不是 SingleAsync。 - Mahmood Garibov

Answer 2

简短回答：你不能。不过，有几个选项：

1. 稍后显式加载关系：

   await context.Entry(user).Reference(x => x.Address).LoadAsync();
   

   这当然需要发出额外的查询，但您可以继续通过UserManager拉取用户。

2. 只需使用上下文。您不必须使用UserManager。它只是使某些事情变得更简单。您始终可以回退到通过上下文直接查询:

var user = context.Users.Include(x => x.Address).SingleOrDefaultAsync(x=> x.Id == User.Identity.GetUserId());

FWIW，您的导航属性不需要使用virtual。这是用于延迟加载的，但EF Core当前不支持。 （尽管EF Core 2.1目前在预览版中，但实际上将支持延迟加载。）无论如何，往往懒惰加载都是一个坏主意，因此您仍应坚持急切或明确地加载您的关系。

- Chris Pratt

---

感谢您提供了关于延迟加载的技巧。这个项目最初是基于EF6开发的，所以在代码库和我的头脑中都有很多遗留问题！ - Mourndark

Answer 3

针对.NET 6.0和EF Core 6.0的更新：

现在可以配置属性，在每次查询时自动包含该属性。

modelBuilder.Entity<MyUser>().Navigation(e => e.Address).AutoInclude();

了解更多信息，请查看： https://learn.microsoft.com/zh-cn/ef/core/querying/related-data/eager#model-configuration-for-auto-including-navigations

- crazy

---

运行良好，但是如果你有一对多的关系，请注意循环。 - Usama Aziz

Answer 4

我发现在UserManager类上编写一个扩展非常有用。

public static async Task<MyUser> FindByUserAsync(
    this UserManager<MyUser> input,
    ClaimsPrincipal user )
{
    return await input.Users
        .Include(x => x.InverseNavigationTable)
        .SingleOrDefaultAsync(x => x.NormalizedUserName == user.Identity.Name.ToUpper());
}

- Daniel Kahle

Answer 5

在我的情况下，最好的选择是添加对Microsoft.EntityFrameworkCore.Proxies的包引用，然后在您的服务中使用UseLazyLoadingProxies。

.AddDbContext<YourDbContext>(
    b => b.UseLazyLoadingProxies()
          .UseSqlServer(myConnectionString));

更多信息https://learn.microsoft.com/de-de/ef/core/querying/related-data/lazy

- Florian Gilde

Answer 6

我知道这是一个旧帖子，但我通过使用Camilo Terevinto提供的第一个选项解决了这个问题，但稍作修改并继承了UserManager，并重写了GetUserAsync方法，以添加我需要加载所需属性的一些逻辑。

public class UserService : UserManager<MyUser> {
    private readonly ApplicationDbContext context;

    public UserService(ApplicationDbContext context, IUserStore<MyUser> store, IOptions<IdentityOptions> optionsAccessor, IPasswordHasher<MyUser> passwordHasher, IEnumerable<IUserValidator<MyUser>> userValidators, IEnumerable<IPasswordValidator<MyUser>> passwordValidators, ILookupNormalizer keyNormalizer, IdentityErrorDescriber errors, IServiceProvider services, ILogger<UserManager<MyUser>> logger) : base(store, optionsAccessor, passwordHasher, userValidators, passwordValidators, keyNormalizer, errors, services, logger) {
        this.context = context;
    }

    public override async Task<MyUser?> GetUserAsync(ClaimsPrincipal principal) {
        var user = await base.GetUserAsync(principal);

        if (user is null)
            return user;

        await context.Entry(user).Reference(x => x.Address).LoadAsync();

        return user;
    }
}

- DChristy