woann / light-php
High performance framework based on swoole
Installs: 25
Dependents: 0
Suggesters: 0
Security: 0
Stars: 15
Watchers: 2
Forks: 6
Open Issues: 2
Type:project
Requires
- illuminate/database: ^5.7
- illuminate/pagination: ^5.7
- philo/laravel-blade: ^3.1
- vlucas/phpdotenv: ^2.5
This package is auto-updated.
Last update: 2024-11-04 19:38:19 UTC
README
🚀
Light-php
是一个基于swoole的高性能php框架,轻量的封装和易用性,使它在中小型高性能项目中有着出色的表现。
文档目录
环境要求
安装教程
1-1.通过Composer安装(packagist),此方式安装版本可能不是最新的,出现此问题请用1-2方式安装。
composer create-project woann/light-php -vvv
1-2.通过Git安装。
git clone https://github.com/woann/Light-php.git
2.重命名.env.example
文件为.env
,并配置
3.项目根目录下执行 php bin\light start
启动服务
4.浏览器访问http://127.0.0.1:9521
即可看到欢迎页面。至此,框架就安装完成了。
配置文件
1.Light-php的配置文件在/config
目录下,框架集成了全局环境配置文件/.env
,常规配置都在.env文件中进行配置。
2./config/app.php
,框架主要配置文件主要用来配置swoole
扩展相关参数。
3./config/databases.php
,数据库配置文件,配置了数据库连接相关参数。
4./config/hook.php
,配置钩子(钩子主要用来将业务逻辑和通知服务分离)。
5./config/redis.php
,redis
配置文件,配置了redis
连接相关参数。
6./config/route.php
,路由配置文件。
7.以上配置文件具体参数意义在代码中都有注释,这里不做更多介绍
路由
以下是一个路由示例/config/route.php
,包含http路由和websocket路由(注意:路由中,控制器参数为控制器的简写,实际控制器文件应在后追加Controller
)
return [ 'm' => 'index', //默认模块 'c' => 'index', //默认控制器 'a' => 'init', //默认操作 'ext' => '.html', //伪静态后缀 例如 .html 'http' => [ //http路由 //uri-----请求方法----模块/控制器/方法----[中间件] '/' => ['GET','Index/Index/index','Test'], 'test/' => ['GET','Index/Index/ws'] ], 'websocket' => [ //websocket路由 //uri----模块/控制器/方法 'ws' => 'Index/WebSocket/index', ] ];
中间件
中间件文件应建立在/app/Middleware
目录下,类名与文件名要一致,并实现Lib\Middleware
接口,中间件处理方法名必须为handle
,过滤后如果通过最终返回结果必须为true
。示例:
<?php namespace app\Middleware; use Lib\Middleware; class Test implements Middleware{ public function handle($request) { //在此处理中间件判断逻辑, //... //程序最后通过验证后,返回true; return true; } }
控制器
1.创建控制器,控制器文件应建立在/app/Controller
目录下,类名与文件名要一致,必须继承Lib\Controller
类,示例:
<?php namespace app\Controllers\Index; use Lib\Controller; class IndexController extends Controller { //普通输出 public function index() { return 'hello world'; } //输出json public function index1() { return $this->json(["code" => 200, "msg" => "success"]); } //调用模板 public function index2() { $a = "test"; //输出/app/resources/views目录下index.blade.php模板,并携带参数$a。支持用 . 拼接模板路径(和laravel中模板引擎部分一样) return $this->view("index",["a" => $a]); //也可以直接调用view函数 return view("admin.index",["a" => $a]); } }
2.获取参数
//获取get参数 $this->request->get();//获取所有get参数:array $this->request->get("name");//传参字符串,获取key为name的参数:string $this->request->get(["name","age"]);//传参数组,获取key为name和age的参数:array //获取post参数 $this->request->post();//获取所有get参数:array $this->request->post("name");//传参字符串,获取key为name的参数:string $this->request->post(["name","age"]);//传参数组,获取key为name和age的参数:array //获取上传文件 $this->request->getFiles();//获取所有 $this->request->getFile("image");//获取指定文件 //文件上传 //--------文件----[路径](基于/resources/uploads/)---[新文件名](默认为随机生成) uploadFile($file,"banner","test.png");//上传文件方法 开发者也可以不用此方法自己写上传操作
钩子
1.创建钩子,钩子文件应建立在/app/Hook
目录下,类名与文件名要一致,必须继承Lib\BaseHook
类,示例:
<?php namespace app\Hook; use Lib\BaseHook; use Lib\Log; class TestHook extends BaseHook { public function start($name,$ip,$port) { //当server启动时执行此钩子 Log::getInstance()->write('INFO',$name,"启动成功","{$ip}:{$port}","at",date('Y-m-d H:i:s')); } public function open($server,$fd){ //可以在此执行websocket链接成功后绑定用户id和fd的操作 } public function close($server,$fd){ //可以在此执行websocket关闭链接后解绑用户id和fd的操作 } }
2.在钩子配置文件/app/config/hook.php
中注册钩子
<?php return [ //Server::onStart 'start' => [ [\app\Hook\TestHook::class,'start'], ], //Server::onOpen 'open' => [ [\app\Hook\TestHook::class,'open'], ], //Server::onClose 'close' => [ [\app\Hook\TestHook::class,'close'], ], ];
3.使用钩子
//--获取钩子服务实例----监听方法--钩子名---参数(...)------ Hook::getInstance()->listen("start",$this->name,$this->config['ip'],$this->config['port']);
Task任务
1.创建Task类,Task文件应建立在/app/Task
目录下,类名与文件名要一致,示例:
<?php namespace app\Task; class Notice{ /** * 给所有在线客户端发送消息 * @param $fd 发起请求的FD * @param $data 要发送的内容 * * @return bool */ public function ToAll($fd,$data){ $fds = [] ;//用来存放所有客户端fd foreach($this->server->connections as $client_fd){ if($fd != $client_fd && $this->server->exist($client_fd)){ //循环向客户端输出消息,排除掉发送者fd $this->server->push($client_fd,$data); $fds[] = $client_fd; } } return "已向[".join(",",$fds)."]发送通知内容:".$data; } }
2.控制器中投递任务
//---------获取task示例----赋值server---------------投递任务---任务类------------方法------------参数 \Lib\Task::getInstance()->setServer($this->server)->delivery(\app\Task\Notice::class,'ToAll',[1,"123"]);
WebSocket
1.开启websocket server,配置.env
文件SERVER_TYPE=websocket
,此配置环境下可同时监听http
2.定义路由,参考文档路由部分,在路由配置文件/config/route.php
,websocket
索引下定义路由。
3.控制器示例
<?php namespace app\Controllers\Index; use Lib\WsController; class WebSocketController extends WsController { public function index() { //给客户端发送消息 //$this->>fd 客户端唯一标示 //$this->>server websocket server对象(此对象提供的功能参考swoole文档) // $data = "哈哈哈我是一条消息"; $data2 = "这是一条通过task任务群发消息"; $this->server->push($this->fd,$data); //投递异步任务 $this->task->delivery (\app\Task\Notice::class,'ToAll',[$this->fd,$data2]); } }
4.前端略过(视图目录中有一个ws.blade.php文件,可以用来测试websocket)...
数据库
数据库采用laravel
框架的Illuminate\Database
,熟悉laravel的小伙伴可极速上手。
1.查询构建器,参考文档
<?php namespace app\Controllers\Index; use Lib\Controller; use Lib\DB; class IndexController extends Controller { public function index() { $res = DB::table('user')->where('id',1)->first(); } }
2.Model,参考文档
namespace app\Models; use Illuminate\Database\Eloquent\Model; class User extends Model { protected $table = 'user'; }
压力测试
- 调用框架内一个json输出方法,输出如下内容:
{ "word": "hello world" }
- 方法内有一条查询语句的压力测试
public function index(){ $res = DB::table('user')->where('id',"=","1")->first(); return $this->json($res); }