业务组件库开发流程

简介: 业务组件库可以帮助我们加速开发流程,提高工作效率,提升代码复用率

业务组件库必要性

项目经过长期维护之后往往会沉淀出很多公共组件,当一个组件编写完成之后,其他维护者想要使用这个组件,了解这个组件是做什么的,应该怎么用,必须再去翻看源码,或者没有压根儿注意到这个组件导致重发开发。这个时候一个完善的组件库就很有必要了,可以保障开发者之间进行良好的协作。

组件库可以帮我们解决以下问题:

  • 业务组件跨项目复用,提升开发效率
  • 统一代码实现,统一代码质量保障
  • 组件库文档提供清晰的使用方式和直观的展示效果

组件库的组成

业务组件构成

业务组件库是基于基础组件库进行编写的,基础组件库是使用公司的antd。我们会对基础组件针对不同需求进行封装,达到可以直接引用无需二次开发的目的(比如:产线下拉选择组件,我们会将接口请求数据、选项模糊查询、多语言等封装到组件内部,无需二次开发,接口请求也不需要再散落到各个页面中)。

目标

  1. 引⼊即可使⽤,⽆需⼆次开发
  2. 完善的文档和组件效果演示,支持代码一键拷贝
  3. 良好的代码质量:使用Jest进行单元测试,保障代码质量
  4. 良好的编码规范和代码提交规范:ESLint、Husky、commit-lint等工具进行校验和拦截
  5. 根据代码提交自动生成ChangeLog
  6. 组件效果演示支持编辑实时渲染(在文档中编辑组件,实时变更展示效果)

开发计划

组件库开发周期

  1. 准备

    • 组件库文档选型评审
    • 首批组件梳理
  2. 开发

    • 基础架构设计

      • 目录结构规范
      • 本地开发环境构建
      • 代码规范校验
      • 代码提交规范校验
      • CR和发布规范
      • TypeScript支持
    • 单元测试

      • Jest + @testing-library
    • 组件开发
    • 组件库文档生成

      • 本地预览调试
      • 本地构建
  3. 初次发布

    • 发布和使用初次版本
  4. 迭代升级

    • 业务组件新增
    • 业务组件迭代
    • 组件库文档托管

      • 在线访问
  5. 可视化构建页面区块和页面

业务组件库完成之后,就可以尝试低代码了,可以使用拖拽或者图像识别自动生成业务代码

混沌前端

相关文章
|
6月前
|
前端开发 JavaScript jenkins
构建高效前端项目:从模块化到自动化
【2月更文挑战第13天】 随着Web技术的不断进步,前端项目的复杂性日益增加。为了确保可维护性和性能,前端工程师必须采用模块化和自动化的策略来优化开发流程。本文将探讨如何使用现代前端工具和最佳实践来构建一个高效的前端项目架构,包括模块打包、代码分割和持续集成等方面。
|
6月前
|
SQL 运维 前端开发
标准&有效的项目开发流程
标准&有效的项目开发流程
120 0
|
前端开发 JavaScript API
构建可重用用户界面:深入了解组件库的价值与实践
在现代应用程序开发中,组件库已经成为加速开发和提高代码质量的利器。它们是可重用的UI构建块,可以帮助开发者创建一致、漂亮和功能强大的用户界面。本博客将深入研究组件库的核心概念、最佳实践以及为什么它们对于现代开发至关重要。
92 0
|
4月前
|
设计模式 算法 运维
开发与运维开发问题之什么是模版模式,模版模式在业务接口设计中如何应用
开发与运维开发问题之什么是模版模式,模版模式在业务接口设计中如何应用
|
6月前
|
算法 测试技术 数据处理
【C++ 设计思路】优化C++项目:高效解耦库接口的实战指南
【C++ 设计思路】优化C++项目:高效解耦库接口的实战指南
168 5
|
12月前
|
存储 分布式计算 大数据
构建与应用大数据环境:从搭建到开发与组件使用的全面指南
构建与应用大数据环境:从搭建到开发与组件使用的全面指南
284 0
|
消息中间件 XML 存储
集成的方式
系统集成-功能集成
109 0
|
容器
【系统架构】组件与(模块化和应用集成)的区别
【系统架构】组件与(模块化和应用集成)的区别
314 0
|
存储 缓存 JavaScript
一个简易的前端业务工具库【tj-jstools】
前端业务工具库:使用TypeScript编写有关js数据类型、浏览器信息、浏览器存储、url、字符串、数值、数组、对象等相关操作,让业务逻辑简单化。
327 0
一个简易的前端业务工具库【tj-jstools】
|
数据可视化 前端开发 Java
云巧组件如何实现代码架构设计可视化
在项目搭建完成进行了N个迭代之后,往往因为需求的变化以及设计的缺陷导致领域模型、接口、数据库设计等和最开始的时候大为不同,架构设计需要保鲜会花去大量的时间。有没有一种办法可以实时反应项目的各种技术设计呢?就像Swagger一样,代码自动生成文档。我们采用了静态代码扫描的方案,通过代码来反应真实的技术设计,这就是《云巧工坊-应用素描》的功能。
272 0