Swoole框架业务封装组件 | Logic component for Swoole

Language

• 中文
• English

介绍

将业务代码抽离封装到一个目录下作为Logic层（Form和Validate）

封装了高效率的表单数据验证规则。

有如下好处：

• 热加载，修改Logic层代码后不用重启服务能立即生效
• 减少控制器代码量，结构清晰易维护

所谓热加载实现原理

我们平时开发调试时大部分都是在调试业务逻辑代码，所以我将业务逻辑封装在一个目录下（独立一个目录，目录名自定义）。

这个Logic层的PHP文件不会在框架服务（swoft、imi、easyswoole、hyperf等）启动时加载，会在Work进程启动后加载的。

写一个接口（调用swoole的$server->reload()）来重载Work进程，而不是重启服务，每次改完业务代码，请求下这个接口让代码重载生效（可以在IDE上新增run配置，可以快速请求该接口来重载）。

Form表单类API

• 通过请求数据实例化表单：

$form = DemoForm::instance($data); 

• 通过请求数据实例化表单，并默认对所有字段设置为必填：

$form = DemoForm::instance($data, true);

• 关闭所有字段去空格（默认是开启）

$form->setIsAutoTrim(false);

• 设置表单所有字段数据

$form->setAttributes($data);

• 验证表单数据是否合法

$form->validate();

• 获取验证错误提示信息

$form->getError();

Validate验证规则

• integer 整型
• string 字符串
• number 数字
• url 链接地址
• email 邮箱
• required 必填项
• boolean 布尔（0或1）
• in 集合
• regex 正则
• array 数组（对子项进行类型校验）
• 自定义校验器 可在form子类进行自定义

结合现有框架使用该组件示例

• Hyperf框架结合swoole-logic组件的演示：https://github.com/qiao520/hyperf-skeleton

• IMI框架结合swoole-logic组件的演示：https://github.com/qiao520/imi-logic

Form表单验证使用示例

本人对Yii比较喜欢，也对它有一定的了解，这个组件主要是参考了Yii的表单验证用法。 如果你有Yii的开发经验，用起来会很顺手。

• Form类示例代码（/demo/DemoForm.php）

use Roers\SwLogic\BaseForm;

class DemoForm extends BaseForm
{
    // 以下是表单属性
    public $name;
    public $email;
    public $age;
    public $sex;
    public $others;
    public $default = 0;

    // 以下是覆盖父类的默认设置
    protected $isAutoTrim = true;   // 开启自动去空格（默认开启）
    protected $defaultRequired = true;   // 开启所有属性为必填（默认未开启）
    protected $defaultErrorMessage = '{attribute}格式错误';  // 覆盖自定义错误提示信息

    /**
     * 定义验证规则
     * @return array
     */
    public function rules()
    {
        return [
            // 验证6到30个字符的字符串
            ['name', 'string', 'min' => 6, 'max' => 30, 'maxMinMessage' => '名字必须在{min}~{max}个字符范围内'],
            // 验证年龄必须是整数
            ['age', 'integer', 'min' => 18, 'max' => 100],
            // 集合验证器，验证性别必须是1或2
            ['sex', 'in', 'in' => [1, 2],],
            // 使用自定义验证器，验证名字不能重复
            ['name', 'validateName'],
            // 还可以这样用，对多个字段用同一个验证器规则
            [['age', 'sex'], 'integer'],
            // 验证邮箱格式，并且必填required对所有校验器都有效
            [['email'], 'email', 'required' => true],
            // 验证是否是数组，并对数组元素进行格式校验
            [['others'], 'array', 'validator' => 'string'],
        ];
    }

    /**
     * 字段名称映射关系
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'name' => '名字',
            'age' => '年龄',
        ];
    }

    /**
     * 业务处理
     * @return array
     */
    public function handle()
    {
        // do something here

        // 返回业务处理结果
        return ['name' => $this->name, 'age' => $this->age];
    }

    /**
     * 自定义验证器
     * @param $attribute
     * @param $options
     * @return bool
     */
    public function validateName($attribute, $options)
    {
        $value = $this->{$attribute};

        if ($value == 'Roers.cn') {
            $this->addError($attribute, "名字{$value}已存在");
            return false;
        }

        return true;
    }
}

• 示例代码demo.php

require 'vendor/autoload.php';

// 演示表单类
use Roers\Demo\DemoForm;

// 调试打印函数
function debug($msg) {
    echo $msg, PHP_EOL;
}

// 表单提交的数据
$data = [
    'name' => 'zhongdalong',
    'age' => '31',
    'sex' => '',
];
// 演示默认所有字段为非必填项
$form = DemoForm::instance($data);
if ($form->validate()) {
    $result = $form->handle();
    debug('验证通过，业务处理结果：' . json_encode($result));
} else {
    debug('验证不通过，错误提示信息：' .  $form->getError());
}

debug(str_repeat('-------', 10));

// 演示默认所有字段为必填项
$form = DemoForm::instance($data, true);
if ($form->validate()) {
    $result = $form->handle();
    debug('验证通过，业务处理结果：' . json_encode($result));
} else {
    debug('验证不通过，错误提示信息：' .  $form->getError());
}

debug(str_repeat('-------', 10));


// 演示未成年注册场景
$data['age'] = 17;
$form = DemoForm::instance($data);
if ($form->validate()) {
    $result = $form->handle();
    debug('验证通过，业务处理结果：' . json_encode($result));
} else {
    debug('验证不通过，错误提示信息：' .  $form->getError());
}

debug(str_repeat('-------', 10));


// 演示自定义验证器
$data['age'] = 18;
$data['name'] = 'Roers.cn';
$form = DemoForm::instance($data);
if ($form->validate()) {
    $result = $form->handle();
    debug('验证通过，业务处理结果：' . json_encode($result));
} else {
    debug('验证不通过，错误提示信息：' .  $form->getError());
}

debug(str_repeat('-------', 10));

• 执行结果

验证通过，业务处理结果：{"name":"zhongdalong","age":"31"}
----------------------------------------------------------------------
验证不通过，错误提示信息：Sex是必填项
----------------------------------------------------------------------
验证不通过，错误提示信息：年龄必须在18 ~ 100范围内
----------------------------------------------------------------------
验证不通过，错误提示信息：名字Roers.cn已存在
----------------------------------------------------------------------

接入该组件步骤

• 首先，我在项目根目录下新建一个logic目录作为业务逻辑层（Logic），这个目录不受框架启动时加载

• 开发一个接口，用于业务代码修改后，调用swoole的$server->reload()重载Work进程，让修改代码也跟着一起重新加载

环境要求

PHP 7.0 +

想法初衷

看过几个Swoole框架（swoft、imi、easyswoole、hyperf，排名不分先后）

都有一个相同的问题：热加载（代码修改后需要重新启动服务），虽然有些框架专门加了缓存优化了启动速度，不过还是慢。

因为swoole是命令行的运行模式，PHP代码加载后就不会重复加载。

一个健全的系统少不了请求参数数据验证、易维护性，这个组件就是为了帮您轻松做这些事情。

安装

composer require qiao520/swoole-logic

联系我

QQ：380552499

喜欢的朋友点个赞，感谢支持！