Merge pull request kvnZero#12 from kvnZero/feat/执行事件

add 语句查询埋点

Author: kvnZero

app/ApiJson/Method/DeleteMethod.php

@@ -3,7 +3,10 @@
 namespace App\ApiJson\Method;
 
 use App\ApiJson\Interface\QueryInterface;
+use App\Event\ApiJson\QueryExecuteAfter;
+use Hyperf\Utils\ApplicationContext;
 use Hyperf\Utils\Arr;
+use Psr\EventDispatcher\EventDispatcherInterface;
 
 class DeleteMethod extends AbstractMethod
 {
@@ -34,6 +37,11 @@ protected function process()
             $this->buildQuery();
             $this->query->delete($id) && $deletedIds[] = $id; //这里主键应可配置
         }
-        return $this->parseManyResponse($deletedIds, $queryMany);
+        $result = $this->parseManyResponse($deletedIds, $queryMany);
+
+        $event = new QueryExecuteAfter($this->query->toSql(), $result);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
+        return $result;
     }
 }

app/ApiJson/Method/GetMethod.php

@@ -3,6 +3,10 @@
 namespace App\ApiJson\Method;
 
 use App\ApiJson\Parse\Handle;
+use App\Event\ApiJson\QueryExecuteAfter;
+use App\Event\ApiJson\QueryExecuteBefore;
+use Hyperf\Utils\ApplicationContext;
+use Psr\EventDispatcher\EventDispatcherInterface;
 
 class GetMethod extends AbstractMethod
 {
@@ -20,14 +24,28 @@ protected function process()
         if (!$queryMany) {
             $this->tableEntity->getConditionEntity()->setLimit(1);
         }
-        $result = $this->query->all();
+
+        //该事件鼓励是做语句缓存或者事件触发 不赞成修改语句做法 修改语句应在更上层的QueryHandle事件
+        $event = new QueryExecuteBefore($this->query->toSql(), $this->method);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
+        if(is_null($event->result)) {
+            $result = $this->query->all();
+        } else {
+            $result = $event->result;
+        }
+
         if ($queryMany) {
             foreach ($result as $key => $item) {
                 $result[$key] = $this->arrayQuery ? [$this->tableEntity->getTableName() => $item] : $item;
             }
         } else {
             $result = current($result);
         }
+
+        $event = new QueryExecuteAfter($this->query->toSql(), $result);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
         return $result ?: [];
     }
 }

app/ApiJson/Method/HeadMethod.php

@@ -3,6 +3,10 @@
 namespace App\ApiJson\Method;
 
 use App\ApiJson\Parse\Handle;
+use App\Event\ApiJson\QueryExecuteAfter;
+use App\Event\ApiJson\QueryExecuteBefore;
+use Hyperf\Utils\ApplicationContext;
+use Psr\EventDispatcher\EventDispatcherInterface;
 
 class HeadMethod extends AbstractMethod
 {
@@ -15,8 +19,21 @@ protected function process()
     {
         $handle = new Handle($this->tableEntity->getConditionEntity(), $this->tableEntity);
         $handle->build();
+
+        $event = new QueryExecuteBefore($this->query->toSql(), $this->method);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
+        if(is_null($event->result)) {
+            $count = $this->query->count();
+        } else {
+            $count = $event->result;
+        }
+
+        $event = new QueryExecuteAfter($this->query->toSql(), $count);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
         return [
-            'count' => $this->query->count()
+            'count' => $count
         ];
     }
 }

app/ApiJson/Method/PostMethod.php

@@ -2,7 +2,10 @@
 
 namespace App\ApiJson\Method;
 
+use App\Event\ApiJson\QueryExecuteAfter;
+use Hyperf\Utils\ApplicationContext;
 use Hyperf\Utils\Arr;
+use Psr\EventDispatcher\EventDispatcherInterface;
 
 class PostMethod extends AbstractMethod
 {
@@ -25,6 +28,11 @@ protected function process()
         foreach ($insertData as $insertItem) {
             $insertIds[] = $this->query->insertGetId($insertItem); //因为需要返回ID 直接insert($insertData)不能得到本次插入的ID 未找到相关可用方法替代
         }
-        return $this->parseManyResponse($insertIds, $this->isQueryMany());
+        $result = $this->parseManyResponse($insertIds, $this->isQueryMany());
+
+        $event = new QueryExecuteAfter($this->query->toSql(), $result);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
+        return $result;
     }
 }

app/ApiJson/Method/PutMethod.php

@@ -2,7 +2,10 @@
 
 namespace App\ApiJson\Method;
 
+use App\Event\ApiJson\QueryExecuteAfter;
+use Hyperf\Utils\ApplicationContext;
 use Hyperf\Utils\Arr;
+use Psr\EventDispatcher\EventDispatcherInterface;
 
 class PutMethod extends AbstractMethod
 {
@@ -41,6 +44,11 @@ protected function process()
                 $this->query->update($updateItem) && $updateIds[] = $id;
             }
         }
-        return $this->parseManyResponse($updateIds, $queryMany);
+        $result = $this->parseManyResponse($updateIds, $queryMany);
+
+        $event = new QueryExecuteAfter($this->query->toSql(), $result);
+        ApplicationContext::getContainer()->get(EventDispatcherInterface::class)->dispatch($event);
+
+        return $result;
     }
 }

app/ApiJson/Model/MysqlQuery.php

@@ -12,6 +12,9 @@ class MysqlQuery implements QueryInterface
     /** @var string $primaryKey */
     protected string $primaryKey = 'id';
 
+    /** @var bool $build 是否已经生成条件 */
+    protected bool $build = false;
+
     /** @var Builder $db */
     protected Builder $db;
 
@@ -54,18 +57,21 @@ public function count($columns = '*'): int
 
     public function insertGetId(array $values, $sequence = null): int
     {
+        $this->build = true;
         return $this->db->insertGetId($values, $sequence);
     }
 
     public function update(array $values): bool
     {
+        $this->build = true;
         $this->buildQuery(false);
         if (empty($this->db->getBindings()['where'])) return false; // 不允许空条件修改
         return $this->db->update($values);
     }
 
     public function delete($id = null): bool
     {
+        $this->build = true;
         return $this->db->delete($id);
     }
 
@@ -88,6 +94,8 @@ public function getBindings(): array
 
     protected function buildQuery(bool $query = true)
     {
+        if ($this->build) return;
+        $this->build = true;
         $queryWhere = $this->conditionEntity->getQueryWhere();
         foreach ($queryWhere as $itemWhere) {
             $this->db->whereRaw($itemWhere['sql'], $itemWhere['bind']);

app/Event/ApiJson/QueryExecuteAfter.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Event\ApiJson;
+
+/**
+ * 任何方法都会执行该事件
+ */
+class QueryExecuteAfter
+{
+    public function __construct(public string $sql, public $result)
+    {
+    }
+}

app/Event/ApiJson/QueryExecuteBefore.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Event\ApiJson;
+
+/**
+ * 查询(GET, HEAD)相关语句执行前会执行该事件
+ */
+class QueryExecuteBefore
+{
+    public $result = null; //如果这里被赋值 则不会执行代码 而会直接抛出该结果
+
+    public function __construct(public string $sql, public string $method)
+    {
+    }
+}