IN 和 OUT DTO 有任何命名约定吗？ [关闭]

Question

如果我必须使用 MVC 架构创建某种 API，我将必须为控制器接收的 DTO 和控制器产生的 DTO 确定一个命名约定，我是对的吗？

例如，给定以下代码：

    public class InStudentDTO
    {
        public int Id { get; set; }
        public List<int> Grades { get; set; }
    }

    public class OutStudentDTO
    {
        public int Id { get; set; }
        public bool HasApprovedCourse { get; set; }
    }

    [HttpPost]
    public OutStudentDto StudentHasApprovedCourse(InStudentDto dto)
    {
        OutStudentDto outStudentDto = _someService.CalculateStudentApprovedCourse(dto);
        return outStudentDto;
    }

这只是一个愚蠢的例子，但重点是我想在具有属性List<int> Grades 的服务中执行一些计算，而不是稍后在控制器的输出中显示它。因此，据我了解，我应该只创建一个不公开 List<int> Grades 属性的全新 DTO，对吗？如果是这样，这个“生成的 DTO”的正确命名约定如何？还是应该将它们命名为 Viewmodel？

谢谢！

Answer 1

没有用于命名 DTO 类型的单一标准或命名约定，因为这是一个实现问题——我不知道 ASP.NET Web API 团队也支持任何特定约定（也有很多使用实际实体的不良示例ASP.NET 官方文档中作为 DTO 的框架实体类型（不要这样做出于多种原因 - 除非您知道自己在做什么）。

但是，我注意到 .NET 开发人员社区的一个普遍趋势是，“输入”DTO（如您所说）通常被命名为 ${ResourceName}Request，而“输出”输出/响应 DTO 通常被命名为 ${Resource/Action}Response - 它是将“Dto”作为类型名称后缀也很常见。

但是，当涉及到命名约定和编码风格时，_通常保持一致比“正确”更重要 - 因此，如果您现有的项目使用 Dto 作为后缀然后这样做，但如果您的项目不使用后缀，那么不要开始使用后缀（没有充分的理由）。

此外，请避免使用像 Id 这样的模棱两可的名称 - 改用全名 (StudentId)。

根据我的主观意见，鉴于您的示例，我会这样命名它们：

    public class StudentCourseApprovalRequestDto
    {
        public int       StudentId { get; set; }
        public List<int> Grades    { get; set; }
    }

    public class StudentCourseApprovalResponseDto
    {
        public int  StudentId         { get; set; }
        public bool HasApprovedCourse { get; set; }
    }

    [HttpGet]
    public StudentCourseApprovalResponseDto StudentHasApprovedCourse( StudentCourseApprovalRequestDto req )
    {
        StudentCourseApprovalResponseDto resp  = _someService.CalculateStudentApprovedCourse( req );
        return resp;
    }