热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

11个PHPer必须要了解的编程规范

从设计之初,PHP被广泛用于开发基于Web的应用程序。由于PHP是一种脚本语言,开发的时候必须遵守一些规范。
本文将讨论常用的良好的代码习惯,或者称为代码规范,在PHP领域。

1,错误报告开启

错误报告是在PHP中一个非常有用的功能,应同时在开发阶段启用。 这可以帮助我们确定我们的代码中的问题。 最常用的功能是“E_ALL”,这有助于我们发现所有的警告和严重错误。 必须指出的是,我们把我们的代码投入上线前,我们应该关闭这个功能提示,否则会在浏览器上的暴漏所有潜在错误及警告。

2,使用DRY原则

‘Do not Repeat Yourself',DRY原则指的是不要重复你的代码.。 这个概念是一个非常有用的编程概念,可硬应用在任何编程语言,如Java,C#或PHP均可以。 使用DRY原则,确保我们在程序中没有冗余的代码。
违反 DRY 原则的解决方案通常被称为 WET,指代“write everything twice”,我们写的相同功能的代码会出现多次以上,别大家戏称是喜欢打字。

让我们看看到下面的代码:
Listing1:
WET代码方式:

$mysql = mysql_connect ( 'localhost', 'mysqladmin_uid', 'mysqladmin_pwd' );
mysql_select_db( 'DB_NAME' ) or die( "Sorry !! No database selected!");

下面使用DRY 原则优化代码:

$db_host = ' localhost ';
$db_user = ' mysqladmin_uid ';
$db_password = ' mysqladmin_pwd ';
$db_database = ' DB_NAME ';
$mysql = mysql_connect($db_host, $db_user, $db_password);
mysql_select_db($db_database);

3,适当的使用缩进及空格

在使用任何一种编程语言编写代码时,必须确保代码在需要的地方提供在必要适当的缩进和足够的空格。 以增加了代码的可读性,用更有效的方式管理代码。

4,使用有意义和一致的命名标准

正如任何编程语言,PHP的老兵还建议我们遵循有意义的命名标准。 我们有两个主要方式在实现这个要求:
A.驼峰式
在这种方法中,第一个字母是小写,每一个单词的第一个字母其后以大写。

Listing2:

public class MyClass {
public void methodName(String argName) {
}
}

B.下划线式
在这种方法中,我们把每两个词之间的下划线(“_”)。 使用这种方法时,代码可以被修改如下:
Listing3:使用下划线代码片段

public class MyClass {
public void method_name(String arg_name) {
}
}

5,避免深层嵌套

使用任何开发语言,多级嵌套降低了代码的可读性。 任何开发者都应应避免使用深层嵌套。

Listing4:代码片段具有多级嵌套

<&#63;php
class MyClass {
public function method_name($arg_name) {
if (is_writable ( $folder )) {
if ($fp = fopen ( $file_location_path, 'w' )) {
if ($stuff = extractSomeConditionalStuff ()) {
if (fwrite ( $fp, $stuff )) {
// ...
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
}
}
&#63;>

上面的代码是一个简单的嵌套代码。 我们可以看到它是非常困难的,如果块结束哪里的身影。 为了更好的可读性,让我们修改的代码:
Listing5:代码片段,避免多级嵌套

function method_name (String arg_name) {
// ...
if (! is_writable ( $folder )) {
return false;
}
if (! $fp = fopen ( $file_location_path, 'w' )) {
return false;
}
if (! $stuff = extractSomeConditionalStuff ()) {
return false;
}
if (fwrite ( $fp, $stuff )) {
// ...
} else {
return false;
}
}

6,添加应有的注释

开发中,请确保你的源代码中有足够的行内注释。 这是一个应该遵守的标准做法。 这有助于深入分析代码,因为通常情况下,负责编码的人不会一直保持不变。 即使同一个人被要求在代码中进行一些简单的修改,行内的注释总是会有助于理解当时编写代码是用来做什么的。 为了在PHP中使用较好的注释标准,建议大家去查看一些标准的PHP文档包,例如phpDocumentor。

7,不要把PHPINFO()函数在网站根目录

phpinfo()函数是一个非常重要的功能,应小心使用。 使用此功能,任何人都可以看到服务器环境的详细信息。它最好始终放在
一个安全位置的文件中使用,一旦开发完成上线后,应该删除这段代码使用。

8,永远不要相信用户

如果您的应用程序涉及任何用户输入,务必要编写安全的代码以处理这种方式,因为它包含各种可能的输入。 想要避免程序被攻击注入或者破坏数据完整性,一定要验证过滤数据的格式。大家可以看下这篇文章《可怕的代码注入方式》

9,合理使用缓存机制

良好的编程方法总是建议使用缓存机制缓存帮助我们获得更好的性能。

在PHP的世界,缓存使用来实现:
Memcached的 —— 一个在使用小数据块存储键值对存 储。
APC —— 可选PHP缓存为开放的PHP操作码缓存
XCache —— 一种快速可靠的PHP操作码缓存
Zend Cache – API,用于实现先进的高速缓存功能的集合。
eAcclerator – 开源的缓存工具

10,避免复制已有变量

将预定义变量复制到具有较小的名字的局部变量不是一个好的编程习惯。 这对应用程序的性能产生不利影响。 让我们来看看下面的代码片段:
Listing6:复制已有变量

$desc = strip_tags($_POST['PHP description']);
echo $desc;

上面的代码的代码是复制一个变量为局部变量不必要的例子。 这是不是一个好的做法。同样的效果可以通过使用下面的代码来实现:

echo strip_tags($_POST['PHP description']);

11,使用框架

框架是大量的研究后开发的,因此,他们被证明是问题较少。 它们使我们的开发更便捷,因为它们提供成熟的解决方案。 在PHP中有很多可用的框架。 在开发过程中,你应该利用这些。 其中的一个框架,被广泛采用的是MVC或模型视图控制器。

结论:

编程规范指导我们更有效的开发代码。

遵循编程规范,确保应用程序的更好的性能。

正如在其他编程语言,要想创造出高质量的代码,PHP也需要遵循这种良好的编程规范。

推荐阅读
  • 浅解XXE与Portswigger Web Sec
    XXE与PortswiggerWebSec​相关链接:​博客园​安全脉搏​FreeBuf​XML的全称为XML外部实体注入,在学习的过程中发现有回显的XXE并不多,而 ... [详细]
  • 背景应用安全领域,各类攻击长久以来都危害着互联网上的应用,在web应用安全风险中,各类注入、跨站等攻击仍然占据着较前的位置。WAF(Web应用防火墙)正是为防御和阻断这类攻击而存在 ... [详细]
  • 本文介绍了Python高级网络编程及TCP/IP协议簇的OSI七层模型。首先简单介绍了七层模型的各层及其封装解封装过程。然后讨论了程序开发中涉及到的网络通信内容,主要包括TCP协议、UDP协议和IPV4协议。最后还介绍了socket编程、聊天socket实现、远程执行命令、上传文件、socketserver及其源码分析等相关内容。 ... [详细]
  • 本文介绍了在开发Android新闻App时,搭建本地服务器的步骤。通过使用XAMPP软件,可以一键式搭建起开发环境,包括Apache、MySQL、PHP、PERL。在本地服务器上新建数据库和表,并设置相应的属性。最后,给出了创建new表的SQL语句。这个教程适合初学者参考。 ... [详细]
  • 搭建Windows Server 2012 R2 IIS8.5+PHP(FastCGI)+MySQL环境的详细步骤
    本文详细介绍了搭建Windows Server 2012 R2 IIS8.5+PHP(FastCGI)+MySQL环境的步骤,包括环境说明、相关软件下载的地址以及所需的插件下载地址。 ... [详细]
  • PHP设置MySQL字符集的方法及使用mysqli_set_charset函数
    本文介绍了PHP设置MySQL字符集的方法,详细介绍了使用mysqli_set_charset函数来规定与数据库服务器进行数据传送时要使用的字符集。通过示例代码演示了如何设置默认客户端字符集。 ... [详细]
  • 本文介绍了如何使用php限制数据库插入的条数并显示每次插入数据库之间的数据数目,以及避免重复提交的方法。同时还介绍了如何限制某一个数据库用户的并发连接数,以及设置数据库的连接数和连接超时时间的方法。最后提供了一些关于浏览器在线用户数和数据库连接数量比例的参考值。 ... [详细]
  • 如何在服务器主机上实现文件共享的方法和工具
    本文介绍了在服务器主机上实现文件共享的方法和工具,包括Linux主机和Windows主机的文件传输方式,Web运维和FTP/SFTP客户端运维两种方式,以及使用WinSCP工具将文件上传至Linux云服务器的操作方法。此外,还介绍了在迁移过程中需要安装迁移Agent并输入目的端服务器所在华为云的AK/SK,以及主机迁移服务会收集的源端服务器信息。 ... [详细]
  • 众筹商城与传统商城的区别及php众筹网站的程序源码
    本文介绍了众筹商城与传统商城的区别,包括所售产品和玩法不同以及运营方式不同。同时还提到了php众筹网站的程序源码和方维众筹的安装和环境问题。 ... [详细]
  • MySQL中的MVVC多版本并发控制机制的应用及实现
    本文介绍了MySQL中MVCC的应用及实现机制。MVCC是一种提高并发性能的技术,通过对事务内读取的内存进行处理,避免写操作堵塞读操作的并发问题。与其他数据库系统的MVCC实现机制不尽相同,MySQL的MVCC是在undolog中实现的。通过undolog可以找回数据的历史版本,提供给用户读取或在回滚时覆盖数据页上的数据。MySQL的大多数事务型存储引擎都实现了MVCC,但各自的实现机制有所不同。 ... [详细]
  • 本文介绍了互联网思维中的三个段子,涵盖了餐饮行业、淘品牌和创业企业的案例。通过这些案例,探讨了互联网思维的九大分类和十九条法则。其中包括雕爷牛腩餐厅的成功经验,三只松鼠淘品牌的包装策略以及一家创业企业的销售额增长情况。这些案例展示了互联网思维在不同领域的应用和成功之道。 ... [详细]
  • 数据库锁的分类和应用
    本文介绍了数据库锁的分类和应用,包括并发控制中的读-读、写-写、读-写/写-读操作的问题,以及不同的锁类型和粒度分类。同时还介绍了死锁的产生和避免方法,并详细解释了MVCC的原理以及如何解决幻读的问题。最后,给出了一些使用数据库锁的实际场景和建议。 ... [详细]
  • 从壹开始前后端分离【 .NET Core2.0 +Vue2.0 】框架之六 || API项目整体搭建 6.1 仓储模式
    代码已上传Github+Gitee,文末有地址  书接上文:前几回文章中,我们花了三天的时间简单了解了下接口文档Swagger框架,已经完全解放了我们的以前的Word说明文档,并且可以在线进行调 ... [详细]
  • 弹性云服务器ECS弹性云服务器(ElasticCloudServer)是一种可随时自助获取、可弹性伸缩的云服务器,帮助用户打造可靠、安全、灵活、高效的应用环境 ... [详细]
  • 【BP靶场portswigger服务端10】XML外部实体注入(XXE注入)9个实验(全)
    前言:介绍:博主:网络安全领域狂热爱好者(承诺在CSDN永久无偿分享文章)。殊荣:CSDN网络安 ... [详细]
author-avatar
mobiledu2502857893
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有