easyswoole快速实现一个网站的api接口程序

本文涉及的产品
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS PostgreSQL,高可用系列 2核4GB
云数据库 RDS MySQL,高可用系列 2核4GB
简介: easyswoole快速实现一个网站的api接口程序

目前,easyswoole已经成为了最知名的swoole框架之一,本人也用easyswoole开发过很多个项目了,现在就来讲一讲如何用easyswoole快速实现一个网站的curd功能的接口。

安装easyswoole和相关组件

环境方面本人不多做说明,可以去官方文档查看。

新增composer.json文件

{
    "require": {
        "easyswoole/easyswoole": "^3.2",
        "easyswoole/mysqli": "^1.2",
        "tioncico/curd-automatic-generation": "^1.0"
    },
    "autoload": {
        "psr-4": {
            "App\\\": "Application/"
        }
    }
}

然后输入以下命令进行引入,安装组件库:

composer up
mkdir -p Application/HttpController
php ./vendor/easyswoole/easyswoole/bin/easyswoole install

设计数据表

假设我们需要做一个简单的文章管理系统,需要用户,文章,评论,置顶,分类,这5个表:

新增文件 test.php

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 19-7-27
 * Time: 上午11:40
 */
include "./vendor/autoload.php";
//会员列表
$result = \\EasySwoole\\Mysqli\\DDLBuilder\\DDLBuilder::table('user_list', function (\\EasySwoole\\Mysqli\\DDLBuilder\\Blueprints\\TableBlueprint $blueprint) {
    $blueprint->colInt('id', '11')->setColumnComment('主键id')->setIsPrimaryKey()->setIsAutoIncrement();
    $blueprint->colVarChar('userAccount', '32')->setColumnComment('会员账号');
    $blueprint->colVarChar('userName', '32')->setColumnComment('会员昵称');
    $blueprint->colVarChar('userPassword', '32')->setColumnComment('会员密码');
    $blueprint->colDateTime('addTime')->setColumnComment('新增时间');
    $blueprint->colTinyInt('isAdmin', 1)->setColumnComment('是否会管理员')->setDefaultValue(0);
    $blueprint->setTableComment('会员列表');
    $blueprint->setTableEngine(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Engines::INNODB);
    $blueprint->setTableCharset(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Character::UTF8\_GENERAL\_CI);
    $blueprint->indexNormal('userAccount', \['userAccount'\]);
});
echo $result;
//文章分类列表
$result = \\EasySwoole\\Mysqli\\DDLBuilder\\DDLBuilder::table('article_list', function (\\EasySwoole\\Mysqli\\DDLBuilder\\Blueprints\\TableBlueprint $blueprint) {
    $blueprint->colInt('id', '11')->setColumnComment('主键id')->setIsPrimaryKey()->setIsAutoIncrement();
    $blueprint->colInt('pid', 11)->setColumnComment('上级id');
    $blueprint->colVarChar('categoryName', '64')->setColumnComment('分类名称');
    $blueprint->setTableComment('分类列表');
    $blueprint->setTableEngine(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Engines::INNODB);
    $blueprint->setTableCharset(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Character::UTF8\_GENERAL\_CI);
});
echo $result;
//文章列表
$result = \\EasySwoole\\Mysqli\\DDLBuilder\\DDLBuilder::table('article_list', function (\\EasySwoole\\Mysqli\\DDLBuilder\\Blueprints\\TableBlueprint $blueprint) {
    $blueprint->colInt('id', '11')->setColumnComment('主键id')->setIsPrimaryKey()->setIsAutoIncrement();
    $blueprint->colInt('categoryId', 11)->setColumnComment('分类id');
    $blueprint->colVarChar('title', '64')->setColumnComment('标题');
    $blueprint->colVarChar('keyword', '64')->setColumnComment('关键字');
    $blueprint->colVarChar('description', '255')->setColumnComment('简介');
    $blueprint->colVarChar('author', '32')->setColumnComment('作者');
    $blueprint->colText('content')->setColumnComment('内容');
    $blueprint->colDateTime('addTime')->setColumnComment('新增时间');
    $blueprint->colTinyInt('isOriginal', 1)->setColumnComment('是否原创')->setDefaultValue(1);
    $blueprint->setTableComment('文章列表');
    $blueprint->setTableEngine(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Engines::INNODB);
    $blueprint->setTableCharset(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Character::UTF8\_GENERAL\_CI);
    $blueprint->indexNormal('title', \['title'\]);
});
echo $result;
//评论列表
$result = \\EasySwoole\\Mysqli\\DDLBuilder\\DDLBuilder::table('comment_list', function (\\EasySwoole\\Mysqli\\DDLBuilder\\Blueprints\\TableBlueprint $blueprint) {
    $blueprint->colInt('id', '11')->setColumnComment('主键id')->setIsPrimaryKey()->setIsAutoIncrement();
    $blueprint->colInt('articleId', 11)->setColumnComment('文章id');
    $blueprint->colInt('commentPid', 11)->setColumnComment('评论父id')->setDefaultValue(0);
    $blueprint->colInt('userId', 11)->setColumnComment('评论会员id');
    $blueprint->colVarChar('userName', '64')->setColumnComment('评论会员名');
    $blueprint->colVarChar('content', '255')->setColumnComment('评论内容');
    $blueprint->colDateTime('addTime')->setColumnComment('评论时间');
    $blueprint->setTableComment('文章评论列表');
    $blueprint->setTableEngine(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Engines::INNODB);
    $blueprint->setTableCharset(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Character::UTF8\_GENERAL\_CI);
    $blueprint->indexNormal('articleId', \['articleId'\]);
    $blueprint->indexNormal('commentPid', \['commentPid'\]);
    $blueprint->indexNormal('userId', \['userId'\]);
});
echo $result;
//评论列表
$result = \\EasySwoole\\Mysqli\\DDLBuilder\\DDLBuilder::table('top_list', function (\\EasySwoole\\Mysqli\\DDLBuilder\\Blueprints\\TableBlueprint $blueprint) {
    $blueprint->colInt('id', '11')->setColumnComment('主键id')->setIsPrimaryKey()->setIsAutoIncrement();
    $blueprint->colInt('articleId', 11)->setColumnComment('文章id');
    $blueprint->setTableComment('文章置顶列表');
    $blueprint->setTableEngine(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Engines::INNODB);
    $blueprint->setTableCharset(\\EasySwoole\\Mysqli\\DDLBuilder\\Enum\\Character::UTF8\_GENERAL\_CI);
    $blueprint->indexNormal('articleId', \['articleId'\]);
});
echo $result;

该文件作用是直接通过easyswoole的mysqli建表工具生成建表sql,运行sql直接建表

配置数据库

在dev.php文件中新增以下配置:

'MYSQL'       => \[
    'host'            => '127.0.0.1',
    'port'            => 3306,
    'user'            => 'root',
    'password'        => 'test',
    'database'        => 'article',
    'timeout'         => 30,
    'charset'         => 'utf8mb4',
    'connect_timeout' => '5',//连接超时时间
\],

注册数据库连接池:

在easyswooleEvent.php的initialize方法中,注册数据库连接池:

public static function initialize()
{
    // TODO: Implement initialize() method.
    date\_default\_timezone_set('Asia/Shanghai');
    $mysqlConfig = new \\EasySwoole\\Mysqli\\Config(\\EasySwoole\\EasySwoole\\Config::getInstance()->getConf('MYSQL'));
    \\EasySwoole\\MysqliPool\\Mysql::getInstance()->register('mysql',$mysqlConfig);
}

初始化basemodel和basecontroller:

新增init.php文件:

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 19-7-27
 * Time: 上午11:59
 */
include "./vendor/autoload.php";
\\EasySwoole\\EasySwoole\\Core::getInstance()->initialize();
$init = new \\AutomaticGeneration\\Init();
$init->initBaseModel();
$init->initBaseController();

该脚本可在App目录中生成基础的baseModel和baseController

新增AdminBase,IndexBase,UserBase控制器,用于控制登录权限

分别在//Application/HttpController/Api/Admin,/Api/User,/Api/Index中新增Base.php文件:

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 19-7-27
 * Time: 下午12:14
 */
namespace App\\HttpController\\Api\\Admin;
use App\\Model\\UserBean;
use EasySwoole\\Http\\Message\\Status;
class Base extends \\App\\HttpController\\Base
{
    protected $who;
    //session的cookie头
    protected $tokenName = 'adminSession';
    //白名单,用于用户请求login方法时,不会因为没有登录而拒绝访问
    protected $whiteList = \['login'\];
    /**
     * onRequest
     * @param null|string $action
     * @return bool|null
     * @throws \\Throwable
     * @author yangzhenyu
     * Time: 13:49
     */
    function onRequest(?string $action): ?bool
    {
        if (parent::onRequest($action)) {
            //白名单判断
            if (in_array($action, $this->whiteList)) {
                return true;
            }
            //获取登入信息,如果没有登录,则不让访问,只有Admin和User需要
            if (!$this->getWho()) {
                $this->writeJson(Status::CODE_UNAUTHORIZED, '', '登入已过期');
                return false;
            }
            return true;
        }
        return false;
    }
    /**
     * getWho
     * @return bool
     * @author yangzhenyu
     * Time: 13:51
     */
    function getWho(): ?UserBean
    {
        if ($this->who instanceof UserBean) {
            return $this->who;
        }
        $sessionKey = $this->request()->getRequestParam($this->tokenName);
        if (empty($sessionKey)) {
            $sessionKey = $this->request()->getCookieParams($this->tokenName);
        }
        if (empty($sessionKey)) {
            return null;
        }
        //这里需要自己实现,通过用户传来的token,去获取用户信息,如果获取失败,则代表没有登录
        return $this->who;
    }
    protected function getValidateRule(?string $action): ?\\EasySwoole\\Validate\\Validate
    {
        // TODO: Implement getValidateRule() method.
    }
}

批量新增curd控制器,表操作model

新增createTable.php文件:

<?php
/**
 * Created by PhpStorm.
 * User: tioncico
 * Date: 19-7-27
 * Time: 上午11:59
 */
include "./vendor/autoload.php";
\\EasySwoole\\EasySwoole\\Core::getInstance()->initialize();
go(function () {
    $db = \\EasySwoole\\MysqliPool\\Mysql::defer('mysql');
    $result = $db->rawQuery("show tables;");
    $tableList = array\_column($result,'Tables\_in_article');
    var_dump($tableList);
    //生成所有的bean,model
    foreach ($tableList as $tableName){
        var_dump($tableName);
        $mysqlTable = new \\AutomaticGeneration\\MysqlTable($db, \\EasySwoole\\EasySwoole\\Config::getInstance()->getConf('MYSQL.database'));
        $tableColumns = $mysqlTable->getColumnList($tableName);
        $tableComment = $mysqlTable->getComment($tableName);
        $path = '';
        $beanConfig = new \\AutomaticGeneration\\Config\\BeanConfig();
        $beanConfig->setBaseNamespace("App\\\Model".$path);
        $beanConfig->setTablePre('');
        $beanConfig->setTableName($tableName);
        $beanConfig->setTableComment($tableComment);
        $beanConfig->setTableColumns($tableColumns);
        $beanBuilder = new \\AutomaticGeneration\\BeanBuilder($beanConfig);
        $result = $beanBuilder->generateBean();
        var_dump($result);
        $path = '';
        $modelConfig = new \\AutomaticGeneration\\Config\\ModelConfig();
        $modelConfig->setBaseNamespace("App\\\Model".$path);
        $modelConfig->setTablePre("");
        $modelConfig->setExtendClass(\\App\\Model\\BaseModel::class);
        $modelConfig->setTableName("user_list");
        $modelConfig->setTableComment($tableComment);
        $modelConfig->setTableColumns($tableColumns);
        $modelBuilder = new \\AutomaticGeneration\\ModelBuilder($modelConfig);
        $result = $modelBuilder->generateModel();
        var_dump($result);
        $path='\\\Api\\\Admin';
        $controllerConfig = new \\AutomaticGeneration\\Config\\ControllerConfig();
        $controllerConfig->setBaseNamespace("App\\\HttpController".$path);
        $controllerConfig->setTablePre('');
        $controllerConfig->setTableName($tableName);
        $controllerConfig->setTableComment($tableComment);
        $controllerConfig->setTableColumns($tableColumns);
        $controllerConfig->setExtendClass("App\\\HttpController".$path."\\\Base");
        $controllerConfig->setModelClass($modelBuilder->getClassName());
        $controllerConfig->setBeanClass($beanBuilder->getClassName());
        $controllerConfig->setMysqlPoolClass(EasySwoole\\MysqliPool\\Mysql::class);
        $controllerConfig->setMysqlPoolName('mysql');
        $controllerBuilder = new \\AutomaticGeneration\\ControllerBuilder($controllerConfig);
        $result = $controllerBuilder->generateController();
        var_dump($result);
        $path='\\\Api\\\Index';
        $controllerConfig = new \\AutomaticGeneration\\Config\\ControllerConfig();
        $controllerConfig->setBaseNamespace("App\\\HttpController".$path);
        $controllerConfig->setTablePre('');
        $controllerConfig->setTableName($tableName);
        $controllerConfig->setTableComment($tableComment);
        $controllerConfig->setTableColumns($tableColumns);
        $controllerConfig->setExtendClass("App\\\HttpController".$path."\\\Base");
        $controllerConfig->setModelClass($modelBuilder->getClassName());
        $controllerConfig->setBeanClass($beanBuilder->getClassName());
        $controllerConfig->setMysqlPoolClass(EasySwoole\\MysqliPool\\Mysql::class);
        $controllerConfig->setMysqlPoolName('mysql');
        $controllerBuilder = new \\AutomaticGeneration\\ControllerBuilder($controllerConfig);
        $result = $controllerBuilder->generateController();
        var_dump($result);
        $path='\\\Api\\\User';
        $controllerConfig = new \\AutomaticGeneration\\Config\\ControllerConfig();
        $controllerConfig->setBaseNamespace("App\\\HttpController".$path);
        $controllerConfig->setTablePre('');
        $controllerConfig->setTableName($tableName);
        $controllerConfig->setTableComment($tableComment);
        $controllerConfig->setTableColumns($tableColumns);
        $controllerConfig->setExtendClass("App\\\HttpController".$path."\\\Base");
        $controllerConfig->setModelClass($modelBuilder->getClassName());
        $controllerConfig->setBeanClass($beanBuilder->getClassName());
        $controllerConfig->setMysqlPoolClass(EasySwoole\\MysqliPool\\Mysql::class);
        $controllerConfig->setMysqlPoolName('mysql');
        $controllerBuilder = new \\AutomaticGeneration\\ControllerBuilder($controllerConfig);
        $result = $controllerBuilder->generateController();
        var_dump($result);
    }
    exit;
});

运行,根据提示去输入需要在getAll时查询的关键字字段,不填也行:

image.png

当前台传入keyword=“测试”,那么sql语句将会生成 title like "%测试%"

完善接口

当这个文件运行完之后,一个文章管理系统的基本api已经是生成好了,大概是这样:

image.png

我们下一步要做的是:

1:完善用户登录接口

2:把User里面所有控制器的update,add等方法删除(普通用户没权限管理文章,文章分类等等,当然评论有权限)

3:每个方法都需要去修改下,毕竟自动生成工具不是那么智能,只能自己继续完善了,但是,已经是很好了,不是吗?

4:每个控制器的getValidateRule方法需要自己完善,这个是用于验证用户传入的基础参数是否正确的方法

给你们看看curd的各种方法自动生成后的截图:





image.png

image.png

image.png

image.png

image.png

这些都是自动生成的哦!

其他:

建表工具文档:https://www.easyswoole.com/Cn/Components/Mysqli/createTable.html

自动生成curd控制器组件地址:https://github.com/tioncico/curdAutomaticGeneration

easyswoole mysql-pool组件:https://www.easyswoole.com/Cn/Components/mysqlPool.html

easyswoole官方文档:https://www.easyswoole.com/Cn/Introduction/environment.html

相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发,帮助IT从业者们通过“阿里云Web应用上云解决方案”,了解一个企业级Web应用上云的常见架构,了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品:云数据库RDS MySQL 版 阿里云关系型数据库RDS(Relational Database Service)是一种稳定可靠、可弹性伸缩的在线数据库服务,提供容灾、备份、恢复、迁移等方面的全套解决方案,彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
目录
相关文章
|
16天前
|
监控 算法 API
电商API接口对接实录:淘宝优惠券接口对接处理促销监控系统
在电商开发中,淘宝详情页的“券后价计算”是极易出错的环节。本文作者结合实战经验,分享了因忽略满减券门槛、有效期、适用范围等导致的踩坑经历,并提供了完整的解决方案,包括淘宝API签名生成、券后价计算逻辑、常见坑点及优化建议,助力开发者精准实现券后价功能,避免业务损失。
|
11天前
|
JSON API 数据安全/隐私保护
深度分析淘宝卖家订单详情API接口,用json返回数据
淘宝卖家订单详情API(taobao.trade.fullinfo.get)是淘宝开放平台提供的重要接口,用于获取单个订单的完整信息,包括订单状态、买家信息、商品明细、支付与物流信息等,支撑订单管理、ERP对接及售后处理。需通过appkey、appsecret和session认证,并遵守调用频率与数据权限限制。本文详解其使用方法并附Python调用示例。
|
13天前
|
JSON API 数据格式
淘宝/天猫图片搜索API接口,json返回数据。
淘宝/天猫平台虽未开放直接的图片搜索API,但可通过阿里妈妈淘宝联盟或天猫开放平台接口实现类似功能。本文提供基于淘宝联盟的图片关联商品搜索Curl示例及JSON响应说明,适用于已获权限的开发者。如需更高精度搜索,可选用阿里云视觉智能API。
|
24天前
|
JSON 算法 API
淘宝商品评论API接口核心解析,json数据返回
淘宝商品评论API是淘宝开放平台提供的数据服务接口,允许开发者通过编程方式获取指定商品的用户评价数据,包括文字、图片、视频评论及评分等。其核心价值在于:
|
13天前
|
JSON 数据挖掘 API
淘宝详情API接口与高级详情API接口用json返回数据区别
淘宝“商品详情API”与“高级商品API”主要区别在于数据深度、字段丰富度及适用场景。前者适用于轻量级导购展示,后者支持详情页展示与深度分析,需根据业务需求选择使用。
|
15天前
|
搜索推荐 数据挖掘 API
【干货满满】阿里妈妈API接口和淘宝联盟的接口有哪些区别
阿里妈妈API覆盖全链路营销,包含广告投放、数据分析及淘宝客推广,适用于品牌商家与营销工具;淘宝联盟API则专注淘宝客业务,提供商品查询、链接生成与佣金结算等功能,适合推广者使用。两者在功能、权限及应用场景上各有侧重。
|
20天前
|
设计模式 JSON Unix
微店商品详情API接口,json数据返回
微店商品详情API接口的典型JSON返回数据结构说明,基于公开的微店开放平台API文档和常见电商API设计模式整理。实际使用时请以微店官方最新文档为准
|
22天前
|
Java API 网络架构
java调用api接口自动判断节假日信息
java调用api接口自动判断节假日信息
353 0
|
23天前
|
JSON API 数据库
手机空号检测API:接口技术详解
介绍号码有效性检测技术,涵盖空号识别原理、高并发架构设计及Python集成示例,助力企业提升电销、风控等场景的运营效率,降低无效号码带来的资源浪费。
170 0
|
23天前
|
JSON API 数据格式
淘宝关键词搜索API接口,json数据返回
淘宝关键词搜索API接口允许开发者通过关键词检索商品,并返回符合条件的商品信息,这些信息通常以JSON格式呈现。以下是一个淘宝关键词搜索API接口返回的JSON数据示例及关键字段说明