--- theme: scrolls-light --- vue和react都已经全面进入了hooks时代（在vue中也称为组合式api，为了方便后面统一称为hooks），然而受到以前react中类组件和vue2写法的影响，很多开发者都不能及时转换过来，以致于开发出一堆面条式代码，整体的代码质量反而不如改版以前了。 hooks组件到底应该如何写，我也曾为此迷惘过一段时间。特别我以前以react开发居多，但在转到新岗位后又变成了使用vue3开发，对于两个框架在思维方式和写法的不同上，很是花了一段时间适应。好在几个月下来，我发现二者虽然在写法上有区别之处，但思想上却大同小异。所以在比较了两个框架的异同后，我总结出了一套通用的hooks api的抽象方式，在这里分享给大家。如果您有不同意见欢迎在评论区指正。 ## 0、概述一个组件内部的所有代码——无论vue还是react——都可以抽象成以下几个部分: 1. 组件视图，组件中用来描述视觉效果的部分，如css和html、react的jsx或者vue的template代码 2. 组件交互逻辑，如组件生命周期，按钮交互，事件等 3. 业务逻辑，如登录注册，获取用户信息，获取商品列表等与组件无关的业务抽象单独拆分这三块并不难，难的是一个组件可能写得特别复杂，里面可能包含了多个视图，每个视图相互之间又有交互；同时又可能包含多个业务逻辑，多个业务的函数和变量杂乱无章地随意放置，导致后续维护的时候要在代码之间反复横跳。要写出高质量的组件，可以思考以下几个问题： ## 1.组件什么时候拆？怎么拆？一个常见的误区是，只有需要复用的时候才去拆分组件，这种看法显然过于片面了。你可以思考一下，自己是如何抽象一个函数的，你只会在代码需要复用的时候才抽出一个函数吗？显然不是。因为函数不仅有代码复用的功能，还具有一定的描述性质以及代码封闭性。这种特性使得我们看到一个函数的时候，不必关注代码细节，就能大概知道这部分代码是干啥的。我们还可以再用函数将一部分函数组合起来，形成更高层级的抽象。按国内流行的说法，高层级的抽象被称为**粗粒度**，低层级的抽象被称为**细粒度**，不同粗细粒度的抽象可以称它们为不同的**抽象层级**。并且一个理想的函数内部，一般只会包含同一抽象层级的代码。组件的拆分也可以遵循同样的道理。我们可以按照当前的结构或者功能、业务，将组件拆分为功能清晰且单一、与外部耦合程度低的组件(即所谓高内聚，低耦合)。如果一个组件里面干了太多事，或者依赖的外部状态太多，那么就不是一个容易维护的组件了。 ![components.png](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/a3ef1830a1454d068914241532b102b9~tplv-k3u1fbpfcp-watermark.image?) 然而，为了保持组件功能单一，我们是不是要将组件拆分得特别细才可以呢？事实并非如此。因为上面说过，抽象是有粗细粒度之分的，也许一个组件从较细的粒度来讲功能并不单一，但是从较粗的粒度来说，可能他们的功能就是单一的了。例如登录和注册是两个不同的功能，但是你从更高层级的抽象来看，它们都属于用户模块的一部分。所以是否要拆分组件，最关键还是得看**复杂度**。如果一个页面特别简单，那么不进行拆分也是可以，有时候拆分得过于细可能反而不利于维护。如何判断一个组件是否复杂？恐怕这里不能给出一个准确的答案，毕竟代码的实现方式千奇百怪，很难有一个机械的标准评判。但是我们不妨站在第三方角度看看自己的代码，如果你是一个工作一年的程序员，是否能比较容易地看懂这里的代码？如果不能就要考虑进行拆分了。如果你非要一个机械的判断标准，我建议是代码控制在200行内。总结一下，拆分组件的时候可以参考下面几个原则： 1. 拆分的组件要保持功能单一。即组件内部代码的代码都只跟这个功能相关； 2. 组件要保持较低的耦合度，不要与组件外部产生过多的交互。如组件内部不要依赖过多的外部变量，父子组件的交互不要搞得太复杂等等。 3. 用组件名准确描述这个组件的功能。就像函数那样，可以让人不用关心组件细节，就大概知道这个组件是干嘛的。如果起名比较困难，考虑下是不是这个组件的功能并不单一。 ![vue.webp](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4be2361473254e579ee0aa90e617f195~tplv-k3u1fbpfcp-watermark.image?) ## 2.如何组织拆分出的组件文件？拆分出来的组件应该放在哪里呢？一个常见的错误做法是一股脑放在一个名为components文件夹里，最后搞得这个文件夹特别臃肿。我的建议是相关联的代码最好尽量聚合在一起。为了让相关联的代码聚合到一起，我们可以把页面搞成文件夹的形式，在文件夹内部存放与当前文件相关的组成部分，并将表示页面的组件命名为index放在文件夹下。再在该文件夹下创建components目录，将组成页面的其他组件放在里面。如果一个页面的某个组成部分很复杂，内部还需要拆分成更细的多个组件，那么就把这个组成部分也做成文件夹，将拆分出的组件放在这个文件夹下。最后就是组件复用的问题。如果一个组件被多个地方复用，就把它单独提取出来，**放到需要复用它的组件们共同的抽象层级上。** 如下： 1. 如果只是被页面内的组件复用，就放到页面文件夹下。 2. 如果只是在当前业务场景下的不同页面复用，就放到当前业务模块的文件夹下。 3. 如果可以在不同业务场景间通用，就放到最顶层的公共文件夹，或者考虑做成组件库。关于项目文件的组织方式已经超过本文讨论的范畴，我打算放到以后专门出一篇文章说下如何组织项目文件。这里只说下页面级别的文件如何进行组织。下面是我常用的一种页面级别的文件的组织方式： ```javascript homePage // 存放当前页面的文件夹 |-- components // 存放当前页面组件的文件夹 |-- componentA // 存放当前页面的组成部分A的文件夹 |-- index.(vue|tsx) // 组件A |-- AChild1.(vue|tsx) // 组件a的组成部分1 |-- AChild2.(vue|tsx) // 组件a的组成部分2 |-- ACommon.(vue|tsx) // 只在componentA内部复用的组件 |-- ComponentB.(vue|tsx) // 当前页面的组成部分B |-- Common.(vue|tsx) // 组件A和组件B里复用的组件 |-- index.(vue|tsx) // 当前页面 ``` 实际上这种组织方式，在抽象意义上并不完美，因为通用组件和页面组成部分的组件并没有区分开来。但是一般来说，一个页面也不会抽出太多组件，为了方便放到一起也不会有太大问题。但是如果你的页面实在复杂，那么再创建一个名为common的文件夹也未尝不可。 ![coding.webp](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/4ee6e17c8be74397877ccfccd8de57c5~tplv-k3u1fbpfcp-watermark.image?) ## 3.如何用hooks抽离组件逻辑？在hooks出现之前，曾流行过一个设计模式，这个模式将组件分为无状态组件和有状态组件（也称为展示组件和容器组件），前者负责控制视觉，后者负责传递数据和处理逻辑。但有了hooks之后，我们完全可以将容器组件中的代码放进hooks里面。后者不仅更容易维护，而且也更方便把业务逻辑与一般组件区分开来。在抽离hooks的时候，我们不仅应该沿用一般函数的抽象思维，如功能单一，耦合度低等等，还应该注意组件中的逻辑可分为两种：组件交互逻辑与业务逻辑。如何把文章开头说的视图、交互逻辑和业务逻辑区分开来，是衡量一个组件质量的重要标准。以一个用户模块为例。一个包含查询用户信息，修改用户信息，修改密码等功能的hooks可以这样写： ```javascript // 用户模块hook const useUser = () => { // react版本的用户状态 const user = useState({}); // vue版本的用户状态 const userInfo = ref({}); // 获取用户状态 const getUserInfo = () => {} // 修改用户状态 const changeUserInfo = () => {}; // 检查两次输入的密码是否相同 const checkRepeatPass = (oldPass，newPass) => {} // 修改密码 const changePassword = () => {}; return { userInfo, getUserInfo, changeUserInfo, checkRepeatPass, changePassword, } } ``` 交互逻辑的hook可以这么写(为了方便只写vue版本的，大家应该也都看得懂): ```javascript // 用户模块交互逻辑hooks const useUserControl = () => { // 组合用户hook const { userInfo, getUserInfo, changeUserInfo, checkRepeatPass, changePassword } = useUser(); // 数据查询loading状态 const loading = ref(false); // 错误提示弹窗的状态 const errorModalState = reactive({ visible: false, // 弹窗显示/隐藏 errorText: '', // 弹窗文案 }); // 修改密码表单提交 const onChangePassword = ({ oldPass, newPass ) => { // 判断两次密码是否一致 if (checkRepeatPass(oldPass, newPass)) { changePassword(); } else { errorModalState.visible = true; errorModalState.text = '两次输入的密码不一致，请修改' } }; // 初始化数据 const initData = () => { getUserInfo(); } // 初始化数据，react使用useEffect onMounted(initData); return { // 用户数据 userInfo, // 修改密码 onChangePassword, // 修改用户信息 onChangeUserInfo: changeUserInfo, } } ``` 然后只要在组件里面引入交互逻辑的hook即可： vue版本： ```html