快速开始

提示

因为 MoChat 构建在 Hyperf 之上，所以我们假定您对 Hyperf 已经基本熟悉

控制器

快速生成

  1. php bin/hyperf.php mcGen:action Foo

命令行会帮你自动生成Foo相关的控制器，并生成相应的注解路由与继承等

  1. ./app
  2. ├── Action
  3. │  ├── Foo
  4. │  │  ├── Create.php
  5. │  │  ├── Destroy.php
  6. │  │  ├── Edit.php
  7. │  │  ├── Index.php
  8. │  │  ├── Show.php
  9. │  │  ├── Store.php
  10. │  │  └── Update.php
  11. ...

./app/Action/Foo/Index.php 如下

  1. <?php
  3. declare(strict_types=1);
  6. namespace App\Action\Foo;
  8. use MoChat\Framework\Action\AbstractAction;
  9. use Hyperf\HttpServer\Annotation\Controller;
  10. use Hyperf\HttpServer\Annotation\RequestMapping;
  12. /**
  13.  * 查询 - 列表
  14.  * @Controller()
  15.  */
  16. class Index extends AbstractAction
  17. {
  18.     /**
  19.      * @RequestMapping(path="/foo/index", methods="GET")
  20.      */
  21.     public function handle(): array
  22.     {
  23.         return ['Index'];
  24.     }
  25. }

场景验证器

系统内置了场景验证器的trait，您可以直接引入，来进行数据格式验证

  1. use MoChat\Framework\Request\ValidateSceneTrait;
  3. ...
  4. public function handle(): array
  5. {
  6.     // 接收参数
  7.     $params = $this->request->inputs(['name'], ['name' => '']);
  8.     // 验证
  9.     $this->validated($params, 'store');
  10.     return [];
  11. }
  13. /**
  14.  * 验证规则.
  15.  */
  16. public function rules(array $inputs): array
  17. {
  18.     return [
  19.         'id'   => 'required|int',
  20.         'name' => 'required|max:25',
  21.     ];
  22. }
  25. /**
  26.  * 属性替换.
  27.  * @return array|string[] ...
  28.  */
  29. public function attributes(): array
  30. {
  31.     return [
  32.         'name' => '姓名',
  33.     ];
  34. }
  36. /**
  37.  * 验证场景.
  38.  * @return array|array[] 场景规则
  39.  */
  40. public function scene(): array
  41. {
  42.     return [
  43.          // 保存
  44.         'store' => ['name'],
  45.     ];
  46. }

模型层、服务层

在自己生成模型层前，请先配置好./config/autoload/databases.php

  1. use Hyperf\Database\Commands\ModelOption;
  2. use MoChat\Framework\Model\AbstractModel;
  4. ...
  5. 'commands' => [
  6.     'gen:model' => [
  7.         'path'          => 'app/Model',
  8.         'force_casts'   => true,
  9.         'inheritance'   => 'AbstractModel',
  10.         'uses'          => AbstractModel::class,
  11.         'property_case' => ModelOption::PROPERTY_CAMEL_CASE,
  12.     ],
  13. ],

foo表

  1. CREATE TABLE "mc_foo" (
  2.   "id" int(11) unsigned NOT NULL AUTO_INCREMENT,
  3.   "name" varchar(255) NOT NULL DEFAULT '' COMMENT '名称',
  4.   "created_at" timestamp NULL DEFAULT CURRENT_TIMESTAMP,
  5.   "updated_at" timestamp NULL DEFAULT NULL,
  6.   "deleted_at" timestamp NULL DEFAULT NULL,
  7.   PRIMARY KEY ("id")
  8. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='foo';

foo模型层、服务层，快速生成

  1. php bin/hyperf.php mcGen:model foo

生成文件内已包含了基本的增删改查分页的基本方法，如下

  1. ./app
  2. ├── Contract
  3. │  └── FooServiceInterface.php
  4. ├── Service
  5. │  └── FooService.php
  6. ├── Model
  7. │  └── Foo.php
  8. ...

层级调用

接口调用顺序默认 控制器 -> 逻辑层（可选）-> 契约层 -> 服务层 -> 模型层

提示

契约与服务已在底层默认绑定，无需再在配置文件中依赖绑定

更详细的二次开发规范，请查看开发规范

注意

我们强烈建议您通过插件的形式来进行二次开发，以达到灵活的开发、迭代与项目部署