YII框架的审计日志是什么？YII框架如何记录操作日志？

Yii::info()

Yii::warning()

Yii::error()

// config/web.php 或 config/main.php
'components' => [
    'log' => [
        'traceLevel' => YII_DEBUG ? 3 : 0, // 调试模式下追踪调用栈
        'targets' => [
            [
                'class' => 'yii\log\FileTarget', // 文件日志
                'levels' => ['error', 'warning'], // 只记录错误和警告
                'logFile' => '@runtime/logs/app.log',
                'except' => ['yii\web\HttpException:404'], // 排除404错误
            ],
            [
                'class' => 'yii\log\DbTarget', // 数据库日志，用于更结构化的记录
                'levels' => ['info'], // 记录info级别，适合操作日志
                'logTable' => '{{%audit_log}}', // 专门的审计日志表
                'categories' => ['application', 'user_action'], // 区分不同类别的日志
                'prefix' => function ($message) {
                    // 添加额外上下文信息，如用户ID、IP
                    $userId = Yii::$app->user->isGuest ? 0 : Yii::$app->user->id;
                    $ip = Yii::$app->request->userIP;
                    return "User: {$userId}, IP: {$ip} | ";
                },
                'exportInterval' => 1, // 每条日志都立即写入
            ],
        ],
    ],
],

// 记录普通信息
Yii::info('用户ID: ' . Yii::$app->user->id . ' 访问了文章列表。', 'user_action');

// 记录数据变更（审计日志的核心）
class Post extends \yii\db\ActiveRecord
{
    public function afterSave($insert, $changedAttributes)
    {
        parent::afterSave($insert, $changedAttributes);

        $logData = [
            'user_id' => Yii::$app->user->id,
            'action' => $insert ? '创建文章' : '更新文章',
            'model_id' => $this->id,
            'model_name' => self::class,
            'old_attributes' => json_encode($changedAttributes), // 记录旧值
            'new_attributes' => json_encode($this->getAttributes()), // 记录新值
            'ip_address' => Yii::$app->request->userIP,
        ];
        Yii::info(json_encode($logData), 'audit_trail'); // 使用特定分类方便过滤
    }

    public function afterDelete()
    {
        parent::afterDelete();
        $logData = [
            'user_id' => Yii::$app->user->id,
            'action' => '删除文章',
            'model_id' => $this->id,
            'model_name' => self::class,
            'ip_address' => Yii::$app->request->userIP,
        ];
        Yii::info(json_encode($logData), 'audit_trail');
    }
}

targets

categories

FileTarget

@runtime/logs

DbTarget

DbTarget

exportInterval

JSON

old_attributes

new_attributes

FileTarget

DbTarget

yii\log\Target

export()

export()

exportInterval

// app/components/AuditLogTarget.php
namespace app\components;

use yii\log\Target;
use Yii;

class AuditLogTarget extends Target
{
    public $auditTableName = '{{%my_custom_audit_log}}'; // 自定义审计表名

    public function export()
    {
        // 遍历所有待处理的日志消息
        foreach ($this->messages as $message) {
            list($text, $level, $category, $timestamp) = $message;

            // 假设我们只关心 'audit_trail' 类别且内容是JSON字符串
            if ($category === 'audit_trail' && is_string($text)) {
                $logData = json_decode($text, true);
                if (json_last_error() !== JSON_ERROR_NONE) {
                    // 如果不是有效的JSON，记录为普通错误或跳过
                    Yii::error('Invalid JSON in audit_trail log: ' . $text, 'application');
                    continue;
                }

                // 准备插入数据库的数据
                $insertData = [
                    'user_id' => $logData['user_id'] ?? 0,
                    'action' => $logData['action'] ?? '未知操作',
                    'model_name' => $logData['model_name'] ?? '',
                    'model_id' => $logData['model_id'] ?? 0,
                    'old_attributes' => $logData['old_attributes'] ?? null,
                    'new_attributes' => $logData['new_attributes'] ?? null,
                    'ip_address' => $logData['ip_address'] ?? null,
                    'created_at' => date('Y-m-d H:i:s', $timestamp),
                    // 还可以添加更多自定义字段
                ];

                // 插入数据库
                Yii::$app->db->createCommand()->insert($this->auditTableName, $insertData)->execute();
            }
        }
    }
}

'components' => [
    'log' => [
        'targets' => [
            // ... 其他日志目标
            [
                'class' => 'app\components\AuditLogTarget',
                'levels' => ['info'], // 只处理info级别的日志
                'categories' => ['audit_trail'], // 只处理 'audit_trail' 类别的日志
                'exportInterval' => 1, // 确保实时写入
            ],
        ],
    ],
],

Yii::info(json_encode($data), 'audit_trail');

afterSave

AuditBehavior

// app/behaviors/AuditBehavior.php
namespace app\behaviors;

use yii\base\Behavior;
use yii\db\ActiveRecord;
use Yii;

class AuditBehavior extends Behavior
{
    public function events()
    {
        return [
            ActiveRecord::EVENT_AFTER_INSERT => 'logAudit',
            ActiveRecord::EVENT_AFTER_UPDATE => 'logAudit',
            ActiveRecord::EVENT_AFTER_DELETE => 'logAudit',
        ];
    }

    public function logAudit($event)
    {
        /** @var ActiveRecord $model */
        $model = $this->owner;
        $action = '';
        $oldAttributes = null;
        $newAttributes = $model->getAttributes();

        if ($event->name === ActiveRecord::EVENT_AFTER_INSERT) {
            $action = '创建';
        } elseif ($event->name === ActiveRecord::EVENT_AFTER_UPDATE) {
            $action = '更新';
            // 记录变更前的数据
            $oldAttributes = $event->changedAttributes; // 只有更新事件才有
        } elseif ($event->name === ActiveRecord::EVENT_AFTER_DELETE) {
            $action = '删除';
            $newAttributes = null; // 删除后没有新属性
        }

        $logData = [
            'user_id' => Yii::$app->user->isGuest ? 0 : Yii::$app->user->id,
            'action' => $action . $model->formName(),
            'model_id' => $model->getPrimaryKey(),
            'model_name' => $model->formName(),
            'old_attributes' => $oldAttributes ? json_encode($oldAttributes) : null,
            'new_attributes' => $newAttributes ? json_encode($newAttributes) : null,
            'ip_address' => Yii::$app->request->userIP,
        ];

        Yii::info(json_encode($logData), 'audit_trail');
    }
}

class Product extends \yii\db\ActiveRecord
{
    public function behaviors()
    {
        return [
            \app\behaviors\AuditBehavior::class,
        ];
    }
    // ...
}