ASF 基于Swoole开发的PHP App Server框架
宰父涵忍
App Server Framework（ASF）
简介
- 当前版本0.01试用版。
- 框架基于PHP-Swoole扩展开发，通过配置文件可以自定义各种应用协议，默认支持http协议。
- 框架本身是一个完整的tcp_server，不再需要apache,nginx,fpm这些，框架已包含log处理，mysql访问封装。
- 框架用fast-route库来做http route处理，直接映射到控制器上,使用者只要写具体的控制器方法就可以实现rest风格的API。
- 至于性能，可以很低调的说：相当高，具体可以参考swoole相关文档：
http://www.swoole.com/
安装运行
环境：linux2.6+、php5.5+、mysql5.5+、swoole1.7.20+
下载：https://github.com/xtjsxtj/asf
tar zxvf asf.tar.gz
cd asf
php ./bin/asf.php test_http start
也可以直接进入具体server目录直接运行入口脚本文件：
cd asf/apps/test_http
php ./index.php
查看当前server进程状态：
php asf/bin/asf.php test_http status
查看所有server运行状态：
php asf/bin/asf.php list目录结构
ASF
├── apps #示例server或实际应用server（实际应用不限制一定放在该目录）
│ ├── test_http #具体应用server示例，http_server
│ │ ├── config #应用配置文件目录
│ │ │ ├── server_conf.php #server控制进程配置文件
│ │ │ └── worker_conf.php #worker处理进程配置文件
│ │ ├── controller #应用控制器目录
│ │ │ ├── base_controller.php #业务相关控制器的基类
│ │ │ └── index_controller.php #业务相关具体控制器类
│ │ └── index.php #应用入口主文件(不限于该名称)，可以单独调用，可以通过bin/asf.php说统一调用
│ │
│ └── test_tcp #具体应用server示例，http_server
│ ├── config #应用配置文件目录
│ │ ├── server_conf.php #server控制进程配置文件
│ │ └── worker_conf.php #worker处理进程配置文件
│ ├── controller #应用控制器目录
│ │ ├── base_controller.php #业务相关控制器的基类
│ │ └── index_controller.php #业务相关具体控制器类
│ ├── protocol #TCP自定义协议目录
│ │ └── voip_protocol.php #VOIP协议自定义解析类
│ └── index.php #应用入口主文件(不限于该名称)，可以单独调用，可以通过bin/asf.php说统一调用
├── bin
│ ├── asf.php #多server起动状态监控shell脚本
│ └── asf.ini #多server列表配置文件
└── lib #ASF底层代码
├── fast-route #fast-route库目录
├── autoload.php #自动加载脚本
├── config.php #route配置脚本
├── controller.php #控制器父类
├── protocol.php #tcp协议解析interface
├── log.php #日志类
├── mysql.php #mysql访问类
├── route.php #http route解析类
└── swoole.php #swoole扩展底层类 http_server开发
当protocol为http（不设置则默认为http），server运行为http_server，这种模式下默认不需要做任何额外的配置，系统会按默认的路由规则分发到具体的控制器中处理，开发者只需要写具体的控制器和方法就可以。
下面是http_server，test_http的开发流程：
server配置文件：apps/test_http/config/server_conf.php
<?php class server_conf { public static $config=array( 'server_name' => 'test_http', //server名称 'log_level' => NOTICE, //跟踪级别 'listen' => 9501, //listen监听端口 'log_file' => '/asf/apps/test_http/index.log', //log文件 ); }worker配置文件：apps/test_http/config/worker_conf.php
<?php class worker_conf{ public static $config=array( 'log_level' => DEBUG, 'mysql' => array( 'socket' => '/tmp/mysql.sock', 'host' => 'localhost', 'port' => 3306, 'user' => 'user', 'password' => 'password', 'database' => 'test', 'charset' => 'utf8', ), }唯一主入口脚本：apps/test_http/index.php
<?php> define('BASE_PATH', __DIR__); require_once BASE_PATH.'/../../lib/autoload.php'; require_once BASE_PATH.'/config/server_conf.php'; $server = new swoole(); $server->start();控制器：apps/test_http/controller/index_controller.php
<?php class index_controller extends base_controller { public function index() { log::prn_log(DEBUG, json_encode($this->content)); log::prn_log(DEBUG, json_encode($this->param)); return 'ok'; } }index_controller基于父类base_controller实现，而base_controller必须基于lib/controller.php的controller实现。
在这种默认的配置下：访问
http://localhost:9501/index/index 路由将会执行上面index_controller控制器中的index方法，http调用返回的结果是：ok
tcp_server开发
当protocol不为http，server就运行为tcp_server，这种模式下需要开发者自行处理TCP协议包的解析。
开发者可以自定义protocol名称，同时必须自行实现该协议的解析类。
下面是tcp_server，test_tcp的开发流程：
server配置文件：apps/test_tcp/config/server_conf.php
<?php class server_conf { public static $config=array( 'server_name' => 'test_tcp', //server名称 'protocol' => 'voip', //自定义协议名称 'log_level' => NOTICE, //跟踪级别 'listen' => 9511, //listen监听端口 'log_file' => '/asf/apps/test_tcp/index.log', //log文件 ); }worker配置文件：apps/test_tcp/config/worker_conf.php
<?php class worker_conf{ public static $config=array( 'log_level' => DEBUG, 'mysql' => array( 'socket' => '/tmp/mysql.sock', 'host' => 'localhost', 'port' => 3306, 'user' => 'user', 'password' => 'password', 'database' => 'test', 'charset' => 'utf8', ), }唯一主入口文件：apps/test_tcp/index.php
<?php> define('BASE_PATH', __DIR__); require_once BASE_PATH.'/../../lib/autoload.php'; require_once BASE_PATH.'/config/server_conf.php'; $server = new swoole(server_conf::$config); $server->start();自定义voip协议解析类
apps/test_tcp/protocol/voip_protocol.php<?php class voip_protocol implements protocol{ public static function input($serv, $fd, $data){ return strlen($data); } public static function decode($serv, $fd, $data){ return $data; } public static function request($serv, $fd, $data){ $db = $serv->mysql; $obj = new index_controller($serv, $data); return $obj->index(); } public static function encode($serv, $fd, $data){ return $data; } }类名和文件名为server_conf中的{protocol}_protocol，并且必须基于lib/protocol.php的interface实现。
配置文件详解
- ASF框架程序配置分为两部分，一个是系统进程的配置server_conf，不能动态修改。
- 另一个是工作进程的配置worker_conf，可以动态修改，修改后通过asf.php server_name reload生效。
- 下面分开详细介绍。
server_conf.php配置文件详解
示例
$config=array( 'server_name' => 'test_http', 'protocol' => 'http', 'log_level' => NOTICE, 'is_sington' => true, 'listen' => ['0.0.0.0:9501', '172.16.18.116:9502'], 'worker_num' => 1, 'daemonize' => true, 'log_file' => '/asf/apps/test_http/index.log', );server_name
sever名称，必须配置，当起动多个server时，保证每个server_name的唯一。protocol
tcp_server协议类型，必须配置，支持http和各种其它自定义协议，如：voip。
如果是http以外的协议名称，则开发必须基于lib/protocol.php interface实现自定义协议解析类。log_level
跟踪级别，必须配置，TRACE,DEBUG,INFO,NOTICE,WARNING,ERROR。is_sington
是否单例运行，可选配置，默认为true，即单实例运行。
假如server_name为test_http，那么server启动后默认会在/var/local目录下生成一个唯一的pid文件：swoole_test_http.pid。listen
监听端口，必须配置，可以是如下几种配置方式：
'listen' => 9501
'listen' => [9501,9502]
'listen' => ['0.0.0.0:9501', '172.16.18.116:9502']worker_num
工作进程数量，可选配置，默认为6个工作进程daemonize
是否以守护进程方式运行，可选配置，默认为true，即以后台方式运行。log_file
跟踪文件，必须配置。最简配置
$config=array( 'server_name' => 'test_http', //server_name 'log_level' => NOTICE, //log_level 'listen' => 9501, //listen port 'log_file' => '/asf/apps/test_http/index.log', //logfile );
worker_conf.php配置文件详解
- 示例
$config=array(
'log_level' => DEBUG,
'mysql' => array(
'socket' => '/tmp/mysql.sock',
'host' => 'localhost',
'port' => 3306,
'user' => 'user',
'password' => 'password',
'database' => 'test',
'charset' => 'utf8',
),
'route' => [
['PUT', '/user/{number}/{id:\d+}', 'index.index'],
['GET', '/{controller}/{number}/{id:\d+}', '_handler.controller_param'],
['GET', '/{controller}/{number}', '_handler.controller_param'],
['POST', '/{controller}/{number}/{id:\d+}', '_handler.controller_param'],
['DELETE', '/{controller}/{number}/{id:\d+}', '_handler.controller_param'],
],
);该配置文件分成三个部分。
* log_level
工作进程的跟踪级别，取值同server_conf中相同，reload后重新生效。
- myql
数据库连接属性配置
'socket' => '/tmp/mysql.sock',//sock连接
'host' => 'localhost', //mysql主机
'port' => 3306, //mysql端口
'user' => 'user', //mysql用户，必须参数
'password' => 'password', //mysql密码，必须参数
'database' => 'database', //数据库名称，必须参数
'charset' => 'utf8', //连接数据库字符集
'sqls' => 'set wait_timeout=24*60*60*31;set wait_timeout=24*60*60*31'
//连接数据库后需要执行的SQL语句,以';'分隔的多条语句route
该配置项只在protocol=http时生效，其它自定义协议名称该配置项无效。
底层根据这里配置的跌幅规则，将http不同的uri请求分配给相应的控制器处理。
具体规则在下面http_server节中详细说明。最简配置
$config=array( 'log_level' => DEBUG, 'mysql' => array( 'socket' => '/tmp/mysql.sock', 'host' => 'localhost', 'port' => 3306, 'user' => 'user', 'password' => 'password', 'database' => 'test', 'charset' => 'utf8', ), );
http_server的route规则配置
- 上面的http_server开发流程中，uri请求是按系统默认的路由分发到控制器去执行的。
- 其实ASF在http_server模式下，还可以按开发者的具体业务要求自定义路由规则到具体的控制器中处理。
- 自定义路由规则在worker_conf的route段下设置，下面我们详细介绍下http_server的route规则配置。
- 路由配置示例
$config=array(
'route' => [
['PUT', '/user/{number}/{id:\d+}', 'index.index'],
['GET', '/{controller}/{number}/{id:\d+}', '_handler.controller_param'],
['GET', '/{controller}/{number}', '_handler.controller_param'],
['POST', '/{controller}/{number}/{id:\d+}', '_handler.controller_param'],
['DELETE', '/{controller}/{number}/{id:\d+}', '_handler.controller_param'],
],
);配置格式
每一条配置规则为一数组类型：['Method', 'Route_reg', 'Controller.Action'] Method POST，GET，PUT，DELETE等,支持['POST','GET']方式 Route_reg 路由规则的正则表达式，用以匹配uri路径 Controller.Action 分配到的处理请求的控制器.方法控制器.方法
底层提供一个默认的控制器_handler，该控制器提供四个方法：- controller_action 解析’/index/index’ uri到相应的控制器的相应方法
- controller 解析’/index’ uri到相应的控制器的默认index方法
- controller_param 解析’/index/name/id’ uri到相应的控制器的默认index方法,同时附加param参数
- controller_action_param 解析’/index/index/name/id’ uri到相应的控制器的相应方法,同时附加param参数
用户自定义规则示例
['PUT', '/user/number/{id:\d+}', 'index.index'],
['PUT', '/user/{number}/{id:\d+}', 'index.index'],第1条规则可以匹配以下规则：
PUT http://localhost/user/number，分配到index控制器的index方法，同时控制器的$this->param参数中保存着：{"id":"123"}
第2条规则可以匹配以下规则：
PUT http://localhost/user/number，分配到index控制器的index方法，同时控制器的$this->param参数中保存着：{"number":"number","id":"123"}
- 默认规则
底层会在用户自定义的路由规则后面增加三条默认的规则：
lib/config.php
<?php
/**
* ASF http默认路由配置类
* @author jiaofuyou@qq.com
* @date 2015-10-25
*/
class Route_config{
public static $default_route = [
//以下这条为系统底层自动填加的路由规则
// POST http://localhost/index/index
['POST', '/{controller}/{action}[/]', '_handler.controller_action'],
// POST http://localhost/index
['POST', '/{controller}[/]', '_handler.controller'],
// POST http://localhost/index/index/prm/id
[['GET','POST'], '/{controller}/{param:.+}', '_handler.controller_param'],
];
}第1条规则可以匹配以下规则：
POST http://localhost/index/test，分配到index控制器的test方法。
第2条规则可以匹配以下规则：
POST http://localhost/index，分配到index控制器的默认index方法。
第3条规则可以匹配以下规则：
POST http://localhost/index/test/name/id，分配到index控制器的默认index方法,同时控制器的$this->param参数中保存着：[‘test’, ‘name’, ‘id’]
- 规则匹配顺序
系统按照先自定义规则，再默认规则的顺序执行，从上往下依次匹配，匹配到了就返回。
因此，定义规则时应该保证，具体的匹配规则在上面，通用的在下面。
tcp server 协议解析interface
- lib/protocol.php
<?php
/**
* Protocol interface
*/
interface protocol
{
/**
* 用于分包，即在接收的buffer中返回当前请求的长度（字节）
* 如果可以在$recv_buffer中得到请求包的长度则返回长度
* 否则返回0，表示需要更多的数据才能得到当前请求包的长度
* 如果返回false或者负数，则代表请求不符合协议，则连接会断开
* @param swoole_srver $serv swoole_server对象
* @param int $fd TCP客户端连接的文件描述符
* @param string $data 收到的数据内容，可能是文本或者二进制内容
* @return int|false
*/
public static function input($serv, $fd, $data);
/**
* 用于请求解包
* input返回值大于0，并且收到了足够的数据，则自动调用decode
* 然后触发on_request回调，并将decode解码后的数据传递给on_request回调的第三个参数
* 也就是说当收到完整的客户端请求时，会自动调用decode解码，无需业务代码中手动调用
* @param swoole_srver $serv swoole_server对象
* @param int $fd TCP客户端连接的文件描述符
* @param string $data 收到的完整的请求包，可能是文本或者二进制内容
* @return mixed
*/
public static function decode($serv, $fd, $data);
/**
* 用于请求分发处理，返回的结果传递给encode编码后返回给客户端
* @param swoole $serv server实例
* @param int $fd 客户端连接fd
* @param mixed $data decode返回的数据包
* @return mixed
*/
public static function request($serv, $fd, $data);
/**
* 用于请求打包
* 底层会自动把on_request返回的结果用encode打包一次，变成符合协议的数据格式
* 也就是说发送给客户端的数据会自动encode打包，无需业务代码中手动调用
* @param swoole_srver $serv swoole_server对象
* @param int $fd TCP客户端连接的文件描述符
* @param mixed $data
* @return string
*/
public static function encode($serv, $fd, $data);
}
- 自定义协议的tcp_server，必须基于interface protocol实现自定义协议的解析类。
http_server 底层控制器父类属性方法
- lib/controller.php
<?php
/**
* http请求处理控制器底层父类
* @author jiaofuyou@qq.com
* @date 2015-10-25
*/
class controller {
protected $server; //swoole_server对象
protected $mysql; //数据访问对象
protected $request; //解析后的数据包
protected $param; //附加参数
/**
* @param swoole $serv swoole实例
* @param mixed request
* @param array $param 附加参数
*/
public function __construct($server, $request, $param=[]) {
$this->server = $server;
$this->mysql = $server->mysql;
$this->request = $request;
$this->param = $param;
if (method_exists($this, '_init')) $this->_init();
}
public function __destruct() {
if (method_exists($this, '_deinit')) $this->_deinit ();
}
}- 应用server目录结构中的controller下的控制均继承自该底层父类。
系统起动脚本使用
asf.ini 文件说明
[servers] test_http = /home/jfy/testprog/asf/apps/test_http/index.php test_tcp = /home/jfy/testprog/asf/apps/test_tcp/index.php每一行格式为: server_name = path/index.php
这里的server_name必须与每个应用中的server_conf配置文件中的server_name相同。asf.php 脚本使用
php asf.php list列出asf.ini文件中配置的所有的server_name对应的服务的运行状态
php asf.php server_name start|stop|reload|restart|status|initreload： 平时重启工作进程，并重新加载worker_conf配置文件内容
restart： 重启整个server
status： 显示server进程状态
init： 根据test_http框架复制一份进应用目录框架server_name必须是asf.ini文件中已经定义好的。
log类使用方法
log类以静态类方式使用。
设置跟踪级别：
log::log_level = NOTICE;
支持：TRACE,DEBUG,INFO,NOTICE,WARNING,ERROR打印跟踪
log::prn_log(NOTICE, “message”);
支持：TRACE,DEBUG,INFO,NOTICE,WARNING,ERROR
mysql类使用方法
- 直接在控制器用$this->mysql来操作mysql数据库。
select_one( sqlstr, flag=true)
/** * 查询唯一记录 * @param string $sql 执行的SQL语句 * @flag bool 查询不到或查询到多条是否打印ERROR log * @return row(array) | false */select_more($sqlstr)
/** * 查询多条记录 * @param string $sql 执行的SQL语句 * @return result(array) | false */insert( data, flag=true)
/** * 插入单条记录 * @param array $data 插入数据字段数组['id' => 123, 'name' => 'jfy'] * @param bool $flag 是否打印成功跟踪，默认为true * @return id | false 成功返回自增字段ID，失败返回false * @see mysql->tabname->insert(['id' => 123, 'name' => 'jfy']); */insert_one( sqlstr, flag=true)
/** * 插入单条记录 * @param string $sql 执行的SQL语句 * @return true | false * $this->insert_id 为自增字段ID */update( data, cond)
/** * 更新单条记录 * @param array $data 更新数据字段数组['name' => 'jfy'] * @param array $cond 更新条件字段数组['id' => 123]，顺序与索引顺序相同 * @return true | false * @see $this->affected_rows 为更新记录数 * @see mysql->tabname->update(['name' => 'jfy'],['id' => 123]); */update_one($sqlstr)
/** * 更新单条记录 * @param string $sql 执行的SQL语句 * @return true | false * @see $this->affected_rows 为更新记录数 */update_more($sqlstr)
/** * 更新多条记录 * @param string $sql 执行的SQL语句 * @return true | false * @see $this->affected_rows 为更新记录数 */delete($cond)
/** * 删除单条记录 * @param array $cond更新条件字段数组['id' => 123]，顺序与索引顺序相同 * @return true | false * @see $this->affected_rows 为删除记录数 * @see mysql->tabname->delete(['id' => 123]); */delete_one($sqlstr)
/** * 删除单条记录 * @param string $sql 执行的SQL语句 * @return true | false * @see $this->affected_rows 为删除记录数 */
控制器操作mysql
apps/test_http/controller/index_controller.php
<?php
class index_controller extends base_controller {
public function index() {
log::prn_log(DEBUG, json_encode($this->content));
log::prn_log(DEBUG, json_encode($this->param));
$db = $this->mysql;
$result = $db->gearman_queue->insert([
'unique_key' => 'd847233c-1ef2-11e5-9130-2c44fd7aee72',
'function_name' => 'test',
'priority' => 1,
'data' => 'test',
'when_to_run' => 0,
]);
if ( $result === false ) return 'error';
$result = $db->select_one("select * from gearman_queue where unique_key='d847233c-1ef2-11e5-9130-2c44fd7aee72'");
if ( $result === false ) return 'error';
var_dump($result);
$result = $db->gearman_queue->update([
'function_name' => 'testtest',
'priority' => 100,
'data' => 'testtesttesttest',
'when_to_run' => 100,
],[
'unique_key' => 'd847233c-1ef2-11e5-9130-2c44fd7aee72',
]);
if ( $result === false ) return 'error';
var_dump($db->select_one("select * from gearman_queue where unique_key='d847233c-1ef2-11e5-9130-2c44fd7aee72'"));
$result = $db->gearman_queue->delete([
'unique_key' => 'd847233c-1ef2-11e5-9130-2c44fd7aee72',
]);
if ( $result === false ) return 'error';
$result = $db->select_more("select * from gearman_queue limti 3");
if ( $result === false ) return 'error';
var_dump($result);
return 'ok';
}
}
类似资料：