代码之旅:基础规范

在设计架构的时候,要考虑由下而上的模式,底层的实践最终会影响整个系统的架构。再好的架构,如果没有辅以有效的工程实践,那么最终我们得到的只是一只空有其表的架构方案。能自下而上影响软件架构的,就只有代码了。

代码本身是一种难以衡量的实践。同一个业务功能有不同的代码实现。想象一个场景,我们对外提供了一个 RESTful API 接口,是不是只要我们能以规范的方式提供这个RESTful API 接口,代码的实现方式和质量就变得不重要了?

从短期来看,如果一个API能快速地提供功能以驱动业务增长,那么它就就是一个成功的 API。不论其设计得多么丑陋,代码质量多差,只要不影响性能,未来就有改进的空间。可是从长期来看,API是要能够面向变化而快速拓展的,如果我们不能方便地在 API 中拓展功能,那么它就真的会影响业务了。尽管重构的代码可以帮助我们走向更好的架构,但是在业务进度不合理的情况下,我们只能在旧的、丑陋的代码上不断堆砌功能。直至有一天,我们愉快地选择重写系统。

在本节里,我们将讨论代码中的一些基础规范,他们更多地关注代码的可读性,而不是代码的质量,我们会在后面的章节里关注代码质量。为了提升代码的可读性,我们需要做到以下的几方面:

  • 规范代码组织结构

    • 统一代码风格,即源代码的书写风格
    • 组件、函数等命名规范
    • 开发工具规范

光看这几点要求,总觉得似乎多了很多条条框框。尽管这种统一性会扼杀团队的多样性,但是对于代码层次的风格统一是相当有必要的。

在这些实践中,有些并不仅仅是实践,他还反应了架构的模式,如代码组织结构 —— 从代码的组织构架上,我们可以真真切切地感受到他与系统架构的相似之处。由于应用内的代码复用采用组件化的架构,所以我们应该隔离不同的组件。比如,在 Angular 生成的组件 component 中,我们就可以看到一种组件完全独立的存在形式。

本文由博客一文多发平台 OpenWrite 发布!

(0)

相关推荐

  • 没有它,你的 DevOps 可能玩不转

    善用兵者,役不再籍,粮不三载.取用于国,因粮于敌,故军食可足也. --<孙子兵法> 在古代,带兵作战的将领,不仅要能善于用兵,而且要能保障粮食的充足.正所谓兵马未动,粮草先行.粮草永远摆在 ...

  • 微服务分解策略

    微服务架构的关键思想是功能分解.这意味着您无需开发单个大型应用程序,就可以将您的应用程序结构分解为一组逻辑服务. 应用程序的体系结构很重要,因为它决定了服务的质量 传统目标:可伸缩性,可靠性和安全性. ...

  • 低代码开发平台

    今天准备再谈下对低代码开发平台的扩展思考,最近2到3年,低代码开发平台可以算作一个小热点,不论是传统的BPM厂家,还是原来的快速开发平台厂家,包括还有一些中台建设厂家都逐步推出自己的低代码开发平台. ...

  • 如何实现云原生?这些云原生工具很关键!

    K8S中文社区 60篇原创内容 公众号 云原生技术可帮助我们更快地交付软件产品,同时降低 IT 运营成本.本文介绍了如何实现云原生,以及一些可以使用的云原生项目. 作者:Kentaro Wakayam ...

  • 工程师的工作实践:SOA 开发基础 (下)

    上篇中从我的理解向大家介绍了"什么是SOA",下篇还是继续原本的打算,梳理一下做SOA开发(本篇指的是智能座舱中SOA开发)需要具备的领域知识体系. 今天要做的梳理,没有思维导图, ...

  • 【答题规范】高考化学专题复习与增分策略:回扣基础 规范答题:考场评分细则与答题规范

    考场评分细则与答题规范(一)明确高考评分原则1.化学用语的"规范化"给分原则化学专用名词中出现错别字(甚至白字)都要参照标准扣分.化学方程式.离子方程式未配平.条件错误或不全等都不 ...

  • 代码搜索引擎:基础篇

    0. 引入 最近,我们遇到了两个场景: 负责基础服务的工程师想下线一个接口但不知道有哪些服务调用 负责 APM 系统的工程师想知道任意 RPC 接口的所有上游调用方 仔细分析不难发现,二者的本质都在于 ...

  • 06 | 基础规范:如何理解 JDBC 关系型数据库访问规范?

    从今天开始,我们将进入 Spring Boot 另一个核心技术体系的讨论,即数据访问技术体系.无论是互联网应用还是传统软件,对于任何一个系统而言,数据的存储和访问都是不可缺少的. 数据访问层的构建可能 ...

  • 中国民法典请求权基础规范梳理及检索顺序-第1版

    王泽鉴:请求权基础的寻找,是处理案例.法律适用的核心工作.在某种意义上甚至可以说,处理案例就在于寻找请求权基础.请求权基础是每一个学习法律的人必须彻底了解,确实掌握的基本概念及思考方法. " ...

  • 【驼人教育·科技教育】科技教育的基础规范

    一.科技内容的三大方面 1. 驼人企业科技创新内容精选: 2. 教材中的教学难点直观展示: 3. 学生日常生活中的科技展示. 二.科技教育的四大目的 1. 了解医疗器械方面的科学技术: 2. 突破学科 ...

  • 规范详解:消防救援站基础规范培训

    ♚ 视频 ♚ 语音 ♚ PPT 规范详解:规范详解系列200集(表单版) 注:以上200集中标号3的链接错误,应如下: 消防视频:消防规范上的火灾危险性分类 201. 规范详解:新版消防应急照明规范中 ...

  • 初学者怎样看懂代码?零基础学编程教你快速理解代码!

    在学习编程的初期,看不懂代码是非常正常的现象,因为程序代码的背后涉及到编程语法.资源整合.算法设计.数据结构等一系列内容,要想搞清楚这些代码的含义,必须为自己制定一个系统的学习计划. 初学者学习代码的 ...

  • 最基础的Python知识学会这些已足够你开始写Python代码了

    https://m.toutiao.com/is/eD2TWLh/ (Python不用大括号标识代码结构使用空白符和缩进来标识代码块)上述最后两行代码就是while循环体,就是因为它们紧随while语 ...

  • 跟着宝利老师去旅行:初遇新疆——新疆之旅的基础攻略

    读万卷书,行万里路. 路上所遇风土人情.名胜古迹,均可以助力你的成长,增长你的见识. 这次,宝利老师带你去新疆. 本次为行程攻略,具体游记后续,欢迎关注! 去有些地方,需要狠狠地下决心.新疆算一个.因 ...