問題反饋

http://wtbis.cn/q/11077

詳細(xì)介紹

記錄管理員對數(shù)據(jù)的增刪改操作以及請求信息，生成的操作日志可讀性高。

安裝使用

該插件依賴 webman admin
不要直接將代碼復(fù)制到項(xiàng)目中，在后臺插件市場安裝

1. 直接在 admin 的插件市場安裝應(yīng)用
2. 在 admin 的 middleware.php 配置文件中增加一個全局中間件 plugin\oplog\app\middleware\AfterOperationLog::class
   • 使用的是 Laravel 的 ORM
     • 修改 config/bootstrap.php 配置文件，增加 plugin\oplog\bootstrap\LaravelHookConnection::class
   • 使用的是 ThinkPHP 的 ORM
     • 修改數(shù)據(jù)庫配置文件中的 type、query、builder 三個字段
       例如：

       <?php
       return [
       'default' => 'mysql',
       'connections' => [
           'mysql' => [
               // 服務(wù)器地址
               'hostname' => 'mysql',
               // 數(shù)據(jù)庫名
               'database' => 'webman_admin',
               // 數(shù)據(jù)庫用戶名
               'username' => 'root',
               // 數(shù)據(jù)庫密碼
               'password' => 'root',
               // 數(shù)據(jù)庫連接端口
               'hostport' => 3306,
               // 數(shù)據(jù)庫連接參數(shù)
               'params' => [
                   // 連接超時3秒
                   \PDO::ATTR_TIMEOUT => 3,
               ],
               // 數(shù)據(jù)庫編碼默認(rèn)采用utf8
               'charset' => 'utf8mb4',
               // 數(shù)據(jù)庫表前綴
               'prefix' => '',
               // 斷線重連
               'break_reconnect' => true,
               // 關(guān)閉SQL監(jiān)聽日志
               'trigger_sql' => true,
               // 自定義分頁類
               'bootstrap' =>  '',
               // 數(shù)據(jù)庫類型
               'type'            => \Chance\Log\orm\think\MySqlConnection::class,
               // 指定查詢對象
               "query"           => \Chance\Log\orm\think\Query::class,
               // Builder類
               "builder"         => \think\db\builder\Mysql::class,
           ],
       ],
       ];

3. 執(zhí)行 php webman TableModelMapping 命令生成表與模型的映射關(guān)系
4. restart

日志主鍵

可在模型中設(shè)置$logKey屬性修改需要記錄的主鍵名稱。

<?php

namespace Chance\Log\Test\model;

class User extends BaseModel
{
    // 日志記錄的主鍵名稱
    public string $logKey = 'id';
}

可讀性設(shè)置

通過表注釋、字段注釋與獲取器來生成可讀性的日志。

表注釋與字段注釋

也可以在模型中通過$tableComment與$columnComment設(shè)置表注釋與字段注釋。

<?php

namespace Chance\Log\Test\model;

class User extends BaseModel
{
    // 表注釋
    public $tableComment = '用戶';
    // 字段注釋
    public $columnComment = [
        'name' => '姓名',
        'sex' => '性別',
    ];
}

獲取器

設(shè)置一個名為字段名_text的獲取器。

<?php

namespace Chance\Log\Test\model;

class User extends BaseModel
{
    // Laravel ORM 獲取器設(shè)置方法
    public function getSexTextAttribute($key): string
    {
        return ['女','男'][($key ?? $this->sex)] ?? '未知';
    }

    // ThinkPHP ORM 獲取器設(shè)置方法
    public function getSexTextAttr($key): string
    {
        return ['女','男'][($key ?? $this->sex)] ?? '未知';
    }
}

日志生成忽略的字段

可在模型中通過 $ignoreLogFields 設(shè)置該表不希望生成日志的字段。

<?php

namespace Chance\Log\Test\model;

class User extends BaseModel
{
    // 日志生成忽略的字段
    public $ignoreLogFields = [
        'create_time',
        'update_time',
    ];
}

數(shù)據(jù)表不生成日志

可在模型中通過 $doNotRecordLog 設(shè)置該表不在生成日志。

<?php

namespace Chance\Log\Test\model;

class User extends BaseModel
{
    // 不生成該表的日志
    public $doNotRecordLog = true;
}