hwj-common-lib/README.md

微信小程序云开发通用模块库，支持灵活的环境配置

# hwj-common-lib

微信小程序云开发通用模块库

## 功能特性

- 统一的错误处理
- JWT 认证
- 数据库操作封装
- 缓存管理
- 灵活的环境配置

## 安装

```bash
npm install hwj-common-lib
```

## 使用方法

### 基本用法

```javascript
const { 
  configure,
  ValidationError,
  LoginError,
  errorHandler,
  Database,
  Cache
} = require('hwj-common-lib')

// 配置环境
configure({
  CLOUD_ENV: 'your-cloud-environment-id'
})

// 使用数据库
const userDB = new Database('users')
const users = await userDB.find({ status: 'active' })

// 使用缓存
const cache = new Cache('namespace')
await cache.set('key', 'value', 3600) // 缓存1小时

// 错误处理
try {
  // 业务代码
} catch (error) {
  return errorHandler(error)
}
```

### 配置优先级

环境配置采用以下优先级顺序：

1. 通过 `configure()` 函数提供的配置
2. 环境变量 (`process.env.CLOUD_ENV` 等)
3. 默认配置值

### 在云函数中使用

在微信小程序云函数中使用时，建议在云函数入口处进行配置：

```javascript
const { configure } = require('hwj-common-lib')

// 在云函数入口处配置
configure({
  CLOUD_ENV: 'your-cloud-environment-id'
})

exports.main = async (event, context) => {
  // 您的云函数代码...
}
```

## API 文档

### 配置函数
- configure(config): 配置库的环境和选项
- getCurrentConfig(): 获取当前配置
- initializeCloud(cloudEnv): 初始化云环境

### Database 类
- create(data): 创建记录
- update(id, data): 更新记录
- find(query, options): 查询记录
- count(query): 统计记录数
- delete(id): 删除记录

### Cache 类
- set(key, value, ttl): 设置缓存
- get(key): 获取缓存
- del(key): 删除缓存
- batchDelete(pattern): 批量删除缓存

### 错误处理
- ValidationError: 参数验证错误
- BusinessError: 业务逻辑错误
- LoginError: 登录相关错误
- TokenError: Token相关错误
- DeviceError: 设备相关错误

### 认证相关
- generateToken(payload): 生成JWT token
- verifyToken(token): 验证JWT token
- auth(event): 认证中间件