项目介绍

基于 Hyperf 框架的骨架基础库应用程序

Requirements

Hyperf 对系统环境有一定的要求，它只能在 Linux 和 Mac 环境下运行，但由于 Docker 虚拟化技术的发展，Docker for Windows 也可以作为 Windows 下的运行环境。

Dockerfile 的各个版本： hyperf/hyperf-docker，或直接基于已经构建的 hyperf/hyperf Image 运行。

当你不想使用 Docker 作为运行环境的基础时，你需要确保你的操作环境满足以下要求:

PHP >= 7.4 and <= 8.0
ext-swoole >= 4.5 ( php.ini swoole.use_shortname=Off 配置为关闭 )
ext-json
ext-pcntl
ext-openssl ( 如需要使用到 HTTPS )
ext-pdo ( 如需要使用到 MySQL 客户端 )
ext-redis ( 如需要使用到 Redis 客户端 )
ext-protobuf ( 如需要使用到 gRPC 服务端或客户端 )

安装或更新依赖

首次执行，如下 2 选 1 命令即可，以后如果需要更新依赖则执行更新命令即可

# 安装依赖 ( 也可以运行 composer update -o 更新依赖来安装 )
composer install

# 更新依赖 ( 注意：后面要加上 -o，这样 vender 更新时才会自动加载 )
composer update -o

常用命令

启动项目

# 开发环境 ( 热更新模式 )
composer dev

# 生产环境
composer start

# kill 进程
composer kill

这将在端口 9501 上启动 cli-server，并将其绑定到所有网络接口。

您可以通过该域名访问 http://localhost:9501 Hyperf 默认主页。

发布配置

# 发布 Redis 消息异步队列配置 ( 如果要发布其他组件的配置，直接修改最后的组件名即可 )
php bin/hyperf.php vendor:publish hyperf/async-queue

# 执行数据填充
php bin/hyperf.php db:seed --path=seeders/userSeeder.php

异步队列 - 创建消费任务

# 后面的名称首字母建议用大写，因为是创建同名文件
php bin/hyperf.php gen:job DemoJob

PhpStorm 推荐配置

在左侧项目目录中选择 runtime 文件 > 鼠标右键 > Mark Directory as > Excluded

2. .php-cs-fixer.php 配置

设置中搜索 php-cs-fixer，并配置上，使得团队统一代码风格

3. 推荐安装插件 ( Plugins )

.env files support
PHP Annotations

4. PhpStorm 识别协程上下文获取后的结果类型

根目录文件 .phpstorm.meta.php

<?php

namespace PHPSTORM_META {

    // Reflect
    override(\Psr\Container\ContainerInterface::get(0), map('@'));
    override(\Hyperf\Context\Context::get(), map([
        'user' => \Core\Model\User::class,     // 定义 Context::get('user')
        'tenant' => \Core\Model\Tenant::class, // 定义 Context::get('tenant')
        0 => '@'
    ]));
    override(\make(0), map('@'));
    override(\di(0), map('@'));

}

├─ app         // 各端应用
│  ├─Admin     // 总后端
│  ├─Common    // 公共资源端 ( 不需要权限验证，部分可能需要登录鉴权 )
│  ├─Demo      // 示例端
│  ├─Tenant    // 租户端 ( 多租户模式 )
├─ bin         // 入口文件
├─ config      // 配置文件
├─ core        // 公共基类 ( 继承 kernel 中的基类，一般开发人员可斟酌修改 )
├─ kernel      // 内核基类 ( 后面会把这目录制作成组件，一般由底层开发人员修改 )
├─ public      // 静态资源目录 ( 比如：本地附件存储 )
├─ storage     // 语言文件

注意：根目录增加文件夹时需要修改的地方

1. composer.json 增加自动加载目录 ( autoload )

{
  "autoload": {
    "psr-4": {
      "App\\": "app/",
      "Core\\": "core/",
      "Kernel\\": "kernel/"
    },
    "files": []
  }
}

2. config/autoload/watcher.php 增加热更新目录

return [
    'driver' => ScanFileDriver::class,
    'bin' => 'php',
    'watch' => [
        'dir' => ['app', 'config', 'core', 'kernel', 'vendor'],
        'file' => ['.env'],
        'scan_interval' => 2000,
    ],
];

3. config/autoload/annotations.php 增加注解扫描目录

return [
    'scan' => [
        // 注解扫描的目录
        'paths' => [
            BASE_PATH . '/app',
            BASE_PATH . '/core',
            BASE_PATH . '/kernel',
        ],
        // 忽略的注解名
        'ignore_annotations' => [
            'mixin',
        ],
    ],
];

lixiaokai/hyperf-admin