• 🔥[译] 正交设计组件的好处


    作者:Dmitri Pavlutin

    原文链接

    正交性是几何学中的术语,互为直角的直角坐标系就具有正交性;在计算技术中表示不依赖性或解耦性。非正交的系统意味着系统中各组件互相高度依赖,这类系统中是不再有局部修正的情况了。

    #1. 为什么好的系统设计是重要的?

    在5年前,我正在为一家欧洲初创公司开发跨平台移动应用。初期的功能是易于实现的,进展顺利。

    6个月过去,需要不断的在现有功能上添加新的功能,随着时间的推移,对现有模块的更改越来越困难。

    在部分需求上,开始拒绝某些新的功能和更新,因为它们将需要太多的时间实施。这个故事以移动应用程序完全重写为原生应用而告终,主要是因为进一步的维护非常的困难。

    我将上述问题归咎于跨平台框架中的错误,归咎于客户端需求变更。但这不是主要问题,我没有意识到一点,我一直在于高度耦合的模块组件做战,就像堂吉柯德大战风车一样。

    我忽略了组件易于更改的特性。我未遵循良好的设计原则,没有赋予组件适应潜在的变化的特性。学习设计原则,一个特别有影响力的正交原理,它可以隔离由于不同原因而变化的事物。

    #2. 正交组件

    如果A和B正交的,则更改A不会更改B(反之亦然)。这就是正交性的概念。在广播设备中,音量和电台选择控件是正交的。音量控制仅更改音量,而电台选择控件仅更改接收到的电台。

    想象一下广播设备坏了,音量控制可更改音量,但也可修改选定的广播电台。音量控制和电台选择控制不是正交的:音量控制会产生副作用。当你尝试向紧密耦合的组件中添加更改时,也会发生相同的情况:你不得不面对更改产生的副作用。

    如果一个组件的更改不影响其他组件,则两个或多个组件正交。例如,显示文章列表的组件应与获取文章的逻辑正交。

    一个好的React应用程序设计是正交的:

    • UI元素
    • 全局状态管理
    • 持久性逻辑(本地存储,cookie)
    • 获取数据 (fetch library, REST or GraphQL)

    将组件隔离,并独立封装。这将使你的组件正交,并且你所做的任何更改都将被隔离,并且仅集中在一个组件上。这就是可预测且易于开发的系统的诀窍。

    #3.使组件正交以获取获取

    让我们来看看下面的例子:

    import React, { useState } from 'react';
    import axios from 'axios';
    import EmployeesList from './EmployeesList';
    
    function EmployeesPage() {
      const [isFetching, setFetching] = useState(false);
      const [employees, setEmployees] = useState([]);
    
      useEffect(function fetch() {
        (async function() {
          setFetching(true);
          const response = await axios.get("/employees");
          setEmployees(response.data);
          setFetching(false);
        })();
      }, []);
      
      if (isFetching) {
        return <div>Fetching employees....</div>;
      }
      return <EmployeesList employees={employees} />;
    }
    

    在以上代码中<EmployeesPage>通过axios库,执行GET请求获取数据。

    如果以后从axios和REST切换到GraphQL会发生什么?如果应用程序具有数十个与获取数据逻辑耦合的组件,则必须手动更改所有组件。其实有更好的方法,让我们从组件中分离出获取数据逻辑细节。

    一个很好的方法是使用React的新功能Suspense:

    import React, { Suspense } from "react";
    import EmployeesList from "./EmployeesList";
    
    function EmployeesPage({ resource }) {
      return (
        <Suspense fallback={<h1>Fetching employees....</h1>}>
          <EmployeesFetch resource={resource} />
        </Suspense>
      );
    }
    
    function EmployeesFetch({ resource }) {
      const employees = resource.employees.read();
      return <EmployeesList employees={employees} />;
    }
    

    现在,直到<EmployeesFetch>读取异步资源之前,<EmployeesPage>都会挂起.

    重要的是<EmployeesPage>与获取数据逻辑正交。<EmployeesPage>不在乎axios是否实现抓取,你可以轻松地将axios更改为本地获取、或迁移为GraphQL:<EmployeesPage>不受影响。

    React:Suspense 文档

    #4.使视图与滚动监听器正交

    假设您你要跳转到顶部按钮,以在用户向下滚动500px以上时显示。单击该按钮时,页面将自动滚动到顶部。

    <ScrollToTop>第一个简单的实现:

    import React, { useState, useEffect } from 'react';
    
    const DISTANCE = 500;
    
    function ScrollToTop() {
      const [crossed, setCrossed] = useState(false);
    
      useEffect(
        function() {
          const handler = () => setCrossed(window.scrollY > DISTANCE);
          handler();
          window.addEventListener("scroll", handler);
          return () => window.removeEventListener("scroll", handler);
        },
        []
      );
    
      function onClick() {
        window.scrollTo({
          top: 0,
          behavior: "smooth"
        });
      }
    
      if (!crossed) {
        return null;
      }
      return <button onClick={onClick}>Jump to top</button>;
    }
    

    <ScrollToTop>实现滚动监听器并呈现一个将页面滚动到顶部的按钮,问题在于这些概念可能会以不同的形式变化。

    更好的正交设计应将滚动监听器与UI隔离,让我们将滚动监听器逻辑提取到自定义钩子useScrollDistance()中:

    import { useState, useEffect } from 'react';
    
    function useScrollDistance(distance) {
      const [crossed, setCrossed] = useState(false);
    
      useEffect(function() {
        const handler = () => setCrossed(window.scrollY > distance);
        handler();
        window.addEventListener("scroll", handler);
        return () => window.removeEventListener("scroll", handler);
      }, [distance]);
    
      return crossed;
    }
    

    然后,在组件<IfScrollCrossed>中使用useScrollAtBottom()

    function IfScrollCrossed({ children, distance }) {
      const isBottom = useScrollDistance(distance);
      return isBottom ? children : null;
    }
    

    <IfScrollCrossed>仅在用户滚动特定距离时才显示,最后,这是单击时滚动到顶部的按钮:

    function onClick() {
      window.scrollTo({
        top: 0,
        behavior: 'smooth'
      });
    }
    
    function JumpToTop() {
      return <button onClick={onClick}>Jump to top</button>;
    }
    

    现在,如果你想使一切正常工作,只需将<JumpToTop>放在<IfAtBottom>的中即可:

    import React from 'react';
    // ...
    const DISTANCE = 500;
    
    function MyComponent() {
      // ...
      return (
        <IfScrollCrossed distance={DISTANCE}>
          <JumpToTop />
        </IfScrollCrossed>
      );
    }
    

    重要的是<IfScrollCrossed>隔离滚动监听器,UI元素的更改也隔离在<JumpToTop>组件中,在这里滚动监听器逻辑和UI元素是正交的。另一个好处是你可以将<IfScrollCrossed>与任何UI结合使用。例如,当用户向下滚动300px时,您可以显示新闻表单:

    import React from 'react';
    // ...
    const DISTANCE_NEWSLETTER = 300;
    
    function OtherComponent() {
      // ...
      return (
        <IfScrollCrossed distance={DISTANCE_NEWSLETTER}>
          <SubscribeToNewsletterForm />
        </IfScrollCrossed>
      );
    }
    

    #5.“Main”组件

    尽管将变化隔离到单独的组件中是正交性的全部内容,但是可能由于不同的原因改变组件。这些就是所谓的“Main”组件(也称为“App”)组件。

    你可以在最外层的index.jsx(或app。jsx)文件内找到“Main”组件:即启动应用程序的组件。它知道有关该应用程序的所有细节:初始化全局状态提供程序(如Redux),配置获取库(如GraphQL Apollo),将路由与组件关联等等。

    你可能有几个“Main”组件:用于客户端(在浏览器中运行)和用于服务器端(实现服务器端渲染)。

    #6.正交设计的好处

    #易于修改

    当组件是正交设计时,对组件所做的任何更改都将隔离在组件内。

    #易读

    由于正交组件仅负责一个任务,因此更容易了解该组件的功能,它不被不属于这里的细节所困扰。

    #易测试

    正交组件仅专注于执行单个任务,你要做的只是测试组件是否正确执行任务。通常,非正交组件需要大量的模拟和手动设置才能进行测试,而且,如果难以测试。而现在你只需修改单个组件。

    #7.思考设计原则

    我喜欢新的React功能,例如hookssuspense等。但是,我也尝试着更广泛地思考,探索这些功能是否有助于我遵循良好的设计。

    • 为什么要使用React hooks?它们使UI渲染逻辑与state和副作用逻辑正交

    • 为什么Suspense获取?它使获取的细节和组件正交

    #8. 权衡

    让我们回想一下“星球大战之西斯的复仇”电影中的一幕。在阿纳金·天行者被他的前导师欧比·旺·克诺比(Obi-Wan Kenobi)击败后,后者说:

    给原力带来平衡,不要把它留在黑暗中

    阿纳金·天行者被选为绝地武士,在黑暗与光明的两面之间取得平衡。

    正交设计通过YAGNI: “You ain't gonna need it”原则来平衡。

    YAGNI成为极限编程的原则:

    始终在真正需要它们时执行这些事情,永远不要在仅仅预见到可能需要它们时才执行。

    (我的理解:只有真正需要时才使用)

    回顾一下文章的开头部分我的故事:我最终获得了一个困难且更改成本很高的应用程序,我的错误是:我无意中创建了并非为更改而设计的组件。这是YAGNI的极端情况。

    另一方面,如果每条逻辑正交,那么你最终将创建过多不需要的抽象,这是正交设计的极限。

    实际的方法是预见变化,详细研究你的应用程序解决的领域问题,并提供潜在功能的列表。如果你认为某个地方会发生变化,请使用正交设计原则。

    #8.关键点

    编写软件不仅与实现应用程序的要求有关,同样重要的是,要努力设计好组件。

    良好设计的关键原则是隔离最有可能改变的逻辑:使其正交。这使你的整个系统具有灵活性,并且可以适应更改或添加新功能。

    你想知道更多吗?你的下一步是可以阅读全英版:The Pragmatic Programmer

    ps: 微信公众号:Yopai,有兴趣的可以关注,每周不定期更新。不断分享,不断进步

  • 相关阅读:
    SpringBoot读取Resource下文件的几种方式(十五)
    Springboot+vue前后端分离文件上传、下载方式及与Spring的异同(十四)
    springboot多个service互相调用的事务处理(十三)
    Bigdecimal用法
    Linux常见wenti
    informix常见问题
    Spring-boot常见问题(十二)
    浅析VO、DTO、DO、PO的概念、区别和用处(八)
    Tbase读写分离与分库分表
    函数的节流和抖动
  • 原文地址:https://www.cnblogs.com/liuheng/p/12170012.html
Copyright © 2020-2023  润新知