Debug

添加一个组件调试。

引入相关类

  • use Error;
  • use Exception;
  • use Leevel\Debug\Debug;
  • use Leevel\Event\Dispatch;
  • use Leevel\Event\IDispatch;
  • use Leevel\Http\JsonResponse;
  • use Leevel\Http\Request;
  • use Leevel\Http\Response;
  • use Leevel\Leevel\App as Apps;
  • use Leevel\Log\File as LogFile;
  • use Leevel\Log\ILog;
  • use Leevel\Log\Log;
  • use Leevel\Option\IOption;
  • use Leevel\Option\Option;
  • use Leevel\Session\File as SessionFile;
  • use Leevel\Session\ISession;
  • use Leevel\Session\Session;

    JSON 关联数组调试

关联数组结构会在尾部追加一个选项 :trace 用于调试。

返回结构

  1. $response = ["foo" => "bar", ":trace" => []];

关联数组在尾部追加一个选项作为调试信息，这与非关联数组有所不同。

  1. public function testJson()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $debug->handle($request, $response);
  16.     $content = $response->getContent();
  18.     $this->assertContains('{"foo":"bar",":trace":', $content);
  20.     $this->assertContains('"php":{"version":', $content);
  22.     $this->assertContains('Starts from this moment with QueryPHP.', $content);
  23. }

JSON 非关联数组调试

非关联数组结构会在尾部追加一个 :trace 用于调试。

返回结构

  1. $response = ["foo", "bar", [":trace" => []]];

非关联数组在尾部追加一个调试信息，将不会破坏返回接口的 JSON 结构。

  1. public function testJsonForNotAssociativeArray()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo', 'bar']);
  14.     $debug->handle($request, $response);
  16.     $content = $response->getContent();
  18.     $this->assertContains('"foo","bar",{":trace":{', $content);
  20.     $this->assertContains('"php":{"version":', $content);
  22.     $this->assertContains('Starts from this moment with QueryPHP.', $content);
  23. }

关闭调试

  1. public function testDisable()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $debug->handle($request, $response);
  16.     $content = $response->getContent();
  18.     $this->assertContains('{"foo":"bar",":trace":', $content);
  20.     $this->assertContains('"php":{"version":', $content);
  22.     $this->assertContains('Starts from this moment with QueryPHP.', $content);
  24.     $debug->disable();
  26.     $response2 = new JsonResponse(['foo' => 'bar']);
  28.     $debug->handle($request, $response2);
  30.     $content = $response2->getContent();
  32.     $this->assertNotContains('{"foo":"bar",":trace":', $content);
  34.     $this->assertNotContains('"php":{"version":', $content);
  36.     $this->assertNotContains('Starts from this moment with QueryPHP.', $content);
  37. }

启用调试

  1. public function testEnable()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $debug->disable();
  16.     $debug->handle($request, $response);
  18.     $content = $response->getContent();
  20.     $this->assertNotContains('{"foo":"bar",":trace":', $content);
  22.     $this->assertNotContains('"php":{"version":', $content);
  24.     $this->assertNotContains('Starts from this moment with QueryPHP.', $content);
  26.     $this->assertTrue($debug->isBootstrap());
  28.     $debug->enable();
  30.     $this->assertTrue($debug->isBootstrap());
  32.     $response2 = new JsonResponse(['foo' => 'bar']);
  34.     $debug->handle($request, $response2);
  36.     $content = $response2->getContent();
  38.     $this->assertContains('{"foo":"bar",":trace":', $content);
  40.     $this->assertContains('"php":{"version":', $content);
  42.     $this->assertContains('Starts from this moment with QueryPHP.', $content);
  43. }

启用调试但是未初始化

  1. public function testEnableWithoutBootstrap()
  2. {
  3.     $debug = $this->createDebug();
  5.     $request = new Request();
  6.     $response = new JsonResponse(['foo' => 'bar']);
  8.     $debug->disable();
  10.     $debug->handle($request, $response);
  12.     $content = $response->getContent();
  14.     $this->assertNotContains('{"foo":"bar",":trace":', $content);
  16.     $this->assertNotContains('"php":{"version":', $content);
  18.     $this->assertNotContains('Starts from this moment with QueryPHP.', $content);
  20.     $this->assertFalse($debug->isBootstrap());
  22.     $debug->enable();
  24.     $this->assertTrue($debug->isBootstrap());
  26.     $response2 = new JsonResponse(['foo' => 'bar']);
  28.     $debug->handle($request, $response2);
  30.     $content = $response2->getContent();
  32.     $this->assertContains('{"foo":"bar",":trace":', $content);
  34.     $this->assertContains('"php":{"version":', $content);
  36.     $this->assertContains('Starts from this moment with QueryPHP.', $content);
  37. }

调试消息等级

支持的消息类型

  1. public function getMessageLevelsData()
  2. {
  3.     return [
  4.         ['emergency'], ['alert'], ['critical'],
  5.         ['error'], ['warning'], ['notice'],
  6.         ['info'], ['debug'], ['log'],
  7.     ];
  8. }

系统支持多种消息类型，可以参考这个进行调试。

  1. public function testMessageLevelsData(string $level)
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $debug->{$level}('hello', 'world');
  16.     $debug->handle($request, $response);
  18.     $content = $response->getContent();
  20.     $this->assertContains('{"foo":"bar",":trace":', $content);
  22.     $this->assertContains('"php":{"version":', $content);
  24.     $this->assertContains('Starts from this moment with QueryPHP.', $content);
  26.     $this->assertContains('{"message":"hello","message_html":null,"is_string":true,"label":"'.$level.'",', $content);
  27.     $this->assertContains('{"message":"world","message_html":null,"is_string":true,"label":"'.$level.'",', $content);
  28. }

调试 Session

  1. public function testWithSession()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $session = $debug->getApp()->make('session');
  16.     $session->set('test_session', 'test_value');
  18.     $debug->handle($request, $response);
  20.     $content = $response->getContent();
  22.     $this->assertContains('"session":{"test_session":"test_value"},', $content);
  23. }

调试 Log

  1. public function testWithLog()
  2. {
  3.     $debug = $this->createDebugWithLog();
  5.     $app = $debug->getApp();
  7.     $this->assertFalse($debug->isBootstrap());
  9.     $debug->bootstrap();
  11.     $this->assertTrue($debug->isBootstrap());
  13.     $request = new Request();
  14.     $response = new JsonResponse(['foo' => 'bar']);
  16.     $log = $app->make('log');
  18.     $log->info('test_log', ['exends' => 'bar']);
  19.     $log->debug('test_log_debug');
  21.     $debug->handle($request, $response);
  23.     $content = $response->getContent();
  25.     $this->assertContains('"logs":{"count":2,', $content);
  27.     $this->assertContains('test_log info: {\"exends\":\"bar\"}', $content);
  29.     $this->assertContains('test_log_debug debug: []', $content);
  30. }

调试时间

  1. public function testTime()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $debug->time('time_test');
  16.     $debug->end('time_test');
  18.     $debug->handle($request, $response);
  20.     $content = $response->getContent();
  22.     $this->assertContains('"time":{"start"', $content);
  24.     $this->assertContains('"measures":[{"label":"time_test","start":', $content);
  25. }

调试带有标签的时间

  1. public function testTimeWithLabel()
  2. {
  3.     $debug = $this->createDebug();
  5.     $this->assertFalse($debug->isBootstrap());
  7.     $debug->bootstrap();
  9.     $this->assertTrue($debug->isBootstrap());
  11.     $request = new Request();
  12.     $response = new JsonResponse(['foo' => 'bar']);
  14.     $debug->time('time_test', 'time_label');
  16.     $debug->end('time_test');
  18.     $debug->handle($request, $response);
  20.     $content = $response->getContent();
  22.     $this->assertContains('"time":{"start"', $content);
  24.     $this->assertContains('"measures":[{"label":"time_label","start":', $content);
  25. }