当对象的一部分是更新而另一部分是创建时跨表处理 DTO
Handling DTOs across tables when one part of the object is an update while another is a create
我在决定如何在以下情况下处理 Entity Framework 的 DTO 时遇到问题。
我有一个客户 table,在单独的 table 中我有客户的联系方式。我的问题来自这样一个事实,即最初可以在没有任何联系人的情况下创建客户。因此,更新 (HTTP PUT) 可能会通过添加新联系人来更新现有客户。或者它可以更新现有客户 bt 更新现有联系人。在后一种情况下,我在 DTO 中的联系人对象将需要一个 ID。在前一种情况下它不会。
public class UpdateCustomer {
int Id {get; set;}
public string Name {get; set;}
public ICollection<Contact> Contacts {get; set;}
}
联系人 DTO 可能如下所示:
public class Contact {
<Will need contactID on update>
public CustomerId {get; set; }
public string ContactType {get; set;}
public string PhoneNumber {get; set;}
}
当用户想要使用 post 同时创建客户和联系人时,这非常有用。没有联系人对象需要 ID。但是假设他们创建了一个只有一个联系人的客户。现在他们想要更新那个客户,更新现有的联系人,还要添加一个新的联系人。这仍然是对 Put 方法的调用,但列表中的一个联系人需要 ID,另一个不需要。
我看到有几种方法可以解决这个问题。最明显的是将客户 creation/updates 和联系人 creation/updates 分开到单独的请求中。现在我可以为每个对象创建一个单独的对象,一个有 ID,一个没有。这就是我的倾向,客户端应用程序只需要进行两个单独的 API 调用。
另一种选择是无论如何在服务器端的联系人对象中包含一个 ID。如果客户端应用程序不提供联系人 ID,则它将为空。如果我看到它为空,我可以尝试添加,如果它不为空,我可以尝试更新。
我喜欢第一个想法,因为它保持独立思考,但会导致额外的 API 调用。我喜欢第二个,因为它允许一个 API 调用一次更新与客户关联的所有组件。缺点是我可能假设最终用户在他们真正想要更新时想要添加,如果他们离开了 ID。
希望这是有道理的。我只是在寻找建议或反馈。
更新:使用 Roar 的建议,这是我下面的工作解决方案。请注意,我在原来的 post 中将 class 称为客户,但实际上它是我数据库中的客户。我只是发现在关于网络 api.
的 post 中使用客户端会让人感到困惑
public async Task UpdateClient(Dtos.Shared.Client client)
{
if (!ClientExists(client.ClientId))
{
throw new ClientNotFoundException();
}
Client clientToUpdate = await AdministrativeContext.ListClients()
.Where(c => c.ClientUuid == client.ClientId)
.FirstOrDefaultAsync();
clientToUpdate.ClientName = client.ClientName;
//filter existing db elements that are still in DTO as well
clientToUpdate.Contacts = clientToUpdate.Contacts
.Where(c => client.Contacts.Any(con => con.ContactId == c.ContactUuid))
.ToList();
client.Contacts.ToList().ForEach(async contact =>
{
if (contact.ContactId == null || contact.ContactId == Guid.Empty) //if guid missing, we want to add
{
clientToUpdate.Contacts.Add(new Entities.Contact()
{
ClientId = await AdministrativeContext.GetClientKeyFromGuidAsync(client.ClientId),
ContactUuid = Guid.NewGuid(),
FirstName = contact.FirstName,
LastName = contact.LastName,
Address = contact.Address,
Email = contact.Email,
Phone = contact.Phone,
TypeId = (await AdministrativeContext.ContactTypes.Where(ct => ct.ContactTypeName == contact.ContactType).FirstOrDefaultAsync()).ContactTypeId
});
}
else //guid defined means update
{
Contact existingContact = clientToUpdate.Contacts.Where(c => contact.ContactId == c.ContactUuid).FirstOrDefault();
existingContact.ClientId = await AdministrativeContext.GetClientKeyFromGuidAsync(client.ClientId);
existingContact.Address = contact.Address;
existingContact.Email = contact.Email;
existingContact.FirstName = contact.FirstName;
existingContact.LastName = contact.LastName;
existingContact.Phone = contact.Phone;
existingContact.TypeId = (await AdministrativeContext.ContactTypes
.Where(ct => ct.ContactTypeName == contact.ContactType)
.FirstOrDefaultAsync()).ContactTypeId;
}
});
await AdministrativeContext.SaveChangesAsync();
}
我解决了update-case通常在一个请求中这样。
- 从填充了联系人集合的数据库中获取客户
- 遍历客户数据库实例中的所有联系人。如果客户 DTO 中不存在,则从客户数据库实例中的联系人集合中删除联系人
- 遍历 DTO 中的所有联系人。如果 Contact#Id = 0(或者在这种情况下可能为 null),将新联系人添加到客户数据库实例中的联系人集合,否则更新联系人集合中的现有联系人实例
- 使用 DTO 中的剩余数据更新客户数据库实例
- 将客户连同联系人集合保存到数据库(需要级联)
我通常使用 NHibernate,但原理应该也适用于 EF。
优点:
- 简单,处理联系人的创建、更新和删除以及客户更新
- 单个db-call更新
缺点:
- 每次更新都需要负载中的所有联系人
我在决定如何在以下情况下处理 Entity Framework 的 DTO 时遇到问题。
我有一个客户 table,在单独的 table 中我有客户的联系方式。我的问题来自这样一个事实,即最初可以在没有任何联系人的情况下创建客户。因此,更新 (HTTP PUT) 可能会通过添加新联系人来更新现有客户。或者它可以更新现有客户 bt 更新现有联系人。在后一种情况下,我在 DTO 中的联系人对象将需要一个 ID。在前一种情况下它不会。
public class UpdateCustomer {
int Id {get; set;}
public string Name {get; set;}
public ICollection<Contact> Contacts {get; set;}
}
联系人 DTO 可能如下所示:
public class Contact {
<Will need contactID on update>
public CustomerId {get; set; }
public string ContactType {get; set;}
public string PhoneNumber {get; set;}
}
当用户想要使用 post 同时创建客户和联系人时,这非常有用。没有联系人对象需要 ID。但是假设他们创建了一个只有一个联系人的客户。现在他们想要更新那个客户,更新现有的联系人,还要添加一个新的联系人。这仍然是对 Put 方法的调用,但列表中的一个联系人需要 ID,另一个不需要。
我看到有几种方法可以解决这个问题。最明显的是将客户 creation/updates 和联系人 creation/updates 分开到单独的请求中。现在我可以为每个对象创建一个单独的对象,一个有 ID,一个没有。这就是我的倾向,客户端应用程序只需要进行两个单独的 API 调用。
另一种选择是无论如何在服务器端的联系人对象中包含一个 ID。如果客户端应用程序不提供联系人 ID,则它将为空。如果我看到它为空,我可以尝试添加,如果它不为空,我可以尝试更新。
我喜欢第一个想法,因为它保持独立思考,但会导致额外的 API 调用。我喜欢第二个,因为它允许一个 API 调用一次更新与客户关联的所有组件。缺点是我可能假设最终用户在他们真正想要更新时想要添加,如果他们离开了 ID。
希望这是有道理的。我只是在寻找建议或反馈。
更新:使用 Roar 的建议,这是我下面的工作解决方案。请注意,我在原来的 post 中将 class 称为客户,但实际上它是我数据库中的客户。我只是发现在关于网络 api.
的 post 中使用客户端会让人感到困惑 public async Task UpdateClient(Dtos.Shared.Client client)
{
if (!ClientExists(client.ClientId))
{
throw new ClientNotFoundException();
}
Client clientToUpdate = await AdministrativeContext.ListClients()
.Where(c => c.ClientUuid == client.ClientId)
.FirstOrDefaultAsync();
clientToUpdate.ClientName = client.ClientName;
//filter existing db elements that are still in DTO as well
clientToUpdate.Contacts = clientToUpdate.Contacts
.Where(c => client.Contacts.Any(con => con.ContactId == c.ContactUuid))
.ToList();
client.Contacts.ToList().ForEach(async contact =>
{
if (contact.ContactId == null || contact.ContactId == Guid.Empty) //if guid missing, we want to add
{
clientToUpdate.Contacts.Add(new Entities.Contact()
{
ClientId = await AdministrativeContext.GetClientKeyFromGuidAsync(client.ClientId),
ContactUuid = Guid.NewGuid(),
FirstName = contact.FirstName,
LastName = contact.LastName,
Address = contact.Address,
Email = contact.Email,
Phone = contact.Phone,
TypeId = (await AdministrativeContext.ContactTypes.Where(ct => ct.ContactTypeName == contact.ContactType).FirstOrDefaultAsync()).ContactTypeId
});
}
else //guid defined means update
{
Contact existingContact = clientToUpdate.Contacts.Where(c => contact.ContactId == c.ContactUuid).FirstOrDefault();
existingContact.ClientId = await AdministrativeContext.GetClientKeyFromGuidAsync(client.ClientId);
existingContact.Address = contact.Address;
existingContact.Email = contact.Email;
existingContact.FirstName = contact.FirstName;
existingContact.LastName = contact.LastName;
existingContact.Phone = contact.Phone;
existingContact.TypeId = (await AdministrativeContext.ContactTypes
.Where(ct => ct.ContactTypeName == contact.ContactType)
.FirstOrDefaultAsync()).ContactTypeId;
}
});
await AdministrativeContext.SaveChangesAsync();
}
我解决了update-case通常在一个请求中这样。
- 从填充了联系人集合的数据库中获取客户
- 遍历客户数据库实例中的所有联系人。如果客户 DTO 中不存在,则从客户数据库实例中的联系人集合中删除联系人
- 遍历 DTO 中的所有联系人。如果 Contact#Id = 0(或者在这种情况下可能为 null),将新联系人添加到客户数据库实例中的联系人集合,否则更新联系人集合中的现有联系人实例
- 使用 DTO 中的剩余数据更新客户数据库实例
- 将客户连同联系人集合保存到数据库(需要级联)
我通常使用 NHibernate,但原理应该也适用于 EF。
优点:
- 简单,处理联系人的创建、更新和删除以及客户更新
- 单个db-call更新
缺点:
- 每次更新都需要负载中的所有联系人