原作者(GitHub地址):https://github.com/TIGERB/easy-tips
<h3 align="center">PHP編碼規范及建議</h3>
### 編碼規范
- PHP代碼文件必須以 <?php 標簽開始。
```
<?php //開頭
// 不結尾
```
- PHP代碼文件必須以不帶BOM的UTF-8編碼。
```
例sublime, setting增加,"show_encoding" : true
```
- 每行的字符數不超過 80 個字符
```
例,sublime
"word_wrap": "true",
"wrap_width": 80,
```
- tap鍵4個空格
```
例,sublime
"tab_size": 4,
```
- PHP代碼中應該只定義類(trait)/函數/常量/其他會產生副作用的操作(如:生成文件輸出以及修改 .ini 配置文件等),只能選其一。
```
例,
a.php
class A
{
}
b.php
function demo()
{
}
c.php
define('A', value);
d.php
ini_set('some_vars', value);
```
- 類/trait/Interface的命名必須遵循 StudlyCaps 大寫開頭的駝峰命名規范。
```
class StudlyCaps
{
}
trait StudlyCaps
{
}
Interface StudlyCaps
{
}
```
- 類中的常量所有字母都必須大寫,單詞間用下劃線分隔。
```
define('FOO_BAR', 'something more');
const FOO_BAR = value;
```
- 方法(類/trait中)名稱必須符合 camelCase 式的小寫開頭駝峰命名規范。
```
class StudlyCaps
{
public function studlyCaps()
{
// coding...
}
}
```
- 函數名稱必須符合 snake_case 式的下劃線式命名規范。
```
function snake_case()
{
// coding...
}
```
- 私有的(private)方法(類/trait中)名稱必須符合 _camelCase 式的前置下劃線小寫開頭駝峰命名規范。
```
class StudlyCaps
{
private function _studlyCaps()
{
// coding...
}
}
```
- 方法名稱 第一個單詞 為動詞。
```
class StudlyCaps
{
public function doSomething()
{
// coding...
}
}
```
- 變量 必須符合 camelCase 式的小寫開頭駝峰命名規范。
```
class StudlyCaps
{
public function doSomething()
{
$someVariable = 'demo';
// coding...
}
}
```
- 方法/函數 多參數時,之間要有1個空格
```
class StudlyCaps
{
public function doSomething($variableOne, $variableTwo)
{
// coding...
}
}
```
- 運算符/表達式 要有一個空格
```
$a = $b + $c;
$a = $b . $c;
```
- 每個 namespace 命名空間聲明語句塊 和 use 聲明語句塊后面,必須 插入一個空白行。
```
namespace Standard;
// 空一行
use Test\TestClass;//use引入類
// 空一行
```
- 類的開始花括號 "{ "必須 寫在函數聲明后自成一行,結束花括號"}"也必須寫在函數主體后自成一行。
```
class StudlyCaps
{
}
```
- 方法/函數的開始花括號 { 必須 寫在函數聲明后自成一行,結束花括號 }也 必須 寫在函數主體后自成一行。
```
class StudlyCaps
{
public function studlyCaps()
{
// coding...
}
}
function snake_case()
{
// coding...
}
```
- 類的屬性和方法 必須 添加訪問修飾符(private、protected 以及 public),abstract 以及 final 必須 聲明在訪問修飾符之前,而 static 必須 聲明在訪問修飾符之后。
```
abstract class StudlyCaps
{
abstract public function studlyCaps();
final public static function studlyCapsOne()
{
}
}
```
- 控制結構的關鍵字后 必須 要有一個空格符,而調用方法或函數時則 一定不可 有。
```
if ($valueOne === $valueTwo) {
// code...
}
switch ($valueThree) {
case 'value':
// code...
break;
default:
// code...
break;
}
do {
// code...
} while ($valueFour <= 10);
while ($valueFive <= 10) {
// code...
}
for ($i = 0; $i < $valueSix; $i++) {
// code...
}
$demo = new Demo()
$demo->doSomething();
do_something();
```
- 控制結構的開始花括號 { 必須 寫在聲明的同一行,而結束花括號 } 必須 寫在主體后自成一行。
```
if ($valueOne === $valueTwo) {
// code...
}
switch ($valueThree) {
case 'value':
// code...
break;
default:
// code...
break;
}
do {
// code...
} while ($valueFour <= 10);
while ($valueFive <= 10) {
// code...
}
for ($i = 0; $i < $valueSix; $i++) {
// code...
}
```
- 控制結構的開始左括號后和結束右括號前,都一定不可有空格符。
```
if ($valueOne === $valueTwo) {// 控制結構(右邊和)左邊不加空格
// code...
}
```
### 編碼建議
- sql過長
```
// heredoc語法
$sql = <<<SQL
SELECT delivery_id
FROM d_test
WHERE delivery_id
IN (123,234)
GROUP BY delivery_id
HAVING SUM(send_number) <= 0;
SQL;
```
- if等控制結構條件過長
```
if ($a > 0
&& $b > 0
&& $c > 0
&& $d > 0
&& $e > 0) {
}
```
- 方法或函數參數大于三個換行
```
public function tooLangFunction(
$valueOne = '',
$valueTwo = '',
$valueThree = '',
$valueFour = '',
$valueFive = '',
$valueSix = '')
{
//coding...
}
```
- 鏈式操作超過兩個
```
$this->nameTest->functionOne()
->functionTwo()
->functionThree();
```
- 數組php5.4以后,使用[]
```
$a = [
'aaa' => 'aaa',
'bbb' => 'bbb'
];
```
- 單引號多引號
- 字符串中無變量,單引號
- 字符串中有變量,雙引號
```
$str = 'str';
$arg = "$str";
```
- 聲明類或者方法或函數添加描述&屬性描述&作者
```
/**
* 類描述
*
* desc
*/
class StandardExample
{
/**
* 常量描述.
*
* @var string
*/
const THIS_IS_A_CONST = '';
/**
* 屬性描述.
*
* @var string
*/
public $nameTest = '';
/**
* 構造函數.
*
* 構造函數描述
* @author name <email>
* @param string $value 形參名稱/描述
* @return 返回值類型 返回值描述
* 返回值類型:string,array,object,mixed(多種,不確定的),void(無返回值)
*/
public function __construct($value = '')
{
// coding...
}
```
- api方法提供測試樣例example
```
/**
* 成員方法名稱.
*
* 成員方法描述
*
* @param string $value 形參名稱/描述
*
* @example domain/api/controller/action?argu1=111&argu2=222
*/
public function testFunction($value = '')
{
// code...
}
```
- 使用try...catch...
```
try {
// coding...
} catch (\Exception $e) {
// coding...
}
```
- 連續調用多個方法(大于3個)使用foreach
```
// 改寫doSome為doSomething
class StandardExample
{
/**
* 方法列表
*
* @var array
*/
private $_functionList = [];
public function __construct($functionList = array())
{
$this->_functionList = $value;
}
public function doSome()
{
$this->functionOne();
$this->functionTwo();
$this->functionThree();
$this->functionFour();
}
public function doSomething()
{
foreach($this->_functionList as $function) {
$this->$function();
}
}
...
}
```
- 文件頂部進行版權聲明
```
// +----------------------------------------------------------------------
// | Company Name xx服務
// +----------------------------------------------------------------------
// | Copyright (c) 2017 http://domain All rights reserved.
// +----------------------------------------------------------------------
// | Author: name <email>
// +----------------------------------------------------------------------
```
- PHP7新特性
- 優雅的寫代碼
- 常見的代碼優化
- 常用的工具類
- PHP原生生成EXCEL
- PHP地理位置計算
- PHP獲取服務器狀態
- 駝峰轉下劃線
- 百度地圖兩點坐標距離計算
- 判斷是否是url
- PHP常見header頭
- 郵件發送類
- 阿拉伯數字轉化為大寫
- 獲取漢字首個拼音
- 根據身份證號獲取星座
- 生成驗證碼類
- 生成唯一ID
- 身份證驗證類
- PHP中文轉拼音
- Nginx配置文件
- curl獲取網頁內容
- 快遞查詢api
- 上傳圖片類
- 股票類
- 找回密碼類
- 字符串助手函數
- 校驗數據規則
- PHP獲取收集相關信息
- 字符串截取助手函數
- 網頁中提取關鍵字
- 檢測瀏覽器語言
- 微信相關類
- 微信獲取access_token
- 獲取用戶基本信息
- 代碼規范
- 編程規范(psr-1,2)
- 編程規范(原作者的建議)
- 經驗
- 常用函數地址
- 函數集合
- 一些常識
- MYSQL相關知識
- 常用sql
- mysql事務隔離級別
- Read uncommitted
- Read committed
- Repeatable read
- Serializable
- 高性能MYSQL讀書筆記
- 第一章MYSQL的架構
- mysql邏輯架構
- redis相關知識
- 1.安裝redis
- 3.php操作redis
- 隊列
- 悲觀鎖
- 樂觀鎖
- 發布
- 訂閱
- redis實戰-文章投票
- 設計模式
- 創建模型實例
- 單例模式
- 工廠模式
- AnimalInterface.php
- Chicken.php
- Factory.php
- Farm.php
- Pig
- SampleFactory.php
- Zoo
- 抽象工廠模式
- AnimalFactory
- Factory
- FarmInterface
- Income
- PandaZoo
- PeonyZoo
- PigFarm
- PlantFactory
- RiceFarm
- ZooInterface
- 原型模式
- 建造者模式
- 結構型模式實例
- 橋接模式
- 享元模式
- 外觀模式
- 適配器模式
- 裝飾器模式
- 組合模式
- 代理模式哦
- 過濾器模式
- 行為型模式實例
- 模板模式
- 策略模式
- 狀態模式
- 觀察者模式
- 責任鏈模式
- 訪問者模式
- 解釋器模式
- 空對象模式
- 中介者模式
- 迭代器模式
- 命令模式
- 備忘錄模式
- 網絡知識
- 互聯網協議概述
- nginx簡易交互過程
- HTTP知識
- LINUX相關知識
- swoole學習
- 1.初識swoole
- 2.WebSocket PHP 即時通訊開發
- 3.異步多進程的 CURL
- 4.異步非阻塞多進程的 Http 服務器
- 5.TCP 服務器
- 5.1同步 TCP 客戶端
- 5.2異步 TCP 客戶端
- 6.UDP 服務器
- 7.異步多任務處理
- 8.毫秒定時器
- 9.高并發投票
- ThinkPHP5學習
- 命令行操作
- 所有命令行中用到的基類
- 1.base
- 2.WorkerBase
- 3.TimeWorkerBase
- 4.CycleWorkerBase
- 5.WorkerCommandBase
- 6.WorkerHookBase
- 1.基礎命令實現
- 2.建立Linux上的守護源碼
- 3.發送模板消息
- 4.基于命令行實現自己的隊列模式
- 5.發送定時短信
- thinkphp5使用sentry
- sentry通知,記錄日志
- 高級查詢
- Kafka相關
- 1.安裝
- 2.為php打擴展
- 3.kafka實現
- 一些工具搭建
- sentry日志收集系統搭建
- walle搭建
- php實現定時任務
- 檢測文件變化