技术开源项目从零到一的心路历程

时间 2020-03-17

标签技术开源项目心路历程繁體版

原文原文链接

这是一次很是漫长过程，整个项目大约经历了2年的开发与维护，期间重大的重构了十几回架构。html

首先一句话介绍一下整个项目：基于 Node.js 的服务端 web 开发框架node

在这里我分享一下个人经验，但愿可以帮助<<<想作开源的同窗>>>laravel

项目地址：传送门git

背景

在公司中，咱们一致都是使用 koa 来做为 node 的底层，对 koa + 各类中间件封装成了一个简易的框架，可是期间遇到了不少很差解决的问题，好比：ctx 的属性如何维护，如何保证框架的扩展性（彻底经过中间件扩展框架既臃肿又不容易维护）等等，因此我本身建立了这个项目，开始了此次开源项目之旅（受 springboot 与 laravel 的启发）。。。es6

框架设计

基于 TypeScript 开发

为了增长用户开发的体验（代码提示）和框架的代码质量（类型检测），我决定引入 Typescript 做为开发语言，其实初版开发的时候我仍是使用的 babel + es6 的方式开发的，可是通过屡次的尝试，最后仍是决定使用 Typescript 重构代码，最后结果也是很是完美（在这里我也推荐你们尝试 Typescript）github

AOP 编程

受 springboot 的启发，在引入装饰器（注解）以后，这种 AOP 的方式给我带来了很是大的体验提高，例如我不再须要在路由文件将路由指向控制器方法，而后找到控制器文件进行控制器代码的编写，我只须要 @http.get(path) 装饰到控制器方法框架就能够自动识别这个路由了web

依赖注入

不少语言的框架都采用了容器+依赖注入的方式，以容器做为框架底层，其余模块以服务的形式在容器注册，借助容器的依赖管理功能来对全部模块解耦，我以为这种方式用起来很是的舒服（我的意见），因此决定将这种方式引入spring

路由

以前用 koa-router 的时候，读过它的源码，性能不怎么好，后来看了 gin （Golang）框架的路由实现，以为很是的适合（前缀树路由结构），性能爆炸，并将其引入了项目中，效果很是理想，详细能够看基准测试数据传送门编程

很是强大的扩展能力

框架不只经过容器对模块进行了解耦，还能够利用容器的依赖管理能力，加强扩展的功能。在个人设计中，不只框架能够注册扩展，扩展也能够注册扩展，扩展之间还能够互相依赖，“扩展扩展的扩展”！！！api

还有很是多的小设计。。。

生态建设

除了框架自己外，生态建设也很是重要，目前例如 Apache Dubbo 的 node 实现， Websocket 网关等扩展生态，也已经发布，将来会有更多官方的生态建设

心态的转变

从一开始为了提高本身而建立的项目，在通过几回重构迭代以后，心态发生了转变，但愿本身的开源项目能帮助有需求的人，但愿本身能为社区做出贡献，这种心态反而可以更快速的帮助本身提高

开源的好处

帮助有需求的人，同时也帮助本身
结交志同道合的朋友
获取社区反馈，提高项目质量

Github 工做流程

使用 Github Flow，全部的代码更改都是经过 Pull Request 进行的

Fork 仓库并从 master 建立本身的分支
若是]添加了应该测试的代码，添加测试。
若是更改了 api，更新文档
确保测试所有经过
确保代码能够经过风格检测
提交 Pull Request!

Commit 提交规范

我选择使用 angular Commits 风格提交 commit，这样 history 看起来更加清晰，还能够自动生成 changelog

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
复制代码

type

提交 commit 的类型，包括如下几种:

feat: 新功能
fix: 修复问题
docs: 修改文档
style: 修改代码格式，不影响代码逻辑
refactor: 重构代码，理论上不影响现有功能
perf: 提高性能
test: 增长修改测试用例
chore: 修改工具相关（包括但不限于文档、代码生成等）
deps: 升级依赖

scope

修改文件的范围（包括但不限于 doc, model, controller, db, provider......) 等内置模块

subject

一句话清楚的描述此次提交作了什么

body

补充 subject，适当增长缘由、目的等相关因素，可选

footer

当有非兼容修改(Breaking Change)时必须在这里描述清楚关联相关 issue，如 Closes #1, Closes #2, #3

总结

以上几点都是我的的选择，可是我仍是比较推荐的，有了统一个风格和规范，才能让项目质量愈来愈好，也方便其余小伙伴加入

其实开源并不难，只要你认真去作了（奉献精神仍是比较重要的），而且认真的处理反馈意见，我相信你的开源项目必定能够走的很远，你们一块儿为开源社区贡献一份力量吧，不管最后结果是怎么样的，对我本身来讲，这是一段对本身提高最大的经历！

若是你是 Node.js 开发者/对 Node.js 感兴趣，欢迎加入个人开源项目哦～传送门