附錄*配置選項 · Swoole 簡明指南

# 配置選項 --- [TOC] 在swoole中，一個swoole_server的相關屬性可以通過 ```php $serv->set( array $configs ); ``` 函數來配置，這些配置選項使得swoole更加靈活。示例： ```php $serv = new swoole_server("0.0.0.0", 9501); $serv->set(array( 'worker_num' => 8, 'max_request' => 10000, 'max_conn' => 100000, 'dispatch_mode' => 2, 'debug_mode'=> 1， 'daemonize' => false, )); ``` 配置選項以及相關介紹如下： ##reactor_num 描述：指定Reactor線程數 說明：設置主進程內事件處理線程的數量，默認會啟用CPU核數相同的數量，一般設置為CPU核數的**1-4倍**，最大不得超過CPU核數*4。 示例： ```php 'reactor_num' => 8 ``` ## worker_num 描述：指定啟動的worker進程數說明：開啟的worker進程數越多，server負載能力越大，但是相應的server占有的內存也會更多。同時，當worker進程數過多時，進程間切換帶來的系統開銷也會更大。因此建議開啟的worker進程數為cpu核數的**1-4**倍。示例： ```php 'worker_num' => 8 ``` ##max_request 描述：每個worker進程允許處理的最大任務數。 說明：設置該值后，每個worker進程在處理完max_request個請求后就會自動重啟。設置該值的主要目的是為了防止worker進程處理大量請求后可能引起的內存溢出。 示例： ```php 'max_request' => 10000 ``` ##max_conn 描述：服務器允許維持的最大TCP連接數 說明：設置此參數后，當服務器已有的連接數達到該值時，新的連接會被拒絕。另外，該參數的值不能超過操作系統**ulimit -n**的值，同時此值也不宜設置過大，因為swoole_server會**一次性申請一大塊內存**用于存放每一個connection的信息。 示例： ```php 'max_conn' => 10000 ``` ##ipc_mode 描述：設置進程間的通信方式。 說明：共有三種通信方式，參數如下： >- 1 => 使用unix socket通信 - 2 => 使用消息隊列通信 - 3 => 使用消息隊列通信，并設置為爭搶模式示例： ```php 'ipc_mode' => 1 ``` ##dispatch_mode 描述：指定數據包分發策略。 說明：共有三種模式，參數如下： >- 1 => 輪循模式，收到會輪循分配給每一個worker進程 >- 2 => 固定模式，根據連接的文件描述符分配worker。這樣可以保證同一個連接發來的數據只會被同一個worker處理 - 3 => 搶占模式，主進程會根據Worker的忙閑狀態選擇投遞，只會投遞給處于閑置狀態的Worker 示例： ```php 'dispatch_mode' => 2 ``` ##task_worker_num 描述：服務器開啟的task進程數。 說明：設置此參數后，服務器會開啟異步task功能。此時可以使用**task**方法投遞異步任務。 >設置此參數后，必須要給swoole_server設置onTask/onFinish兩個回調函數，否則啟動服務器會報錯。 示例： ```php 'task_worker_num' => 8 ``` ##task_max_request 描述：每個task進程允許處理的最大任務數。 說明：參考[max_request](#2max_request) task_worker_num 示例： ```php 'task_max_request' => 10000 ``` ##task_ipc_mode 描述：設置task進程與worker進程之間通信的方式。 說明：參考[ipc_mode](#4ipc_mode) 示例： ```php 'task_ipc_mode' => 2 ``` ##task_tmpdir 描述：設置task的數據臨時目錄 說明：在swoole_server中，如果投遞的數據超過8192字節，將啟用臨時文件來保存數據。這里的task_tmpdir就是用來設置臨時文件保存的位置。 >需要swoole-1.7.7+ 示例： ```php 'task_tmpdir' => '/tmp/task/' ``` ##daemonize 描述：設置程序進入后臺作為守護進程運行。 說明：長時間運行的服務器端程序必須啟用此項。如果不啟用守護進程，當ssh終端退出后，程序將被終止運行。啟用守護進程后，標準輸入和輸出會被重定向到 [log_file](#10log_file)，如果 [log_file](#10log_file)未設置，則所有輸出會被丟棄。 示例： ```php 'daemonize' => 0 ``` ##log_file 描述：指定日志文件路徑 說明：在swoole運行期發生的異常信息會記錄到這個文件中。默認會打印到屏幕。注意log_file **不會自動切分文件**，所以需要定期清理此文件。 示例： ```php 'log_file' => '/data/log/swoole.log' ``` ## log_level 描述：設置`swoole_server`錯誤日志打印的等級 說明：等級范圍是0-5，低于log_level設置的日志信息不會拋出。 示例： ```php 'log_level' => '1 ``` ##heartbeat_check_interval 描述：設置心跳檢測間隔 說明：此選項表示每隔多久輪循一次，單位為秒。每次檢測時遍歷所有連接，如果某個連接在間隔時間內沒有數據發送，則強制關閉連接（會有onClose回調）。 示例： ```php 'heartbeat_check_interval' => 60 ``` ##heartbeat_idle_time 描述：設置某個連接允許的最大閑置時間。 說明：該參數配合[heartbeat_check_interval](#11heartbeat_check_interval)使用。每次遍歷所有連接時，如果某個連接在[heartbeat_idle_time](#12heartbeat_idle_time)時間內沒有數據發送，則強制關閉連接。默認設置為[heartbeat_check_interval](#11heartbeat_check_interval) * 2。 示例： ```php 'heartbeat_idle_time' => 600 ``` ##open_eof_split 描述：打開eof檢測功能 說明：與[package_eof ](#14package_eof )配合使用。此選項將檢測客戶端連接發來的數據，當數據包結尾是指定的[package_eof ](#14package_eof )字符串時才會將數據包投遞至Worker進程，否則會一直拼接數據包直到緩存溢出或超時才會終止。一旦出錯，該連接會被判定為惡意連接，數據包會被丟棄并強制關閉連接。 > EOF檢測不會從數據中間查找eof字符串，所以Worker進程可能會同時收到多個數據包，需要在應用層代碼中自行**explode("\r\n", $data)** 來拆分數據包 示例： ```php 'open_eof_split' => true ``` ##package_eof 描述：設置EOF字符串 說明：package_eof最大只允許傳入**8個**字節的字符串 示例： ```php 'package_eof ' => '/r/n' ``` ##open_length_check 描述：打開包長檢測 說明：包長檢測提供了**固定包頭+包體**這種格式協議的解析，。啟用后，可以保證Worker進程onReceive每次都會收到一個完整的數據包。 示例： ```php 'open_length_check' => true ``` ##package_length_offset 描述：包頭中第幾個字節開始存放了長度字段 說明：配合[open_length_check](#15open_length_check)使用，用于指明長度字段的位置。 示例： ```php 'package_length_offset' => 5 ``` ##package_body_offset 描述：從第幾個字節開始計算長度。 說明：配合[open_length_check](#15open_length_check)使用，用于指明包頭的長度。 示例： ```php 'package_body_offset' => 10 ``` ##package_length_type 描述：指定包長字段的類型 說明：配合[open_length_check](#15open_length_check)使用，指定長度字段的類型，參數如下： >- 's' => int16_t 機器字節序 - 'S' => uint16_t 機器字節序 - 'n' => uint16_t 大端字節序 - ’N‘ => uint32_t 大端字節序 - 'L' => uint32_t 機器字節序 - 'l' => int 機器字節序示例： ```php 'package_length_type' => 'N' ``` ##package_max_length 描述：設置最大數據包尺寸 說明：該值決定了數據包緩存區的大小。如果緩存的數據超過了該值，則會引發錯誤。具體錯誤處理由開啟的協議解析的類型決定。 示例： ```php 'package_max_length' => 8192 ``` ##open_cpu_affinity 描述：啟用CPU親和性設置 說明：在多核的硬件平臺中，啟用此特性會將swoole的reactor線程/worker進程綁定到固定的一個核上。可以避免進程/線程的運行時在多個核之間互相切換，提高CPU Cache的命中率。 示例： ```php 'open_cpu_affinity' => true ``` ## cpu_affinity_ignore 描述：設置不使用指定的CPU核 說明：IO密集型程序中，所有網絡中斷都是用CPU0來處理，如果網絡IO很重，CPU0負載過高會導致網絡中斷無法及時處理，那網絡收發包的能力就會下降。此參數用于設置將特定的CPU內核空出專門用于處理網絡中斷。 接受一個數組作為參數，array(0, 1) 表示不使用CPU0,CPU1 >此選項必須與open_cpu_affinity同時設置才會生效示例： ```php 'cpu_affinity_ignore' => array(0, 1) ``` ##open_tcp_nodelay 描述：啟用open_tcp_nodelay 說明：開啟后TCP連接發送數據時會無關閉Nagle合并算法，立即發往客戶端連接。在某些場景下，如http服務器，可以提升響應速度。 示例： ```php 'open_tcp_nodelay' => true ``` ##tcp_defer_accept 描述：啟用tcp_defer_accept特性 說明：啟動后，只有一個TCP連接有數據發送時才會觸發accept。 示例： ```php 'tcp_defer_accept' => true ``` ##open_tcp_keepalive 描述：打開TCP的KEEP_ALIVE選項 說明：使用TCP內置的keep_alive屬性，用于保證連接不會因為長時閑置而被關閉。 示例： ```php 'open_tcp_keepalive' => true ``` ##tcp_keepidle 描述：指定探測間隔。 說明：配合[open_tcp_keepalive](#24open_tcp_keepalive)使用，如果某個連接在[tcp_keepidle](#25tcp_keepidle)內沒有任何數據來往，則進行探測。 示例： ```php 'tcp_keepidle' => 600 ``` ##tcp_keepinterval 描述：指定探測時的發包間隔 說明：配合[open_tcp_keepalive](#24open_tcp_keepalive)使用 示例： ```php 'tcp_keepinterval' => 60 ``` ##tcp_keepcount 描述：指定探測的嘗試次數 說明：配合[open_tcp_keepalive](#24open_tcp_keepalive)使用，若[tcp_keepcount](#27tcp_keepcount)次嘗試后仍無響應，則判定連接已關閉。 示例： ```php 'tcp_keepcount' => 5 ``` ##backlog 描述：指定Listen隊列長度 說明：此參數將決定最多同時有多少個等待accept的連接。 示例： ```php 'backlog' => 128 ``` ## chroot 描述：重定向Worker進程的文件系統根目錄 說明：此設置可以使進程對文件系統的讀寫與實際的操作系統文件系統隔離。提升安全性。 >需要swoole-1.7.9+ 示例： ```php 'chroot' => '/data/server/' ``` ## user/group 描述：設置worker/task子進程的所屬用戶/用戶組 說明：此設置可以使進程對文件系統的讀寫與實際的操作系統文件系統隔離。提升安全性。 >需要swoole-1.7.9+ 僅在使用root用戶啟動時有效示例： ```php 'user' => 'www' 'group' => 'www' ``` ## discard_timeout_request 描述：設置是否丟棄已經超時的請求 說明：swoole在配置dispatch_mode=1或3后，系統無法保證onConnect/onReceive/onClose的順序，因此可能會有一些請求數據在連接關閉后，才能到達Worker進程。 > discard_timeout_request配置默認為true，表示如果worker進程收到了已關閉連接的數據請求，將自動丟棄。 discard_timeout_request如果設置為false，表示無論連接是否關閉Worker進程都會處理數據請求。需要swoole-1.7.16+ 示例： ```php 'discard_timeout_request' => true ``` ## enable_reuse_port 描述：設置端口重用 說明：此參數用于優化TCP連接的Accept性能，啟用端口重用后多個進程可以同時進行Accept操作。 >僅在Linux-3.9.0以上版本的內核可用示例： ```php 'enable_reuse_port' => true ``` ##ssl_cert_file和ssl_key_file 描述：設置SSL隧道加密 說明：設置值為一個文件名字符串，指定**cert證書**和**key**的路徑。 示例： ```php 'ssl_cert_file' => '/config/ssl.crt', 'ssl_key_file' => '/config//ssl.key', ``` ## ssl_client_cert_file 描述：指定CA證書路徑 說明：開啟雙向SSL認證時，需要指定客戶端所使用的CA證書 示例： ```php 'ssl_client_cert_file' => '../ca.crt' ``` ## ssl_verify_depth 描述：設置客戶證書認證鏈的長度 說明：開啟雙向SSL認證時使用 示例： ```php 'ssl_verify_depth' => 1 ``` ## ssl_method 描述：設置OpenSSL隧道加密的算法 說明：Server與Client使用的算法必須一致，否則SSL/TLS握手會失敗，連接會被切斷。默認算法為 SWOOLE_SSLv23_METHOD >SWOOLE_SSLv3_METHOD SWOOLE_SSLv3_SERVER_METHOD SWOOLE_SSLv3_CLIENT_METHOD SWOOLE_SSLv23_METHOD（默認加密方法） SWOOLE_SSLv23_SERVER_METHOD SWOOLE_SSLv23_CLIENT_METHOD SWOOLE_TLSv1_METHOD SWOOLE_TLSv1_SERVER_METHOD SWOOLE_TLSv1_CLIENT_METHOD SWOOLE_TLSv1_1_METHOD SWOOLE_TLSv1_1_SERVER_METHOD SWOOLE_TLSv1_1_CLIENT_METHOD SWOOLE_TLSv1_2_METHOD SWOOLE_TLSv1_2_SERVER_METHOD SWOOLE_TLSv1_2_CLIENT_METHOD SWOOLE_DTLSv1_METHOD SWOOLE_DTLSv1_SERVER_METHOD SWOOLE_DTLSv1_CLIENT_METHOD 示例： ```php 'ssl_method' => SWOOLE_SSLv23_METHOD ``` ## ssl_ciphers 描述：配置SSL加密套件 說明：啟用http2協議后，Chrome/Firefox等瀏覽器要求必須使用高強度加密套件。某些低版本瀏覽器可能不支持默認的加密套件，可設置為空字符串兼容低版本瀏覽器 ? 示例： ```php 'ssl_ciphers' => 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH' ```