EasySwoole 学习笔记一

最新推荐文章于 2021-06-15 22:53:10 发布

置顶 taojiaheng

最新推荐文章于 2021-06-15 22:53:10 发布

阅读量3.7k

点赞数

分类专栏： EasySwoole

本文链接：https://blog.csdn.net/qq_35211819/article/details/103138831

版权

EasySwoole 专栏收录该内容

2 篇文章 1 订阅

订阅专栏

EasySwoole学习笔记

一安装

1. EasySwoole 官网地址 https://www.easyswoole.com

2. Swoole 官网地址 https://www.swoole.com/

安装EasySwoole 具体步骤参照官网文档 https://www.easyswoole.com/Introduction/install.html 建议使用虚拟机方便代码编辑调试笔者使用的是Centos7 虚拟机安装 php版本 7.2.22 swoole 版本 4.4.5 EasySwoole 版本 3.3.1-dev

安装完成之后进入框架根目录启动应用 php easyswoole start

# 启动应用 非守护模式 非守护模式停止 直接 ctrl + c
php easyswoole start
# 启动应用 守护模式
php easyswoole start d
# 停止easySwoole(守护模式下使用)
php easyswoole stop    
# 热重启easySwoole(守护模式下使用)      
php easyswoole reload 
#　重启easySwoole(守护模式下使用)       
php easyswoole restart

访问你的你的 IP:9501 不出意外就可以看到EasySwoole 的欢迎页面了框架默认端口9501 可以在dev.php 项目配置文件修改

如果浏览器卡住不动大概率是被Linux 的防火墙给屏蔽了可以尝试关闭防火墙以笔者cenots7 为例 systemctl stop firewalld

如果出现 failed to listen server port[0.0.0.0:9501], Error: Address already in use 酱紫的错误是端口被占用关闭占用端口程序或者修改dev.php MAIN_SERVER 下 PROT 端口号即可

TIPS 如何方便的编辑LINUX 或者 LINUX 虚拟机中的文件不需要可直接跳过这一步

如果你是使用的 虚拟机 那么可以使用两种方法编辑虚拟机中的项目文件

1. 使用 VMware 中的共享文件夹的功能将本地文件系统映射到虚拟机中直接修改本地文件就OK了

2. 使用IDE phpstorm 提供的编辑远程服务器功能

因为EasySwoole 不建议使用虚拟机的共享文件夹功能它是这么说的 https://www.easyswoole.com/Introduction/install.html

不可把虚拟机共享目录作为安装目录，否则会因为权限不足无法创建socket，产生报错：listen xxxxxx.sock fail

所以笔者介绍下第二种方法

在linux虚拟机或者服务器上安装好框架在Windows中进行编辑

选择 File > New Project form Existing Files

选择第四个

填写项目名称和本地路径

填写服务器信息

Finish 完成 Ok

设置Ctrl + s 保存修改到服务器

选择 Ctrl + S

到这里就设置完毕了远程Linux 服务器也是可以这样使用的

二基本控制器使用

框架默认控制器文件在App\HttpController 目录下的Index.php 文件中

EasySwoole 控制器需要继承 \EasySwoole\Http\AbstractInterface\Controller 接口可以使用框架自带的Http的操作API 并且必须实现Index方法

默认执行的Index方法

function index()
{
    // EASYSWOOLE_ROOT 常量是指向项目根目录的路径
    $file = EASYSWOOLE_ROOT.'/vendor/easyswoole/easyswoole/src/Resource/Http/welcome.html';
    if(!is_file($file)){
        $file = EASYSWOOLE_ROOT.'/src/Resource/Http/welcome.html';
    }
    // $this->response()->write() 方法输出Http 消息
    $this->response()->write(file_get_contents($file));
}

这里框架生成的默认控制器读取了 welcome.html文件并将其发送到客户端这里必须使用 $this->response()->write() 方法输出而不能使用过 echo var_dump 之类的输出函数否则会将其输出至控制台

Http响应相关基本API

$this->response() //获取响应对象

// 发送客户端数据
$this->response()->write('hello world');

// Http重定向
$this->response()->redirect("/newURL/index.html");

// 设置Cookie
$this->response()->setCookie('cookie_name', 'cookie_value', time() + 60 * 60 * 24, '/');

// 结束对该次HTTP发送数据 结束之后 无法向客户端发送数据
$this->response()->end();

// 检查是否结束发送数据 返回的是 bool
$this->response()->isEndResponse()

// 向客户端发送一个http状态码
$this->response()->withStatus(404);

// 用于向HTTP客户端发送一个header
$this->response()->withHeader('Content-type','application/json;charset=utf-8');

//用于获取原始的swoole_http_response实例
$this->response()->getSwooleResponse();

// 发送文件 注意 光调用这个函数文件不会被下载而是会显示到浏览器 需要设置下载文件的Header头才可以自动下载
$this->response()->sendFile('/home/sqlmap/sqlmapproject-sqlmap-8d608df/sqlmap.py');

// 下载需要设置的额外Header
$this->response()->withHeader('Content-Type', 'application/download');
$this->response()->withHeader('Content-Disposition', 'attachment;filename=file_name');

Http请求相关基本API

// 用于获取用户通过POST或者GET提交的参数 若POST与GET存在同键名参数，则以GET为准
// 例如 访问 /index/index?a=1&b=1
$data = $request->getRequestParams();
var_dump($data);
/* 输出
array(2) {
  ["a"]=>
  string(1) "1"
  ["b"]=>
  string(1) "2"
}
*/

// 用于获取用户通过POST或者GET提交的某一个参数
$data = $request->getRequestParam('key');

// 该方法用于获取HTTP请求中的cookie信息
$request->getCookieParams();

// 该方法用于获取客户端上传的全部文件信息 返回 \EasySwoole\Http\Message\UploadFile
$request->getUploadedFiles();
$request->getUploadedFile('img');

// 该方法用于获取以非form-data或x-www-form-urlenceded编码格式POST提交的原始数据，相当于PHP中的$HTTP_RAW_POST_DATA
$this->request()->getBody()->__toString();

// 获得get内容
$get = $request->getQueryParams();

// 获得post内容
$post = $request->getParsedBody();

// 获得头部
$header = $request->getHeaders();

// 获得server
$server = $request->getServerParams();

// 获得cookie
$cookie = $request->getCookieParams();

多模块的使用方法一般Http项目基本包含前后台分为两个大的模块去实现的在EasySwoole中只需要在App\HttpController文件夹下新建文件夹 Home 和 Admin 两个文件夹每个文件夹新建一个Index控制器目录结构如下

// Home/Index.php
<?php
/**
 * Created by PhpStorm.
 * User: taojiaheng
 * Date: 2019/11/19
 * Time: 14:27
 */
namespace App\HttpController\Home;
class Index extends \App\HttpController\Controller
{
    public function index()
    {
        $this->response()->write('model is Home');
    }
}

// Admin/Index.php
<?php
/**
 * Created by PhpStorm.
 * User: taojiaheng
 * Date: 2019/11/19
 * Time: 14:27
 */
namespace App\HttpController\Admin;
class Index extends \App\HttpController\Controller
{
    public function index()
    {
        $this->response()->write('model is Admin');
    }
}

注意命名空间 \App\HttpController\Controller 类是自己创建的控制器基类

<?php
/**
 * 基础控制器类
 * Created by PhpStorm.
 * User: taojiaheng
 * Date: 2019/11/19
 * Time: 11:24
 */
namespace App\HttpController;

abstract class Controller extends \EasySwoole\Http\AbstractInterface\Controller
{
    abstract function index();
}

访问 /home/Index/index 输出 model is Home

访问 /admin/Index/index 输出 model is Admin

三. 使用视图和模板

视图官网文档 https://www.easyswoole.com/Components/template.html

这里笔者使用的是TP的模板引擎 https://github.com/top-think/think-template

1. 安装相关依赖

composer require easyswoole/template
composer require topthink/think-template

2. 实现渲染引擎

在 App 目录下新建 System 目录存放渲染引擎实现的代码 ThinkTemplate.php

<?php
/**
 * Created by PhpStorm.
 * User: taojiaheng
 * Date: 2019/11/18
 * Time: 17:37
 */
namespace App\System;

use EasySwoole\Template\RenderInterface;
use think\facade\Template;

class ThinkTemplate implements RenderInterface
{
    // tp模板类对象
    private $_topThinkTemplate;

    public function __construct()
    {
        $temp_dir = sys_get_temp_dir();
        $config = [
            'view_path' => EASYSWOOLE_ROOT . '/App/HttpTemplate/', // 模板存放文件夹根目录
            'cache_path' => $temp_dir, // 模板文件缓存目录
            'view_suffix' => 'html' // 模板文件后缀
        ];
        $this->_topThinkTemplate = new \think\Template($config);
    }

    public function afterRender(?string $result, string $template, array $data = [], array $options = [])
    {
    }
    // 当模板解析出现异常时调用
    public function onException(\Throwable $throwable): string
    {
        $msg = $throwable->getMessage() . " is file " . $throwable->getFile() . ' of line' . $throwable->getLine();
        return $msg;
    }
    // 渲染逻辑实现
    public function render(string $template, array $data = [], array $options = []): ?string
    {
        foreach ($data as $k => $v) {
            $this->_topThinkTemplate->assign([$k => $v]);
        }
        // Tp 模板渲染函数都是直接输出 需要打开缓冲区将输出写入变量中 然后渲染的结果
        ob_start();
        $this->_topThinkTemplate->fetch($template);
        $content = ob_get_contents();
        ob_end_clean();
        return $content;
    }
}

3. 注册渲染引擎

需要对模板引擎进行实例化并且注入到EasySwoole 的视图中在项目根目录 EasySwooleEvent.php 中 mainServerCreate 事件函数中进行注入代码如下

// 设置Http服务模板类
Render::getInstance()->getConfig()->setRender(new ThinkTemplate());
Render::getInstance()->getConfig()->setTempDir(EASYSWOOLE_TEMP_DIR);
Render::getInstance()->attachServer(ServerManager::getInstance()->getSwooleServer());

4. 测试调用写的模板

在App目录下创建 HttpTemplate 目录 PS:之前在 ThinkTemplate.php 文件中设置的路径

创建文件 /App/HttpTemplate/Admin/Index/index.html 路径与模块控制器响应函数相对应你也可以按照自己的喜欢来

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>tao</title>
</head>
<body>
<ul>
    {foreach $user_list as $key => $val}
    <li>{$key} => {$val}</li>
    {/foreach}
</ul>
</body>
</html>

在 App\HttpController\Admin 中调用

use EasySwoole\Template\Render;
public function index()
    {
        $user_list = [
            '1', '2', '3', '4', '5'
        ];
        $this->response()->write(Render::getInstance()->render('Admin/Index/index', ['user_list' => $user_list]));
    }

结果如下

但是这样的模板传值非常麻烦有木有还必须要放在一个数组中一次性传给 Render 对象我们可以将操作封装到基类控制器实现类似于TP框架的操作代码如下

<?php
/**
 * 基础控制器类
 * Created by PhpStorm.
 * User: taojiaheng
 * Date: 2019/11/19
 * Time: 11:24
 */
namespace App\HttpController;

use EasySwoole\Template\Render;

abstract class Controller extends \EasySwoole\Http\AbstractInterface\Controller
{
    public $template_data = [];

    abstract function index();


    public function assign($name, $value) {
        $this->template_data[$name] = $value;
    }

    public function fetch($template_name) {
        return Render::getInstance()->render($template_name, $this->template_data);
    }
}

这样我们就可以使用TP的风格进行模板传值了效果和上面时一样的 PS:暂时需要指定模板的路径

function index()
    {
        $user_list = [
            '1', '2', '3', '4', '5'
        ];
        $this->assign('user_list', $user_list);
        $this->response()->write($this->fetch('Admin/Index/index'));
    }

最后的目录结构

taojiaheng

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
1
评论
EasySwoole 学习笔记一

EasySwoole学习笔记一安装1. EasySwoole 官网地址https://www.easyswoole.com2. Swoole 官网地址https://www.swoole.com/安装EasySwoole 具体步骤参照官网文档https://www.easyswoole.com/Introduction/install.html 建议使用虚拟机方便...
复制链接

扫一扫