主頁 > 後端開發 > PHP-PSR 現代PHPer的開發規范

PHP-PSR 現代PHPer的開發規范

2020-09-24 05:41:09 後端開發

PSR是PHP Standards Recommendation的簡稱,意為PHP推薦標準,要想了解PSR,首先得知道制定這一標準的人/組織是誰————PHP-FIG,

PHP-FIG

PHP-FIG全稱為PHP Framework Interop Group,是一個組織,這個組織的成員由一些PHP框架的代表組成,這些人聚在一起“討論框架之間的共性,尋找可以合作的方式”,PHP-FIG制訂了推薦規范,PHP框架可以自愿實作這些規范,改進其他框架的通信和共享功能,
PHP-FIG的使命是實作框架之間的互操作性,

PSR-1:基本的代碼風格

在文章的最開始,我們就已經簡單介紹過什么是PSR,PSR是PHP標準,而PSR-1是PHP最基本也是最簡單的標準,

PHP標簽

必須把代碼放在<?php ?>或<? ?>標簽中,不得使用其它的標簽句法

這點相信很多PHPer都很容易遵守,而且在現實擼代碼中一般都是采用正常的<?php ?>標簽

編碼

所有PHP檔案都必須使用UTF-8字符集編碼,而且不能有位元組順序標記(Byte Order Mark,BOM)

這個也很常見,就是無BOM和有BOM格式,記得剛開始敲PHP代碼的時候,前輩總是很關照,一定要用IDE調成無BOM格式啊,當時表示懵懂,然后就跟著做了,現在看到這里,又重新查了資料,找到了為什么不能使用有BOM格式的原因,BOM會產生多余的輸出,就像平白無故多了一個空行:

php在處理BOM頭的時候,有時候存在錯誤,可能造成你在使用 headersession_start 之類的函式時,出現 檔案已經輸出的錯誤,多數都是因為BOM頭送出去了,,因為在php看來,成了一個空格,所以使用無BOM的格式

目的

一個PHP檔案可以定義符號(類、性狀、函式、常量等),或者執行有副作用的操作(生成結果或者處理資料),但不能同時做兩件事

這個規定的意思差不多就是一個變數、方法或者一個類,只能相應完成一個操作、做一件事情,這樣保證了代碼的清晰易懂,也保證了方法、變數的單一性,各司其職,其實也是為了方便,我們在以后專案/應用較大時,可以很好的解耦

自動加載

PHP的命名空間和類必須遵守PSR-4自動加載器標準

后續看PSR-4的具體解釋

類的名稱

PHP類的名稱必須使用駝峰式,又名標題式

駝峰式和分詞式(每個單詞用_隔開)這兩種寫法,記得以前存在很大的爭議,有人支持駝峰(GirlFriend),有人支持分詞式(girl_friend),現在好了,統一規定出來了,為了PHP更好的發展,那就委屈支持分詞式的兄弟,統一駝峰了,記得公司的CI2專案,用的就是這種分詞式,不過也是框架規定,后來在自己的專案中,自己有預感的使用了駝峰式,哈哈,為自己的眼光點贊~

常量的名稱

PHP的常量名稱必須大寫;

這點應該是毋庸置疑的吧,最開始寫PHP的時候,這個寫法已經根深蒂固了,

方法的名稱

使用駝峰式(boyFriend)

方法的命名和類的命名方式有些相似,不過還是有些區別:類的命名規定首字母大寫(BoyFriendMoney),而方法的命名規定首字母小寫(boyFriendMoney)

PSR-2:嚴格的代碼風格
PSR-2 相較于PSR-1是更為嚴格的代碼規范,個人和官方都認為開發者應該遵循更為嚴格的代碼標準,在現代的PHP生態系統中,風格統一,可以更好的讓其他開發者理解PHP代碼,

貫徹PSR-1

使用PSR-2 之前先要貫徹PSR-1

縮進

使用四個空格縮進,

關于縮進這個問題,相信有很多爭議,我在真正正視這個問題之前,一直使用的都是IDE的tab鍵,然后當同事和自己在撰寫同一檔案的時候,就會出先代碼縮進不一的情況,導致代碼結構非常亂,所以在出現這個問題之后,就統一了一下檔案縮進的標準,以四個空格為縮進,這樣的話,就算是用不一致的編輯器打開,效果也是一樣的,
很多IDE都可以設定tab鍵,百度一下就可以搜到,

檔案和代碼行

PHP檔案必須使用UNIX風格的換行符(LF),最后要有一個空行,而且不能使用PHP關閉 ?> 標簽,

最開始我也不懂為什么在純PHP頁面中不使用關閉 ?> 標簽,后來在書中找到了答案

為了避免意料之外的輸出錯誤,如果加上關閉標簽,而且在關閉標簽后有空行,那么這個空行也被當成輸出,導致錯誤(例如,設定http首部時)

關鍵字

關鍵字,要使用小寫;

之前不知道在哪兒看的PHP的教程,上面寫的PHP代碼像truefalse這樣的關鍵字都使用的是大寫TRUEFALSE,我也一直在這樣使用,后來看到PSR-2的規范,才知道應該要使用小寫,心累~

命名空間

每個命名空間陳述句后必須跟著一個空行,類似的,使用use關鍵字匯入命名空間或為命名空間創建別名時,在一系列use宣告陳述句后要加一個空行

類似于:

<?php
// 宣告本檔案的命名空間
namespace My\Friend;
 
// 匯入命名空間
use Other\Friend;
 
class GirlFrined
{
 
}

類定義體的起始括號應在類名之后另起一行寫;
類定義體的結束括號必須在定義體之后新起一行寫;

例:

<?php
 
class Frined
{
    public function getSex()
    {
        // do something
    }
}

方法

方法定義體的起始括號應在方法名之后另起一行寫;
方法定義體的結束括號必須在方法定義體之后新起一行寫;

請參考上面類示例中方法的例子,

可見性
1、類中的每個屬性和方法都要宣告可見性,可見性由public、protected或者private指定,其作用是決定在類的內部和外部如何訪問屬性的方法,
2、私有方法的名稱前加上下劃線
3、如果類屬性宣告為abstract和final,這兩個限定符必須放在可見性關鍵字之前
4、如果屬性、方法宣告為static,這個限定符必須放在可見性關鍵字之后
例子:

// 1、2
public $sex;
private $_sex;
protected $sex;
 
// 3、
abstract public $sex;
final public $sex;
 
// 4、
public static $sex;
public static $age;

控制結構
所有控制結構關鍵字后面都要有一個空格,控制結構關鍵字包括:if、elseif、else、switch、case、while、do while、for、foreach、try、catch,如果控制結構關鍵字后面有一對圓括號,起始圓括號后面不能有空格,結束圓括號之前不能有空格,與類和方法的定義體不同,控制結構關鍵字后面的起始括號應該和控制機構關鍵字寫在同一行,控制結構關鍵字后面的結束括號必須寫在單獨一行,

例:

/** 
* 錯誤的示例:
* 這里有4個錯誤:
* 1、if關鍵詞后面和圓括號之前沒有空格
* 2、圓括號前后有空格
* 3、后圓括號和起始括號之前沒有空格
* 4、else關鍵詞前后沒有空格
**/
if( 1 == true ){
    // do something
}else{
    // do something
}
 
/** 
* 正確的示例:
**/
if (1 == true) {
    // do something
} else {
    // do something
}

PSR-3:日志記錄器介面
日志記錄器
PHP-FIG發布的第三個推薦規范和前兩個不同,這個有點特殊,是一個介面,規定PHP日志記錄器組件可以實作的方法,

日志記錄器是物件,用于把不同重要程度的訊息寫入指定的輸出,記錄的訊息用于診斷、檢查和排除應用中的操作、穩定性和性能方面的問題,例如:開發的時候把除錯資訊寫入到文本檔案,把網站的流量統計資訊記錄到資料庫等,
相信基本上所有的框架中都實作了日志功能,那么如果想要使用PSR-3規范的日志記錄器,該怎么做呢?首先要滿足兩點:

日志功能委托給第三方庫實作
最終用戶能選擇他們喜歡的日志記錄器組件
撰寫PSR-3日志記錄器
符合PSR-3推薦規范的PHP日志記錄器組件,必須包含一個實作Psr\Log\LoggerInterface介面的PHP類,PSR-3介面復用了RFC 5424系統日志協議,規定要實作9個方法:

下面的代碼是我從PHP-FIG的官網上拿過來的.

<?php
 
namespace Psr\Log;
 
interface LoggerInterface
{
 
    public function emergency($message, array $context = array());
    public function alert($message, array $context = array());    
    public function critical($message, array $context = array());
    public function error($message, array $context = array());
    public function warning($message, array $context = array());
    public function notice($message, array $context = array());
    public function info($message, array $context = array());
    public function debug($message, array $context = array());
    public function log($level, $message, array $context = array());
}

這個類中的每一個方法都對應RFC 5424協議的一個日志級別,而且都接受兩個引數,第一個引數必須是一個字串,或者有一個__toString()方法的物件,第二個引數為陣列,可選引數;

如果要撰寫符合PSR-3規范的日志記錄器,那么就要創建一個實作Psr\Log\LoggerInterface介面的PHP類,而且要提供這個介面中每個方法的具體實作

使用PSR-3日志記錄器
PSR-3規范出來之后,達到這種效果的組件太多了,這里就不介紹,如何實作這個介面的類了,現在有成熟的日志記錄器組件,推薦monolog/monolog,這個組件完全上線了PSR-3的介面,而且可以使用自定義的訊息格式化程式和處理程式擴展功能,
如果monolog滿足不了日常的使用,我們可以在此基礎上拓展自己的方法,也非常簡單;

使用monolog示例:

<?php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
 
// 準備日志記錄器
$logger = new Logger('my_logger');
$logger->pushHandler(new StreamHandler('logs/development.log', Logger::DEBUG));
$logger->pushHandler(new StreamHandler('logs/production.log', Logger::WARNING));
// 使用日志記錄器
$logger->debug('This is debug message');
$logger->debug('This is warning message');

PSR-4:自動加載器

PHP-FIG發布的第四個推薦規范描述了一個標準的自動加載器策略;自動加載器的意思就是指在程式運行時按需查找PHP類、介面(interface)或性狀(trait)并將其載入加載器,

自動加載器策略

PSR-4推薦規范不要求改變代碼的實作方式,只建議如何使用檔案系統目錄結構和PHP命名空間組織代碼,PSR-4**依賴**PHP命名空間和檔案系統目錄結構查找并加載PHP類、性狀和介面

為什么自動加載器很重要

舉一個很常見的場景,我們引入檔案通常都是采用require、include這樣的方法,這樣的方式簡單也可靠,但是如果我們引入一兩個還好說,但是當我們一個專案運行時需要引入幾十個檔案呢,那我們豈不是要寫幾十個require或者include?這樣既不方便,又不美觀,所以PHP-FIG在此基礎上考慮,規范了一個統一的自動加載器策略;

如何使用自動加載器

建議使用依賴管理器Composer自動生成的PSR-4自動加載器,
現代的PHP框架,laravel、Yii、TP5等都使用了依賴Composer的自動加載器策略,方便我們下載組件和引入合適的類,

PSR-ME:制定自己的PHP規范

  1. 遵循PSR-1、PSR-2的使用規范
  2. 合適、精簡的變數、方法、類命名,能讓人看一眼就清楚是做什么的
  3. 盡量撰寫出高內聚、低耦合的代碼
  4. 保持代碼結構整潔、美觀

總結

PHP-FIG推出的PHP規范,并不一定說所有的PHP開發者必須遵守,制定這一規范的目的就是為了,在全世界的PHP開發者在查看代碼的時候,能更加簡單和輕松,造出來的組件/輪子可以很容易的就被所有開發者熟知和使用,同時也減少了我們的作業投入率,得到更大的作業效率,使產出大于投入,效率更高更快,


轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/116834.html

標籤:PHP

上一篇:Linux 下的這些高效指令,是你快速學習的神器

下一篇:09.DRF-ModelSerializer

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態,例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1:當函式不可能拋出例外或不能接受拋出例外時,使用noexcept 理由 如果不打算拋出例外的話,程式就會認為無法處理這種錯誤,并且應當盡早終止,如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接:https://codeforces.com/problemset/problem/1400/E 來源:Codeforces 思路:給你一個陣列,現在你可以進行兩種操作,操作1:將一段沒有 0 的區間進行減一的操作,操作2:將 i 位置上的元素歸零。最終問:將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯,就附帶了一個自己的翻譯版本 思考 這一題,它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數,這里就不慢慢介紹了。但是,重讀題,我們突然發現反向質數都是 $7$ 位,而將它反過來后的數字卻是 $6$ 位數,這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記:C++中的 const 變數詳解,教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中,會分配記憶體(也就是說可以通過地址間接修改變數的值)。測驗代碼如下: 運行結果: 2、全域const變數存放在只讀資料段(不能通過地址修改,會發生寫入錯誤), 默認為外部聯編,可以給其他源檔案使用(需要用extern關鍵字修飾) 運行結果: ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中,添加資源 2. 點擊新添加的資源,復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案,編輯,使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索,點擊查找全部,然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h,在其中預先定義好宏 ID(不清楚其實ID值應該設定多少,可以先新建一個相同的資源項,再在這個資源的ID值的基礎上遞增即可) 2. 在資源視圖中選中專案資源,按F7編輯資源檔案,按 ID 型別 相對路徑的形式添加 資源。(別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記:關于C++的參考型別,專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考,也叫別名。 參考就是給一個變數名取一個變數名,方便我們間接地使用這個變數。我們可以給一個變數創建N個參考,這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間,占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名,但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++:初學者完整指南

    眾所周知,C ++的學習曲線陡峭,但是花時間學習這種語言將為您的職業帶來奇跡,并使您與其他開發人員區分開。您會更輕松地學習新語言,形成真正的解決問題的技能,并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣(即清晰一致的編碼風格,在撰寫代碼時注釋代碼,并限制類內部的可見性),并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標(smart pointers)是一類資料結構,是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標(pointer)是一個包含記憶體地址的變數的通用概念。這個地址參考,或 ” 指向”(points at)一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身,參考傳遞(如果傳遞的值需要實體化到堆里)如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如: 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號:Hunter后端 原文鏈接:Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類,Extract() 和 Trunc() Extract() 函式作用是提取日期,比如我們可以提取一個日期欄位的年份,月份,日等資料 Trunc() 的作用則是截取,比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM? JVM,全稱Java Virtual Machine(Java虛擬機),是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊,使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息!

    更新完微信服務號的模板訊息之后,我又趕緊把微信小程式的訂閱訊息給實作了!之前我一直以為微信小程式也是要企業才能申請,沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類: 位元組緩沖流:BufferedInputStream,BufferedOutputStream 字符緩沖流:BufferedReader,BufferedWriter 緩沖流的基本原理,是在創建流物件時,會創建一個內置的默認大小的緩沖區陣列,通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說,人太懶了,現在基本都不喜歡寫筆記了,但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的,寫的注釋挺全的,應該直接看得懂,就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景:視頻分段傳輸、視頻多段傳輸(理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發,從基本到高級概念,包括簡介,UWP,第一個應用程式,商店,XAML控制元件,資料系結,XAML性能,自適應設計,自適應UI,自適應代碼,檔案管理,SQLite資料庫,應用程式到應用程式通信,應用程式本地化,應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more