CSpeed框架,全堆栈的基于C语言的PHP扩展框架,以高性能为目标
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
IDE
demo
kernel
tests
.deps
CREDITS
EXPERIMENTAL
README.md
classes.c
config.m4
config.w32
cspeed.c
cspeed.php
php_cspeed.h
run-tests.php
操作手册.md

README.md

CSpeed 基于C语言的扩展框架 v2.1.13手册

快速上手

CSpeed作为一个开源C语言PHP扩展,为了更加方便开发者进行项目的开发,特意制作了本扩展,简化WEB、API开发工作,开发者只需要下载源码,源码目录包含有一个 ”demo“ 目录,即可快速上手框架来完成开发工作

环境

CSpeed 基于 PHP7.x 开发,使用环境要求:

1、Linux/mac OSX

2、PHP7.x

CSpeed v2.1.13 分布式数据库 alpha

新版本 v2.1.13 分布式数据库的测试版本。需要拉取分布式数据库分支源码
目前已经初具模型:
采用Bison & Flex 进行语法与词法分析
底层采用 PDO 进行数据库操作

不支持的特性[ 后续版本添加支持 ]:

1. SELECT 语句不支持 模糊查询如下:
	SELECT *
	如果一定需要模糊查询,请使用替换语法:
	SELECT tablename.* 进行替换
	
2. 不支持 SELECT 的嵌套查询,如:
	SELECT name,age FROM (SELECT supjos.* FROM supjos) AS tmp

3. 不支持批量 INSERT INTO

4. 不支持 SELECT 查询的表的 AS 别名
	

支持:

1. SELECT 查询

2. INSERT 插入

3. UPDATE 更新

4. DELETE 删除

在进行 INSERT | UPDATE | DELETE 操作的时候必须指定配置文件所配置的 shardingKey 字段,否则引擎会提示:

INSERT操作:

SQL: 1064 'INSERT' command must provide shardingKey..

DELETE操作:

DELETE command must provide `shardingKey` WHERE condition.

UPDATE操作:

UPDATE command must provide `shardingKey` IN WHERE condition.

示例:

// 初始化分布式数据库模型
$adapter = new DbAdapter();

// 加载配置文件
// 分表、分库配置
$adapter->loadConfig([
    /** 分表数据表名称 */
    'tables' => [
        'supjos',
        'blog'
    ],
    /** 分表、分库键 */
    'shardingKey' => 'id',
    /** 水平分表大小 */
    'hSize' => 2,
    /** 分库数据库适配器[读写分离] */
    'readDb'    => [
        'db',
        'db2'
    ],
    /** 分库数据库适配器[读写分离] */
    'writeDb'   => [
        'db2'
    ],
    /**1. 读写分离. 2. 全部操作使用readDb 3. 全部操作使用writeDb*/
    'balance' => 1,
	/* 当数据库适配器不存在容器中的时候是否显示错误信息 */
	'displayDbNotExistError' => true    
]);

// 执行SQL操作
$adapter->createCommand(
    "SELECT supjos.id,supjos.name,supjos.age as sage,blog.name as bname FROM supjos,blog WHERE blog.id IN(1,2)"
);

// 打印SQL结果
print_r($adapter->execute());

安装 CSpeed v2.1.13

CSpeed 扩展目前在 Github码云 平台均有代码存储库,用户只需下载源码然后按照如下方法安装即可:

Github:

https://github.com/liqiongfan/cspeed

码云:

https://gitee.com/josinli/cspeed

安装步骤:

1/usr/local/php_to_path/bin/phpize

2./configure --with-php-config=/usr/local/php_to_path/bin/php-config

3make install 

编译完成后在 php.ini 配置文件添加如下内容:

extension_dir = "/usr/local/php-7.1.8-nts/lib/php/extensions/no-debug-non-zts-20160303/"

extension=cspeed.so

然后重启 Nginx 的 PHP-FPM 或者 Apache:

4systemctl restart php-fpm 或者 systemctl restart httpd

路由环境配置

默认情况下 CSpeed 会从服务器的请求参数 PATH-INFO 获取路由信息并进行解析,用户也可以配置成从 URL 获取 GET参数 来进行路由解析,开发者仅需要从ini配置文件设置即可,如下:

core.path.info.symbol           = __url              ; 使用GET形式获取路由URL的GET参数名
core.path.info.mode             = get                ; PATH(PATH-INFO)、GET、AUTO

core.path.info.symbol 配置 GET 参数的解析参数值,如果配置CSpeedURL 解析参数,用户可以自定义URL中的路由段以完成路由解析,默认值:__csurl,用户可以自定义此字段灵活进行框架的配置解析

core.path.info.mode 定义 CSpeed的路由解析模式,默认情况为 PATH-INFO 模式,用户可以在此处定义 GET、AUTO、PATH 模式,GET 模式的灵活设置需要用户配置 core.path.info.symbol选项,如果配置成 AUTO模式,CSpeed会自动从两种模式中获取有路由字段的进行解析,如果PATH-INFO 模式与 URL 模式具有路由字段信息,则以 PATH-INFO 为准.

下方分别列出两种模式的 nginx 配置:

PATH-INFO

location / {
    if (!-e $request_filename) {
        rewrite ^/(.*)$ /index.php/$1 last;
        break;
    }
}

location ~ \.php {
    fastcgi_pass   127.0.0.1:9000;
    fastcgi_index  index.php;  
    fastcgi_split_path_info ^(.+\.php)(/.+)$;
    fastcgi_param  PATH_INFO $fastcgi_path_info;
    fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
    include        fastcgi_params;
}

URL(CSpeed系统默认的__csurl模式)

location / {
    rewrite ^/(.*)$ /index.php?__csurl=/$1 last;
}

location ~ \.php {
    fastcgi_pass   127.0.0.1:9000;
    fastcgi_index  index.php;  
    fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
    include        fastcgi_params;
}

对比于 PATH-INFO 模式, URL 模式情况下 nginx 的配置文件的所需配置选项也相应的变得简单,用户可以在此种模式下通过设置 core.path.info.symbol_url( CSpeed 系统默认值:__csurl)来兼容 Phalcon 框架的路由

框架特性

1、JSON-RPC 分布式支持

服务端代码:

namespace app\modules\rpc\controllers;

class Goods extends \Cs\rpc\Server
{
    
    function initialise()
    {
        // handle函数绑定 RPC 服务端处理类
        $this->handle($this);
    }
    
    // ----- 所有的对外的 RPC 方法
    
    /**
     * 每一个 RPC 方法都包含一个 参数(本方法使用:$params)用来接收客户端的发送的请求信息
     * $params是一个数组,数组的每一项对应于请求参数的每一项
     * 如果需要将数据返回给客户端,只需要将所需数据 return 即可.
     */
    function listsRpc($params)
    {
        return [ 'version' => '2.1.11', 'kernel' => 'CSpeed' ];
    }
    
    /**
     * 添加商品服务
     */
    function addRpc($params)
    {
        // TODO ..
    }
    
    /**
     * 删除商品服务
     */
    function deleteRpc($params)
    {
        // TODO...
    }
    
    // 等等服务代码
}

客户端代码:


// 绑定RPC的服务端地址,注意地址必须是有效的地址,且携带 http 或者 https 前缀
$goodsServer = new \Cs\rpc\Client("http://www.xxx.com/index/goods");

// $lists就是服务器端返回的符合RPC规范的数据,开发者需要自行解析,如下示例:
// {"jsonrpc":"2.0","id":1,"result":{"version":"2.1.11","name":"CSpeed"}}
$lists = $goodsServer->lists();

传入单个参数,如:


$goodsServer = new \Cs\rpc\Client("http://www.xxx.com/index/goods");
$lists = $goodsServer->lists(['id' => 11, 'category' => 'fruit']);

在服务端的方法内参数就是一个包含如下变量的数组:


namespace app\modules\rpc\controllers;

class Goods extends \Cs\rpc\Server
{
    
    function initialise()
    {
        // handle函数绑定 RPC 服务端处理类
        $this->handle($this);
    }
    
    /**
     * 参数 $params 就是一个数组,数组的内容如下:
     * $params = [
     *     [
     *         'id'       => 11,
     *         'category' => 'fruit
     *     ]
     * ]
     */
    function listsRpc($params)
    {
    
    }
    
}

也可以传入多个参数:


$goodsServer = new \Cs\rpc\Client("http://www.xxx.com/index/goods");
$lists = $goodsServer->lists(11, 'cspeed');

在服务端的方法内参数就是一个包含如下变量的数组:


namespace app\modules\rpc\controllers;

class Goods extends \Cs\rpc\Server
{
    
    function initialise()
    {
        // handle函数绑定 RPC 服务端处理类
        $this->handle($this);
    }
    
    /**
     * 参数 $params 就是一个数组,数组的内容如下:
     * $params = [
     *     11,
     *     'cspeed'
     * ]
     */
    function listsRpc($params)
    {
    
    }
    
}

2、解耦工厂: Cs\ObjectFactory

当一个系统越来越大、复杂的时候,这时候面对一个庞大复杂的系统,更改一个小功能都可能会导致需要进行无数次的代码更换或者重构,如果这时候使用 文件解耦 来进行处理,则后续工作都可以不用操作,全部交给 CSpeed 系统来完成,既方便有简单,并且性能也高。

Cs\ObjectFactory类只有两个方法:

function __construct($factoryFilePath)
{
}

// $key 就表示下方的 config.php 中的 rsa 与 aes 
function getObject($key)
{
}

CSpeed 解耦的配置文件配置如下所示[ config.php ]:


return [
    'rsa' => [
        'class'      => '\app\models\User',
        'params'     => [
            "hello", "CSpeed", "v2.1.11'
        ],
        'properties' => [
            'name' => '\app\models\Tools',
            'two'  => '\app\models\Tools'
        ],
        'values'     => [
            'abc'     => new stdClass(),
            'linux'   => 'Linux',
            'windows' => 'Windows',
            'macos'   => 'macOSX'
        ],
        'attrs'       => [
            'private' => false,
        ]
    ],
    'aes' => [
        'class'      => 'Cs\tool\Config',
        'properties' => [
            'data' => 'app\models\User'
        ]
    ]
];

用户只需要在 配置文件里面 返回一个指定格式的数组,即可

具体的格式如下:

数组的每一项是一个关联键值对,键对应于类表示ID,后续可以用来从CSpeed中获取对应的类对象,值表示一个数组,此数组对应于让CSpeed怎么初始化类,此数组格式如下:

class 表示:类对象,是一个包含命名空间的类名称
params 表示构造函数传入的参数
properties 表示:使用IOC setter方法注入的对象属性,是一个数组,数组的每一项对应于一个 setter 方法。
values 表示:初始化类对象的属性值
attrs 表示:哪种属性的类对象可以初始化,可选值:privateprotectedprivate

params数组

'params'     => [
    "hello", "CSpeed", "v2.1.11'
]

数组的每一项表示对应于类的构造函数的实际参数

properties数组

'properties' => [
    'name' => '\app\models\Tools',
    'two'  => '\app\models\Tools'
]

数组的每一项对应于一个 setter 方法,setter方法名为数组中每一项的键名,每一项的值表示setter方法注入的对象的类名称(包含命名空间),如上面所示,两个setter方法分别对应如下的PHP代码:

function setName(new \app\models\Tools());

function setTwo(new \app\models\Tools());

attrs数组

对应于怎么初始化类对象的属性

'attrs'       => [
    'private' => false,
]

上面就表示类对象的 private 属性不使用指定值初始化(不影响内部的private属性:OOP的封装特性),protected、public属性使用指定值进行初始化

3、观察者事件机制 Cs\tool\Component

当在开发一个拥有很多功能的系统或者模块的时候,可能需要处理很多相同的业务逻辑,通常的处理手法是:

1、使用继承,父类进行处理


class Commmon
{
    function __construct()
    {
        // TODO...
    }
}

class User extends Common
{
    function __construct()
    {
        parent::__construct();
    }
}

class Manager extnds Common
{
    function __construct()
    {
        parent::__construct();
    }
}

2、使用事件机制


class Test
{
    function __construct()
    {
        $this->on('before', funtion($obj){
            // TODO...
        });
    }
}

CSpeed 支持观察者事件机制,可以通过 Cs\tool\Component 来进行支持

Cs\tool\Component 包含如下三个方法:

function on($eventName, $eventClosure);

function off($eventName, $eventClosure = NULL);

function trigger($eventName);

CSpeed框架继承 Cs\tool\Component 的类如下三个:

Cs\mvc\Controller   
Cs\mvc\Model                
Cs\rpc\Server           

开发者只需要在如上三个类中的 initialise 方法内绑定事件即可, 注意:initialise方法在 CSpeed框架中,当存在此方法时,框架会从顶级父类开始执行到本类的initialise方法来完成初始化,也就是会先执行父类的initialise,然后执行子类initialise,直到本类的initialise方法,如:

namesapce app\modules\admin\controllers;

class User extends \Cs\mvc\Controller
{
    function initialise()
    {
        $this->on(self::EVENT_BEFORE_ACTION, function($object){
            // TODO...
        });
    }
}

4、统一入口初始化: Cs\BootInit接口

用户只需要定义一个 BootInit 的类,不适用命名空间,并且实现 Cs\BootInit 接口,然后把 BootInit 类的文件放入配置文件,即可让系统自动完成整套系统的初始化工作:

class BootInit implements Cs\BootInit
{
    // TODO...
    // 在此类中的以指定的前缀开头的方法都会被依次执行,如在配置文件指定方法前缀为:__init
    // 那么本类中所有的以 __init 开头的方法都会被执行
    function __initDi($di, $router)
    {
        // TODO... 
    }
    
    function __initRouter($di, $router)
    {
        // TODO...
    }
    
    function __initIOC($di, $router)
    {
        // TODO...
    }
}

5、模型支持切换数据库

在复杂的系统开发中,定制化的开发对应自身的系统开发具备非常优秀的开发效率,也便于自身的团队协作。 有时候针对于数据库会进行简单化的读写分离,那么分离后的代码结构可能会针对不同的模块进行二级分组等来提高系统的开发效率。如:

目录结构如下:

+app
  ++models
    ++read
      ++User
      ++Info
    ++write
      ++User
      ++Info

CSpeed 中,如果需要达到上面的代码架构,很简单,用户只需要在模型的构造函数里面,绑定相应的数据库即可。如:

namesapce app\models\read;

class User extends \Cs\mvc\Model
{
    function __construct()
    {
        // 构造函数内,必须显式执行父类的构造函数来完成初始化
        parent::__construct();
        
        // 设置当前模型使用 read 数据库连接
        $this->setDb('read');
    }
}

在使用 setDb 注入数据库的时候,需要先事先注入相应的数据库连接:


$di->set('read', function(){
    return new \Cs\db\pdo\Adapter([
        'dsn' => 'mysql:host=localhost;port=3306;dbname=supjos',
        'username' => 'root',
        'password' => 'root',
        'options'  => [                   // options参数非必填
           \PDO::ATTR_PERSISTENT => true, // 持久连接
           \PDO::ATTR_AUTOCOMMIT => 0     // 默认不自动提交
       ]
    ]);
});

6、强悍的路由

任何一个框架都应该有一套路由规则,以便用户可以自定义路由的走向来完成特定的功能。

CSpeed 框架支持 配置文件加载路由 与直接 添加路由 来完成

1、配置文件加载路由[ini文件]

如 [ router.ini 文件]:

/a/b/c=/b/c/a

/d/e/:controller:=/aa/bb/$1

/cspeed/version/:action:=/cspeed/{$1}/do

/index/index/index = /say/index/index

路由文件中的每一行代表一个路由规则,注意每一条路由规则不能包含空格,等号的左右分别代表 来源路由重定向路由, 来源路由表示URL地址栏输入的路由,重定向路由表示:当来源路由匹配的时候,需要重定向到的路由URL。如第一条表示: 当来源路由是:/a/b/c的时候,重定向到 /b/c/a路由,第二条规则,表示: 当来源路由是:/d/e/hello的时候,重定向到:/cspeed/hello/do,其中的:controller:表示 预定义正则,含义与正则表达式([^0-9-][a-zA-Z0-9-]*)一样,$1就表示上面正则([^0-9-][a-zA-Z0-9-]*)匹配的url

CSpeed 预定义的正则如下所示:

:action:、:controller:、:module:          表示 ([^0-9-][a-zA-Z0-9-]*)
:any:                                         表示 ([^/]+)
:id:                                          表示 ([0-9]+)

7、命令行模式支持

注意:CSpeed 框架支持的命令行模式的控制器类是不支持使用命名空间的控制器类。

一个命令行模式的CSpeed应用只需要如下两步即可:

1、编写入口文件[index.php]

$task = new \Cs\console\Task();

// 或者也可以使用参数形式初始化系统,参数格式与 Cs\App 一致
$task = new \Cs\console\Task("xxx/xxx.ini", "dev");

// 运行命令行
$task->run($argv[1]);

2、在bash目录运行如下命令

php -f index.php hello/world/cspeed

来执行 hello模块 world控制器 cspeed方法

注意:在CSpeed中方法以Action或者Rpc结尾,以Action结尾的方法表示路由方法,Rpc结尾的方法是RPC服务端的暴露方法

8、完善的ActiveRecord特性

在应用的开发过程中,都会遇到不想手工编写SQL的烦恼,以及面临SQL注入的危险,这时候使用框架封装的方法来执行SQL以牺牲性能来换取便利与安全。

如,假设数据有 www_product 表,表中有四个字段:time, name, version, id,如下建立模型:

namespace app\models;

class Good extends \Cs\mvc\Model
{
    // 不建议用户使用构造函数,务必记住,如果定义构造函数,一定需要调用父类的
    // 构造函数
    function __construct()
    {
        parent::__construct();
    }
    
    // 使用本方法完成一些初始化工作
    function initialise($object)
    {
        // TODO...
        // 此方法只要存在就一定执行,不管是new模型还是find获取模型
        // [注意]:构造函数只有在new模型的时候执行。
        // 方法传入了本类的对象(此处是$object代表Good对象)作为参数
    }
    
    function tableName()
    {
        return 'www_product';
    }
}

CSpeed框架中,默认情况下:one() 函数返回类对象,all() 函数返回类对象数组,数组中的每一项代表一个类对象,方便用户进行 AR 操作。如果需要获取数组格式的查询数组,请调用类的 asArray()方法后调用相应的 one()或者 all()方法。

CURD

添加一条记录[C]:

$good = new \app\models\Good();

$good->time = date('Y-m-d H:i:s');
$good->name = 'CSpeed';
$good->version = '2.1.11';
$good->id = 1;
$good->has = 1;

if ($good->save()){
    // TODO...
    // 成功添加记录
} else {
   // TODO...
   // 添加记录失败
}

更新记录[U]:

$good = \app\models\Good::find();

if ($good->where([ 'id' => 1 ])->save([
    'name'   => 'CSpeed-V2.1.11',
    'version => 'v2.1.11' 
])){
    // TODO...
} else {
    // TODO...
}

查找记录[R]

$good = \app\models\Good::find();

// 返回对象
$lists = $good->orderBy(['id DESC', 'age ASC'])->all();

// 返回数组
$lists = $good->orderBy("id DESC")->asArray()->all();

// 查询一条记录
$lists = $good->orderBy(['id DESC', 'age ASC'])->one();

//返回数组
$lists = $good->orderBy(['id DESC', 'age ASC'])->asArray()->one();

删除记录[D]:

$good = \app\models\Good::find();

if ($good->where([ 'id' => 1 ])->delete()){
    // TODO...
} else {
    // TODO...
}

9、最简单的MVC框架

B/S 架构开发中, MVC 开发模式无疑最快、效率最高。现代的软件开发中:提高代码重用、增加开发速度和减少维护修改量无疑作为了一个重点。

CSpeed 性能

测试命令:

/usr/local/httpd-2.4.29/bin/ab -c100 -n100000 http://www.supjos.com/hello/cspeed/

测试结果:

Concurrency Level:      100
Time taken for tests:   9.781 seconds
Complete requests:      100000
Failed requests:        0
Total transferred:      18500000 bytes
HTML transferred:       0 bytes
Requests per second:    10223.94 [#/sec] (mean)
Time per request:       9.781 [ms] (mean)
Time per request:       0.098 [ms] (mean, across all concurrent requests)
Transfer rate:          1847.10 [Kbytes/sec] received

Connection Times (ms)
          min  mean[+/-sd] median   max
Connect:        0    1   0.9      0       9
Processing:     1    9   1.8      9      25
Waiting:        1    9   1.8      9      24
Total:          4   10   1.3     10      28
WARNING: The median and mean for the initial connection time are not within a normal deviation
    These results are probably not that reliable.

Percentage of the requests served within a certain time (ms)
  50%     10
  66%     10
  75%     10
  80%     10
  90%     11
  95%     12
  98%     13
  99%     13
 100%     28 (longest request)

附录·系统配置

CSpeed系统全部采用 ini 格式的配置文件

[core]
core.application                = ../app                 ; WEB目录
core.bootstrap                  = ../app/bootstrap.php   ; 指定bootstrap 类目录
core.bootstrap.class.name       = BootInit               ; 引导类名称
core.bootstrap.method.string    = __init                 ; 指定Bootstrap类的初始化方法的前缀 
core.router.modules             = index,home,back        ; 注册多模块
core.router.default.module      = index                  ; 默认模块
core.router.default.controller  = index                  ; 默认控制器
core.router.default.action      = index                  ; 默认方法
core.view.ext                   = phtml                  ; 视图文件后缀
core.view.auto.render           = on                     ; 是否自动渲染视图,ontrueyes:自动渲染、offfalseno:不渲染
core.url.pattern                = .html                  ; 伪静态设置
core.debug.mode                 = on                     ; 是否开启调试模式 ontrueyes:开启调试模式、offfalseno:关闭调试模式
core.path.info.symbol           = __csurl                ; 使用GET形式获取路由URLGET参数名
core.path.info.mode             = auto                   ; PATH(PATH-INFO)、GETAUTO

[db]
db.master.dsn                   =  'mysql:host=localhost;port=3306;dbname=supjos'    ; 数据库类型
db.master.username              =  root                                              ; 数据库用户名
db.master.password              =  3333                                              ; 数据库密码

[dev:core]
core.application                = ../app                 ; WEB目录
core.bootstrap                  = ../app/bootstrap.php   ; 指定bootstrap 类目录
core.bootstrap.class.name       = BootInit               ; 引导类名称
core.bootstrap.method.string    = __init                 ; 指定Bootstrap类的初始化方法的前缀 
core.router.modules             = index,home,back        ; 注册多模块
core.router.default.module      = index                  ; 默认模块
core.router.default.controller  = index                  ; 默认控制器
core.router.default.action      = index                  ; 默认方法
core.view.ext                   = phtml                  ; 视图文件后缀
core.view.auto.render           = on                     ; 是否自动渲染视图,ontrueyes:自动渲染、offfalseno:不渲染
core.url.pattern                = .html                  ; 伪静态设置
core.debug.mode                 = on                     ; 是否开启调试模式 ontrueyes:开启调试模式、offfalseno:关闭调试模式
core.path.info.symbol           = __csurl                ; 使用GET形式获取路由URLGET参数名
core.path.info.mode             = auto                   ; PATH(PATH-INFO)、GETAUTO

[dev:db]
db.master.dsn                   =  'mysql:host=localhost;port=3306;dbname=supjos'    ; 数据库类型
db.master.username              =  root                                              ; 数据库用户名
db.master.password              =  3333                                              ; 数据库密码

PhpStorm 代码提示

如果用户需要使用 PhpStorm 的代码提示功能,只需要下载源码,然后根据 IDE 中的 README.md 文档要求操作即可

QQ群交流

https://jq.qq.com/?_wv=1027&k=5kSunAR

欢迎 star 或者给与宝贵的意见与建议,您的建议是 CSpeed 前进的动力。

CSpeed 扩展官方QQ群号: 605383362