如何用C#实现数据库的数据传输对象(DTO)?为什么需要?

来源:这里教程网 时间:2026-02-21 17:26:29 作者:

在C#开发中,数据传输对象(DTO)是一种设计模式,用于在不同层或系统之间安全、高效地传递数据。它通常是一个简单的类,只包含属性,不包含业务逻辑,主要用于封装需要传输的数据。

为什么需要DTO?

直接使用数据库实体类(Entity)进行数据传输会带来一些问题:

暴露敏感字段:比如密码、内部ID等字段不应该返回给前端。 避免过度传输:前端可能只需要部分字段,传整个实体会造成带宽浪费。 解耦层级:将数据库模型与API输出分离,数据库结构变化不会直接影响接口契约。 跨系统兼容性:不同系统可能对数据结构要求不同,DTO可做适配。

因此,使用DTO能提升安全性、灵活性和可维护性。

如何用C#实现DTO?

下面是一个简单示例,展示从数据库实体到DTO的转换过程。

1. 定义数据库实体(Entity)

假设有一个用户表对应的实体类:

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public string Password { get; set; } // 敏感字段
    public DateTime CreatedAt { get; set; }
}
2. 创建对应的DTO类

只暴露必要的字段:

public class UserDto
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public DateTime CreatedAt { get; set; }
}
3. 在服务中进行转换

从Entity转为DTO,可以在服务层手动映射,或使用工具如AutoMapper。

手动映射示例:

public UserDto GetUserDto(User user)
{
    return new UserDto
    {
        Id = user.Id,
        Name = user.Name,
        Email = user.Email,
        CreatedAt = user.CreatedAt
    };
}

使用AutoMapper自动映射:

安装NuGet包:

AutoMapper

// 配置映射(通常在启动时注册)
var config = new MapperConfiguration(cfg =>
    cfg.CreateMap<User, UserDto>()
);
IMapper mapper = config.CreateMapper();
// 使用
UserDto dto = mapper.Map<UserDto>(userEntity);
4. 在ASP.NET Core API中返回DTO

控制器应返回DTO而不是实体:

[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
    var user = _context.Users.Find(id);
    if (user == null) return NotFound();
    var dto = mapper.Map<UserDto>(user);
    return Ok(dto);
}

DTO的常见变体

根据用途,可以定义不同类型的DTO:

UserCreateDto:用于接收创建用户的请求,不含Id或CreatedAt。 UserUpdateDto:用于更新操作,可能只包含可修改字段。 UserSummaryDto:列表页使用,仅含Id、Name等关键信息。

这样能进一步细化接口输入输出,提升API清晰度。

基本上就这些。用好DTO能让你的应用结构更清晰,接口更安全,后期维护更容易。虽然多写几个类看似麻烦,但长远来看非常值得。

相关推荐