README-cn.md

Fast-Hyperf

Hyperf 的一把梭组件

composer require yogcloud/framework

功能

提供从 Controller Request Model Service Interface 一整套生成命令

$ php bin/hyperf
fs
    fs:controller        生成 controller, 默认生成于 app/Controller 目录下
    fs:model             生成 Model, 默认生成于 app/Model 目录下 自动生成 Service,Interface
    fs:request           生成 request, 默认生成于 app/Request 目录下
    fs:service           生成 service, 默认生成于 app/Service 目录下
    fs:serviceInterface  生成 service Interface, 默认生成于 app/Service 目录下
server
    server:restart       Restart hyperf servers.
    server:start         Start hyperf servers.
    server:stop          Stop hyperf servers.

一键生成代码 快速CRUD

php bin/hyperf.php fs:model test

Model App\Model\Test was created.
success:[/demo/app/Rpc/TestServiceInterface.php]
success:[/demo/app/Service/TestService.php]

生成代码

    /**
     * Query single entry - by ID.
     * @param int $id ID
     * @param array|string[] $columns Query field
     * @return array
     */
    public function getOneById(int $id, array $columns = ['*']): array;

    /**
     * Query single - according to the where condition.
     * @param array $where
     * @param array|string[] $columns
     * @param array Optional ['orderByRaw'=> 'id asc', 'with' = []]
     * @return array
     */
    public function findByWhere(array $where, array $columns=['*'], array $options = []): array;

    /**
     * Query multiple - by ID.
     * @param array $ids ID
     * @param array|string[] $columns
     * @return array
     */
    public function getAllById(array $ids, array $columns = ['*']): array;

    /**
     * Query multiple items according to where criteria.
     * @param array $where
     * @param array $columns
     * @param array  ['orderByRaw'=> 'id asc', 'with' = [], 'selectRaw' => 'count(*) as count']
     * @return array
     */
    public function getManyByWhere(array $where, array $columns = ['*'], array $options = []): array;

    /**
     * Multiple pages.
     * @param array $where
     * @param array|string[] $columns
     * @param array $options  ['orderByRaw'=> 'id asc', 'perPage' => 15, 'page' => null, 'pageName' => 'page']
     * @return array
     */
    public function getPageList(array $where, array $columns = ['*'], array $options = []): array;

    /**
     * Add single.
     * @param array $data
     * @return int
     */
    public function createOne(array $data): int;

    /**
     * Add multiple.
     * @param array $data
     * @return bool
     */
    public function createAll(array $data): bool;

    /**
     * Modify single entry - according to ID.
     * @param int $id id
     * @param array $data
     * @return int
     */
    public function updateOneById(int $id, array $data): int;

    /**
     * Modify multiple - according to ID.
     * @param array $where
     * @param array $data
     * @return int
     */
    public function updateByWhere(array $where, array $data): int;

    /**
     * Delete - Single.
     * @param int $id
     * @return int
     */
    public function deleteOne(int $id): int;

    /**
     * Delete - multiple.
     * @param array $ids
     * @return int
     */
    public function deleteAll(array $ids): int;

    /**
     * Handle native SQL operations.
     * @param mixed $raw
     * @param array $where
     * @return array
     */
    public function rawWhere($raw, array $where = []): array;

    /**
     * Get a single value
     * @param string $column
     * @param array $where
     * @return string
     */
    public function valueWhere(string $column, array $where): string;

多应用

在 主项目外生成

设计之初就是为了多应用多功能模块

因为Hyperf/Utils/CodeGen需要读取composer-psr4所以需要添加生成的路径

"autoload": {
    "psr-4": {
        "App\\": "src/", // 默认情况
        "Demo\\Plugin\\Test": "plugin/demo/test/src/" // 自定义插件/组件
    }
}

添加之后需要更新一下composer缓存

composer dump-autoload -o

生成

php bin/hyperf fs:model test --path plugin/demo/test/src

生成的TestService可方便操作数据免去大部分CRUD时间

生成Service时 --cache false 可不启用缓存(默认启用)

缓存会请求后生成, 更新/删除 删除缓存(默认9000TTL,不会一直占用资源)

技巧

期待你们发现其他小技巧欢迎Pr

1. SelectRaw

'selectRaw' => 'sum(`id`) as sum'

2. 闭包Where查询

[function ($q) {
    $q->where('id', '=', 1)->orWhere('id', '=', 2);
}]

3. 分表查询

'sub_table' => '2022-06-10', // 这里传递日期 parseTableStrategy 回去解析你当前选择的分表策略进行解析对应的key
// 选择hash策略可以传ID
// 选择取余策略可以传关键key

License

Apache License Version 2.0, http://www.apache.org/licenses/