Skip to content

BoyYangzai/fe-team-work

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 

Repository files navigation

Why 🤔

之前在字节的时候 看过剪映团队负责人 曾琛 写的 剪映 性能优化,超脱于市面上所有的专栏,确实很佩服,是真正的沉淀出了经验,故在此沉淀一下我的团队和业务经验
一部分是学习来自于开源社区巨佬们的技术经验和优秀编码习惯,另一部分是沉淀出自己待过的四个厂百度、支付宝、字节、腾讯,自己觉得最舒服的 FE TEAM 和 FE Development Engineer 的业务能力标准和经验

Stardard ✨

一个职级在 2-1 到 2-2 之间(腾讯 t9)的前端,我觉得应该具备以下能力:
1.owner 稳定 - 需求评审、风险把控、技术优化、方案调研确定、技术评审、推动改良、能够独立 onwer 一个复杂的业务项目,稳定完成需求
2.带人 - 定制团队规范、带小型前端团队/带新人、需求分配、把控需求交付流程
3.关注技术 - 指无论有什么样的需求,脑子里都有一套对应的方案流程
一个很明显的区别就是,很多前端甚至连 Github 都不能熟练使用,更不能指望调研给出优秀的技术方案

Front End Team Requirements(前端团队要求)

Collaborative Development Specification(协同开发规范)

  • 如果非开源项目 or 注重 git commit history 的美观,请勿使用 squash merge,防止找不到对应的协同开发者
  • 如果想要提交代码到协同者的分支 or 火车分支,请提交 merge request,复制 mr link 给对方,为保证代码质量,可先 CR + approve,请勿直接 push

Engineering Experience - Team Oriented(工程经验 - 团队导向)

  • 业务中尽量避免使用 //@ts-ignore //@ts-noCheck,过不去的 Lint,要么是技术不到位要么是懒
  • ESlint Prettier 与 VScode Workspace
    这里是在腾讯的时候,发现的一个工作流问题,有一些 Pipe Line 会阻止 warning 的lint error,但是我本地没有 Eslint,只有 Prettier,导致无法在开发阶段去发现并且自动 Ctrl+S 去修复
    最佳实践:ESlint 在开发阶段自动读取 WorkSpace 中的配置并且 Ctrl+S 会自动去 fix 这些 warning
    No Prettier ❌
// .vscode/settings.json
{
  "eslint.validate": [
    "javascript",
    "typescript",
    "javascriptreact",
    "typescriptreact",
    "vue",
    "json",
    "jsonc",
    "json5"
  ],
  "stylelint.validate": [
    "css",
    "less",
    "scss"
  ],
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}
  • 非开源仓库请务必 lock,防止某天 Pipe Line 构建完成后,线上崩溃,以及被投毒
  • 官网开发首选 amis,参考 Antv 官网、AntDesign 官网、CapCut 官网等 (首先自己公司的框架,我一般用 Dumi)
    优点:
    1.后续迭代便利,开发难度小
    2.只需修改 Config 即可更换网站信息
    3.静态站点的 SSG
    4.有问题随时可以找 @Peach老师(🤪
  • wasm 不是必须品,应用场景较少,主要用于:
    1.大规模计算,视频、绘制、引擎 如 Antv 可视化渲染、视频团队、抖音烟花特效等
    2.突破原有 SDK 的性能瓶颈 如 字节电商 IM SDK、监控 SDK
    3.增加被反编译的成本 如 字节风控 SDK
  • umi3 升 4 比较容易,3 已经不维护,不会 onCall 和 新 Feature,但市面上很多团队还在使用
    收益:
    1.构建速度 以及 Hot Module update 显著提高
    2.新特性以及可以及时被响应的 Github issue
    3.毕竟咱也是 umi 团队成员,基本不会有无法解决的问题
    缺点:需要一定的人力投入 以及 全量回归 成本
  • 巨型 Monorepo 仓库不同的 Pkg 下的依赖版本冲突 以及 老仓库巨石应用 某个基层包 的升级 都可以通过 Resolution 去解决
    前者场景表现为项目崩溃、后者场景多数为安全合规 包版本卡点(在字节、腾讯都解决过类似的问题)
  • 大厂以及开源项目的国际化:
    原理:其实都是 react-i18n,比较简单的去取对应 lang key 下的 value
    基建团队做了什么?
    答:参考 Element-plus 的国际化,通过一个第三方的翻译平台,方便翻译人员操作,同时生成对应的 JSON 文件,只不过大厂不是第三方的服务,而是有自己的国际化翻译平台
    所以如果未来去初创/中小公司带团队,海外业务国际化的技术选型可以使用第三方的服务
  • 用户行为分析的埋点一般是 PM 提需求,在哪里埋,数据分析需要什么指标,前端埋点比较简单,一般只需要带上对应的 Event key value
  • 性能监控指标 C 端业务会看重这个 一般 X-FMP FCP 会比较重要一点
  • 大量动态加载的静态资源,图片、gif、视频、字体等,都可以通过 InDexDB 去做一层 Cache,有效提高请求速度
  • 合理使用 preconnect、prefetch、preload
  • git commit message 请一定带上 type 信息,如果需要带上 emoji(一般是开源项目),请遵循 git message emoji 标准

Individual Front End Development Competency Requirements(前端开发工程师能力要求)

Hooks

  • 与 React 原生 Hook 写法保持一致 小驼峰,返回 State 与 UpdateState
    const useCpData = () => {
      ...
      return [cpData, setCpData]
    }
  • Hook 与 Modal State 在一些情况下 在 Hook 中处理 Modal 中的状态去复用极为方便 举个例子 有大大小小 10 个模块,且可以单独通过 url 进入,此时 Modal 中不一定存在对应的 State Value,但每个页面都需要这个 Modal State

优点:

  • 只负责 Save Init State Or Get State from Modal,脱离业务逻辑
  • 逻辑复用极其简单,无需在每个模块去 Init State
    const useUserInfo = (props) => {
      const userInfo = useRedux(state: GlobalModal => state.Modal.userInfo)
      const setUserInfo = useRedux(state: GlobalModal => state.Modal.setUserInfo)

      const fetchUserInfo = () => {
          dispatch(params) // saveState to Modal
       }

      useEffect(() => {
      if(!userInfo){
        fetchUserInfo()
        }
      },[])
      ...
      return [userInfo, setUserInfo]
    }
  • 功能型 Hook 不与业务数据相关联,请提取出 @TEAM/utils 第三方 PKG 如 useEventOutSide 这种

Tips: Meta 团队提供了非常多的 Hooks,但是很多 Hooks 都是为 SSR 服务的,一般的业务开发都无需关心

Component

  • 组件命名 - 大驼峰 文件名:大驼峰 or 连接符
  • 类型声明原则 组件大驼峰 + Props

标准 tsx 组件

   // pages/Login/LoginModal/index.tsx
   interface LoginModalProps {
      ...
   }
   const LoginModal: FC<LoginModalProps> = () => <>
      ...
   </>
   export default LoginModal;
  • 组件事件以及回调函数命名应遵循 onEvent => handleEvent
  • 业务组件 - 推荐 Data(数据) 与 View(视图) 分离,用相应的 Data Hook 去 管理/创建 CP 单例
    举个例子,这里有一个商业化复杂应用场景下的 Table Modal, 虽然复杂 但是极其耐用
    具体的功能大概是:
    复杂业务场景的 Search + 后端分页 + 复杂业务表格数据以及嵌套多重数据 + 自定义 UI 插槽 + 以及各种 Modal Render Props
  // 通用组件 非 Page CP
  // components/TableModal/index.tsx
  interface TableModalProps{
    records: TableRecords;
    columns: TableColumns;
    pagination: PaginationInfo;
    searchProps: TeamSearchCpProps,
    ...
  }

  const TableModal:FC<TableModalProps> = () => {
    return <> ... </>
  }

  export default TableModal;
  // components/TableModal/hooks/useTableModal.ts
  const useTableModal = () => {
    const [data, setData] = useState<TableModalData>([])
    const [pagination, setPagination] = useState<PaginationInfo>({ pageIndex: 1, pageSize });
    const [tableStatus, setTableStatus] = useState<TableStatus>(TableStatus.empty)
    ... Hook with Data 
    return [data, pagination, tableStatus, setData, setPagination, setTableStatus]
  }

   // Usage 伪代码
   const Component: FC = () => {
      const [data, pagination, tableStatus, setData, setPagination, setTableStatus] = useTableModal()
      return <>
         <TableModal
         records={data}
         status ={tableStatus}
         pagination={pagination}
         ...
         />
         ...
      </>
   }

Modal State

  • 去不同公司不同团队写 React,必须要适应的是不同的状态管理
    基于 Redux 的 Dva、easy-xxx 等,Mobx、zustand、jotai等
    我本人在过的团队使用的基本上都是围绕 redux 理念的生态,但是现在有不少团队在使用其他的状态管理工具
  • 以页面为维度去划分 Namespace 其实是有点混乱的,如Dva,本质上还是全局的状态
    个人推荐 全局状态划分不同的顶层 Modal,易于区分不同的数据模型、清晰易懂、容易定位
    如项目量级过大,顶级 Modal 确实会出现过多的问题,不过切忌顶层全局 Modal 与 页面级/组件级 混用,会产生交接成本

模块

  • 导入顺序优先级
    1.第三方 Pkg
    2.本地 JS 模块
    3.非 JS 模块
  • 类型导入最好带上 type 关键字
  • 类型声明放在 ./type.ts

正确示例✅

import { Cp1, Cp2, ... } from 'antd';
import { xxx } from 'umi;

import MyComponent from './MyComponent';
import useHook from './hooks/useHook';

import type { myType} from './type.ts';
import styles from './index.less'; 

Proven coding experience(成熟编码经验)

  • 避免默认导出与具名导出同时使用,会导致意外的 Bundle 体积增大(特殊情况除外 如语义化的附属组件 参考 AntDesign Form)
   // 错误示例❌
   export { utilA, utilB };
   export default Utils;
  • 习惯使用枚举 (你也不想你的代码里面一堆看不懂的 数字/字符串 来表示业务逻辑吧 1001是什么 1002是什么 1003是什么???)
    优点:
    1.维护十分方便,方便对应 Value 统一修改
    2.语义化、同一种类枚举类型业务逻辑更加清晰
    3.抽离复用
   // 错误示例❌
   interface UserInfo {
      type: 'normal' | 'admin' | 'onwer'
   }
   ...
   if(res === 'normal') { ... }
   // 正确示例✅
   export enum UserType {
      NORMAL = 'normal',
      ADMIN = 'admin',
      OWNER = 'owner'
   }
   ...
   if(res === UserType.OWNER) { ... }
  • 避免频繁使用 useMemo、useCallback
  • useMemo、useCallback 依赖超过 5 个,去掉 Hook,避免增加心智负担
  • ⭐️⭐️⭐️ 请将复杂业务/计算逻辑 统一抽离放在 useMemo 中
   // 组件设计场景
   const mergedXXX = useMemo(()=>{
      const XXX = ... // prop
      return context.XXX ?? XXX
   },[dep1, dep2, ...)

   // 业务场景
   const mergedTableData =  useMemo(()=>{
      const XXX = ...
      ... //复杂业务逻辑
      ... //复杂业务逻辑
      return XXX
   },[selectedData, mergedColumns, ...)
  • 避免三元表达式嵌套
  • 注意空格,养成习惯,包括纯代码以及中英文混合使用
   // 这是一个关于业务 Code 的注释
  • 在公司代码中,尽量使用 if 条件语句替代可扩展的可选链逻辑 ? (看似麻烦 好处是代码易读懂且方便后续扩展)

正确 ✅

   interface UserInfo {
      [key: string]: string
   }
   const res: {
      userInfo: UserInfo
   } = dispatch();

   if (res?.useInfo) {
     console.log(res.useInfo.age);
   }
  • 调用不一定存在的函数,请记得 fn?.(),一般用于组件封装场景,以及数据通信

About

前端业务开发指南

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published