封装中修改旧代码的时机

只是单纯为了代码的统一、整洁、简练去修改旧代码是十分不可取的,这并不是镇长去小学视察

以 Antd 的 RangePicker 为例,起初写A模块下的几个页面时,有几处出现了下面的重复代码

...
    this.state = {
      queryParams: {
        minCreateTime: '2020-7-8',
        maxCreateTime: '2020-10-2',
      },
    };
...
    const { queryParams } = this.state;
    const minCreateTime = queryParams.minCreateTime
      ? moment(queryParams.minCreateTime)
      : null;
    const maxCreateTime = queryParams.maxCreateTime
      ? moment(queryParams.maxCreateTime)
      : null;
...
        <DatePicker.RangePicker
          placeholder={['起始', '结束']}
          showTime={{ format: 'HH:mm' }}
          format={'YYYY-MM-DD HH:mm:ss'}
          value={[minCreateTime, maxCreateTime]}
          onChange={(dates) =>
            this.onUpdateQueryParams({minCreateTime:dates[0].format('YYYY-MM-DD HH:mm:ss'),maxCreateTime:dates[1].format('YYYY-MM-DD HH:mm:ss')})
          }
        ></DatePicker.RangePicker>

当时并非是主要矛盾,也就自动忽略了,复制黏贴一下也不是很难,也不知该怎么封装...

结果写B模块时突然就有了灵感,上面的代码都做了哪些事情呢?

  • 防止 null
  • DatePicker.RangePicker 的一些默认属性
  • 将后台给的 字符串 转换成 moment,最后再转换为字符串传回去。

因为是新的封装,过程就很省事了,基于上述,粗略封装如下:

const YYYYMMDDHHmmss = 'YYYY-MM-DD HH:mm:ss'
import moment from 'moment';
interface PageRangePickerProps extends Omit<RangePickerProps, 'onChange'> {
  startTime: string;
  endTime: string;
  onChange: (startTime: string, endTime: String) => void;
}
interface PageRangePickerState {}
class PageRangePicker extends React.PureComponent<
  PageRangePickerProps,
  PageRangePickerState
> {
  static defaultProps = {
    startTime: null,
    endTime: null,
    placeholder: ['起始', '结束'],
    showTime: { format: 'HH:mm' },
    format: YYYYMMDDHHmmss,
    onChange: () => {},
  };
  public render() {
    const { startTime, endTime, onChange, ...restProps } = this.props;
    let startTimeMoment = startTime ? moment(startTime) : null;
    let endTimeMoment = endTime ? moment(endTime) : null;
    return (
      <DatePicker.RangePicker
        onChange={this.onChange}
        {...restProps}
        value={[startTimeMoment, endTimeMoment]}
      />
    );
  }
  private onChange = (dates: RangePickerValue) => {
    const startTime = dates[0].format(YYYYMMDDHHmmss);
    const endTime = dates[1].format(YYYYMMDDHHmmss);
    this.props.onChange(startTime, endTime);
  };
}

export default PageRangePicker;
  • 通过Omit 剔除了原本的onChange 声明,直接支持传字符串
  • 继承antd 的 RangePickerProps 依然可以得到提示
  • static defaultProps 设置默认属性

可以预见的坑是,这个组件和Form结合会有问题...

那么问题来了,我到底有没有必要把之前旧的写法都一一改成现在这样

衡量的核心不在于有没有时间、需要多少时间,而在于有没有这个必要。

假设A模块有3个页面使用旧的写法,而B模块2个页面使用旧写法,第三个页面时完成了封装。

显然B模块还在开发阶段,替换原有的写法是很有必要的,而对于A模块,如果已经提测或是上线,则没有必要去改动。

什么时候去改动取决于任务的分配,比如,当用户没有选择具体的时分秒,我们希望是00:00 - 23:59

对于PageRangePicker 只需要加上

showTime={{
   ...
   defaultValue:[moment('00:00:00','HH:mm:ss'),moment('23:59:59','HH:mm:ss')]
}}

对于旧代码,则可以替换新的组件,类似这种的更改正是展现我们对代码追求的好时候。

再往前后想一想,当RangePickerProps 出现设计的瑕疵时,太糟糕了!,这意味着要在组件内部耦合很多逻辑来满足需求,什么时候需要写一个新的组件,什么时候替换旧有的组件

坦白的讲,大家都是成年人了,一定要理性的看待问题,而不是一味的讲究代码的整洁、一致性。

没有完美的代码,不说业务需要的变化,即便是技术本身的迭代与演化,甚至于我们自身的不断成长,任何人去看一段代码,想要挑出点毛病总是很容易的,关键是要看所谓的"毛病"带来了怎样的影响

更改逻辑需要耗费大量的时间?成员在使用的时候容易发生一些隐型问题?bug数目多和这个有关?

如果只是一些感性上的东西则大可不必,诸如,我觉得这样不合理、这个命名有点怪、这样写不够清晰,这样不够优雅、出现两个版本会很难维护、或者在使用的时候遇到一些挫折就觉得不好用使用封装好的东西,就是要按照人家封装的思维去使用,而不是按照自己的意志,这一点如果不搞清楚,在如今的前端世界是要吃很多暗亏的!

我经历过很多次,有些人在不了解业务以及封装涉及范围的前提下,就随便的改动,或许他们认为自己足够了解,结果造成了隐性的问题,这一点在团队协作中十分可怕。

必须要承认,好的封装能给工作带来极大的便利,对于工作效率的追求自然是不能停止的

但当我们大刀阔斧的一展自己对代码的追求与理解时,先要扪心自问对于所要做的事了解多少、需要投入多少时间、需要做哪些测试、会波及那些业务、能够获得怎样的回报,毕竟封装是一种投资。

2020/7/11 23:46,知乎上的一个回答,太美了!


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343