php - 自定义日志记录 - CakePHP (1.3)

Question

我想扩展 cakephp 日志记录工具。使用

$this->log($msg, $level)

您可以将 $msg 和 $level 记录到 tmp/logs/$level.log。

我希望如何使用日志记录:

1. 不同级别的不同功能，例如$this->debug($msg) 为 $this->log($msg, 'debug') 和 $this->error($msg) 用于 $this->log($msg, 'error') 等用于日志记录。
2. 自动将类名放在消息前面，例如$this->debug($msg) 如果 $this 的类型为“MyClass”，则将导致“MyClass: $msg”。

我知道我可以通过扩展 AppModel、AppController 等来扩展功能，但是由于我在我的应用程序中到处都需要功能，所以我宁愿需要扩展 cakephp 的对象——但没有找到一个稳定的机制(不要不想在 cake/文件夹中更改它)。我想为该功能实现一个新类，但我不确定如何在 cakephp 中提供它。

能否请您给我一些提示，告诉我在哪里/如何巧妙地实现这些扩展？

Answer 1

全局便捷方法

好吧，你真的做不到monkey patching在 PHP(至少 5.2)中，这对于在您离开后必须维护您的代码的开发人员来说可能是一件好事。 :)

CakePHP - 作为一个具有严格约定的 MVC 框架 - 让你很难打破 MVC 范式，因为它只允许你单独扩展你需要的部分(即。AppModel， AppController 等)，并在核心中保持面向对象的基础不变(这使得很难添加“可以在任何地方使用”的代码以防止潜在的误用)。

至于添加超越所有 MVC 分离的功能，它的位置是 app/config/bootstrap.php。当您在此处放置代码时，很明显它不是框架的一部分(这是正确的)，但允许您在 CakePHP 加载之前添加这些基本要素。在这里可以做的一些选择可能是:

1. 创建一个函数(例如，一些自定义函数，如 error()，以您喜欢的方式调用 CakeLog::write()。)
2. 加载一个类(例如，加载您自己的日志类，名称为..Log，这样您就可以在某些地方调用Log::error())
3. 见下文:

记录器 API

Cake 确实允许对诸如记录器之类的东西进行许多自定义，但不幸的是，在这种情况下，暴露给我们的 API 已经在核心中定义了。 CakePHP 中用于登录的 API 如下所示，您可以在任何地方使用任何一种方法(好吧，前者仅在类中):

$this->log($msg, $level) // any class extending `Object` inherits this
// or
CakeLog::write($level, $message); // this is actually what is called by the above

您试图消除的任意 $level 参数实际上是 quite a powerful feature :

$this->log('Cannot connect to SMTP server', 'email'); // logs to app/logs/email.log
// vs
$this->email('Cannot connect to SMTP server'); // ambiguous - does this send emails?

我们只是创建了一个全新的日志类型，而没有编写额外的代码行，我们的代码的意图非常清楚。

自定义记录器

核心开发人员有先见之明add a condition如果我们希望，允许我们完全替换记录器类:

function log($msg, $type = LOG_ERROR) {
    if (!class_exists('CakeLog')) { // winning
        require LIBS . 'cake_log.php';
    }
    // ...

如您所见，核心 CakeLog 类只有在不存在这样的类时才会被实例化，让您有机会插入您自己创建的东西(或经过一些调整的精确副本 - 虽然您可能希望在升级时与核心同步更改 - 手动 - ):

// app/config/bootstrap.php
App::import('Lib', 'CakeLog'); // copy cake/libs/cake_log.php to app/lib/cake_log.php

以上内容可以让您完全控制应用程序中 CakeLog 类的实现，因此您可以执行一些操作，例如将调用类名动态添加到您的日志消息中。但是，更直接的方式(以及其他类型的日志记录 - 例如数据库)是 create a custom log stream :

CakeLog::config('file', array(
    'engine' => 'FileLog', // copy cake/libs/log/file_log.php to app/libs/log/file_log.php
));

TL;DR - 虽然您可以在 CakePHP Bootstrap 之前加载您自己的代码或在提供的每个 MVC 层中单独使用，但您不应该篡改核心提供的对象层次结构.这使得很难添加全局继承的类方法。

我的建议:使用提供给您的 API，并专注于添加更多功能，而不是语法上的细微差别。 :)