【PHP開發規範】老生常談的編碼開發規範你懂多少？

時間 2020-05-15

原文原文鏈接

【PHP開發規範】老生常談的編碼開發規範你懂多少？

這幾天看了一下阿里技術發佈的一套Java開發規範《阿里巴巴Java開發手冊》，裏面寫了阿里內部的Java開發規範標準，寫的很好。這套Java統一規範標準將有助於提升行業編碼規範化水平，幫助行業人員提升開發質量和效率、大大下降代碼維護成本。php

看完我去搜下了一些PHP的一些開發規範標準，其中瞭解到了PSR規範是PHP行業中經常使用的一套開發標準。感嘆本身學得那麼少，標準的規範這麼晚才發現。html

其實對於新手或者有幾年經驗的開發者來講，這些規範咱們都要掌握的，不少時候咱們作好這些規範，在協同開發中，能提升咱們的開發質量和效率。緩存

什麼是PSR？

PSR 是 PHP Standard Recommendations 的簡寫，由 PHP FIG 組織制定的 PHP 規範，是 PHP 開發的實踐標準。框架

PHP FIG目前已表決經過了 6 套標準，已經獲得大部分 PHP 框架的支持和承認。ide

其中已經經過的有：函數

PSR-1 基礎編碼規範

PSR-2 編碼風格規範

PSR-3 日誌接口規範

PSR-4 自動加載規範

PSR-6 緩存接口規範

PSR-7 HTTP 消息接口規範

*注：其中PSR-0已被棄用，PSR-5還在起草中，之後再補充學習

這裏先介紹PSR-1 基礎編碼規範ui

1. 概覽

PHP代碼文件必須以 <?php 或 <?= 標籤開始；

PHP代碼文件必須以不帶 BOM 的 UTF-8 編碼；

PHP代碼中應該只定義類、函數、常量等聲明，或其餘會產生反作用的操做（如：生成文件輸出以及修改 .ini 配置文件等），兩者只能選其一；

命名空間以及類必須符合 PSR 的自動加載規範：[PSR-4]() 中的一個；

類的命名必須遵循 StudlyCaps 大寫開頭的駝峯命名規範；

類中的常量全部字母都必須大寫，單詞間用下劃線分隔；

方法名稱必須符合 camelCase 式的小寫開頭駝峯命名規範。

2. 文件

2.1. PHP標籤

PHP代碼必須使用 <?php ?> 長標籤或 <?= ?> 短輸出標籤；編碼

必定不可使用其它自定義標籤。spa

2.2. 字符編碼

PHP代碼必須且只可以使用不帶BOM的UTF-8 編碼。（這點很重要）

2.3. 反作用

一份 PHP 文件中應該要不就只定義新的聲明，如類、函數或常量等不產生反作用的操做，要不就只書寫會產生反作用的邏輯操做，但不應同時具備二者。

「反作用」(side effects) 一詞的意思是，僅僅經過包含文件，不直接聲明類、函數和常量等，而執行的邏輯操做。

「反作用」包含卻不只限於：

生成輸出

直接的 require 或 include

鏈接外部服務

修改 ini 配置

拋出錯誤或異常

修改全局或靜態變量

讀或寫文件等

如下是一個反例，一份包含「函數聲明」以及產生「反作用」的代碼：

<?php // 「反作用」：修改 ini 配置
ini_set('error_reporting', E_ALL); // 「反作用」：引入文件
include "file.php"; // 「反作用」：生成輸出
echo "<html>\n"; // 聲明函數
function foo() { // 函數主體部分
}

下面是一個範例，一份只包含聲明不產生「反作用」的代碼：

<?php // 聲明函數
function foo() { // 函數主體部分
} // 條件聲明 **不** 屬於「反作用」
if (! function_exists('bar')) { function bar() { // 函數主體部分
 } }

3. 命名空間和類

命名空間以及類的命名必須遵循 [PSR-4]()。

根據規範，每一個類都獨立爲一個文件，且命名空間至少有一個層次：頂級的組織名稱（vendor name）。

類的命名必須遵循 StudlyCaps 大寫開頭的駝峯命名規範。

PHP 5.3 及之後版本的代碼必須使用正式的命名空間。

例如：

<?php // PHP 5.3及之後版本的寫法
namespace Vendor\Model; class Foo { }

5.2.x 及以前的版本應該使用僞命名空間的寫法，約定俗成使用頂級的組織名稱（vendor name）如 Vendor_ 爲類前綴。

<?php // 5.2.x及以前版本的寫法
class Vendor_Model_Foo { }

4. 類的常量、屬性和方法

此處的「類」指代全部的類、接口以及可複用代碼塊（traits）。

4.1. 常量

類的常量中全部字母都必須大寫，詞間如下劃線分隔。

參照如下代碼：

<?php namespace Vendor\Model; class Foo { const VERSION = '1.0'; const DATE_APPROVED = '2012-06-01'; }

4.2. 屬性

類的屬性命名能夠遵循：

大寫開頭的駝峯式 ($StudlyCaps)

小寫開頭的駝峯式 ($camelCase)

下劃線分隔式 ($under_score)

本規範不作強制要求，但不管遵循哪一種命名方式，都應該在必定的範圍內保持一致。這個範圍能夠是整個團隊、整個包、整個類或整個方法。

4.3. 方法

方法名稱必須符合 camelCase() 式的小寫開頭駝峯命名規範。

參考資料：

https://psr.phphub.org/

------------------------------------------------------------------------------

歡迎關注個人公衆號【phper的進階之路】，將不斷更新各類技術心得，免費提供各類學習資源！！！

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。