npm package: @jnmhub/g-global-context
Description: 全局上下文对象 g，用于存储在请求处理过程中需要共享的数据。
Author: 李金木
Latest version: 1.0.1

# g-global-context

一个轻量级的 Node.js 中间件工具，提供可在请求生命周期内共享数据的全局对象 `g`，并自动在每次请求处理前清空该对象，避免请求间数据污染。

## 安装

```bash
# npm
npm install g-global-context

# yarn
yarn add g-global-context

# pnpm
pnpm add g-global-context
```

## 特性

-   🚀 轻量无依赖，核心代码仅数十行
-   🔄 自动清空：请求处理前自动清空全局对象，避免跨请求数据污染
-   🎯 灵活共享：在请求处理全流程中共享临时数据
-   ⚡ 兼容 Express/Koa 等主流 Node.js Web 框架

## 使用示例

### 1. 基础使用（Express 示例）

```javascript
import express from 'express'
import { g, mounted } from 'g-global-context'

const app = express()

// 挂载中间件（必须在业务路由前）
app.use(mounted())

// 业务中间件：设置全局数据
app.use((req, res, next) => {
    // 存储请求相关的临时数据
    g.requestId = Date.now() + Math.random().toString(36).slice(2)
    g.userInfo = { id: 1, name: 'test' }
    next()
})

// 路由中使用全局数据
app.get('/', (req, res) => {
    // 获取全局对象中的数据
    res.send({
        requestId: g.requestId,
        userInfo: g.userInfo,
        message: '全局对象数据示例'
    })
})

app.listen(3000, () => {
    console.log('服务器运行在 http://localhost:3000')
})
```

### 2. Koa 适配

Koa 需适配中间件格式（Koa 中间件为 async 函数，接收 ctx 参数）：

```javascript
import Koa from 'koa'
import { g, mounted } from 'g-global-context'

const app = new Koa()

// 适配 Koa 中间件格式
app.use((ctx, next) => {
    // 调用原中间件的逻辑
    return mounted()(ctx.req, ctx.res, next)
})

// 业务中间件
app.use(async (ctx, next) => {
    g.ctx = ctx
    g.requestTime = new Date()
    await next()
})

// 路由
app.use(async ctx => {
    ctx.body = {
        requestTime: g.requestTime,
        ctx: g.ctx.path,
        message: 'Koa 中使用全局对象'
    }
})

app.listen(3000)
```

### 3. 手动清空全局对象

若需手动清空 `g` 对象，可直接调用内置的清空逻辑：

```javascript
import { g } from 'g-global-context'

// 手动清空
const clearObject = obj => {
    for (const key in obj) {
        if (obj.hasOwnProperty(key)) {
            delete obj[key]
        }
    }
}

// 清空 g 对象
clearObject(g)
console.log(g) // {}
```

## API 文档

### 1. `g`

-   **类型**：`Object`
-   **描述**：全局共享对象，用于存储请求生命周期内的临时数据，每次请求处理前会被自动清空。
-   **示例**：
    ```javascript
    g.token = 'xxx'
    g.user = { id: 1, name: 'test' }
    ```

### 2. `mounted()`

-   **返回值**：`Function` - Express 风格的中间件函数 `(req, res, next) => void`
-   **描述**：挂载中间件，在每个请求处理前自动清空 `g` 对象，确保请求间数据隔离。
-   **使用场景**：需在所有业务路由/中间件之前挂载。

## 核心原理

1. 导出空对象 `g` 作为全局数据容器，所有模块导入的 `g` 指向同一个引用；
2. `mounted` 中间件在每次请求进入时，调用 `clearObject` 遍历并删除 `g` 的所有自有属性；
3. 利用 JavaScript 对象引用特性，实现请求全流程的数据共享与自动隔离。

## 注意事项

1. **请求隔离**：中间件会在每次请求处理前清空 `g`，确保不同请求间的数据隔离，请勿存储跨请求的持久化数据；
2. **框架兼容**：默认适配 Express 风格的中间件（`req, res, next`），Koa/egg 等框架需做简单适配；
3. **数据类型**：`g` 仅支持存储可枚举的自有属性，若需存储 Symbol 键或不可枚举属性，需自行扩展清空逻辑；
4. **全局污染**：`g` 为模块级单例对象，请勿挂载过大或敏感数据，避免内存泄漏。

## 开发与贡献

### 目录结构

```
g-global-context/
├── src/
│   └── g.js          # 核心逻辑
├── index.js          # 导出入口
├── package.json      # 包配置
└── README.md         # 说明文档
```

## 许可证

MIT License

Copyright (c) [年份] [你的名字/组织]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.