在 CodeIgniter 4(CI4)中,設定通常可以透過 .env
檔案或 app/Config/
目錄下的設定檔來管理。了解這兩種方式的差異,有助於正確地管理應用程式設定並確保維護的便利性。
1. .env
檔案
特點
-
.env
檔案用於環境設定,通常用來管理不同環境(開發、測試、正式環境)之間的差異。 -
主要儲存與環境相關的資訊,例如:
-
資料庫連線資訊(DB_HOST、DB_USER、DB_PASS)
-
API 金鑰、第三方服務設定
-
DEBUG 模式設定(CI_ENVIRONMENT)
-
-
CI4 啟動時會自動載入
.env
檔案,並可透過env('KEY_NAME')
取得設定值。
在 .env
檔案中設定:
CI_ENVIRONMENT = production
app.baseURL = 'https://example.com'
database.default.hostname = localhost
database.default.database = mydb
database.default.username = root
database.default.password = secret
CUSTOM_SETTING = 'my_value'
在程式中讀取設定值:
$baseURL = env('app.baseURL'); // 取得 baseURL 設定
$customValue = env('CUSTOM_SETTING'); // 取得自訂變數
適用場景
-
涉及敏感資訊(如密碼、API 金鑰、伺服器設定等)。
-
需要根據不同環境動態切換設定(開發、正式環境)。
-
適合於 CI/CD 部署時,將環境設定獨立於程式碼之外。
2. Config
設定檔
特點
-
Config
目錄內的設定檔主要用於儲存應用程式內部邏輯設定,例如:-
系統預設值(時區、網站名稱)
-
檔案上傳路徑、預設參數等
-
-
設定通常不會根據環境變化,而是較為靜態的應用設定。
-
可透過自訂的
Config
類別擴充額外的設定。
使用範例
建立 app/Config/MyCustomConfig.php
設定檔:
namespace Config;
use CodeIgniter\Config\BaseConfig;
class MyCustomConfig extends BaseConfig
{
public $siteName = 'My Website';
public $itemsPerPage = 20;
}
在程式中使用設定:
$config = config('MyCustomConfig');
echo $config->siteName; // 輸出 'My Website'
適用場景
-
與環境無關的應用邏輯設定,例如每頁顯示筆數、功能開關等。
-
須納入版本控制的設定,如 UI 相關設定。
-
不涉及敏感資訊的靜態參數。
3. .env
與 Config
設定的差異比較
差異點 | .env 檔案 |
Config 類別 |
---|---|---|
儲存方式 | 環境變數,純文字格式 | PHP 類別 |
存取方式 | env('KEY_NAME') |
config('ConfigClassName') |
適用場景 | 環境敏感設定、機密資訊 | 應用邏輯設定、靜態參數 |
版本控制 | 一般不納入 Git 版本控制 | 通常納入版本控制 |
影響範圍 | 環境設定,影響整個系統 | 影響應用程式內部行為 |
4. 使用建議
-
將環境變數放在
.env
檔案,例如:-
CI_ENVIRONMENT
(開發或正式環境設定) -
資料庫設定
-
第三方 API 金鑰
-
-
將應用邏輯設定放在
Config
類別,例如:-
預設語言、時區
-
頁面分頁設定
-
檔案上傳設定
-
透過適當區分 .env
與 Config
設定,能夠有效管理不同環境的需求,並維持程式碼的清晰與可維護性。