Discuz! 的編碼規範

時間 2019-12-19

標籤 discuz 編碼規範欄目 Discuz 简体版

原文原文鏈接

http://open.discuz.net/?ac=document&page=dev_coderulephp

前言

本規範由編程原則組成，融合並提煉了開發人員長時間積累下來的成熟經驗，意在幫助造成良好一致的編程風格。

適用範圍

如無特殊說明，如下規則要求徹底適用於Discuz!項目，同時也可大部分適用於COMSENZ旗下其餘PHP項目。

標準化的重要性和好處

當一個軟件項目嘗試着遵照公共一致的標準時，可使參與項目的開發人員更容易瞭解項目中的代碼、弄清程序的情況。使新的參與者能夠很快的適應環境，防止部分參與者出於節省時間的須要，自創一套風格並養成終生的習慣，致使其它人在閱讀時浪費過多的時間和精力。並且在一致的環境下，也能夠減小編碼出錯的機會。缺陷是因爲每一個人的標準不一樣，因此須要一段時間來適應和改變本身的編碼風格，暫時性的降底了工做效率。從使項目長遠健康的發展以及後期更高的團隊工做效率來考慮暫時的工做效率下降是值得的，也是必需要通過的一個過程。標準不是項目成功的關鍵，但能夠幫助咱們在團隊協做中有更高的效率而且更加順利的完成既定的任務。

程序員能夠了解任何代碼，弄清程序的情況
新人能夠很快的適應環境
防止新接觸PHP的人出於節省時間的須要，自創一套風格並養成終生的習慣
防止新接觸PHP的人一次次的犯一樣的錯誤
在一致的環境下，人們能夠減小犯錯的機會
程序員們有了一致的敵人

PHP編碼規範與原則

代碼標記

PHP程序可使用 <?php ?>來界定 PHP 代碼，在HTML頁面中嵌入純變量時，可使用 <?php echo $variablename;?>這樣的形式。

注意：爲了使代碼進一步規範化和標準化，從Discuz! X2版本起開始禁用 <? ?>和 <?=$variablename?>這種速記形式。

註釋

註釋是對於那些容易忘記做用的代碼添加簡短的介紹性內容。請使用 C 樣式的註釋「/* */」和標準 C++ 註釋「//」。

在Discuz!每個程序文件頭部中，應放入相應SVN控制字串，以方便SVN提交時自動更新：

$Id$

例如：html

/**
 *      [Discuz!] (C)2001-2099 Comsenz Inc.
 *      This is NOT a freeware, use is subject to license terms
 *
 *      $Id$
 */

程序開發中不免留下一些臨時代碼和調試代碼，此類代碼必須添加註釋，以避免往後遺忘。全部臨時性、調試性、試驗性的代碼，必須添加統一的註釋標記「//debug」並後跟完整的註釋信息，這樣能夠方便在程序發佈和最終調試前批量檢查程序中是否還存在有疑問的代碼。例如：

$num = 1;
$flag = TRUE; 	//debug 這裏不能肯定是否須要對$flag進行賦值
if(empty($flag)) {
	//Statements
}

書寫規則

縮進

每一個縮進的單位約定是一個TAB(4個空白字符寬度)，需每一個參與項目的開發人員在編輯器(UltraEdit、EditPlus、Zend Studio等)中進行強制設定，以防在編寫代碼時遺忘而形成格式上的不規範。

本縮進規範適用於PHP、JavaScript中的函數、類、邏輯結構、循環等。

大括號{}、if和switch

首括號與關鍵詞同行，尾括號與關鍵字同列；
if結構中，else和elseif與先後兩個大括號同行，左右各一個空格。另外，即使if後只有一行語句，仍然須要加入大括號，以保證結構清晰；
switch結構中，一般當一個case塊處理後，將跳過以後的case塊處理，所以大多數狀況下須要添加break。break的位置視程序邏輯，與case同在一行，或新起一行都可，但同一switch體中，break的位置格式應當保持一致。

如下是符合上述規範的例子：程序員

if($condition) {
	switch($var) {
		case 1: 	echo ‘var is 1’; break;
		case 2: 	echo ‘var is 2’; break;
		default: 	echo ‘var is neither 1 or 2’; break;
	}
} else {
	switch($str) {
		case ‘abc’:
			$result = ‘abc’;
			break;
		default:
			$result = ‘unknown’;
			break;
	}
}

運算符、小括號、空格、關鍵詞和函數

每一個運算符與兩邊參與運算的值或表達式中間要有一個空格，惟一的特例是字符鏈接運算符號兩邊不加空格；
左括號「(」應和函數關鍵詞緊貼在一塊兒，除此之外應當使用空格將「(」同前面內容分開；
右括號「)」除後面是「)」或者「.」之外，其餘一概用空格隔開它們；
除字符串中特地須要，通常狀況下，在程序以及HTML中不出現兩個連續的空格；
任何狀況下，PHP程序中不能出現空白的帶有TAB或空格的行，即：這類空白行應當不包含任何TAB或空格。同時，任何程序行尾也不能出現多餘的TAB或空格。多數編輯器具備自動去除行尾空格的功能，若是習慣養成很差，可臨時使用它，避免多餘空格產生；
每段較大的程序體，上、下應當加入空白行，兩個程序塊之間只使用1個空行，禁止使用多行。
程序塊劃分儘可能合理，過大或者太小的分割都會影響他人對代碼的閱讀和理解。通常能夠以較大函數定義、邏輯結構、功能結構來進行劃分。少於15行的程序塊，可不加上下空白行；
說明或顯示部分中，內容如含有中文、數字、英文單詞混雜，應當在數字或者英文單詞的先後加入空格。

根據上述原則，如下舉例說明正確的書寫格式：

$result = (($a + 1) * 3 / 2 + $num)).’Test’;
$condition ? func1($var) : func2($var);
$condition ? $long_statement : $another_long_statement;
if($flag) {

	//Statements
	//More than 15 lines

}
showmessage(‘請使用 restore.php 工具恢復數據。’);

函數定義

參數的名字和變量的命名規範一致；
函數定義中的左小括號，與函數名緊挨，中間無需空格；
開始的左大括號與函數定義爲同一行，中間加一個空格，不要另起一行；
具備默認值的參數應該位於參數列表的後面；
函數調用與定義的時候參數與參數之間加入一個空格；
必須仔細檢查並切實杜絕函數起始縮進位置與結束縮進位置不一樣的現象；

例如，符合標準的定義：

function authcode($string, $operation, $key = '') {
	if($flag) {
		//Statement
	}
	//函數體
}

不符合標準的定義：

function authcode($string,$operation,$key = '')
{
	//函數體
}

引號

PHP中單引號和雙引號具備不一樣的含義，最大的幾項區別以下：

單引號中，任何變量($var)、特殊轉義字符(如「\t \r \n」等)不會被解析，所以PHP的解析速度更快，轉義字符僅僅支持「\’」和「\\」這樣對單引號和反斜槓自己的轉義；
雙引號中，變量($var)值會代入字符串中，特殊轉義字符也會被解析成特定的單個字符，還有一些專門針對上述兩項特性的特殊功能性轉義，例如「\$」和「{$array[‘key’]}。這樣雖然程序編寫更加方便，但同時PHP的解析也很慢；
數組中，若是下標不是整型，而是字符串類型，請務必用單引號將下標括起，正確的寫法爲$array[‘key’]，而不是$array[key]，由於不正確的寫法會使PHP解析器認爲key是一個常量，進而先判斷常量是否存在，不存在時才以「key」做爲下標帶入表達式中，同時出發錯誤事件，產生一條Notice級錯誤。
所以，在絕大多數可使用單引號的場合，禁止使用雙引號。依據上述分析，能夠或必須使用單引號的狀況包括但不限於下述：
- 字符串爲固定值，不包含「\t」等特殊轉義字符；
- 數組的固定下標，例如$array[‘key’]；
- 表達式中不須要帶入變量，例如$string = ‘test’;，而非$string = 「test$var」；
例外的，在正則表達式(用於preg_系列函數和ereg系列函數)中，Discuz!所有使用雙引號，這是爲了人工分析和編寫的方便，並保持正則表達式的統一，減小沒必要要的分析混淆。
數據庫SQL語句中，全部數據必須加單引號，不管數值仍是字串，以免可能的注入漏洞和SQL錯誤。正確的寫法爲：

UPDATE cdb_members SET adminid=’1’ WHERE username=’$admin’ AND adminid=’2’;

全部數據在插入數據庫以前，均須要進行addslashes()處理，以避免特殊字符未經轉義在插入數據庫的時候出現錯誤。Discuz!中全部經過 GET, POST, FILE,取得的變量默認狀況下已經使用了addslashes()進行了轉義，沒必要重複進行。若是數據處理必要(例如用於直接顯示)，可使用 stripslashes() 恢復，但數據在插入數據庫以前必須再次進行轉義。緩存文件中，通常對緩存數據的值採用 addcslashes($string, '\'\\')進行轉義。

Discuz!語言問題

在功能設計階段，當須要使用中文或者給出用戶中文提示的時候能夠直接在程序中插入簡體中文文字，待程序整理和測試階段由專人進行語言分離工做；

功能說明性語言、短語通常不使用「。」或者其餘標點符號做爲結束，文字中的標點符號，應使用全角。但注意：因爲中英文模板與語言包問題，功能說明性的語言中，冒號使用半角」:」，而不使用全角；

提示信息(用showmessage()和cpmsg()顯示的)和使用技巧(如後臺管理界面中的tips)等大篇幅文字中，當中的標點符號應當遵循中文語法規則，以使用全角中文標點爲主，結尾應當加入全角句號。

儘管程序語言包是在最後整理階段才進行提取，但程序中直接寫出的中文內容，也應充分保證書面語的特徵：語言通順、簡潔、得體、無歧義。應完全杜絕認爲直接寫提示語言是臨時性操做的想法，反覆推敲，並總結以前提示語言的特徵規範，加以應用。良好的語言文字表達能力，是每一個優秀程序員必須具有的基本素質之一。

命名原則

命名是程序規劃的核心。古人相信只要知道一我的真正的名字就會得到凌駕於那我的之上的難以想象的力量。只要你給事物想到正確的名字，就會給你以及後來的人帶來比代碼更強的力量。

名字就是事物在它所處的生態環境中一個長久而深遠的結果。總的來講，只有瞭解系統的程序員才能爲系統取出最合適的名字。若是全部的命名都與其天然相適合，則關係清晰，含義能夠推導得出，通常人的推想也能在乎料之中。

就通常約定而言，類、函數和變量的名字應該老是可以描述讓代碼閱讀者可以容易的知道這些代碼的做用。形式越簡單、越有規則，就越容易讓人感知和理解。應該避免使用模棱兩可，晦澀不標準的命名。

變量、對象、函數名

變量、對象、函數名一概爲小寫格式，除非必要，單詞之間通常不使用下劃線「_」進行分割；
以標準計算機英文爲藍本，杜絕一切拼音、或拼音英文混雜的命名方式；
變量命名只能使用項目中有據可查的英文縮寫方式，例如可使用$data而不可以使用$data一、$data2這樣容易產生混淆的形式，應當使用$threaddata、$postdata這樣一目瞭然容易理解的形式；
能夠合理的對過長的命名進行縮寫，例如$bio($biography)，$tpp($threadsPerPage)，前提是英文中有這樣既有的縮寫形式，或字母符合英文縮寫規範；
必須清楚所使用英文單詞的詞性，在權限相關的範圍內，大多使用$allow***或$is***的形式，前者後面接動詞，後者後面接形容詞。

常量

常量應該老是所有使用大寫字母命名，少數特別必要的狀況下，可以使用劃線來分隔單詞；
PHP 的內建值 TRUE、FALSE 和NULL必須所有采用大寫字母書寫。

變量的初始化與邏輯檢查

任何變量在進行累加、直接顯示或存儲前必需進行初使化,例如：正則表達式

$number = 0; 			//數值型初始化
$string = ‘’; 		//字符串初始化
$array = array(); 	//數組初始化

判斷一個沒法肯定（不知道是否已被賦值）的變量時，可用empty()或isset()，而不要直接使用if($switch)的形式，除非你確切的知道此變量必定已經被初始化並賦值。

empty()和isset()的區別爲：

bool empty(mixed var)

若是 var 是非空或非零的值，則 empty() 返回 FALSE。換句話說，""、0、"0"、NULL、FALSE、array()、var $var; 以及沒有任何屬性的對象都將被認爲是空的，若是 var 爲空，則返回 TRUE。

bool isset(mixed var[, mixed var[, ...]])

若是 var 存在則返回 TRUE，不然返回 FALSE。

若是已經使用 unset() 釋放了一個變量以後，它將再也不是 isset()。若使用 isset() 測試一個被設置成 NULL 的變量，將返回 FALSE。同時要注意的是一個 NULL 字節（"\0"）並不等同於 PHP 的 NULL 常數。

判斷一個變量是否爲數組，請使用is_array()，這種判斷尤爲適用於對數組進行遍歷的操做，例如foreach()，由於若是不事先判斷，foreach()會對非數組類型的變量報錯；
判斷一個數組元素是否存在，可以使用isset($array[‘key’])，也可以使用empty()，二者異同見上。

安全性

PHP中的變量不併不像C語言那樣須要事先聲明，解釋器會在第一次使用時自動建立他們，一樣類型也不須要指定，解釋器會根據上下文環境自動肯定。從開發人員的角度來看，這無疑是一種極其方便的處理方法。一個變量被建立了，就能夠在程序中的任何地方使用。這致使的結果就是開發人員工常常不注意初始化變量。所以，爲了提升程序的安全性，咱們不能相信任何沒有明肯定義的變量。全部的變量在定義使用前要初使化以防止惡意構造提交的變量覆蓋程序中使用的變量。

兼容性

代碼設計應當兼顧PHP 高低版本的特性，當前，應仍然以PHP 4.0.6做爲最低經過平臺，儘可能不使用高版本PHP 新增的函數、常數或者常量。若是使用只在高版本才具有的函數，必須對其進行二次封裝，自動判斷當前PHP版本，並自行編寫低版本下的兼容代碼；
對於個別函數，參數要求或者代碼要求應當以較爲嚴格的PHP版本爲準；
除非必要，不要使用PHP擴展模塊中的函數。使用時應當加入必要的判斷，當服務器環境不支持此函數的時候，進行必要的處理。文檔和程序中的功能說明中，也應加上兼容性說明。

代碼重用

代碼的有效重用能夠減小效率的損失與資源的浪費。在開發軟件項目時爲了不重複勞動和浪費時間。開發人員應儘可能提升現有代碼的重用率，同時將更多的精力用在新技術的應用和新功能的創新開發上面。

在須要屢次使用代碼，而且對於您但願實現的任務沒有可用的內置 PHP 函數時，不吝嗇定義函數或類。開發者須根據功能、調用狀況，將函數和類放置於相應的function或class中。超過3行，實現相同功能的程序切勿在不一樣程序中屢次出現，這是沒法容忍和迴避的問題；
在任什麼時候候都不要出現同一個程序中出現兩段或更多的類似代碼或相同代碼，即使在不一樣程序中，也應盡力避免。開發者應當老是有能力找到避免代碼大段(超過10行)重複或相似的狀況。

須要強調的是，本部分雖然篇幅較短，但倒是十分須要經驗，並將花費開發者大量時間和精力去進行優化的部分，任何產品開發者必須時刻清楚和理解代碼重用的重要性和必要性，切實在加強產品效率、邏輯性和可讀性上下功夫，這是一名優秀軟件開發者所必須具有的基本素質。

其餘細節問題

包含調用

包含調用程序文件，請所有使用require_once，以免可能的重複包含問題；
包含調用緩存文件，因爲緩存文件沒法保證100%正確打開，請使用include_once或include。在必要時，可使用@include_once或@include的方式，以忽略錯誤提示；
包含和調用代碼中，須以「./」或DISCUZ_ROOT.’./’開頭，應避免直接寫程序文件名(例如：require_once ‘x.php’;)的作法；
全部被包含和調用的程序文件，包括但不限於程序、緩存或模板，一般其不能被直接URL請求。Discuz!經過在./source/class/class_core.php中定義一個標記性常量IN_DISCUZ，來判斷程序是否被合法調用。所以，在除了./source/class/class_core.php之外的任何一個被包含和調用的程序文件中，須要包含如下內容，以使得訪問者沒法直接經過URL請求該文件：

if(!defined('IN_DISCUZ')) {
	exit('Access Denied');
}

錯誤報告級別

在軟件開發和調試階段，請使用error_reporting(E_ALL);做爲默認的錯誤報告級別，此級別最爲嚴格，可以報告程序中全部的錯誤、警告和提示信息，以幫助開發者檢查和核對代碼，避免大多數安全性問題和邏輯錯誤、拼寫錯誤。error_reporting()能夠在config/config_global.php中添加一行$_config['debug'] = 1;debug值能夠在0~2以前取值，數值越大報錯等級越高。
在軟件發佈時，請使用error_reporting(E_ERROR | E_WARNING | E_PARSE);做爲默認的錯誤報告級別，以利於用戶使用並將無謂錯誤提示信息降至最低。

數據庫設計

字段

表和字段命名

表和字段的命名之前面《4.4命名原則》的約定爲基本準則。

全部數據表名稱，只要其名稱是可數名詞，則必須以複數方式命名，例如：cdb_members(用戶表)、cdb_posts(帖子表)；存儲多項內容的字段，或表明數量的字段，也應當以複數方式命名，例如：params(parameters，自定義Discuz!代碼的參數個數)、views(查看次數)、replies(回覆次數)。

當幾個表間的字段有關連時，要注意表與表之間關聯字段命名的統一，如cdb_threads表中的tid與cdb_posts表中的tid。

表明id自增量的字段，一般用如下幾種形式：

最經常使用的核心id，或常常在URL中進行調用的，儘可能用簡寫的形式，例如tid、pid、uid；
有功能性做用，URL中偶爾用到的id，使用全稱的形式，例如pluginid；
沒有功能性做用，只爲管理和維護方便而設的id，可使用全稱的形式，也可只將其命名爲id。

全部與表、字段相關的命名，請務必大量參考Discuz!現有字段的命名方式，以保證命名的系統性和統一性。sql

字段結構

容許NULL值的字段，數據庫在進行比較操做時，會先判斷其是否爲NULL，非NULL時才進行值的必對。所以基於效率的考慮，全部字段均不能爲空，即所有NOT NULL；
預計不會存儲非負數的字段，例如各項id、發帖數等，必須設置爲UNSIGNED類型。UNSIGNED類型比非UNSIGNED類型所能存儲的正整數範圍大一倍，所以能得到更大的數值存儲空間；
存儲開關、選項數據的字段，一般使用tinyint(1)非UNSIGNED類型，少數狀況也可能使用enum()結果集的方式。tinyint做爲開關字段時，一般1爲打開；0爲關閉；-1爲特殊數據，例如N/A(不可用)；高於1的爲特殊結果或開關二進制數組合(詳見Discuz!中相關代碼)；
MEMORY/HEAP類型的表中，要尤爲注意規劃節約使用存儲空間，這將節約更多內存。例如cdb_sessions表中，就將IP地址的存儲拆分爲4個tinyint(3) UNSIGNED類型的字段，而沒有采用char(15)的方式；
任何類型的數據表，字段空間應當本着足夠用，不浪費的原則，數值類型的字段取值範圍見下表：

字段類型	存儲空間(b)	UNSIGNED	取值範圍
tinyint	1	否	-128~127
tinyint	1	是	0~255
smallint	2	否	-32768~32767
smallint	2	是	0~65535
mediumint	3	否	-8388608~8388607
mediumint	3	是	0~16777215
int	4	否	-2147483648~2147483647
int	4	是	0~4294967295
bigint	8	否	-9223372036854775808~9223372036854775807
bigint	8	是	0~18446744073709551615

SQL語句

全部SQL語句中，除了表名、字段名稱之外，所有語句和函數均需大寫，應當杜絕小寫方式或大小寫混雜的寫法。例如select * from cdb_members;是不符合規範的寫法。
很長的SQL語句應當有適當的斷行，依據JOIN、FROM、ORDER BY等關鍵字進行界定。
一般狀況下，在對多表進行操做時，要根據不一樣表名稱，對每一個表指定一個1~2個字母的縮寫，以利於語句簡潔和可讀性。

以下的語句範例，是符合規範的：

$query = $db->query("SELECT s.*, m.* FROM {$tablepre}sessions s, {$tablepre}members m WHERE m.uid=s.uid AND s.sid='$sid');

性能與效率

定長與變長表

包含任何varchar、text等變長字段的數據表，即爲變長表，反之則爲定長表。

對於變長表，因爲記錄大小不一樣，在其上進行許多刪除和更改將會使表中的碎片更多。須要按期運行OPTIMIZE TABLE以保持性能。而定長表就沒有這個問題；
若是表中有可變長的字段，將它們轉換爲定長字段可以改進性能，由於定長記錄易於處理。但在試圖這樣作以前，應該考慮下列問題：
使用定長列涉及某種折衷。它們更快，但佔用的空間更多。char(n) 類型列的每一個值總要佔用n 個字節(即便空串也是如此)，由於在表中存儲時，值的長度不夠將在右邊補空格；
而varchar(n)類型的列所佔空間較少，由於只給它們分配存儲每一個值所須要的空間，每一個值再加一個字節用於記錄其長度。所以，若是在char和varchar類型之間進行選擇，須要對時間與空間做出折衷；
變長表到定長表的轉換，不能只轉換一個可變長字段，必須對它們所有進行轉換。並且必須使用一個ALTER TABLE語句同時所有轉換，不然轉換將不起做用；
有時不能使用定長類型，即便想這樣作也不行。例如對於比255字符更長的串，沒有定長類型；
在設計表結構時若是可以使用定長數據類型儘可能用定長的，由於定長表的查詢、檢索、更新速度都很快。必要時能夠把部分關鍵的、承擔頻繁訪問的表拆分，例如定長數據一個表，非定長數據一個表。例如Discuz!的cdb_members和cdb_memberfields表、cdb_forums和cdb_forumfields表等。所以規劃數據結構時須要進行全局考慮；

進行表結構設計時，應當作到恰到好處，反覆推敲，從而實現最優的數據存儲體系。數據庫

運算與檢索

數值運算通常比字符串運算更快。例如比較運算，可在單一運算中對數進行比較。而串運算涉及幾個逐字節的比較，若是串更長的話，這種比較還要多。
若是串列的值數目有限，應該利用普通整型或emum類型來得到數值運算的優越性。
更小的字段類型永遠比更大的字段類型處理要快得多。對於字符串，其處理時間與串長度直接相關。通常狀況下，較小的表處理更快。對於定長表，應該選擇最小的類型，只要能存儲所需範圍的值便可。例如，若是mediumint夠用，就不要選擇bigint。對於可變長類型，也仍然可以節省空間。一個TEXT 類型的值用2 字節記錄值的長度，而一個LONGTEXT 則用4字節記錄其值的長度。若是存儲的值長度永遠不會超過64KB，使用TEXT 將使每一個值節省2字節。

結構優化與索引優化

索引能加快查詢速度，而索引優化和查詢優化是相輔相成的，既能夠依據查詢對索引進行優化，也能夠依據現有索引對查詢進行優化，這取決於修改查詢或索引，哪一個對現有產品架構和效率的影響最小。

索引優化與查詢優化是多年經驗積累的結晶，在此沒法詳述，但仍然給出幾條最基本的準則。

首先，根據產品的實際運行和被訪問狀況，找出哪些SQL語句是最常被執行的。最常被執行和最常出如今程序中是徹底不一樣的概念。最常被執行的SQL語句，又可被劃分爲對大表(數據條目多的)和對小表(數據條目少的)的操做。不管大表或小表，有可分爲讀(SELECT)多、寫(UPDATE/INSERT)多或讀寫都多的操做。

對常被執行的SQL語句而言，對大表操做須要尤爲注意：

寫操做多的，一般可以使用寫入緩存的方法，先將須要寫或須要更新的數據緩存至文件或其餘表，按期對大表進行批量寫操做，例如Discuz!中點擊數延遲更新機制，就是依據此原理實現。同時，應儘可能使得常被讀寫的大表爲定長類型，即使本來的結構中大表並不是定長。大表定長化，能夠經過改變數據存儲結構和數據讀取方式，將一個大表拆成一個讀寫多的定長表，和一個讀多寫少的變長表來實現；
讀操做多的，須要依據SQL查詢頻率設置專門針對高頻SQL語句的索引和聯合索引。

而小表就相對簡單，加入符合查詢要求的特定索引，一般效果比較明顯。同時，定長化小表也有益於效率和負載能力的提升。字段比較少的小定長表，甚至能夠不須要索引。

其次，看SQL語句的條件和排序字段是否動態性很高(即根據不一樣功能開關或屬性，SQL查詢條件和排序字段的變化很大的狀況)，動態性太高的SQL語句是沒法經過索引進行優化的。唯一的辦法只有將數據緩存起來，按期更新，適用於結果對實效性要求不高的場合。

MySQL索引，經常使用的有PRIMARY KEY、INDEX、UNIQUE幾種，詳情請查閱MySQL文檔。一般，在單表數據值不重複的狀況下，PRIMARY KEY和UNIQUE索引比INDEX更快，請酌情使用。

事實上，索引是將條件查詢、排序的讀操做資源消耗，分佈到了寫操做中，索引越多，耗費磁盤空間越大，寫操做越慢。所以，索引決不能盲目添加。對字段索引與否，最根本的出發點，依次仍然是SQL語句執行的機率、表的大小和寫操做的頻繁程度。

查詢優化

MySQL中並無提供針對查詢條件的優化功能，所以須要開發者在程序中對查詢條件的前後順序人工進行優化。例如以下的SQL語句：

SELECT * FROM table WHERE a>’0’ AND b<’1’ ORDER BY c LIMIT 10;

事實上不管a>’0’仍是b<’1’哪一個條件在前，獲得的結果都是同樣的，但查詢速度就大不相同，尤爲在對大表進行操做時。

開發者須要牢記這個原則：最早出現的條件，必定是過濾和排除掉更多結果的條件；第二齣現的次之；以此類推。於是，表中不一樣字段的值的分佈，對查詢速度有着很大影響。而ORDER BY中的條件，只與索引有關，與條件順序無關。

除了條件順序優化之外，針對固定或相對固定的SQL查詢語句，還能夠經過對索引結構進行優化，進而實現至關高的查詢速度。原則是：在大多數狀況下，根據WHERE條件的前後順序和ORDER BY的排序字段的前後順序而創建的聯合索引，就是與這條SQL語句匹配的最優索引結構。儘管，事實的產品中不能只考慮一條SQL語句，也不能不考慮空間佔用而創建太多的索引。

一樣以上面的SQL語句爲例，最優的當table表的記錄達到百萬甚至千萬級後，能夠明顯的看到索引優化帶來的速度提高。

依據上面條件優化和索引優化的兩個原則，當table表的值爲以下方案時，能夠得出最優的條件順序方案：

字段a	字段b	字段c
1	7	11
2	8	10
3	9	13
最優條件：b<’1’ AND a>’0’ 最優索引：INDEX abc (b, a, c) 緣由：b<’1’做爲第一條件能夠先過濾掉75%的結果。若是以a>’0’做爲第一條件，則只能先過濾掉25%的結果注意：編程字段c因爲未出現於條件中，故條件順序優化與其無關最優索引由最優條件順序得來，而非由例子中的SQL語句得來索引並不是修改數據存儲的物理順序，而是經過對應特定偏移量的物理數據而實現的虛擬指針

EXPLAIN語句是檢測索引和查詢可否良好匹配的簡便方法。在phpMyAdmin或其餘MySQL客戶端中運行EXPLAIN+查詢語句，例如EXPLAIN SELECT * FROM table WHERE a>’0’ AND b<’1’ ORDER BY c;這種形式，即便得開發者無需模擬上百萬條數據，也能夠驗證索引是否合理，相關細節請參考MySQL說明。

值得提出的是，Using filesort是最不該當出現的狀況，若是EXPLAIN得出此結果，說明數據庫爲這個查詢專門創建了一個用以緩存結果的臨時表文件，並在查詢結束後刪除。衆所周知，硬盤I/O速度始終是計算機存儲的瓶頸，所以，查詢中應當盡全力避免高執行頻率的SQL語句使用filesort。儘管，開發者永遠都不可能保證產品中的所有SQL語句都不會使用filesort。

限於篇幅，本文檔遠遠沒有涵蓋數據庫優化的方方面面，例如：聯合索引與普通索引的可重用性、JOIN鏈接的索引設計、MEMORY/HEAP表等。數據庫優化實際上就是在不少因素和利弊間不斷權衡、修改，唯有在成功與失敗經驗中反覆推敲才能得出的經驗，這種經驗每每就是最難能難得和價值連城的。

兼容性問題

因爲MySQL 3.23至5.0的變化很大，所以程序中儘可能不使用特殊的SQL語句，以避免帶來兼容性問題，並給數據庫移植形成困難。
一般在MySQL 4.1以上版本，Discuz!應使用至關的字符集來存儲，例如GBK/BIG5/UTF-8。傳統的latin1編碼雖然有必定的兼容性，但仍然不是推薦的選擇。使用相應非默認字符集時，程序每次運行時須要使用SET NAMES ‘character_set’;來規定鏈接、傳輸和結果的字符集。
Mysql 5.0以上新增了數種SQL_MODE，默認的SQL_MODE依服務器安裝設置不一樣而不一樣，所以程序每次運行時須要使用SET SQL_MODE=’’;來規定當前的SQL模式。

模板設計

代碼標記

HTML代碼標記一概採用小寫字母形式，杜絕任何使用大寫字母的方式

模板中全部的邏輯體，如{if}、{loop}等，必須先後使用HTML註釋()，即相似的形式。事實上，Discuz!模板編譯器是支持不加HTML註釋的邏輯體寫法的，但加入註釋可使得模板可讀性更好，同時方便用戶使用DreamWeaver或FrontPage等對模板進行修改。

在HTML標記中使用的邏輯體無需使用HTML註釋()，即<input type=」text」{if xxx} value=」1」{/if} />

書寫規則

HTML

全部HTML標記參數賦值需使用雙引號包含，例如，應當使用<input type=」text」 name=」test」 value=」ok」 />,而絕對不能使用<input type=text name=test value=ok />。

在任何狀況下，產品中的模板文件必須採用手寫HTML代碼的方式，而絕對不能使用DreamWeaver、FrontPage等自動網頁製做工具進行撰寫或修改。

非成對標記必須以「/>」結尾，如
、<input …/>,<input /> 標記的屬性必須按照如下順序書寫：<input type="" name="" id="" class="" … />

變量

模板中使用的變量，依據做用和出現位置不一樣，分爲幾種方式：

邏輯體中，即被包圍起來的部分，例如這種形式，其中的變量書寫規範與PHP程序中徹底一致；
模板內容中，即未被包圍起來的部分，與PHP程序中最大的不一樣是，對數組字符串類型下標無需加入單引號，由於Discuz!模板編譯器會在對模板進行編譯時將這部分的單引號自動加入。

偶爾的，開發者須要使用{}將變量括起來，以避免出現模板編譯錯誤，可能的狀況以下：

變量先後含有中括號的或其餘敏感字符的(包括但不限於「$」、「’」等)，正確的寫法爲descriptionnew[{$buddy[buddyid]}]；
數組的下標爲變量的，正確的寫法爲{$extcredits[$creditstrans][title]}；
其餘變量十分複雜的狀況。

語言元素

Discuz!模板編譯器能夠解析對應於./templates/default/templates.lang.php(以默認模板爲例)的語言元素。在模板中調用相應語言元素的代碼爲{lang item}，其中item爲在templates.lang.php中定義的語言元素名。

縮進

在Discuz!的*.htm模板文件中，因爲具有邏輯結構，故不考慮任何HTML自己的縮進，全部縮進均意爲着邏輯上的縮進結構。縮進採用TAB方式，不使用空格做爲縮進符號，僅需適當斷行便可。例如：

<!--{loop $threadlist $thread}-->
	<table cellspacing=」0」 cellspadding=」0」 border=」0」>
	<tr><td>$thread[message]</tr></td>
	</table>
<!--{/loop}-->

文件與目錄

文件命名

全部包含PHP代碼的程序文件或半程序文件，應以小寫.php做爲擴展名，而不要使用.phtml、.php三、.inc、.class等做爲擴展名。

普通程序

可以被URL直接調用的程序，例如home.php、index.php、forum.php，直接使用程序名+.php的方式命名

函數庫和類庫程序

分別以小寫function_xxxx.php和class_xxxx.php的格式命名書寫。函數庫和類庫程序只能被其餘程序引用，而不能獨立運行。其中不能包含任何流程性的、不屬於任何函數或類的程序代碼。

流程性程序

以小寫.inc.php做爲擴展名。只能被其餘程序引用，而不能獨立運行。其中不能包含任何函數或類代碼的程序代碼。

模板源文件

以小寫.htm做爲擴展名。模板源文件按照Discuz!模板編碼規則進行編寫，不是能夠執行的程序，而只能被Discuz!模板編譯器所解析，放置於./templates/default或./templates下的其餘模板目錄下。

模板目標文件

模板文件被編譯後自動生成的目標程序，以小寫.tpl.php做爲擴展名，存放於./data/template目錄下。

語言包文件

以小寫lang_xxxx.php格式命名，只能存放模板或程序使用的語言包信息。
模板語言包存放在對應模塊名下的lang_template.php，例如：家園的模板語言包source\language\home\lang_template.php

緩存文件

此類文件爲系統自動生成，以cache_xxx.php、usergroup_xxx.php、style_xxx.php等相似形式命名，存放於./data/cache目錄下。

目錄命名

Discuz!目錄命名之前面《4.4命名原則》的約定爲基本準則。在可能的狀況下，多以複數形式出現，如./templates、./images等。
因爲目錄數量較少，所以目錄命名大可能是一些習慣和約定俗成，開發人員如需新建目錄，應與項目組成員進行磋商，達成一致後方可實施。

空目錄索引

請在全部不包含普通程序(即可以被URL直接調用的程序)的目錄中放置一個1字節的index.htm文件，內容爲一個空格。幾乎除Discuz!根目錄之外，全部目錄都屬於這一類型，所以開發者須要在這些目錄所有放入空index.htm文件，以免當http服務器的Directory Listing打開時，服務器文件被索引和列表。
附件目錄等敏感目錄，要在程序中實現相應功能，當新建下級目錄時，必須自動寫入一個空的index.htm文件，以免新建目錄被索引的問題。

更新時間：2012-5-3數組