PHP程序员需要注意的代码规范PSR有哪些?

更新日期: 2022-08-25阅读: 804标签: 规范

再次仔细的看了一下关于php代码的书写规范,我发现自己确实有很多不足的地方,需要改进,PHP代码遵循PSR(PHP Standard Recommendation)规范,之前忘了看哪本书看到psr4,psr4优化的是composer的依赖倒置,现在已经到psr18了,官网链接 php-fig(https://www.php-fig.org/psr/) 。

代码如果写的很随意,就会显得自己不专业,也会给别人的阅读带来不便。

1、变量、函数写法驼峰

我之前的代码里就是变量有下划线、有驼峰非常不标准

public function readMessage()

{

$fdServer = new FdServer();

$countServer = new CountServer();



$toUid = $this->request->getToUid($this->body['to_uid']);

$syncStamp = $this->request->getSyncStamp($this->body['syncstamp']);

##略

}

2、如果只是当前类使用,不涉及外面的类调用,控制权限给private,方法名用下划线,如果返回数据,返回数据类型最好也保持统一。

private function _formatData($data)

{

if(!$data) return [];



foreach ($data as $val){

//...略

}



return $data;

}

3、if条件和嵌套

个人习惯如果是if最好是加上{},也有人习惯不加,没有权威手册说加好还是不加好。

function getPayAmount() {

let result;

if (isDead)

result = deadAmount();

else {

if (isSeparated)

result = separatedAmount();

else {

if (isRetired)

result = retiredAmount();

else

result = normalPayAmount();

}

}

return result;

}

优化后,是不是清爽了太多?

function getPayAmount() {

if (isDead) return deadAmount();

if (isSeparated) return separatedAmount();

if (isRetired) return retiredAmount();

return normalPayAmount();

}

4、重复2次的地方,要写一个函数处理

写函数处理代码的好处是修改时可以统一修改,方便调用,而且在性能上也更优,PHP的底层调用函数结束后,释放资源,如果不分离代码,需等待全部程序执行完毕在统一释放。

5、ORM层数据库的链式调用,ORM主要是采用面向对象的思想对数据库进行操作。

Model::create()->where('status', 1)->where(' (id > 10 or id <2) ')->get();

底下的链式对Sql执行进行了预处理,防止Sql注入

public function getNovelApplyCount(int $nid)

{

$sql = "SELECT COUNT(*) number FROM {$this->table}

WHERE `novel_id` = :novel_id";

$data = [

':novel_id' => $nid,

];



$tag = $this->getNovelTag($nid);

$res = $this->dao->conn(false)->setTag($tag)->preparedSql($sql, $data)->fetchOne();

return $res['number'] ?? 0;

}

6、PHP5到PHP7的变化

虽说现在已经8.0了,但还是很有必要看一下的。PHP5最重要的特性就是丰富了面向对象的设计和语法,PHP7最大的特性就是提升了性能,PHP7还有个小细节是弱类型语法像强类型语法转变的风格,参数做了很大的限制。我个人猜想可能是限制了数据类型,考虑的是性能的提升,底层少了一层类型转化。

protected function onRequest(?string $action): ?bool

{

//接收参数

$this->params = $this->request()->getRequestParam();

$this->method = $this->request()->getMethod();

return true;

}



private static function _formatQueryData(string $loginKey): string

{

$data['timestamp'] = time();

$data['loginKey'] = $loginKey;

$token = self::setToken($data);

$data['token'] = $token;

$params = http_build_query($data);

return $params;

}

7、代码列最好不要超过120,单个函数不要超过100行(psr2原文)

There MUST NOT be a hard limit on line length.



The soft limit on line length MUST be 120 characters; automated style checkers MUST warn but MUST NOT error at the soft limit.



Lines SHOULD NOT be longer than 80 characters; lines longer than that SHOULD be split into multiple subsequent lines of no more than 80 characters each.



There MUST NOT be trailing whitespace at the end of non-blank lines.



Blank lines MAY be added to improve readability and to indicate related blocks of code.



There MUST NOT be more than one statement per line.

8、psr14的主题是Event Dispatcher,大概就是把定义的对象写在调用函数里。

class WebSocketEvent

{

const MYSQL_CONN_NAME = 'mysql-msg';

/**

* @param \Swoole\Http\Request $request

* @param \Swoole\Http\Response $response

* @return bool

*/

public function onHandShake(\Swoole\Http\Request $request, \Swoole\Http\Response $response)

{

/** 此处自定义握手规则 返回 false 时中止握手 */

if (!$this->customHandShake($request, $response)) {

$response->end();

return false;

}



/** 此处是 RFC规范中的WebSocket握手验证过程 必须执行 否则无法正确握手 */

if ($this->secWebsocketAccept($request, $response)) {

$response->end();

return true;

}



$response->end();

return false;

}

}

9、代码分层

就像Tcp/Ip协议一样,复杂的处理过程就是进行人为的逻辑分层,PHP的分层有之前的MVC和现在流行的DDD模式,有人说MVC是滴血模式,我个人觉得MVC也是很好用的,不能网上流行什么我们就用什么,主流的一般都是大公司的处理方式和模式,可是互联网一共有多少大公司呢,开发者要有自己的思维方式,用什么看具体的业务需要。

10、PhpStrom的设置

命名规范还有个小窍门,如果是命名不规范,PHPstrom会提示绿色波浪线,注释不规范就会提示黄色波浪线,下面是不规则的Demo。


Mac格式化代码:shift+alt+command+l

链接: https://fly63.com/article/detial/12049

web开发,前后分离接口规范

目前我们现在用的前后端分离模式属于第一阶段,下一阶段可以在前端工程化方面,对技术框架的选择、前端模块化重用方面,可多做考量。也就是要迎来“==前端为主的 MV* 时代==”。

js中箭头函数的编码规范,如何更好的使用箭头函数

当您必须使用匿名函数,请使用箭头函数表示法,它创建了一个在 this 上下文中执行的函数的版本,这通常是你想要的,而且这样的写法更为简洁。如果你有一个相当复杂的函数,你或许可以把逻辑部分转移到一个声明函数上。

用standard来管理JavaScript 代码规范

standard是一个开源的JS代码规范库,制定了所谓standard(标准)的JS代码规范,配合编辑器插件可以实时检查代码规范以及语法错误,通过执行命令检查代码规范以及语法错误,自动修复(可以直接修复的)不合规范的代码,使其符合规范

Web 前端开发代码规范(基础)

对于一个多人团队来说,制定一个统一的规范是必要的,因为个性化的东西无法产生良好的聚合效果,规范化可以提高编码工作效率,使代码保持统一的风格,以便于代码整合和后期维护。

Node.js的模块加载机制(CommonJS规范)

为了编写可维护的代码,我们把很多函数分组,分别放到不同的文件里,这样,每个文件包含的代码就相对较少,很多编程语言都采用这种组织代码的方式。在Node环境中,一个.js文件就称之为一个模块(module)

web前端js中ES6的规范写法

引号的使用,单引号优先(如果不是引号嵌套,不要使用双引号)、空格的使用问题:(关键字后 符号后 排版 函数 赋值符号= )等、不写没有使用过的变量,如果定义了一个变量,后来一直没有参与过运算,那么不应该定义这个变量...

编码规范_html代码规范化编写

嵌套的节点应该缩进;在属性上,使用双引号,不要使用单引号;属性名全小写,用中划线做分隔符;不要在自动闭合标签结尾处使用斜线(HTML5 规范 指出他们是可选的);不要忽略可选的关闭标签;

CommonJS 规范中的 module、module.exports 区别

CommonJS规范规定,每个模块内部,module变量代表当前模块。这个变量是一个对象,它的exports属性(即module.exports)是对外的接口。加载某个模块,其实是加载该模块的module.exports属性。module.exports属性表示当前模块对外输出的接口

W3C 代码标准规范

W3C通过设立领域(Domains)和标准计划(Activities)来组织W3C的标准活动,围绕每个标准计划,会设立相关的W3C工作组织(包括工作组、社区组、商务组等)。W3C会根据产业界的标准需求调整Domains和Activity的设置及相关的工作组设置。

css3代码书写规范

不要使用 @import 与 <link> 标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。CSS有些属性是可以缩写的,比如padding,margin,font等等,这样精简代码同时又能提高用户的阅读体验。

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!