Skip to content

Latest commit

 

History

History
245 lines (155 loc) · 10.7 KB

快速打造中小团队的前端基建 - 协作篇.md

File metadata and controls

245 lines (155 loc) · 10.7 KB
Raw

前言

作为一名野生的前端开发，自打本猿入行起，就未经过什么系统的学习，待过的团队也是大大小小没个准儿：

  • 要么大牛带队，但是后端大牛。
  • 要么临时凑的团队，受制于从前，前端不自由。
  • 要么从0到项目部署，都是为了敏捷而敏捷，颇不规范。

话虽如此，经过4年生涯摧残的废猿我，也是有自己的一番心得体会的。

1. 从DevOps流程看前端基建

很多专注于切图的萌新前端看到这张图是蒙圈的：

DevOps是什么？这些工具都是啥？我在哪？

很多前端在接触到什么前端工程化，什么持续构建/集成相关知识时就犯怂。也有觉得这与业务开发无关，不必理会。

但是往长远想，切图是不可能一辈子切图的，你业务再怎么厉害，前端代码再如何牛，没有了后端运维测试大佬们相助，一个完整的软件生产周期就没法走完。

而成为一名全栈很难，更别说全链路开发者了。

言归正传，当你进入一个新团队，前端从0开始，怎样从DevOps的角度去提高团队效能呢？

一套简易的DevOps流程包含了协作、构建、测试、部署、运行。

而前端常说的开发规范、代码管理、测试、构建部署以及工程化其实都是在这一整个体系中。

当然，中小团队想玩好DevOps整套流程，需要的时间与研发成本，不比开发项目少。

DevOps核心思想就是：“快速交付价值，灵活响应变化”。其基本原则如下：

  • 高效的协作和沟通；

  • 自动化流程和工具；

  • 快速敏捷的开发；

  • 持续交付和部署；

  • 不断学习和创新。

接下来我将从协作、构建、测试、部署、运行五个方面谈谈，如何快速打造用于中小团队的前端基建。

2. 在团队内/外促进协作

前端基建协作方面可以写的东西太多了，暂且粗略分为：团队内 与 团队外。

以下可能是前端们都能遇到的问题：

  • 成员间水平各异，编写代码的风格各不相同，项目间难以统一管理。
  • 不同项目Webpack配置差异过大，基础工具函数库和请求封装不一样。
  • 项目结构与技术栈上下横跳，明明是同一UI风格，基础组件没法复用，全靠复制粘贴。
  • 代码没注释，项目没文档，新人难以接手，旧项目无法维护。

三层代码规范约束

  • 第一层，ESLint：

常见的ESLint风格有：airbnb，google，standard。

在多个项目间，规则不应左右横跳，如果项目周期紧张，可以适当放宽规则，让warning类弱警告可以通过。且一般建议成员的IDE和插件要统一，将客观因素影响降到最低。

  • 第二层，Git Hooks。

git 自身包含许多 hooks，在 commit，push 等 git 事件前后触发执行。

而husky能够防止不规范代码被commit、push、merge等等。

代码提交不规范，全组部署两行泪。

npm install husky pre-commit  --save-dev

拿我以前的项目为例子：

// package.json
  "scripts": {
    // ...
    "lint": "node_modules/.bin/eslint '**/*.{js,jsx}' && node_modules/.bin/stylelint '**/*.{css,scss}'",
    "lint:fix": "node_modules/.bin/eslint '**/*.{js,jsx}' --fix && node_modules/.bin/stylelint '**/*.{css,scss}' --fix"
  },
  "husky": {
    "hooks": {
      "pre-commit": "npm run lint",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },

通过简单的安装配置，无论你通过命令行还是Sourcetree提交代码，都需要通过严格的校验。

建议在根目录README.md注明提交规范：

## Git 规范

使用 [commitlint](https://github.com/conventional-changelog/commitlint) 工具，常用有以下几种类型：

- feat ：新功能
- fix ：修复 bug
- chore ：对构建或者辅助工具的更改
- refactor ：既不是修复 bug 也不是添加新功能的代码更改
- style ：不影响代码含义的更改 (例如空格、格式化、少了分号)
- docs ： 只是文档的更改
- perf ：提高性能的代码更改
- revert ：撤回提交
- test ：添加或修正测试

举例
git commit -m 'feat: add list'
  • 第三层，CI(持续集成)。

《前端代码规范最佳实践》

前两步的校验可以手动跳过（找骂），但CI中的校验是绝对绕不过的，因为它在服务端校验。使用 gitlab CI 做持续集成，配置文件 .gitlab-ci.yaml 如下所示:

lint:
  stage:lint
  only:
    -/^feature\/.*$/
  script:
    -npmlint

这层校验，一般在稍大点的企业中，会由运维部的配置组完成。

统一前端物料

公共组件、公共UI、工具函数库、第三方sdk等该如何规范？

如何快速封装部门UI组件库？

首先，得感谢各大UI组件库的维护者们，给我们省了非常多的开发成本。

遥想Jquery时代，到处找插件的日子....

但是每个新团队都有自己的UI风格取向，你单引一个ElementUI，肯定会出现业务水土不服以及观感不同的地方，而如果你在每个项目都强行魔改，到处污染样式，这得多心累啊。

虽然各大组件库都有提供初始化变量的方式，但业务向的组件就没办法了。

解决方案之一，就是国外很火的一个开源库：StoryBook:

Storybook是一个开源工具，用于独立开发React、Vue和Angular的UI组件。它能有组织和高效地构建UI组件。

Storybook提供了一个沙箱，用于隔离地构建UI组件。

类似于组件库的官方文档，却更加强大。可以通过控件和对出入参数调整，快速查看组件的用法，测试也可以对组件功能完整性等做校验。

一般的建议步骤是：

  1. 将业务从公共组件中抽离出来。
  2. 在项目中安装StoryBook(多项目时另起)
  3. 按官方文档标准，创建stories，并设定参数（同时也建议先写Jest测试脚本），写上必要的注释。
  4. 为不同组件配置StoryBook控件，最后部署。

如何统一部门所用的工具函数库和第三方sdk

其实这里更多的是沟通的问题，首先需要明确的几点：

  • 部门内对约定俗成的工具库要有提前沟通，不能这头装一个MomentJs，另一头又装了DayJS。一般的原则是：轻量的自己写，超过可接受大小的找替代，譬如:DayJS替代MomentJs，ImmerJS替代immutableJS等。
  • 部门间的有登录机制，请求库封装协议等。如果是SSO/扫码登录等，就协定只用一套，不允许后端随意变动。如果是请求库封装，就必须要后端统一Restful风格，相信我，不用Restful规范的团队都是灾难。前端连调会生不如死。
  • Mock方式、路由管理以及样式写法也应当统一。

在团队外促进协作

核心原则就是：“能用文档解决的就尽量别BB。”

虽说现今前端的地位愈发重要，但我们经常在项目开发中遇到以下问题：

  • 不同的后端接口规范不一样，前端需要耗费大量时间去做数据清洗兼容。
  • 前端静态页开发完了，后端迟迟不给接口，因为没有接口文档，天天都得问。
  • 测试反馈的问题，在原型上没有体现。

首先是原型方面：

  1. 一定要看明白产品给的原型文档！！！多问多沟通，这太重要了。
  2. 好的产品一般都会提供项目流程详图，但前端还是需要基于实际，做一张页面流程图。
  3. 要产品提供具体字段类型相关定义，不然得和后端扯皮。。。

其次是后端：

  1. 执行Restful接口规范，不符合规范的接口驳回。
    • 劝退师就经历过，前东家有个JAVA架构师，连跨域和Restful都不知道，定的规范不成规范，一个简单查询接口返回五六级，其美名曰：“结构化数据”。
    • 遇到这种沉浸于自己世界不听劝的后端，我只有一句劝：要么把他搞走，要么跑路吧。
  2. 必要的接口文档站点与API测试（如Swagger，Apidoc），不接受文件传输形式的接口。
    • 早期的联调都是通过呐喊告知对方接口的标准。刚开始有什么不清楚的直接问就好了，但是到了后面的时候连写接口代码的那个人都忘了这接口怎么用，维护成本巨高。
    • 在没有接口文档站点出现前，接口文档以word文档出现，辅以postman、http、curl等工具去测试。但仍然不够直观，维护起来也难。
    • 以web交互为主的Swagger解决了测试，维护以及实时性的问题。从一定程度上也避免了扯皮问题：只有你后端没更新文档，这联调滞后时间就不该由前端担起。

然后是测试方面：

  1. 为了避免测试提出一些无效的bug，最好提前参与测试的用例评审。
  2. 在实际开发中，如果有不合理功能需要修改，所有的修改都必须要求产品经理更新到PRD以及原型设计中。否则，测试如果不知道的话，会认为是bug。
  3. 通过自测和编写Jest单元测试，将代码意外bug降到合理程度。
  4. 和测试一起吐槽后端的接口规范（滑稽）。

最后是运维方面：

  1. 除了CI/CD相关的，其实很可以和运维一起写写nginx和插件开发。

3. 效率沟通工具

可能大家比较习惯的是使用QQ或者微信去传输文件，日常沟通还行，就是对开发者不太友好。

如何是跨国家沟通，一般都是建议jira+slack的组合，但这两个工具稍微有些水土不服。

沟通 项目管理
企业微信 Teambition
钉钉 Tapd

这四个工具随意选择都不会有太大问题。

内心OS: 请在下班后关闭以上工具的消息推送...

结束

搞前端基建这玩意儿，可比写代码累多了。。

劝退师个人微信：huab119

也可以来我的GitHub博客里拿所有文章的源文件：

前端劝退指南：https://github.com/roger-hiro/BlogFN 一起玩耍呀。~