Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chance-fyi/operation-log
自动为数据库的增删改操作生成可读的操作日志
https://github.com/chance-fyi/operation-log
hyperform laravel-orm log operation-log thinkphp-orm
Last synced: 2 months ago
JSON representation
自动为数据库的增删改操作生成可读的操作日志
- Host: GitHub
- URL: https://github.com/chance-fyi/operation-log
- Owner: Chance-fyi
- License: mit
- Created: 2021-12-13T07:44:16.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-26T08:33:55.000Z (about 1 year ago)
- Last Synced: 2024-10-04T16:18:11.295Z (3 months ago)
- Topics: hyperform, laravel-orm, log, operation-log, thinkphp-orm
- Language: PHP
- Homepage:
- Size: 203 KB
- Stars: 30
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
支持 Laravel 的 ORM 、Hyperf 的 ORM 与 ThinkPHP 的 ORM 。可以生成增、删、改，包括批量增、删、改，以及 使用 DB 操作的日志。
通过~~模型事件~~与获取器，自动生成可读性高的操作日志。2.0 版本已弃用模型事件，因为批量操作没有触发模型事件，使用模型事件无法覆盖所有模型对数据库的操作以及 DB 操作。
### 安装
> composer require chance-fyi/operation-log
### 注意
> 因为使用了单例，所以在常驻内存的框架中使用一定要在每次请求结束之后将生成的日志清空。
### 使用 Laravel 的 ORM
首先在数据库的配置文件 `config/database.php` 中增加两个配置项 `modelNamespace` 和 `logKey`。
```php
env('DB_CONNECTION', 'mysql'),
...
'connections' => [
'mysql' => [
'driver' => 'mysql',
'url' => env('DATABASE_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'forge'),
'username' => env('DB_USERNAME', 'forge'),
'password' => env('DB_PASSWORD', ''),
...
...
// 模型所在的命名空间
"modelNamespace" => "Chance\Log\Test\model",
// 日志记录的主键
"logKey" => "id",
],
...
]
...
];
```
然后注册 MySQL 数据库连接的解析器。
```php
\Illuminate\Database\Connection::resolverFor('mysql', function ($connection, $database, $prefix, $config) {
return new \Chance\Log\orm\illuminate\MySqlConnection($connection, $database, $prefix, $config);
});
```
### 使用 ThinkPHP 的 ORM
在数据库的配置文件 config/database.php 中增加三个配置项 `query`、`modelNamespace` 和 `logKey`，并修改 `type` 与 `builder`。
```php
env('database.driver', 'mysql'),
...
'connections' => [
'mysql' => [
// 服务器地址
'hostname' => env('database.hostname', '127.0.0.1'),
// 数据库名
'database' => env('database.database', ''),
// 用户名
'username' => env('database.username', 'root'),
// 密码
'password' => env('database.password', ''),
// 端口
'hostport' => env('database.hostport', '3306'),
...
...
// 数据库类型
'type' => \Chance\Log\orm\think\MySqlConnection::class,
// 指定查询对象
"query" => \Chance\Log\orm\think\Query::class,
// Builder类
"builder" => \think\db\builder\Mysql::class,
// 模型所在的命名空间
"modelNamespace" => "Chance\Log\Test\model",
// 日志记录的主键
"logKey" => "id",
],
// 更多的数据库配置信息
...
],
...
];
```
### 日志主键
可在模型中设置`$logKey`属性修改需要记录的主键名称。
```php
'姓名',
'sex' => '性别',
];
}
```
**获取器**
设置一个名为`字段名_text`的获取器。
```php
sex)] ?? '未知';
}
// ThinkPHP ORM 获取器设置方法
public function getSexTextAttr($key): string
{
return ['女','男'][($key ?? $this->sex)] ?? '未知';
}
}
```
### 日志生成忽略的字段
可在模型中通过 `$ignoreLogFields` 设置该表不希望生成日志的字段。
```php
[
"table1" => "app\\model\\Table1",
"table2" => "app\\model\\Table2",
],
"database2" => [],
]);
```
### 获取日志信息
```php
\Chance\Log\facades\OperationLog::getLog();
```
### 清除日志信息
```php
\Chance\Log\facades\OperationLog::clearLog();
```
### 启用禁用
```php
# 启用 (默认)
\Chance\Log\facades\OperationLog::enable();
# 禁用
\Chance\Log\facades\OperationLog::disable();
```
### 效果图
