DTO中公共方法的边界与最佳实践:何时使用,何时避免

dto中公共方法的边界与最佳实践:何时使用,何时避免

DTO(数据传输对象)应主要作为数据载体,避免承载业务逻辑。虽然在特定情况下,DTO可以包含与自身数据紧密相关的、用于序列化或反序列化的辅助方法,但应严格区分于通用的数据转换或业务操作。对于常见的字段转换,更推荐使用框架提供的装饰器、管道或独立的辅助函数,以维护DTO的纯粹性与职责单一原则。

DTO 的核心职责与设计原则

数据传输对象(DTO – Data Transfer Object)是软件架构中一个常见的设计模式,其核心目的是在不同层或不同服务之间传输数据。在典型的分层架构(如控制器层、服务层、数据访问层)中,DTO通常用于:

数据封装: 将多个数据字段封装成一个单一的对象,方便在网络或进程间传输。数据验证: 结合验证库(如 class-validator),对传入的数据进行结构和内容验证。数据塑形: 提供一个清晰的数据接口,隐藏底层数据模型的复杂性。

一个基本的设计原则是,DTO应该是“贫血的”(anemic),即它应该只包含数据字段和基本的访问器(getter/setter),而不包含任何业务逻辑。这样做的目的是保持职责分离,确保 DTO 专注于数据传输,而业务逻辑则由服务层或其他业务组件处理。

在 DTO 中添加方法的考量

关于在 DTO 中添加公共方法,业界存在一些讨论,但普遍倾向于谨慎使用。

不建议的场景:通用数据转换或业务逻辑

以下是用户提出的示例,展示了在 DTO 中添加一个将字段转换为小写的方法:

export class CreateCustomerDto {  @IsString()  @IsNotEmpty()  name: string;  // ... 更多字段 ...  public setLowercaseName() {    return this.name.toLowerCase();  }}

这种做法通常不被推荐。原因如下:

职责混淆: toLowerCase() 这样的操作属于数据转换或数据处理范畴,它与 DTO 的核心职责——数据传输——关联不紧密。将此类方法置于 DTO 中,会模糊 DTO 与业务逻辑对象之间的界限。可维护性与可测试性: 随着 DTO 中方法的增多,其复杂性会上升,增加了维护和测试的难度。业务逻辑应该集中在服务层,便于管理和独立测试。框架集成: 现代框架(如 NestJS)提供了更优雅、更标准化的方式来处理这类数据转换。

允许的特定场景:与数据传输紧密相关的辅助操作

尽管不鼓励添加业务逻辑,但在极少数情况下,DTO 可以包含一些与自身数据紧密相关,且仅用于辅助数据传输或序列化/反序列化的方法。这些方法应满足以下条件:

操作仅限于 DTO 内部数据: 方法的逻辑不依赖外部服务或复杂的业务规则,只对 DTO 自身的字段进行操作。目的在于数据格式化或衍生: 例如,将 DTO 中的多个字段组合成一个特定格式的字符串,或者根据 DTO 字段计算出一个衍生值,但这些操作必须是为了满足数据传输的特定格式要求,而非业务决策。不包含任何业务决策或状态改变: 方法不应触发任何副作用,也不应改变 DTO 以外的任何系统状态。

例如,一个 DTO 可能包含一个方法,用于将内部存储的日期对象格式化为特定字符串,以符合某个外部 API 的要求,但这应被视为一种数据表示的辅助,而非业务处理。即使是这类场景,也应权衡其必要性,因为通常有更好的替代方案。

替代方案与最佳实践

在 NestJS 等现代框架中,处理数据转换和验证有更推荐的方式:

class-validator 和 class-transformer 库:

验证: 使用 @IsString(), @IsNotEmpty() 等装饰器进行数据验证。

转换: 使用 @Transform() 装饰器进行字段级别的转换。例如,将 name 字段自动转换为小写:

import { Transform } from 'class-transformer';import { IsString, IsNotEmpty } from 'class-validator';export class CreateCustomerDto {  @IsString()  @IsNotEmpty()  @Transform(({ value }) => value.toLowerCase()) // 在此处进行转换  name: string;  // ... 更多字段 ...}

这种方式将转换逻辑声明性地绑定到字段上,清晰且易于维护。

管道(Pipes):NestJS 的管道机制非常适合处理数据转换和验证。你可以创建自定义管道来封装复杂的转换逻辑,并在控制器层应用它们。

// custom-lowercase.pipe.tsimport { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';@Injectable()export class LowercasePipe implements PipeTransform {  transform(value: any, metadata: ArgumentMetadata) {    if (typeof value === 'string') {      return value.toLowerCase();    }    return value;  }}// customer.controller.tsimport { Body, Controller, Post, UsePipes } from '@nestjs/common';import { CreateCustomerDto } from './create-customer.dto';import { LowercasePipe } from './custom-lowercase.pipe';@Controller('customers')export class CustomersController {  @Post()  // @UsePipes(new LowercasePipe()) // 可以在这里应用管道,但通常更细粒度地应用  create(@Body(LowercasePipe) createCustomerDto: CreateCustomerDto) {    // createCustomerDto.name 已经是小写    console.log(createCustomerDto.name);    return createCustomerDto;  }}

对于 DTO 内部的特定字段转换,通常 @Transform 更为直接。管道更适用于请求体或参数的整体转换。

服务层或辅助函数:任何涉及业务逻辑或复杂数据处理的操作都应放在服务层。如果某个转换是通用的,不限于某个 DTO,可以将其封装成一个独立的辅助函数或工具类。

总结

在 DTO 中添加公共方法应遵循“职责单一”和“贫血 DTO”的原则。 DTO 的主要任务是数据传输,不应承载业务逻辑或通用的数据转换。对于字段级别的转换,推荐使用 class-transformer 的 @Transform() 装饰器;对于更复杂的请求数据处理,可以使用 NestJS 的管道;而真正的业务逻辑则应始终放在服务层。

严格遵守这些实践,有助于构建结构清晰、易于维护和扩展的应用程序。在 DTO 中保持方法使用的克制,是维护良好架构的关键一步。

以上就是DTO中公共方法的边界与最佳实践:何时使用,何时避免的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1535061.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月21日 02:06:41
下一篇 2025年12月21日 02:06:56

相关推荐

  • 深入理解CSS框架与JS之间的关系

    深入理解CSS框架与JS之间的关系 在现代web开发中,CSS框架和JavaScript (JS) 是两个常用的工具。CSS框架通过提供一系列样式和布局选项,可以帮助我们快速构建美观的网页。而JS则提供了一套功能强大的脚本语言,可以为网页添加交互和动态效果。本文将深入探讨CSS框架和JS之间的关系,…

    2025年12月24日
    000
  • HTML+CSS+JS实现雪花飘扬(代码分享)

    使用html+css+js如何实现下雪特效?下面本篇文章给大家分享一个html+css+js实现雪花飘扬的示例,希望对大家有所帮助。 很多南方的小伙伴可能没怎么见过或者从来没见过下雪,今天我给大家带来一个小Demo,模拟了下雪场景,首先让我们看一下运行效果 可以点击看看在线运行:http://hai…

    2025年12月24日 好文分享
    500
  • 10款好看且实用的文字动画特效,让你的页面更吸引人!

    图片和文字是网页不可缺少的组成部分,图片运用得当可以让网页变得生动,但普通的文字不行。那么就可以给文字添加一些样式,实现一下好看的文字效果,让页面变得更交互,更吸引人。下面创想鸟就来给大家分享10款文字动画特效,好看且实用,快来收藏吧! 1、网页玻璃文字动画特效 模板简介:使用css3制作网页渐变底…

    2025年12月24日 好文分享
    000
  • tp5如何引入css文件

    tp5引入css文件的方法:1、将css文件放在public目录下的static文件里即可;2、在页面引入中写上“”语句即可。 本教程操作环境:windows7系统、CSS3&&HTML5版、Dell G3电脑。 其实很简单,只需要将css,js,image文件放在这个目录下即可 页…

    2025年12月24日
    000
  • 聊聊CSS 与 JS 是如何阻塞 DOM 解析和渲染的

    本篇文章给大家介绍一下css和js阻塞 dom 解析和渲染的原理。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。 hello~各位亲爱的看官老爷们大家好。估计大家都听过,尽量将CSS放头部,JS放底部,这样可以提高页面的性能。然而,为什么呢?大家有考虑过么?很长一段时间,我都是知其…

    2025年12月24日
    200
  • js如何修改css样式

    js修改css样式的方法:1、使用【obj.className】来修改样式表的类名;2、使用【obj.style.cssTest】来修改嵌入式的css;3、使用【obj.className】来修改样式表的类名;4、使用更改外联的css。 本教程操作环境:windows7系统、css3版,DELL G…

    2025年12月24日
    000
  • 如何使用纯CSS、JS实现图片轮播效果

    本篇文章给大家详细介绍一下使用纯css、js实现图片轮播效果的方法。有一定的参考价值,有需要的朋友可以参考一下,希望对大家有所帮助。 .carousel {width: 648px;height: 400px;margin: 0 auto;text-align: center;position: a…

    2025年12月24日
    000
  • js如何修改css

    js修改css的方法:1、使用【obj.style.cssTest】来修改嵌入式的css;2、使用【bj.className】来修改样式表的类名;3、使用更改外联的css文件,从而改变元素的css。 本教程操作环境:windows7系统、css3版,DELL G3电脑。 js修改css的方法: 方法…

    2025年12月24日
    000
  • js如何改变css样式

    js改变css样式的方法:1、使用cssText方法;2、使用【setProperty()】方法;3、使用css属性对应的style属性。 本教程操作环境:windows7系统、css3版,DELL G3电脑。 js改变css样式的方法: 第一种:用cssText div.style.cssText…

    2025年12月24日
    000
  • 为什么css放上面js放下面

    css放上面js放下面的原因:1、在加载html生成DOM tree的时候,可以同时对DOM tree进行渲染,这样可以防止闪跳,白屏或者布局混乱;2、javascript加载后会立即执行,同时会阻塞后面的资源加载。 本文操作环境:Windows7系统、HTML5&&CSS3版,DE…

    2025年12月24日
    000
  • 推荐六款移动端 UI 框架

    作为一个前端人员来说,总结几款相对来说不错的用于移动端开发的UI框架是非常必要的,以下几种移动端UI框架就能基本满足工作中开发需要,根据项目需求,选用合适的框架搭建项目,更能容易提高开发效率。 一、MUI         最接近原生APP体验的高性能前端框架,追求性能体验,是我们开始启动MUI项目的…

    2025年12月24日
    000
  • css如何实现图片的旋转展示效果(代码示例)

    本篇文章给大家带来内容是通过代码示例介绍使用css+js实现图片的旋转展示,制作一个手动操作的“无限”照片轮播图。有一定的参考价值,有需要的朋友可以参考一下,希望对你们有所帮助。 下面我们就开始介绍如何实现效果。 1、构建图像轮播框架 首先是HTML。它有点难以阅读,因为我们删除了元素之间的任何空格…

    2025年12月24日
    000
  • css3+js实现烟花绽放的动画效果(代码示例)

    本篇文章给大家介绍通过js+css3的transforms属性和keyframes属性来实现烟花绽放的动画效果的方法。有一定的参考价值,有需要的朋友可以参考一下,希望对你们有所帮助。 首先我们来看看效果: 动画的实现原理: 动画使用了两个关键帧(keyframes): 一个是烟花筒上升的轨迹,另一个…

    2025年12月24日
    000
  • css+js如何在幻灯片上添加文字?实现幻灯片的旋转切换(附代码)

    本篇文章给大家带来的内容是介绍css+js如何在幻灯片上添加文字?实现幻灯片的旋转切换(附代码)。有一定的参考价值,有需要的朋友可以参考一下,希望对你们有所帮助。 在之前的文章【css如何实现幻灯片效果?幻灯片的实现方法】中介绍了实现淡入淡出幻灯片的实现方法,本篇文章就在其基础上去解释如何在幻灯片上…

    2025年12月24日
    000
  • css+js如何实现简单的动态进度条效果?(代码实例)

    css+js如何实现简单的动态进度条?本篇文章就给大家用css+js制作一个简单的动态进度条效果,并将页面动态进度条滚动加载的代码分享给大家,感兴趣的小伙伴可以参考借鉴一下,希望对你们有所帮助。 我们要知道,这里主要使用了css3的animation动画属性,首先将进度条设置为一个初始宽度为0,背景…

    2025年12月24日
    000
  • 手写CSS+js实现radio单选按钮

    本文给大家介绍手写css+js实现radio单选按钮,有一定的参考价值,有需要的朋友可以参考一下,希望对你们有所帮助。 有的时候我们需要用长得漂亮一点的单选按钮,那么,就要抛弃原有的自己来写,下面就是我实现的 你丑你先你才丑你先你更丑你先 .radio{display: flex;align-ite…

    2025年12月24日
    000
  • css3+js绘制动态时钟(附代码)

    本章给大家介绍如何使用css3与js实现动态时钟效果,有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助。 先看看效果图: 首先,思考了一下页面的布局,大致需要4层div,最底层是一个表盘的背景图,然后其余3层分别是时针,分针,秒针的图层. html代码如下: 变量名是随便起的,不要介意;…

    2025年12月24日
    000
  • 什么是web标准??

    本章给大家介绍什么是web标准??通过介绍大家可以对web标准有更深入的了解,有一定的参考价值,有需要的朋友可以参考一下,希望对你有所帮助。 web标准 不是某一个标准,而是一系列标准的集合。网页主要由三部分组成:结构(Structure)、表现(Presentation)和行为(Behavior)…

    好文分享 2025年12月24日
    000
  • 关于javascript和css3开发打气球小游戏的完整代码

    这篇文章主要介绍了关于javascript和css3开发打气球小游戏的完整代码,有着一定的参考价值,现在分享给大家,有需要的朋友可以参考一下 这是一个简单但是印象深刻的小游戏,打气球小游戏的实现代码,主要基于js和css3,基于css3画气球,具体实现代码大家参考下本文 效果知识点: css3画气球…

    2025年12月24日
    000
  • js和CSS3实现卡牌旋转切换效果

    这篇文章主要为大家详细介绍了js css3实现卡牌旋转切换效果,具有一定的参考价值,感兴趣的小伙伴们可以参考一下 我们经常会在游戏里看到一些几张卡牌左右切换的效果,中间的一张最突出醒目,向左或向右滑动可切换到另一张,今天我们就用CSS3来实现下这种效果。 我们先来看个demo,具体的样式各位可以自己…

    2025年12月24日
    000

发表回复

登录后才能评论
关注微信