接口中若不会用到对象的所有字段,是否有必要完整定义全部字段?
结论先行
你完全不需要定义用不到的B属性,仅声明用到的A属性的写法不会违反任何主流开发规则,反而符合多项公认的最佳实践。
具体原因
- 符合TypeScript的设计逻辑:TS采用「结构类型(鸭子类型)」的校验规则,只要你实际用到的属性类型匹配,服务端返回的额外字段不会引发类型报错,你定义的精简接口本质是对响应做了业务侧的按需裁剪,完全合理。
- 符合接口隔离原则:你的类型定义只需要暴露当前模块实际依赖的成员,不需要引入无关属性,避免后续维护人员误以为模块依赖
B属性,额外增加维护成本。 - 符合YAGNI原则(You Aren't Gonna Need It):对当前用不到的属性不做冗余定义,后续就算服务端新增、删除其他无关字段,你也不需要同步修改类型定义,减少了无意义的维护工作量。
什么时候需要定义全量字段
只有当你需要做全量响应校验、或者要把完整响应对象透传给其他依赖全量字段的模块时,才需要定义和服务端返回完全一致的完整结构,其他场景下都推荐按需定义用到的属性即可。
内容的提问来源于stack exchange,提问作者flm
相关产品推荐
相关产品推荐

