@aipeli/midway-log2db

🎉🚀midway-log2db🎉👋

🏠 项目主页

记录API访问日志并保存到数据中,自动识别来访问者IP地址位置、用户代理信息等

Recode access api to db based on MidwayJS(koa) v3.x

📦 环境要求

• midway >=3.x

🛠️ 安装

pnpm install @aipeli/midway-log2db

✍️ 用法

import { Crud, BaseController } from '@aipeli/midway-crud';
import { Log2DbService } from '@aipeli/midway-log2db';
import { Get, Inject } from '@midwayjs/decorator';
import { Context } from '@midwayjs/koa';

@Crud('/log2db')
export class ShopAdminLog2DbController extends BaseController {
  @Inject()
  ctx: Context;
  @Inject()
  log2db: Log2DbService;
  
  /**
   * 保存日志记录
   * http://127.0.0.1:7001/admin/shop/log2db/record
   * @returns 返回保存日志记录的ID
   */
  @Get('/record')
  async record() {
    const result_data = await this.log2db.record(
      this.ctx,
      this.ctx.url.split('?')[0],
      this.ctx.req.method === 'GET'
        ? this.ctx.request.query
        : this.ctx.request.body,
      this.ctx.admin ? this.ctx.admin.userId : 1,
      this.ctx.request.header['user-agent']
    );
    return { success: true, message: 'OK', data: result_data };
  }

  /**
   * 清除日志
   * http://127.0.0.1:7001/admin/shop/log2db/clear
   */
  @Get('/clear')
  async clear() {
    // 清除全部日志
    await this.log2db.clear();
    await this.log2db.clear(0, true);
    // 清除3天前的日志
    await this.log2db.clear(3, false);

  }
}

🧪 配置

配置 config/config.default.ts

import { MidwayConfig } from '@midwayjs/core';

export default {
  // use for cookie sign key, should change to your own and keep security
  keys: '1644208064112_2754',
  koa: {
    port: 7001,
  },
  orm: {
    /**
     * 单数据库实例
     */
    default: {
      type: 'mysql',
      host: '127.0.0.1',
      port: 3306,
      username: 'root',
      password: 'root',
      database: 'midway_crud',
      synchronize: true, // 如果第一次使用，不存在表，有同步的需求可以写 true
      logging: false,
    },
  },
  log2db: {
    ipdb: '/ipdb/ipipfree.ipdb'
  }
} as MidwayConfig;

配置 /configuration.ts

import { Configuration, App } from '@midwayjs/decorator';
import * as koa from '@midwayjs/koa';
import * as validate from '@midwayjs/validate';
import * as info from '@midwayjs/info';
import { join } from 'path';
import * as crud from '@aipeli/midway-crud';
import * as log2db from '@aipeli/midway-log2db';
@Configuration({
  imports: [
    koa,
    validate,
    crud,
    log2db,
    {
      component: info,
      enabledEnvironment: ['local'],
    },
  ],
  importConfigs: [join(__dirname, './config')],
})
export class ContainerLifeCycle {
  @App()
  app: koa.Application;

  async onReady() {

  }
}

🧑 开发人员

• 🧑 aipeli
  • 🌏 Website: http://www.fast-js.com
  • 💼 GitHub: @aipeli/midway

🤝 贡献

欢迎投稿、问题和功能请求！ issues 地址.

⭐️ 支持

如果项目对你有帮助，请给我一个 start⭐️ 吧!

• 💼 GitHub: @aipeli/midway

📝 License

Copyright © 2022 aipeli. This project is MIT licensed.

---

This README was generated with ❤️ by fast-readme