高级 PHP 工程师必备的编码技巧及思维

高级 PHP 工程师必备的编码技巧及思维

大家好,又见面了,我是全栈君。

好的开发者通常以代码质量来定义。在软件行业,写好的代码意味着在在测试,更新,扩展或者修复漏洞中省钱。本文,我将向你展示一些现实生活中技巧和想法的例子,来帮助你清理你的逻辑代码,重构它,让它变得更健壮和模块化。这些技巧将不仅仅帮助你重构你的旧代码,而且给你一些如何从现在开始写出简洁代码的好建议。

 

什么是重构,为什么我们需要它?

重构是指帮助我们写简洁代码的方法和步骤。这对其他可能阅读,扩展和不需要怎么编辑来复用我们代码的其他开发者来说是很重要的。

 

下面的内容将向你展示一些重构逻辑代码,让它变得更好的例子。

 

不要在没有单元测试的情况下重构生产环境的代码

我的第一条建议是从不在没有完全进行单元测试的情况下开始重构逻辑代码。我的理由是:你将会以很难有修复的损坏的功能收尾,因为你也很难指出是哪里损坏了。因此,如果你要重构它,从测试开始。保证你准备重构的部分被测试覆盖到。PHPUnit 代码覆盖分析.

 

从你代码最底层开始重构

看一下下面的图片。这是一个我从 Github 找到的真实的酒店管理系统项目。这是一个开源的项目,可想闭源项目将是糟糕的。

高级 PHP 工程师必备的编码技巧及思维

示例:从底层开始重构

你看这个代码,这里用红色标出了三个层级。最底层应该是在第一个 if 条件下被 if/else 包围的申明。通常,最底层是集中在单一逻辑处理,比较容易重构。

 

让你的方法更短,分解它们到更小的方法或者配置文件 / DB 表

也许在这里,我们可以向下面一样提炼它到一个私有方法:

高级 PHP 工程师必备的编码技巧及思维

使你的方法更短

 

下一个深入点将是上传参数和加载视图。现在,再来看看在重构其他部分之后的 add() 方法。它变得更加简洁,易读,易于测试。

高级 PHP 工程师必备的编码技巧及思维

示例:首先重构最底层

 

if 申明坚持使用大括号

大多数编程语言都支持单行 if 申明,因为这样比较简单,所以一些开发就这么使用,但是这样不便于阅读,而且容易造成问题,因为一个空行就可以中断条件造成崩溃。看下下面两个示例的不同:

高级 PHP 工程师必备的编码技巧及思维

示例:使用大括号

 

别使用魔术数字或者魔术字符串:

下个示例中,你注意到如果房间超过 250 ,会返回一个错误信息。这里,250 就被认为是一个魔术数字。如果你不是写这个的开发者,很难指出这个数字表示什么。

高级 PHP 工程师必备的编码技巧及思维

示例:魔术数字

 

为了重构这个方法,我们可以指出 250 表示最大的房间数。为了替换硬编码,我们可以提取它到一个变量 $maxAvailableRooms 。现在对其他开发者来说,它变得更易被理解。

高级 PHP 工程师必备的编码技巧及思维

示例:修复魔术数字

 

不要使用 else 申明,如果你不是真的需要:

在相同的 availablerooms () 函数中,你注意到那个 if 申明, 其中我们可以很容易摆脱 else 部分,而且逻辑保持一致。

高级 PHP 工程师必备的编码技巧及思维

示例:忽略 else 申明

 

使用能够表示你的方法,变量和测试的命名

在后面的示例中,你会发现酒店管理系统有两个方法分别是 “index () ” 和 “ room_m () ”。对我来说,我搞不清它们的目的是什么。我认为它应该很容易被理解,如果它们的命名都能够描述自己。

高级 PHP 工程师必备的编码技巧及思维

示例:不好的方法命名

 

充分利用你的编程语言的功能

许多开发者不会利用到他们使用的编程语言的全部功能。很多功能能够节约你们的的时间,而且能够让你们的代码更健壮。看下下面的示例,注意如何在更少代码情况下更容易达到相同的结果的,通过使用类型提示。

 

高级 PHP 工程师必备的编码技巧及思维

高级 PHP 工程师必备的编码技巧及思维

最后,我想提供一些关于更好编码的快速提示:

 

  • 使用新的数组形式 [] 替代旧的 array ()。

  • 除非不检查数据类型很重要,否则使用 === 操作符替代 ==。

  • 给公共方法提供简短的描述性名称总是一个好主意。私有方法可以使用更长的名称,因为它们的适用范围比较有限。

  • 仅对实现接口的方法使用通用名称例如 add (),并对单个类方法使用描述性名称例如 addUser () 或 addDocument ()。

  • 从类中删除未使用的方法。

  • 对返回值为 boolean 等的函数使用 is/has 前缀:isAdmin ($user),hasPermission ($user)。

  • 始终在类方法和属性中使用访问修饰符。

  • 注意接口污染:仅使用用户可以公开使用的方法。

  • 在公共方法位于顶部的位置组织类方法。

  • 始终在类中应用单一职责的概念。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/111850.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • jdk动态代理和cglib动态代理详解

    jdk动态代理和cglib动态代理详解本文内容概括:静态代理概述 基于继承方式实现静态代理 基于聚合方式实现静态代理 jdk动态代理实现 如何实现一个HashMap的动态代理类 cglib动态代理实现 jdk和cglib代理的区别 动态代理和静态代理的区别 spring如何选择jdk和cglib代理如上图,代理模式可分为动态代理和静态代理,我们比较常用的有动态代理中的jdk动态代理和Cglib代理,像spr…

    2022年5月16日
    34
  • python 安装CV2

    通常一个指令pipintsallopencv-python大多数的情况下,是可以的安装成功CV2,可是有时,这个指令安装的pip会出现CV2版本与python安装的版本,不匹配导致,你安装的opencv不成功,个人示例:1.先更新pippython-mpipinstall–upgradepip 2.从清华的镜像 `https://pypi.tuna.tsingh…

    2022年4月8日
    193
  • MATLAB中imfill()函数[通俗易懂]

    MATLAB中imfill()函数[通俗易懂]函数功能:该函数用于填充bai图像区域和“空洞”。语法格式:BW2=imfill(BW)这种du格式将一张二值图像显示在屏zhi幕上,允许用户使用鼠标在图像上点几个点,这几个点围成的区域即要

    2022年8月4日
    5
  • OpenCV-Python教程(8、Canny边缘检测)

    OpenCV-Python教程(8、Canny边缘检测)本篇文章介绍如何用OpenCV-Python来使用Canny算子。提示:转载请详细注明原作者及出处,谢谢!本文介绍使用OpenCV-Python实现基本的滤波处理本文不介详细的理论知识,读者可从其他资料中获取相应的背景知识。笔者推荐清华大学出版社的《图像处理与计算机视觉算法及应用(第2版)》。原型OpenCV-Python中Canny函数的原型为:edge

    2022年5月30日
    35
  • C# 中List与json字符串的相互转换「建议收藏」

    C# 中List与json字符串的相互转换「建议收藏」将list转换成json字符串List<HingeType>hinges=[{id:1,name:hingeOne},{id:2,name:hingeTwo},···];StringhingeString=Newtonsoft.Json.JsonConvert.SerializeObject(hinges);将json字符串转换成listList<HingeType>hingeList=Newtonsoft.Json.JsonConvert.Deseria

    2022年10月17日
    0
  • 《生物化学与分子生物学》—-绪论—-听课笔记(一)

    《生物化学与分子生物学》—-绪论—-听课笔记(一)[华中科技大学]生物化学与分子生物学绪论1.1生物化学与分子生物学绪论(1)生物化学(Biochemistry、Biologicalchemistry):研究生物体(微生物、植物、动物及人体)的化学组成和生命过程中的化学变化规律的科学。 分子生物学(MolecularBiology):生物化学有机地融合了微生物学、遗传学和细胞生物学的有关知识—-形成了现代的分子生物学。它…

    2022年7月11日
    11

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号