PHP-PSR 現代PHPer的開發規範

来源:https://www.cnblogs.com/a609251438/archive/2019/11/10/11832159.html
-Advertisement-
Play Games

PSR是PHP Standards Recommendation的簡稱，意為PHP推薦標準。要想瞭解PSR，首先得知道制定這一標準的人/組織是誰————PHP-FIG。 PHP-FIG PHP-FIG全稱為PHP Framework Interop Group,是一個組織，這個組織的成員由一些PHP ...


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頭的時候，有時候存在錯誤，可能造成你在使用 header 或 session_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代碼像true、false這樣的關鍵字都使用的是大寫TRUE、FALSE，我也一直在這樣使用，後來看到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開發者在查看代碼的時候，能更加簡單和輕鬆。造出來的組件/輪子可以很容易的就被所有開發者熟知和使用，同時也減少了我們的工作投入率，得到更大的工作效率，使產出大於投入，效率更高更快。



您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Vue學習筆記(五)——配置開發環境及初建項目
    前言 在上一篇中，我們通過初步的認識，簡單瞭解 Vue 生命周期的八個階段，以及可以應用在之後的開發中，針對不同的階段的鉤子採取不同的操作，更好的實現我們的業務代碼，處理更加複雜的業務邏輯。 而在這一篇中，我們將通過配置vue的開發環境以及搭建項目，進一步的學習vue在開發中的使用方式。 對於開發v ...
  • 23種GoF設計模式概述
    23種GoF設計模式概述 在前面，我們對 GoF 的 23 種設計模式進行了分類，這裡先對各個設計模式的功能進行簡要介紹，以便有個大概瞭解。後面的章節再進行詳細介紹。 創建型模式 關註於怎麼創建對象的創建型模式，他們將對象的創建與使用相互分離，對象的使用者無需關心如何創建對象，只知道怎麼使用就行，以 ...
  • 分散式事務之基本概念
    1 基礎概念 1.1. 什麼是事務 什麼是事務？舉個生活的例子 ：你去小賣部買東西，“一手交錢，一手交貨“就是一個事務的例子，交錢和交貨必須全部成功，事務才算成功，任一個活動失敗，事務將撤銷所有已成功的活動。明白上述例子，再來看事務的定義 ：事務可以看做是一次大的活動，它由不同的小活動組成，這些活動 ...
  • python語言線程標準庫threading.local源碼解讀
    本段源碼可以學習的地方： 1. 考慮到效率問題，可以通過上下文的機制，在屬性被訪問的時候臨時構建； 2. 可以重寫一些魔術方法，比如 __new__ 方法，在調用 object.__new__(cls) 前後進行屬性的一些小設置； 3. 在本庫中使用的重寫魔術方法，上下文這兩種基礎之上，我們可以想... ...
  • Python【day 15】基本數據類型-int str bool list
    '''''' ''' 1 python的定義 是一門弱類型的解釋性的高級編程語言 這裡的高級是相對低級（例如：彙編語言等） 高級編程語言和低級編程語言的區別 1、前者更接近於人的理解--字母組成的語法 2、後者更接近於計算器的理解--位元組碼、二進位 2 python的特點 人生苦短，我用python... ...
  • 死磕 java線程系列之終篇
    （手機橫屏看源碼更方便） 簡介 線程系列我們基本就學完了，這一個系列我們基本都是圍繞著線程池在講，其實關於線程還有很多東西可以講，後面有機會我們再補充進來。當然，如果你有什麼好的想法，也可以公從號右下角聯繫我。 重要知識點 直接上圖，看著這張圖我相信你能夠回憶起很多東西，也可以看著這張圖來自己提問自 ...
  • Java連載49-常量格式、package包介紹
    一、常量 1.常量的定義：final修飾的實例變數是不可變的，這種變數一般和static聯合使用，被稱為“常量” 2.常量的語法格式： public static final 類型 常量名 = 值； java規範中要求所有常量的名字全部大寫，每個單詞之間使用下劃線連接 package com.bjp ...
  • F#周報2019年第45期
    新聞 "邀請博客主們：2019年的F Advent日曆" "宣告ML.NET 1.4" ".NET Core與Jupyter筆記本" "在Jupyter筆記本中使用ML.NET" "用於Windows桌面的.NET Core 3" "宣告.NET Core 3.1預覽版2" "在.NET Core ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類