youzanyun/yz-cloud-boot

Bootstrap for YZCloud PHP Application

1.2.2 2020-04-15 07:15 UTC

This package is auto-updated.

Last update: 2020-05-15 07:30:09 UTC


README

Bootstrap for YZCloud PHP Application

Based on Slim Framework: http://www.slimframework.com/

安装

使用

目录结构

一个标准的基于 YZCloudBoot 的应用程序应该基本上是这样的结构

.
|-- composer.json       # 用户工程的 composer.json
|-- config/             # 配置文件目录
|   |-- env.php         # 环境变量定义,主要定义 YZCLOUD_BOOT_APP_DIR 指定应用根目录 
|   |-- routes.php      # 路由配置文件
|   |-- beps.php        # 业务扩展点配置文件
|   |-- meps.php        # 消息扩展点配置文件
|
|-- src/                # 用户工程的源码
|   |-- Bep             # 业务扩展点实现 (可自定义)
|   |-- Mep             # 消息扩展点实现 (可自定义)
|   |-- Controller      # 控制器 (可自定义)
|   |-- ...             # 其它用户工程的目录
|
|-- templates/          # 模版文件目录
|
|-- vendor/             # composer 三方组件目录
|   |-- ...             # 其它组件的目录
|   |-- youzanyun
|       |-- yz-cloud-boot               # 本框架所在目录
|           |-- bin                     # 启/停脚本
|           |   |-- preload.sh          # 服务启动前置脚本
|           |   |-- php_dev_server.sh   # 开发服务器启动脚本
|           |   |-- daemon.php          # 后台任务
|           |
|           |-- public                  # Web Root 目录,Web 服务器需要以里面的 index.php 为默认页面
|           |   |-- index.php           # 应用程序入口
|           |
|           |-- src                     # 本框架的业务代码

Facade

实现了类似于 Laravel 的 Facade 特性,提供了可以迅速访问组件的绝大多数组件的静态代理

具体的命名空间位于 \YouzanCloudBoot\Facades

目前包括:

SlimFramework 原生

静态代理 被代理对象
\YouzanCloudBoot\Facades\AppFacade \Slim\App 的实例 $app 对象
\YouzanCloudBoot\Facades\DIFacade $app->getContainer()
\YouzanCloudBoot\Facades\RouteFacade \Slim\App 的实例 $app 对象 (这是 \YouzanCloudBoot\Facades\AppFacade 的别名)
\YouzanCloudBoot\Facades\RequestFacade $app->getContainer()->get('request')
\YouzanCloudBoot\Facades\ResponseFacade $app->getContainer()->get('response')
\YouzanCloudBoot\Facades\LogFacade $app->getContainer()->get('logger')

有赞云框架专属

静态代理 被代理对象
\YouzanCloudBoot\Facades\BepRegFacade $app->getContainer()->get('bepRegistry')
\YouzanCloudBoot\Facades\MepRegFacade $app->getContainer()->get('mepRegistry')
\YouzanCloudBoot\Facades\EnvFacade $app->getContainer()->get('envUtil')
\YouzanCloudBoot\Facades\HttpFacade $app->getContainer()->get('httpClient')
\YouzanCloudBoot\Facades\DBFacade $app->getContainer()->get('yzcMySQL')
\YouzanCloudBoot\Facades\PDOFactoryFacade $app->getContainer()->get('pdoFactory')
\YouzanCloudBoot\Facades\RedisFacade $app->getContainer()->get('yzcRedis')
\YouzanCloudBoot\Facades\RedisFactoryFacade $app->getContainer()->get('redisFactory')
\YouzanCloudBoot\Facades\TokenFacade $app->getContainer()->get('tokenUtil')
\YouzanCloudBoot\Facades\ViewFacade $app->getContainer()->get('view')

具体的类参考,可以参见每个类头部的 PHP Doc,在 PHPStorm 等 IDE 内可以识别 @method 并提供语法提示

依赖注入容器和默认组件

依赖注入使用了 SlimFramework 默认内建的 Pimple: https://pimple.symfony.com/

默认包含了所有 SlimFramework 的组件,可以参考: http://www.slimframework.com/docs/v3/concepts/di.htmlRequired services 章节

以下是我们这个框架中封装的组件:

<?php
// @var \YouzanCloudBoot\Util\EnvUtil $envUtil 环境访问实用工具
$envUtil = YouzanCloudBoot\Facades\DIFacade::get('envUtil');

// @var \YouzanCloudBoot\Util\TokenUtil $tokenUtil Token工具
$tokenUtil = YouzanCloudBoot\Facades\DIFacade::get('tokenUtil');

// @var \Monolog\Logger $logger 日志
$logger = YouzanCloudBoot\Facades\DIFacade::get('logger');

// @var \YouzanCloudBoot\ExtensionPoint\BepRegistry $bepRegistry 业务扩展点注册器
$bepRegistry = YouzanCloudBoot\Facades\DIFacade::get('bepRegistry');

// @var \YouzanCloudBoot\ExtensionPoint\TopicRegistry $mepRegistry 消息扩展点注册器
$mepRegistry = YouzanCloudBoot\Facades\DIFacade::get('mepRegistry');

// @var \YouzanCloudBoot\Util\ObjectBuilder $objectBuilder 反序列化辅助工具,将扩展点调用参数转换成匹配接口的对象
$objectBuilder = YouzanCloudBoot\Facades\DIFacade::get('objectBuilder');

// @var \YouzanCloudBoot\Store\PDOFactory $pdoFactory PDO 工厂,用于生成 PDO 实例
$pdoFactory = YouzanCloudBoot\Facades\DIFacade::get('pdoFactory');

// @var \YouzanCloudBoot\Store\RedisFactory $redisFactory Redis 工厂,用于生成 Redis 实例
$redisFactory = YouzanCloudBoot\Facades\DIFacade::get('redisFactory');

// @var \YouzanCloudBoot\Http\HttpClientWrapper $httpClient HTTP 客户端,进行了有赞云统一接出的封装以配合白名单机制
$httpClient = YouzanCloudBoot\Facades\DIFacade::get('httpClient');

// @var \PDO $yzcMysql 连接有赞云上 MySQL 组件的 PDO 客户端,其采用的 MySQL 连接字符集为 utf8mb4,获得的 PDO 对象是 PHP 官方 PDO 对象
$yzcMysql = YouzanCloudBoot\Facades\DIFacade::get('yzcMysql');

// @var \Redis $yzcRedis 连接有赞云上 Redis 组件的 Redis 客户端,获得的 Redis 对象是 php-redis 扩展提供的标准 Redis 对象 象
$yzcRedis = YouzanCloudBoot\Facades\DIFacade::get('yzcRedis');