【TypeScript】 在业务项目中的类型治理

news2026/4/6 7:18:02
TypeScript 在业务项目中的类型治理重点不是写类型而是少挖坑一、很多团队用了 TypeScript为什么还是经常出问题很多项目上了 TypeScript 之后表面看起来挺规范接口有类型组件参数有类型函数入参也有类型但实际开发里问题还是很多后端字段一变前端一大片报错或者静默出错列表页、详情页、弹窗页各自写一套类型越写越重复为了图省事到处any代码能通过编译但业务逻辑还是容易出错这说明一个问题TypeScript 用了不代表类型治理做好了。真正麻烦的从来不是“会不会写 interface”而是“类型有没有真正管住业务”。二、什么叫类型治理我理解的类型治理不是把项目变成类型体操比赛而是做三件事让关键数据结构有统一出口让错误尽量提前暴露在开发阶段让多人协作时代码更不容易写偏说白了类型治理不是为了看起来高级而是为了减少沟通成本和返工成本。三、业务项目里最常见的类型问题1. 接口类型到处复制这个问题特别常见。比如一个用户模块可能会出现用户列表类型用户详情类型用户编辑类型用户表单类型用户筛选参数类型如果这些类型都是各写各的过一段时间你就会发现同一个字段在不同文件里名字不一样有的地方是可选有的地方是必填后端一改字段改不全2. 把类型写在离业务太远的地方有些项目喜欢把所有类型都堆到一个超大的types.ts里看起来像统一管理实际上很容易失控。因为业务模块多了之后这种文件会越来越难找也很容易出现“改这个类型会影响谁我也不知道”的情况。3.any用着用着就收不回来了最开始大家一般都会说“先用any顶一下后面再补。”现实通常是后面根本没人补。而且any最麻烦的地方不是它本身而是它会让错误一路传染。一个地方放开后面几个函数的约束都可能失效。4. 类型只是“写了”没有参与设计这个问题很隐蔽。比如一个接口返回状态值后端约定只有012但前端直接写成number。这样当然也能跑但类型没有把真实业务边界表达出来后面判断分支还是容易写松。四、我做类型治理时比较看重的 4 个原则1. 先管核心链路不追求一次全覆盖业务项目里最忌讳一上来就想“把所有类型都补齐”。因为工作量大而且收益不平均。更现实的做法是优先治理这些地方接口请求和响应核心业务实体公共组件入参表单模型字典映射和状态枚举这些地方一旦稳定下来很多问题会明显变少。2. 类型要围绕业务模型组织比如用户模块就围绕用户这件事收类型而不是东一块西一块散着放。一个比较实用的思路是按模块拆// user.types.tsexportinterfaceUserItem{id:stringname:stringstatus:UserStatus phone?:string}exportinterfaceUserQueryParams{keyword?:stringstatus?:UserStatus pageNum:numberpageSize:number}exportinterfaceUserFormData{name:stringstatus:UserStatus phone:string}exporttypeUserStatus0|1|2这样做的好处是别人看这个模块时能比较快找到相关类型。3. 类型命名要能直接看懂用途比起写一堆模糊命名我更建议把用途写清楚。例如UserItemUserDetailUserQueryParamsUserFormDataCreateUserRequestUserListResponse这种命名虽然不花哨但最适合协作。4. 严控any但别过度炫技我不赞成项目里大量使用any但也不赞成为了“类型高级”而把代码写得没人看得懂。业务项目里最重要的是类型能表达真实约束团队成员看得懂出问题时好定位如果一个类型技巧写完之后只有写的人自己能维护那它的收益通常没想象中那么高。五、我认为最有价值的治理点1. 把接口层先管住这一层是最值得先做的。因为业务项目里的很多混乱都是从接口字段开始扩散的。比如统一请求返回exportinterfaceApiResponseT{code:numbermessage:stringdata:T}exportinterfacePageResultT{list:T[]total:number}然后接口函数明确返回值exportfunctiongetUserList(params:UserQueryParams){returnrequestApiResponsePageResultUserItem({url:/user/list,method:get,params})}这样列表页拿到的数据结构就更稳定不容易“猜着用”。2. 把状态值、字典值收成明确类型很多 bug 都出在“值是对的但判断写错了”。比如状态字段如果只是number或string那任何值都能进来。更稳的方式是exporttypeUserStatusenabled|disabled或者exportenumUserStatus{Enabledenabled,Disableddisabled}这样不仅代码提示更清楚也能减少魔法值乱飞的问题。3. 让表单类型和接口类型分开这点很多项目容易混。因为接口详情数据和页面表单数据看起来很像但它们经常不是一回事。比如详情接口里有创建时间、更新时间、创建人表单提交根本不需要这些字段某些字段接口返回可能是null但表单里要转成空字符串所以我的建议是UserDetail归接口模型UserFormData归页面交互模型不要为了省一点定义成本把两者硬绑在一起。4. 公共组件的类型要收紧业务项目里很多问题其实是从“组件什么都能传”开始的。比如一个表格组件、弹窗组件、选择器组件如果入参太松调用方就会乱传后面排查很麻烦。所以公共组件一定要尽量做到必填参数明确可选参数边界清楚事件回调签名明确这一步做好团队协作会舒服很多。六、类型治理落地时怎么做更现实第一阶段先禁住最危险的写法例如减少新增any避免接口返回裸Promiseany公共模块禁止随意复制类型这一阶段不用追求多漂亮先把口子收住。第二阶段按业务模块逐步收口比如先从用户模块、订单模块、权限模块这种核心模块开始。做法可以是统一实体类型统一查询参数类型统一接口返回类型统一表单数据类型这样一个模块一个模块推进团队更容易接受。第三阶段把规范变成默认动作到了这一步重点已经不是“补类型”而是让大家自然按照同一套方式写。例如新接口必须补响应类型新页面必须定义查询参数和表单模型公共组件必须补 props 和 emits 类型当这些成为默认动作时类型治理才算真正落地。七、几个很现实的落地建议1. 不要拿类型系统硬套混乱业务如果业务字段本身就混乱比如同一状态值不同接口定义不一致那先解决接口约定问题再谈类型治理。不然只是把混乱用另一种形式写进代码里。2. 类型文件不要贪大而全按模块收比按全局收更稳。因为业务项目后期维护最怕的不是类型少而是类型找不到、改不动、牵一发动全身。3. 先做高频、核心、易出错的部分不是所有地方都值得投入同样精力。把最关键的数据链路先管住收益会比追求 100% 覆盖更高。4. 团队要接受“够用的类型”不是“最炫的类型”业务项目看的是长期维护不是秀技巧。只要能把边界表达清楚、把错误提前暴露出来就已经很有价值了。八、最后总结TypeScript 在业务项目里最核心的作用不是让代码看起来更高级而是帮你减少低级错误、减少沟通歧义、减少后期返工。类型治理真正该做的不是铺天盖地补类型而是把关键链路管住接口层核心业务实体表单模型状态枚举公共组件边界把这些地方做好项目会稳很多。反过来说如果项目里还是到处any类型重复定义接口模型和页面模型混用状态值乱写那就算已经用了 TypeScript最后也只是“看起来有类型实际上还在裸奔”。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2488310.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

SpringBoot-17-MyBatis动态SQL标签之常用标签

文章目录 1 代码1.1 实体User.java1.2 接口UserMapper.java1.3 映射UserMapper.xml1.3.1 标签if1.3.2 标签if和where1.3.3 标签choose和when和otherwise1.4 UserController.java2 常用动态SQL标签2.1 标签set2.1.1 UserMapper.java2.1.2 UserMapper.xml2.1.3 UserController.ja…

wordpress后台更新后 前端没变化的解决方法

使用siteground主机的wordpress网站,会出现更新了网站内容和修改了php模板文件、js文件、css文件、图片文件后,网站没有变化的情况。 不熟悉siteground主机的新手,遇到这个问题,就很抓狂,明明是哪都没操作错误&#x…

网络编程(Modbus进阶)

思维导图 Modbus RTU(先学一点理论) 概念 Modbus RTU 是工业自动化领域 最广泛应用的串行通信协议,由 Modicon 公司(现施耐德电气)于 1979 年推出。它以 高效率、强健性、易实现的特点成为工业控制系统的通信标准。 包…

UE5 学习系列(二)用户操作界面及介绍

这篇博客是 UE5 学习系列博客的第二篇,在第一篇的基础上展开这篇内容。博客参考的 B 站视频资料和第一篇的链接如下: 【Note】:如果你已经完成安装等操作,可以只执行第一篇博客中 2. 新建一个空白游戏项目 章节操作,重…

IDEA运行Tomcat出现乱码问题解决汇总

最近正值期末周,有很多同学在写期末Java web作业时,运行tomcat出现乱码问题,经过多次解决与研究,我做了如下整理: 原因: IDEA本身编码与tomcat的编码与Windows编码不同导致,Windows 系统控制台…

利用最小二乘法找圆心和半径

#include <iostream> #include <vector> #include <cmath> #include <Eigen/Dense> // 需安装Eigen库用于矩阵运算 // 定义点结构 struct Point { double x, y; Point(double x_, double y_) : x(x_), y(y_) {} }; // 最小二乘法求圆心和半径 …

使用docker在3台服务器上搭建基于redis 6.x的一主两从三台均是哨兵模式

一、环境及版本说明 如果服务器已经安装了docker,则忽略此步骤,如果没有安装,则可以按照一下方式安装: 1. 在线安装(有互联网环境): 请看我这篇文章 传送阵>> 点我查看 2. 离线安装(内网环境):请看我这篇文章 传送阵>> 点我查看 说明&#xff1a;假设每台服务器已…

XML Group端口详解

在XML数据映射过程中&#xff0c;经常需要对数据进行分组聚合操作。例如&#xff0c;当处理包含多个物料明细的XML文件时&#xff0c;可能需要将相同物料号的明细归为一组&#xff0c;或对相同物料号的数量进行求和计算。传统实现方式通常需要编写脚本代码&#xff0c;增加了开…

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器的上位机配置操作说明

LBE-LEX系列工业语音播放器|预警播报器|喇叭蜂鸣器专为工业环境精心打造&#xff0c;完美适配AGV和无人叉车。同时&#xff0c;集成以太网与语音合成技术&#xff0c;为各类高级系统&#xff08;如MES、调度系统、库位管理、立库等&#xff09;提供高效便捷的语音交互体验。 L…

(LeetCode 每日一题) 3442. 奇偶频次间的最大差值 I (哈希、字符串)

题目&#xff1a;3442. 奇偶频次间的最大差值 I 思路 &#xff1a;哈希&#xff0c;时间复杂度0(n)。 用哈希表来记录每个字符串中字符的分布情况&#xff0c;哈希表这里用数组即可实现。 C版本&#xff1a; class Solution { public:int maxDifference(string s) {int a[26]…

【大模型RAG】拍照搜题技术架构速览:三层管道、两级检索、兜底大模型

摘要 拍照搜题系统采用“三层管道&#xff08;多模态 OCR → 语义检索 → 答案渲染&#xff09;、两级检索&#xff08;倒排 BM25 向量 HNSW&#xff09;并以大语言模型兜底”的整体框架&#xff1a; 多模态 OCR 层 将题目图片经过超分、去噪、倾斜校正后&#xff0c;分别用…

【Axure高保真原型】引导弹窗

今天和大家中分享引导弹窗的原型模板&#xff0c;载入页面后&#xff0c;会显示引导弹窗&#xff0c;适用于引导用户使用页面&#xff0c;点击完成后&#xff0c;会显示下一个引导弹窗&#xff0c;直至最后一个引导弹窗完成后进入首页。具体效果可以点击下方视频观看或打开下方…

接口测试中缓存处理策略

在接口测试中&#xff0c;缓存处理策略是一个关键环节&#xff0c;直接影响测试结果的准确性和可靠性。合理的缓存处理策略能够确保测试环境的一致性&#xff0c;避免因缓存数据导致的测试偏差。以下是接口测试中常见的缓存处理策略及其详细说明&#xff1a; 一、缓存处理的核…

龙虎榜——20250610

上证指数放量收阴线&#xff0c;个股多数下跌&#xff0c;盘中受消息影响大幅波动。 深证指数放量收阴线形成顶分型&#xff0c;指数短线有调整的需求&#xff0c;大概需要一两天。 2025年6月10日龙虎榜行业方向分析 1. 金融科技 代表标的&#xff1a;御银股份、雄帝科技 驱动…

观成科技:隐蔽隧道工具Ligolo-ng加密流量分析

1.工具介绍 Ligolo-ng是一款由go编写的高效隧道工具&#xff0c;该工具基于TUN接口实现其功能&#xff0c;利用反向TCP/TLS连接建立一条隐蔽的通信信道&#xff0c;支持使用Let’s Encrypt自动生成证书。Ligolo-ng的通信隐蔽性体现在其支持多种连接方式&#xff0c;适应复杂网…

铭豹扩展坞 USB转网口 突然无法识别解决方法

当 USB 转网口扩展坞在一台笔记本上无法识别,但在其他电脑上正常工作时,问题通常出在笔记本自身或其与扩展坞的兼容性上。以下是系统化的定位思路和排查步骤,帮助你快速找到故障原因: 背景: 一个M-pard(铭豹)扩展坞的网卡突然无法识别了,扩展出来的三个USB接口正常。…

未来机器人的大脑:如何用神经网络模拟器实现更智能的决策?

编辑&#xff1a;陈萍萍的公主一点人工一点智能 未来机器人的大脑&#xff1a;如何用神经网络模拟器实现更智能的决策&#xff1f;RWM通过双自回归机制有效解决了复合误差、部分可观测性和随机动力学等关键挑战&#xff0c;在不依赖领域特定归纳偏见的条件下实现了卓越的预测准…

Linux应用开发之网络套接字编程(实例篇)

服务端与客户端单连接 服务端代码 #include <sys/socket.h> #include <sys/types.h> #include <netinet/in.h> #include <stdio.h> #include <stdlib.h> #include <string.h> #include <arpa/inet.h> #include <pthread.h> …

华为云AI开发平台ModelArts

华为云ModelArts&#xff1a;重塑AI开发流程的“智能引擎”与“创新加速器”&#xff01; 在人工智能浪潮席卷全球的2025年&#xff0c;企业拥抱AI的意愿空前高涨&#xff0c;但技术门槛高、流程复杂、资源投入巨大的现实&#xff0c;却让许多创新构想止步于实验室。数据科学家…

深度学习在微纳光子学中的应用

深度学习在微纳光子学中的主要应用方向 深度学习与微纳光子学的结合主要集中在以下几个方向&#xff1a; 逆向设计 通过神经网络快速预测微纳结构的光学响应&#xff0c;替代传统耗时的数值模拟方法。例如设计超表面、光子晶体等结构。 特征提取与优化 从复杂的光学数据中自…