README

CodeSpy 集成包提供了一个强大的 spyOn 全局函数，旨在增强您的代码库中的调试工作。此函数允许与 CodeSpy 应用程序无缝通信，实现代码执行的实时监控和分析。对于希望更深入了解其应用程序、更有效地识别问题并提高代码质量的开发者来说，这是一个必不可少的工具。

功能

全局 spyOn 函数：无需侵入性更改即可轻松将调试语句集成到您的代码中。
与 CodeSpy 应用程序的通信：利用 CodeSpy 应用程序提供增强的调试体验，提供图形界面来查看代码的行为。
序列化支持：将对象传递给 spyOn 函数，将其序列化为 JSON 以进行全面检查。非常适合检查复杂的数据结构。
可配置的递归深度：自定义序列化的深度，以便更深入地检查嵌套对象。此功能允许开发者在细节和性能之间进行平衡。
故障排除变得简单：通过能够序列化对象并控制递归深度，开发者可以更有效地定位问题，从而节省调试的时间和精力。

先决条件

要使用此包，您必须安装 CodeSpy 应用程序。该应用程序通过 spyOn 函数收集调试数据，并便于可视化和管理工作。

安装

使用以下命令通过 Composer 安装包

composer require onx/code-spy

此命令将 CodeSpy 集成包添加到您的项目中，使您能够立即使用增强的调试功能开始调试。

用法

要使用 spyOn 函数调试您的代码，只需传递目标对象，并可选地指定序列化的递归深度。以下是一个基本示例

spyOn($yourObject, $recursionDepth);

参数

$yourObject (必需)：您希望检查的对象或数据。
$recursionDepth (可选)：表示序列化应深入多少层的整数。请谨慎使用深序列化，因为它可能会影响性能，并可能在设置得过高时引发问题。

示例

// Debugging a complex array structure with recursion depth set to 2
$arrayToDebug = ['key1' => 'value1', 'key2' => ['subkey1' => 'subvalue1']];
spyOn($arrayToDebug, 2);

// Debugging an object with default recursion depth
$objectToDebug = new MyClass();
spyOn($objectToDebug);

故障排除技巧

处理深序列化：如果您遇到由于深序列化而导致的问题或性能下降，请考虑减少递归深度。这有助于减轻潜在的内存溢出或过多的处理时间。
生产环境中的调试：强烈建议在生产环境中避免或限制使用 spyOn。如果必须使用，请确保它有条件地使用，并在使用后将其删除或禁用，以防止出现任何安全或性能问题。
数据过载：在调试非常大的或复杂对象时，您可能会遇到减速或崩溃。为了避免这种情况，仅序列化对象的最相关部分或减少递归深度。

许可证

CodeSpy 集成包是开源软件，根据 MIT 许可证许可。此宽松的许可证允许无限制地使用、修改和分发软件，使其成为开发者和公司 alike 的绝佳选择。

onx / code-spy

维护者

详细信息

README

功能

先决条件

安装

用法

示例

故障排除技巧

许可证