swoole常用配置设置

「爱情、让人受尽委屈。」 2022-05-03 08:57 452阅读 0赞

1.worker\_num

描述：指定启动的worker进程数。  
说明：swoole是master-> n \* worker的模式，开启的worker进程数越多，server负载能力越大，但是相应的server占有的内存也会更多，  
建议开启的worker进程数为cpu核数的1-4倍。  
示例：  
‘worker\_num’ => 8

2.max\_request  
描述：每个worker进程允许处理的最大任务数。  
说明：设置该值后，每个worker进程在处理完max\_request个请求后就会自动重启。设置该值的主要目的是为了防止worker进程处理大量请求后可能引起的内存溢出。  
示例：  
‘max\_request’ => 10000

3.max\_conn  
描述：服务器允许维持的最大TCP连接数  
说明：设置此参数后，当服务器已有的连接数达到该值时，新的连接会被拒绝。另外，该参数的值不能超过操作系统ulimit -n的值，同时此值也不宜设置过大，  
因为swoole\_server会一次性申请一大块内存用于存放每一个connection的信息。  
示例：  
‘max\_conn’ => 10000

4.ipc\_mode  
描述：设置进程间的通信方式。  
说明：共有三种通信方式，参数如下：  
1 => 使用unix socket通信  
2 => 使用消息队列通信  
3 => 使用消息队列通信，并设置为争抢模式  
示例：  
‘ipc\_mode’ => 1

5.dispatch\_mode  
描述：指定数据包分发策略。  
说明：共有三种模式，参数如下：  
1 => 轮循模式，收到会轮循分配给每一个worker进程  
2 => 固定模式，根据连接的文件描述符分配worker。这样可以保证同一个连接发来的数据只会被同一个worker处理  
3 => 抢占模式，主进程会根据Worker的忙闲状态选择投递，只会投递给处于闲置状态的Worker  
示例：  
‘dispatch\_mode’ => 2

6.task\_worker\_num  
描述：服务器开启的task进程数。  
说明：设置此参数后，服务器会开启异步task功能。此时可以使用task方法投递异步任务。  
设置此参数后，必须要给swoole\_server设置onTask/onFinish两个回调函数，否则启动服务器会报错。

示例：  
‘task\_worker\_num’ => 8

7.task\_max\_request  
描述：每个task进程允许处理的最大任务数。  
说明：参考max\_request task\_worker\_num  
示例：  
‘task\_max\_request’ => 10000

8.task\_ipc\_mode  
描述：设置task进程与worker进程之间通信的方式。  
说明：参考ipc\_mode  
示例：  
‘task\_ipc\_mode’ => 2

9.daemonize（非常重要）  
描述：设置程序进入后台作为守护进程运行。  
说明：长时间运行的服务器端程序必须启用此项。如果不启用守护进程，当ssh终端退出后，程序将被终止运行。启用守护进程后，标准输入和输出会被重定向到 log\_file，  
如果 log\_file未设置，则所有输出会被丢弃。  
示例：  
‘daemonize’ => 0

10.log\_file  
描述：指定日志文件路径  
说明：在swoole运行期发生的异常信息会记录到这个文件中。默认会打印到屏幕。注意log\_file 不会自动切分文件，所以需要定期清理此文件。  
示例：  
‘log\_file’ => ‘/data/log/swoole.log’

11.heartbeat\_check\_interval  
描述：设置心跳检测间隔  
说明：此选项表示每隔多久轮循一次，单位为秒。每次检测时遍历所有连接，如果某个连接在间隔时间内没有数据发送，则强制关闭连接（会有onClose回调）。  
示例：  
‘heartbeat\_check\_interval’ => 60

12.heartbeat\_idle\_time  
描述：设置某个连接允许的最大闲置时间。  
说明：该参数配合heartbeat\_check\_interval使用。每次遍历所有连接时，如果某个连接在heartbeat\_idle\_time时间内没有数据发送，则强制关闭连接。  
默认设置为heartbeat\_check\_interval \* 2。  
示例：  
‘heartbeat\_idle\_time’ => 600

13.open\_eof\_check  
描述：打开eof（end of file 文件读取到尾部）检测功能  
说明：与package\_eof 配合使用。此选项将检测客户端连接发来的数据，当数据包结尾是指定的package\_eof 字符串时才会将数据包投递至Worker进程，否则会一直拼接  
数据包直到缓存溢出或超时才会终止。一旦出错，该连接会被判定为恶意连接，数据包会被丢弃并强制关闭连接。  
EOF检测不会从数据中间查找eof字符串，所以Worker进程可能会同时收到多个数据包，需要在应用层代码中自行explode("\\r\\n", $data) 来拆分数据包  
示例：  
‘open\_eof\_check’ => true

14.package\_eof  
描述：设置EOF字符串  
说明：package\_eof最大只允许传入8个字节的字符串  
示例：  
'package\_eof ’ => ‘/r/n’

15.open\_length\_check  
描述：打开包长检测  
说明：包长检测提供了固定包头+包体这种格式协议的解析，启用后，可以保证Worker进程onReceive每次都会收到一个完整的数据包。  
示例：  
‘open\_length\_check’ => true

16.package\_length\_offset  
描述：包头中第几个字节开始存放了长度字段  
说明：配合open\_length\_check使用，用于指明长度字段的位置。  
示例：  
‘package\_length\_offset’ => 5

17.package\_body\_offset  
描述：从第几个字节开始计算长度。  
说明：配合open\_length\_check使用，用于指明包头的长度。  
示例：  
‘package\_body\_offset’ => 10

18.package\_length\_type  
描述：指定包长字段的类型  
说明：配合open\_length\_check使用，指定长度字段的类型，参数如下：  
‘s’ => int16\_t 机器字节序  
‘S’ => uint16\_t 机器字节序  
‘n’ => uint16\_t 大端字节序  
’N‘ => uint32\_t 大端字节序  
‘L’ => uint32\_t 机器字节序  
‘l’ => int 机器字节序  
示例：  
‘package\_length\_type’ => ‘N’

19.package\_max\_length  
描述：设置最大数据包尺寸  
说明：该值决定了数据包缓存区的大小。如果缓存的数据超过了该值，则会引发错误。具体错误处理由开启的协议解析的类型决定。  
示例：  
‘package\_max\_length’ => 8192

20.open\_cpu\_affinity  
描述：启用CPU亲和性设置  
说明：在多核的硬件平台中，启用此特性会将swoole的reactor线程/worker进程绑定到固定的一个核上。可以避免进程/线程的运行时在多个核之间互相切换，提高CPU Cache  
的命中率。  
示例：  
‘open\_cpu\_affinity’ => true

21.open\_tcp\_nodelay  
描述：启用open\_tcp\_nodelay  
说明：开启后TCP连接发送数据时会无关闭Nagle合并算法，立即发往客户端连接。在某些场景下，如http服务器，可以提升响应速度。  
示例：  
‘open\_tcp\_nodelay’ => true

22.tcp\_defer\_accept  
描述：启用tcp\_defer\_accept特性  
说明：启动后，只有一个TCP连接有数据发送时才会触发accept。  
示例：  
‘tcp\_defer\_accept’ => true

以下是对这个参数的解释：  
建立连接后，立即读数据（读取HTTP请求）。在这种情况下，client发出ACK（ACK (Acknowledgement），即确认字符，在数据通信中，接收站发给发送站的一种传输类控制字符。表示发来的数据已确认接收无误。）之后，server被唤醒（accept返回），并立即试图读数据，由于client还没有发数据，server又再度阻塞。这对于调度是一种浪费。  
另外，client发的那个ACK也没有实际作用，是不必要的。  
假如server端内核忽略client发的ACK，而直接等待数据，数据收到之后再唤醒serve（accept返回），server醒来后就可以直接得到数据并处理。这就是TCP\_DEFER\_ACCEPT的作用。

23.ssl\_cert\_file和ssl\_key\_file  
描述：设置SSL隧道加密  
说明：设置值为一个文件名字符串，指定cert证书和key的路径。  
示例：  
‘ssl\_cert\_file’ => ‘/config/ssl.crt’,  
‘ssl\_key\_file’ => ‘/config//ssl.key’,

24.open\_tcp\_keepalive  
描述：打开TCP的KEEP\_ALIVE选项  
说明：使用TCP内置的keep\_alive属性，用于保证连接不会因为长时闲置而被关闭。  
示例：  
‘open\_tcp\_keepalive’ => true

25.tcp\_keepidle  
描述：指定探测间隔。  
说明：配合open\_tcp\_keepalive使用，如果某个连接在tcp\_keepidle内没有任何数据来往，则进行探测。  
示例：  
‘tcp\_keepidle’ => 600

26.tcp\_keepinterval  
描述：指定探测时的发包间隔  
说明：配合open\_tcp\_keepalive使用  
示例：  
‘tcp\_keepinterval’ => 60

27.tcp\_keepcount  
描述：指定探测的尝试次数  
说明：配合open\_tcp\_keepalive使用，若tcp\_keepcount次尝试后仍无响应，则判定连接已关闭。  
示例：  
‘tcp\_keepcount’ => 5

28.backlog  
描述：指定Listen队列长度  
说明：此参数将决定最多同时有多少个等待accept的连接。  
示例：  
‘backlog’ => 128

29.reactor\_num  
描述：指定Reactor线程数  
说明：设置主进程内事件处理线程的数量，默认会启用CPU核数相同的数量， 一般设置为CPU核数的1-4倍，最大不得超过CPU核数\*4。  
示例：  
‘reactor\_num’ => 8

30.task\_tmpdir  
描述：设置task的数据临时目录  
说明：在swoole\_server中，如果投递的数据超过8192字节，将启用临时文件来保存数据。这里的task\_tmpdir就是用来设置临时文件保存的位置。  
需要swoole-1.7.7+  
示例：  
‘task\_tmpdir’ => ‘/tmp/task/’