webman-mvc

webman-mvc 是一个基于 webman 的 mvc 框架，使用composer现有的生态开发，代码规范参考了java的spring框架，开发环境推荐使用 phpstorm 开发。

特性

支持env配置（vlucas/phpdotenv）
支持协程开发（workbunny/webman-coroutine）
支持注解开发（linfly/annotation）
支持验证器（topthink/think-validate）
支持依赖注入（php-di/php-di）
支持AOP面向切面编程(luoyue/webman-aop)
支持单元测试（phpunit/phpunit）
支持数据库ORM（illuminate/database）

安装

composer create-project luoyue/webman-mvc

生产环境时执行以下命令可以减少代码体积。

composer update --no-dev

启动

windows环境

php windows.php

linux环境

php start.php start -d

二进制启动

请移步至相关项目仓库查看。
自动安装PHP+composer环境（二进制版）

docker环境

使用官方镜像

# 启动容器
docker run -d -v E:\workerman\test:/opt -p 8787:8787 luoyueapi/webman-mvc

自定义构建镜像

在项目根目录下创建Dockerfile文件，内容如下：

FROM php:8.3-zts

# 安装Composer，用于开发环境
#RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
COPY --from=composer /usr/bin/composer /usr/bin/

# 安装必要依赖
RUN apt-get update && apt-get install -y libssl-dev libcurl4-openssl-dev libpq-dev libzip-dev libbz2-dev \
libwebp-dev libjpeg-dev libpng-dev libfreetype6-dev libvpx-dev unzip libevent-dev

# 安装php扩展
RUN docker-php-ext-install pcntl pdo_mysql pdo_pgsql sockets zip bz2 gd
RUN pecl install redis
RUN pecl install -D 'enable-openssl="yes" enable-swoole-curl="yes" enable-http2="yes" enable-swoole-thread="yes"' swoole

# 设置挂载点
VOLUME ["/opt"]

# 设置工作目录
WORKDIR /opt

# 运行webman
ENTRYPOINT ["php", "-d", "extension=swoole", "start.php", "start"]

然后运行如下代码进行构建：

# 构建镜像
docker build -t webman-mvc .
# 启动容器
docker run -d -v E:\workerman\test:/opt -p 8787:8787 webman-mvc

Tips：在使用phpstorm开发时，可直接使用运行配置启动webman-mvc。

目录结构

├── app                           应用目录
│   ├── annotation                注解目录
│   ├── controller                控制器目录
│   ├── service                   服务目录
│   ├── model                     模型目录
│   ├── view                      视图目录
│   ├── middleware                中间件目录
│   │   └── StaticFile.php        自带静态文件中间件
│   ├── process                   自定义进程目录
│   │   ├── Http.php              Http进程
│   │   └── Monitor.php           监控进程
│   └── functions.php             业务自定义函数写到这个文件里
├── config                        配置目录
│   ├── app.php                   应用配置
│   ├── autoload.php              这里配置的文件会被自动加载
│   ├── bootstrap.php             进程启动时onWorkerStart时运行的回调配置
│   ├── container.php             容器配置
│   ├── dependence.php            容器依赖配置
│   ├── database.php              数据库配置
│   ├── exception.php             异常配置
│   ├── log.php                   日志配置
│   ├── middleware.php            中间件配置
│   ├── process.php               自定义进程配置
│   ├── redis.php                 redis配置
│   ├── route.php                 路由配置
│   ├── server.php                端口、进程数等服务器配置
│   ├── view.php                  视图配置
│   ├── static.php                静态文件开关及静态文件中间件配置
│   ├── translation.php           多语言配置
│   └── session.php               session配置
├── public                        静态资源目录
├── runtime                       应用的运行时目录，需要可写权限
├── tests                         单元测试目录
├── .env                          环境配置文件
├── start.php                     服务启动文件
├── vendor                        composer安装的第三方类库目录
└── support                       类库适配(包括第三方类库)
    ├── Request.php               请求类
    ├── Response.php              响应类
    ├── helpers.php               助手函数(业务自定义函数请写到app/functions.php)
    └── bootstrap.php             进程启动后初始化脚本

业务分层

1. 控制层 (Controller)

控制层负责处理来自客户端的请求，接收输入并返回响应。它的主要职责包括：

接收和解析 HTTP 请求。
调用服务层的相应方法进行业务处理。
返回处理结果给客户端，通常是 JSON 格式的数据。
处理请求的路由和参数。

2. 服务层 (Service)

服务层负责实现具体的业务逻辑，通常包括：

处理复杂的业务规则和流程。
调用 DAO 层进行数据访问。
进行事务管理，确保数据一致性。
提供接口供控制层调用，简化控制层的逻辑。

3. 事件层 (event)

事件层定义了服务层的通用代码，实现业务模块之间的解耦，如用户注册或者登录后需要做一系列操作。它的主要职责包括：

编写服务层可复用的代码。
实现业务的单一且独立功能，如用户注册或者登录后需要做一系列操作。

4. 验证层 (Validation)

验证层主要负责对输入数据进行验证，确保数据的有效性和完整性。它的主要功能包括：

定义输入数据的验证规则。
检查请求参数是否符合预期格式。
返回验证错误信息，阻止无效数据进入业务逻辑层。

5. 模型层 (Model)

模型层定义了系统的数据结构和业务对象，通常包括：

数据模型的定义（例如，用户、订单等）。
数据与对象之间的映射关系。
可能包含一些与数据相关的业务逻辑。

这种分层架构使得后端系统的各个部分职责明确，便于维护和扩展。每一层都可以独立开发和测试，增强了系统的可读性和可复用性。通过这种结构，开发者可以更容易地管理复杂的业务逻辑和数据操作，从而提高系统的整体性能和稳定性。

env配置

所有配置项都可以通过.env文件配置。在docker环境中可在运行时指定环境变量，如：docker run -e SERVER_APP_DEBUG=true webman-mvc。
配置项可自定义，具体使用请看vlucas/phpdotenv或webman官方文档。
系统默认配置项在.env.example中，并且是默认值。如需更改请执行如下命令。
更多请查看官方文档。

cp .env.example .env

注解处理

注解使用的是linfly/annotation,官方文档仅适用于1.x版本，仅供参考。
控制器的文件名的后缀在webman中是需要与配置文件SERVER_APP_CONTROLLER_SUFFIX保持一致，但使用注解模式时，则不需要。不过为了项目规范，建议使用控制器后缀。

控制器注解

控制器类必须包含#[Controller]注解，如：#[Controller("/api")]。
方法必须包含方法注解, 如：#[GetMapping("index")]。
示例:在app/controller中新建文件TestController.php如下代码

<?php

namespace app\controller;

use LinFly\Annotation\Attributes\Route\GetMapping;
use LinFly\Annotation\Attributes\Route\Controller;
use support\Request;
use support\Response;

#[Controller("/api")]
class TestController
{
    //GET http://127.0.0.1:8787/api/index
    #[GetMapping("index")]
    public function index(Request $request): Response
    {
        return json(['code' => 0, 'msg' => 'ok']);
    }
}

命名空间注解

控制器类必须包含#[NamespaceController]注解，如：#[NamespaceController(namespace: "app\controller")],中间为删除类名中的命名空间前缀后的作为路径，替换后为路由地址。
使用__NAMESPACE__作为参数，则自动将当前类名做为路由地址。
示例:在app/controller中新建文件TestController.php如下代码

<?php

namespace app\controller;

use LinFly\Annotation\Attributes\Route\GetMapping;
use LinFly\Annotation\Attributes\Route\NamespaceController;
use support\Request;
use support\Response;

#[NamespaceController(namespace: __NAMESPACE__)]
class TestController
{
    //GET http://127.0.0.1:8787/test/index
    #[GetMapping("index")]
    public function index(Request $request): Response
    {
        return json(['code' => 0, 'msg' => 'ok']);
    }
}

方法路由注解

可使用的注解: RequestMapping, GetMapping, PostMapping, PutMapping, DeleteMapping, PatchMapping, HeadMapping, OptionsMapping
关于路径参数:
- #[RequestMapping], 不带参数，则使用方法名作为路由地址。
- #[RequestMapping("")], 则使用控制器前缀作为路由器地址。
- #[RequestMapping("/api")]: 使用根路径，如/api。
- #[RequestMapping("api")]: 使用控制器前缀+路径参数，如#[Controller("/test")]注解路径为/test/api。
- #[RequestMapping("/api/{id}")]: 使用路由参数，如/api/abc。
- #[RequestMapping("/api/{id:\d+}")]: 使用正则表达式约束路由参数，如/api/123。

中间件注解

#[Middleware]注解可作用在类和方法上，在类上注解则作用在类中的所有方法上，在方法上注解则作用在当前方法上。
注解可使用webman官方的注解也可使用linfly/annotation注解。

<?php
namespace app\controller;

use Webman\Annotation\Middleware;
//use LinFly\Annotation\Attributes\Route\Middleware;
use LinFly\Annotation\Attributes\Route\Controller;

#[Controller("/code")]
#[Middleware(\app\middleware\CrossDomain::class)]
class TestController
{

    #[GetMapping("index")]
    public function index(Request $request): Response
    {
        return json(['code' => 0, 'msg' => 'ok']);
    }

}

验证器注解

验证器处理器使用thinkphp中的验证器，使用#[Validate]注解即可。
params参数为传入的变量,validate为验证器类名,如:#[Validate(params: ["$get"], validate: \app\validate\TestValidate::class)]
此注解同样可作用在类和方法上。

<?php
#[Controller("/code")]
#[Validate(params: '$post', validate: TestValidate::class)]
class TestController
{

    #[Inject]
    private readonly CodeService $codeService;

    #[PostMapping]
    public function index(Request $request): Response
    {
        return json(['code' => 0, 'msg' => 'ok']);
    }

}

编写自定义注解

编写注解类，代码如下：

<?php

namespace app\annotation;

use app\annotation\Parser\MessageParser;
use LinFly\Annotation\AbstractAnnotationAttribute;

// 注解类要使用内置注解处理则必须继承
#[\Attribute(\Attribute::TARGET_ALL)]
class Message extends AbstractAnnotationAttribute
{

    public function __construct(string $message)
    {
        // 向解析器传参，否则无法获取到注解参数
        $this->setArguments(func_get_args());
    }

    // 获取注解解析器
    public static function getParser(): string|array
    {
        return MessageParser::class;
    }
}

编写注解解析器类，代码如下：

<?php

namespace app\annotation\Parser;

use LinFly\Annotation\Contracts\IAnnotationParser;

class MessageParser implements iAnnotationParser
{

    protected static array $messages = [];

    public static function process(array $item): void
    {
        print_r($item);
    }

}

然后再对任意类使用注解，运行后控制台输出打印注解收集的信息。

依赖注入

相关文档:php-di/php-di，此项目使用#[Inject]注解即可。
注解使用方式: #[Inject]注解可作用在成员变量、成员方法、控制器方法的形参上，在类上注解则作用在类中的所有方法上，在方法上注解则作用在当前方法上。

<?php
namespace app\controller;

use app\service\IndexService;
use DI\Attribute\Inject;
use LinFly\Annotation\Attributes\Route\RequestMapping;

class IndexController
{
    #[Inject]
    private readonly IndexService $indexService;

    #[RequestMapping("")]
    public function index(Request $request): Response
    {
        return $this->indexService->index();
    }
}

<?php
namespace app\service;

interface IndexService {
    function index(): array;
}

<?php
namespace app\service;

use luoyue\WebmanMvcAnnotationLibrary\annotation\Service;
use app\service\IndexService;

#[Service]
class IndexServiceImpl implements IndexService
{

    public function index(): array
    {
        return [
            'code' => 200,
            'message' => 'success',
            'data' => 'hello world'
        ];
    }

}

Bean注解

Bean注解用于在容器中注册第三方对象，bean可以是任何类型，如类、闭包、对象等。

例如我们需要使用第三方邮件库，实例化对象时需要传入参数，此时我们可以使用Bean注解。

<?php

namespace app\utils;

use luoyue\WebmanMvcAnnotationLibrary\annotation\Bean;
use Psr\Container\ContainerInterface;

class test
{
    #[Bean]
    public function test(ContainerInterface $c): \SplFileInfo
    {
        echo '初始化操作';
        return new \SplFileInfo('/'); //以SplFileInfo为例
    }
}

然后在service中使用Inject注解即可。

<?php

namespace app\service\impl;

use app\service\IndexService;
use DI\Attribute\Inject;
use support\Container;
use luoyue\WebmanMvcAnnotationLibrary\annotation\Service;

#[Service]
class IndexServiceImpl implements IndexService
{
    #[Inject('SplFileInfo')]
    private \SplFileInfo $test;

    public function index(): void
    {
        print_r($this->test);
    }
}

Event事件

使用前请查看相关文档

本项目可使用注解来实现注册事件。

<?php

namespace app\event;

use luoyue\WebmanMvcAnnotationLibrary\annotation\Event;

class User
{
    #[Event('user.register')]
    function register($user)
    {
        var_export($user);
    }

    #[Event('user.logout')]
    function logout($user)
    {
        var_export($user);
    }
}

注解效果与如下配置效果一致。

<?php
return [
    'user.register' => [
        [app\event\User::class, 'register'],
        // ...其它事件处理函数...
    ],
    'user.logout' => [
        [app\event\User::class, 'logout'],
        // ...其它事件处理函数...
    ]
];

上下文处理

上下文是webman框架中用于存储和获取当前请求的数据信息，如存储当前请求的request等。请求完成后框架会自动销毁上下文。

例如我们可以使用上下文保存当前用户信息，并在任意类中获取。

首先编写中间件

<?php

namespace app\middleware;

use Webman\Context;
use Webman\Http\Request;
use Webman\Http\Response;
use Webman\MiddlewareInterface;

class TestContext implements MiddlewareInterface
{

    public function process(Request $request, callable $handler): Response
    {
        Context::set('userInfo', [
            'id' => 1,
            'name' => "落月",
        ]);
        return $handler($request);
    }
}

然后编写控制器

    #[GetMapping]
    #[Middleware(TestContext::class)]
    public function test(Request $request): Response
    {
        return json(Context::get('userInfo'));
    }

访问/test，输出：{"id": 1,"name": "落月"}

面向切面编程（AOP）

相关文档:lvwebman/webman-aop。
此功能正在开发中，请勿在生产环境中使用。

协程开发

推荐使用linux环境或docker环境下开发，在windows环境下可能会出问题。

示例1（利用协程实现SSE）：

    public function sse(): Response
    {
        $connection = request()->connection;
        $waitGroup = new WaitGroup();
        $waitGroup->add(30);
        for ($i = 0; $i < $waitGroup->count(); $i++) {
            /** @var Coroutine[] $coroutine */
            $coroutine[$i] = new Coroutine(function () use ($waitGroup, $connection, $i, &$coroutine) {
                sleep(0.1 * $i);
                $connection->send(new ServerSentEvents([
                    'event' => 'message',
                    'data' => 'hello' . $i,
                    'id' => $i
                ]));
                $waitGroup->done();
            });
        }

        $timeOne = microtime(true);
        //设置定时器
        $timer_id = Timer::add(1, function () use ($connection, $waitGroup, &$timer_id, $timeOne, &$coroutine) {
            // 发送完毕，断开客户端的tcp连接
            if ($waitGroup->count() == 0) {
                Timer::del($timer_id);
                $connection->close(new ServerSentEvents([
                    'event' => 'close',
                    'data' => 'close',
                    'id' => 0
                ]));
                $timeTwo = microtime(true);
                echo '[协程] [运行时间] ' . ($timeTwo - $timeOne) . PHP_EOL;
            }
        });

        //tcp关闭连接后立刻停止协程
        $connection->onClose = function () use ($timer_id, &$coroutine) {
            Timer::del($timer_id);
            foreach ($coroutine as $weakMap) {
                print_r($weakMap->origin());
                $weakMap->kill($weakMap);
            }
//            foreach ($weakMap->getCoroutinesWeakMap()->getIterator() as $value) {
//                [$seconds, $microseconds] = explode('.', $value['startTime']);
//                echo '[协程] [' . $value['id'] . '] ' . date('Y-m-d H:i:s', $seconds) . ' ' . $microseconds . PHP_EOL;
//            }
        };

        return response("\r\n")->withHeaders([
            "Content-Type" => "text/event-stream",
        ]);
    }

示例2（利用协程实现Chunked）：

    public function chunked(): Response
    {
        $connection = request()->connection;
        $waitGroup = new WaitGroup();
        $waitGroup->add(30);
        for ($i = 0; $i < $waitGroup->count(); $i++) {
            $coroutine = new Coroutine(function () use ($waitGroup, $connection, $i) {
                sleep(0.1 * $i);
                $connection->send(new Chunk($i . " "));
                $waitGroup->done();
            });
        }

        $timeOne = microtime(true);
        //设置定时器
        $timer_id = Timer::add(1, function () use ($connection, $waitGroup, &$timer_id, $timeOne) {
            // 发送完毕，断开客户端的tcp连接
            if ($waitGroup->count() == 0) {
                Timer::del($timer_id);
                $connection->close(new Chunk(''));
                $timeTwo = microtime(true);
                echo '[协程] [运行时间] ' . ($timeTwo - $timeOne) . PHP_EOL;
            }
        });


        //tcp关闭连接后立刻停止协程
        $connection->onClose = function () use ($timer_id, &$coroutine) {
            Timer::del($timer_id);
            foreach ($coroutine as $weakMap) {
                $weakMap->kill($weakMap);
            }
        };

        return response()->withHeaders([
            "Transfer-Encoding" => "chunked",
            "Content-Type" => "application/octet-stream" //二进制流
        ]);
    }

更多使用方式请查看相关文档workbunny/webman-coroutine。

单元测试（PHPUnit）

以测试配置文件为例，首先在项目根目录下创建tests目录，然后创建测试类，代码如下：

<?php

namespace tests;

use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\TestCase;

class TestConfigTest extends TestCase
{
    #[Test]
    public function testAppConfig()
    {
        $config = config('app');
        self::assertIsArray($config); // 断言是否为数组
        self::assertArrayHasKey('debug', $config); // 断言数组中是否存在键名debug
        self::assertIsBool($config['debug']); // 断言键值是否为布尔值
        self::assertArrayHasKey('default_timezone', $config); // 断言数组中是否存在键
        self::assertIsString($config['default_timezone']); // 断言键值是否为字符串
    }
}

然后执行 php vendor/bin/phpunit 命令即可执行测试。

单元测试配置文件在phpunit.xml中，请自行更改。

更多用法请查看相关文档。

使用webman命令行插件

其他用法请查看更多相关文档。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

webman-mvc

特性

安装

启动

windows环境

linux环境

二进制启动

docker环境

目录结构

业务分层

1. 控制层 (Controller)

2. 服务层 (Service)

3. 事件层 (event)

4. 验证层 (Validation)

5. 模型层 (Model)

env配置

注解处理

控制器注解

命名空间注解

方法路由注解

中间件注解

验证器注解

编写自定义注解

依赖注入

Bean注解

Event事件

上下文处理

面向切面编程（AOP）

协程开发

单元测试（PHPUnit）

使用webman命令行插件

About

Releases 4

Packages

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 93 Commits
.github/workflows		.github/workflows
.run		.run
app		app
config		config
public		public
support		support
tests		tests
.env.example		.env.example
.gitignore		.gitignore
.php-cs-fixer.php		.php-cs-fixer.php
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json
composer.lock		composer.lock
phpunit.xml		phpunit.xml
start.php		start.php
webman		webman
windows.bat		windows.bat
windows.php		windows.php

License

lvluoyue/webman-mvc

Folders and files

Latest commit

History

Repository files navigation

webman-mvc

特性

安装

启动

windows环境

linux环境

二进制启动

docker环境

目录结构

业务分层

1. 控制层 (Controller)

2. 服务层 (Service)

3. 事件层 (event)

4. 验证层 (Validation)

5. 模型层 (Model)

env配置

注解处理

控制器注解

命名空间注解

方法路由注解

中间件注解

验证器注解

编写自定义注解

依赖注入

Bean注解

Event事件

上下文处理

面向切面编程（AOP）

协程开发

单元测试（PHPUnit）

使用webman命令行插件

About

Resources

License

Stars

Watchers

Forks

Releases 4

Packages 0

Languages

Packages