Blog
Blog
PHODAL

查看分类 杂谈

作为一个资深的咨询师、程序员,GitHub 是我用过的最好工具,因为 Google 并非总是那么用。GitHub 是一个宝藏库,可没有藏宝图,GitHub 一1亿的仓库也和你没有关系。这么一些年下来,也算是掌握了一定的技巧,写篇文章记录一下,也就顺其自然了。

所谓最优,就是从一堆非最佳的方案中找到最好的一个,或者整合一个。

“微” 害架构,即微架构以不合理的方式运行着,其表现形式不适当地采用 “微架构”(微服务、APP 插件化、微前端等)技术拆分臃肿的单体应用,导致软件架构进一步复杂化、难以维护,使得原本具有优势的微架构微微出现一些问题。

无论是学习还是应用新的技术,都需要一个短暂的学习与练习,才能获得相应的经验。这就造成了一个冲突,日益增长的技能需求,同不足的时间之间的矛盾。

为了在我的编辑器中使用 Angular,我用 Angular 编写了一个重命名功能。而为了使用它,我得再次使用一次 customEvent,而在这个微前端架构的系统中,其事件通讯机制已经相当的复杂。在这部分的代码进一步恶化之前,我得尝试有没有别的方式。于是,我想到了之前在其它组件中使用的 Web Components 技术,而 Angular 6 正好可以支持。

微应用化即在开发和运行时,应用都是以单一、微小应用的形式存在。

微应用化与微前端架构相当的类似,它们在开发时都是独立应用,在构建时又可以按照需求单独加载。如果以微前端的单独开发、单独部署、运行时聚合的基本思想来看,微应用化就是微前端的一种实践。只是使用微应用化意味着:我们只能使用唯一的一种前端框架。如果从框架不限的角度来定义,怕是离微前端有些远,不过大团队怕是不会想同时支持多个前端框架。

最近,我在写一个新的 markdown 内容,过程中发现没有合适的 markdown 客户端。于是,我希望为自己定制一款全新的编辑器,原因有许多吧,大抵是没有一个编辑器能满足我的需求。

在前端应用中,动画是一个常见的场景。在使用了一系列的动画库之后,终于需要自己来实现一个动画了。这次的动画则是基于 Angular 框架。我的场景是一个类似于添加购物车的动画。在这个场景里,需要两个动画,一个是购物车数量的增加动画,一个则是折叠页面元素的动画。 在实现的过程上,我采用了两种不同的 Angular 动画的方式: - 使用 TypeScript 控制动画 - 使用 @Component 中的 animations Angular 动画基础 --- 如 Angular 官网中的示例那样,要在 Angular 应用中添加动画是比较简单的一件事——前提是我们懂得添加的法则。如下是官网的示例: ``` @Component({ selector: 'app-hero-list-basic', template: `
  • {{hero.name}}
`, styleUrls: ['./hero-list.component.css'], animations: [ trigger('heroState', [ state('inactive', style({ backgroundColor: '#eee', transform: 'scale(1)' })), state('active', style({ backgroundColor: '#cfd8dc', transform: 'scale(1.1)' })), transition('inactive => active', animate('100ms ease-in')), transition('active => inactive', animate('100ms ease-out')) ]) ] }) ``` 要使用动画,需要在模板中使用 ``[@heroState]``语法,这里的 ``heroState`` 对应着 ``@Component`` 中的 ``heroState`` 相关的动画。 - 在这个 ``trigger`` 中,我们定义了 ``inactive`` 和 ``active`` 两个不同的 ``state``。即当模板中的 ``hero.state`` 发生变化的时候,我们就会找到对应的 ``state`` 的样式等等的内容。 - 在这个 ``trigger`` 中,我们还定义了两个 ``transition``,即当我们的 ``state`` 从 ``inactive => active`` 或者 ``active => inactive`` 时,我们就会执行后面的动画。 原理上,大概就是这么多了。然后,我就开始了我的动画之旅。 购物车数量增加动画 --- 对于我的场景来说,要添加这个动画并不难。无非就是上一个值淡出,新的值淡入: ``` trigger('count', [ transition('void => current', [ animate( '400ms 150ms', keyframes([ style({ opacity: 0.6, transform: 'translateY(0)', offset: 0 }), style({ opacity: 0.3, transform: 'translateY(-15px)', offset: 0.5 }), style({ opacity: 0, transform: 'translateY(-30px)', offset: 1 }) ]) ) ]), transition('void => last', [ animate( 250, keyframes([ style({ opacity: 0, transform: 'translateY(100%)', offset: 0 }), style({ opacity: 0.3, transform: 'translateY(15px)', offset: 0.5 }), style({ opacity: 0.8, transform: 'translateY(0)', offset: 1.0 }) ]) ) ]) ]) ``` 代码就是这么简单,这里用到了关键帧 ``keyframes``,来进行一些简单的动画转换。 页面缩放动画 --- 随后,我需要做的就是对页面的元素进行缩放等效果,这个时候就需要用到 AnimationBuilder 来实现了: ``` const myAnimation = this.animationBuilder.build([ animate( 1000, keyframes([ style({ opacity: 0.8, transform: 'scale(0.8)', offset: 0.3 }), style({ opacity: 0.3, transform: 'scale(0.3)', offset: 0.5 }), style({ opacity: 0.2, transform: 'scale(0.2) translate(12000px, 8000px)', offset: 1 }) ]) ) ]); const player = myAnimation.create(forkFormComponent); player.play(); player.onDone(() => { const nativeElement = this.cartContainer.nativeElement; nativeElement.removeChild(nativeElement.childNodes[0]); this.renderer.setStyle(nativeElement, 'display', 'none'); }); ``` 在那之前,我先复制了页面元素: ``` const formElement = this.formElement.nativeElement; const forkFormComponent = this.cartContainer.nativeElement; forkFormComponent.appendChild(formElement.cloneNode(true)); this.renderer.setStyle(forkFormComponent, 'display', 'block'); this.renderer.setStyle(forkFormComponent, 'position', 'absolute'); this.renderer.setStyle(forkFormComponent, 'top', '-300px'); this.renderer.setStyle(forkFormComponent, 'left', '0'); ``` 这样一来,就能复制页面的 DOM,然后实现缩放效果了。
> “我只是修改了一个 if 条件,没有想到它导致持续集成失败,部署也因此失败,还影响了 QA 测试其它功能。” Web 应用的质量提升,是一个非常有意思的话题。我们明知道有一系列的手段可以提升代码质量,但是限于多种原因,我们并不会去做。在我工作的第一个项目里,由于大家都是年轻人(Junior Consultant),我们实施了一系列的基础措施,来提升应用质量,诸如写测试、追求测试覆盖率、运行预提交脚本等等。 在最近的这个项目里,我们面临着类似的问题——需要提升项目的代码质量。于是,便想写一篇文章介绍一个相关的内容。这篇文章大致可以分为这几个部分: - Web 应用的质量问题 - 使用测试提升质量 - 使用 Lint 和 Git Hooks 检测代码 - 如何防范危险提交 那么,让我们继续回到老生常谈的 “Web 应用的质量问题”。 Web 应用的质量问题 --- Web 应用通常面临着上线和质量之间的博弈——只要不影响用户体验,小的 Bug 往往对于项目来说可以 “容忍” 的。这样一来说可以早些上线,实现用户价值。除此还有其开发的影响:一个是敏捷方式的开发周期,一个则是可以多次上线。 故而,Web 开发与一些特殊领域及行业的软件开发不同,在这些特殊的行业里,一个开发成本上亿的软件,可能只会运行、部署一次,不会有第二次机会,如原子弹的控制系统。还有一些类型的案例,就是智能汽车上的自动驾驶系统,稍有不慎就是车损人忙。相当于 Web 应用虽然更新困难,可它们还是能远程更新的。但是在这些系统上,它们就更追求系统的质量,而不是开发速度。Web 应用部署失败可以回滚,虽然会带来一定的钱力损失,但是极少带来生命危险。 因此在**质量**和**速度**方面,在 Web 开发上因此保持着一个微妙的平衡。 可软件开发不仅仅只有质量和速度的问题,还有一个产品问题——即,能做出符合用户需求的产品。于是,就变成了**质量-速度-需求**,一个更复杂的平衡。为了交付出更符合用户需求的产品,就不得不经常做一些需求变更。而取决于这些变更的时间,它往往会影响到代码质量和开发速度——实现一个需求的时间越短,那么其测试的时间越短,Bug 出现的可能性就更高。过去我遇到过,今晚上线,下午临时改需求。可想而知,测试人员是没有时间测试的。 在这个时候,持续集成只能显式地告诉我们,我们的测试挂了,我们的某些功能 broken 了,我们不应该部署这个新版本。然而并不是持续集成出问题了,我们就不能部署,我们仍然还是能部署的。 Blabla,那么问题来了,最有效的方式呢? 使用测试提高质量 --- 用于保证这个项目的质量,在代码提交之后,会经过一系列的测试: - 单元测试 - 自动化 UI 测试 - 开发人员手动进行集成测试 - 测试人员进行 3~4 轮的测试 如果只是宏观来看一个项目的测试的话,那么在一个敏捷项目里,测试可以分为这么几个阶段: - Dev (开发)环境的 Desk Check,主要用于演示功能是否和需求一致。 - QA (测试)环境的测试,用于进行一些常规的测试。 - ST (System Test)环境的测试,常用于与第三方系统联调。当出现第三方系统的时候,就需要该环境来集成。 - UAT(User Acceptance Test,用户接受测试)环境的测试,通常用由业务方的代码来验收产品是否符合需求。 如果一个 Web 应用能经过这么一系列的测试,那么它的质量在一定程度上是得到保障的。所以,开发人员如果不想活得太久,就可以 “不负责任” 地直接把功能扔给测试人员。笑~ 可是,在有一些公司时吧,Bug 率可是会影响绩效的,又或者是有这么多 Bug 看上去不那么专业,等等 blabla。 言而总之,总而言之,开发人员自己写测试会更友好一些。按照测试金字塔理论来说,我们需要三种类型的测试: - 单元测试,用于保证我们的基础函数是正常、正确工作的。 - 服务测试,不仅仅自身的服务,也会测试第三方依赖服务。 - UI 测试,模仿用户操作行为的测试。 对于一个前端项目来说,我们通常只需要两种:``单元测试`` 和 ``E2E 测试``。实际上,理论上应该还有 ``UI 组件的测试``,但是一般而言,我们在选用 UI 组件的时候,会考虑到组件的稳定性。 可是在多数国内公司里,写测试往往是不可能的。退而求次,我们就需要一种更简单而友好的方式,来做这样的事情。 使用 Lint 和 Git Hooks 检测代码 --- 在代码提交之前,我们还可以进行一些常见的操作: - 静态代码分析(lint),用于进行静态代码分析,常见的如 Lint4j、TSLint、ESLint。 - 运行测试,为了不影响持续集成,我们需要在代码提交之前进行测试。 现代的编辑器(使用相应插件)、IDE 可以提高很好的技术手段,在开发的过程中静态代码分析,并随时提高建议。如 Intellij IDEA 和 WebStorm 就会根据 TSLint,来提醒开发者 TypeScript 代码的一些规范问题。 这些分析工具主要进行一些代码上的分析,如《全栈应用开发:精益实践》一书所说,一般会进行如下一系列的风格检测: - 规范函数名及变量 - 代码格式规范 - 限制语言特性 - 函数行数限制 - 多重嵌套限制 - 未使用代码 - 等等 而这些规范,如果没有强制,那就是个游戏。于是,我们通常会依赖于 Git Hooks 来做这样的事。对于一个使用 Git 来管理源码的项目来说,Git Hooks 可以做这么一些事情,可以在 ``.git/hooks`` 目录下查看: ``` applypatch-msg post-merge pre-auto-gc prepare-commit-msg commit-msg post-receive pre-commit push-to-checkout post-applypatch post-rewrite pre-push update post-checkout post-update pre-rebase post-commit pre-applypatch pre-receive ``` 一般而言,我们只会在两个阶段做相应的事情: - ``pre-commit``,预本地提交。通常会在该提交之前,进行一些语法和 lint 的检测。 - ``pre-push``,预远程提交。通常会在该提交之前,运行一些测试。 于是,在我们的这个前端项目里,我们就又写了这两个 ``scripts``。对应的实现如下: ``` { "precommit": "lint-staged", "prepush": "ng test && ng build --prod" } ``` 在 ``precommit`` 时,我们配合 ``lint-staged`` 和 ``prettier`` 来进行代码格式化: ``` "lint-staged": { "src/app/*.{css,scss}": [ "stylelint --syntax=scss", "prettier --parser --write", "git add" ], "{src,test}/**/*.ts": [ "prettier --write --single-quote", "git add" ] } ``` 事实上,使用 ``ng lint --fix`` 也是一个不错的方式。 随后,我们在 push 代码之前,即 ``prepush``,进行了测试及 Angular 的构建 production 的脚本。由于单元测试运行得相当的快,它可以在几分钟内完成,快速对问题做出响应。而不是等到持续集成出问题时,再去修复。 但是 Git 提高了这一种的种选项,也提供了一个 ``--no-verify`` 的参数。它可以让开发者不需要进行上面的验证,就能提交代码。 我们往往无法阻止别人做这样的事情,特别是当出现多个团队协作的时候。 难以防范的危险提交 --- 原本,我想将标题取为 “有风险的提交”,但是我觉得危险的提交更为可靠。 常见的有要去吃饭了、要下班了、要开会了等等,临走前提交了一下代码。功能可能本身没有问题,但是它 block 后续的一系列行为。 当然了出现不可坑的因素,如地震、火灾等的时候,就不需要考虑这些事情了。 只是有了这些规范和实践,可以帮助我们开发出更稳定的 Web 应用。 结论 --- 开发速度和质量,是一个难以平衡的天平。在不同的时间里,我们应该做不同的技术决策。

就我而言,一年里我也没写出几篇让自己满意的文章。因为写一篇好的技术文章真的很难。

Feeds

RSS / Atom

最近文章

关于作者

Phodal Huang

Engineer, Consultant, Writer, Designer

ThoughtWorks 技术专家

工程师 / 咨询师 / 作家 / 设计学徒

开源深度爱好者

出版有《前端架构:从入门到微前端》、《自己动手设计物联网》、《全栈应用开发:精益实践》

联系我: h@phodal.com

微信公众号: 最新技术分享

存档

分类

标签

作者