# streamlineCode

**Repository Path**: Ltc25/streamlineCode-on-express

## Basic Information

- **Project Name**: streamlineCode
- **Description**: streamline-code-by-ikun2274 是一个基于 Express 的低代码路由构建工具，用于快速构建数据库操作、分页、认证等路由。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-03
- **Last Updated**: 2026-04-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目介绍 streamline-code-by-ikun2274

### 基本介绍
streamline-code-by-ikun2274 是一个基于 Express 的低代码路由构建工具，用于快速构建数据库操作、分页、认证等路由。

### 版本信息
- 当前版本：0.14.00
- 最后更新：2026-04-06

## 安装
```bash
npm install streamline-code-by-ikun2274
```

## 核心功能
- 快速构建 CRUD 路由
- 内置身份验证中间件
- 分页和数据过滤
- 基于 db.fields 的数据验证
- 统一响应格式
- 灵活的中间件配置

## 快速开始

### 1. 配置数据库
```javascript
import { setDbConfig } from 'streamline-code-by-ikun2274';

// 设置数据库配置
setDbConfig({
    host: 'your_db_host',
    user: 'your_db_user', 
    password: 'your_db_password', 
    database: 'your_db_name'
});
```

### 2. 启动服务器
```javascript
import { startServer } from 'streamline-code-by-ikun2274';

// 启动服务器
startServer({
    port: 8008, // 端口配置
    allowedOrigins: [ 
        // 允许的域名
        'http://127.0.0.1:5501',
    ]
});
```

### 3. 构建路由
```javascript
import { StreamlineRouter } from 'streamline-code-by-ikun2274';

// 低代码路由构建函数
StreamlineRouter({
    // 路由路径
    url: '/api/productlist',
    // 路由方法
    method: 'get',

    // 可选：内置中间件配置
    BuiltinMid: {
        // 可选的中间件参数
        Parameter: ['pagination:12', 'unifiedResponse', 'shuffle']
    },
    
    // 数据库和其他操作配置
    PlusHandler: {
        // 数据库操作
        db: {
            // 数据库表名
            table: 'productdb',
            // 数据表操作
            operation: 'select',
            // 主键字段（可选）
            primaryKey: 'id',
            // 查询字段（可选）
            fields: '*',
            // 分类字段（可选）
            categoryField: 'category_id'
        },
        
        // 其他操作
        other: {
            // 成功消息（可选）
            successMessage: '操作成功',
            // 错误消息（可选）
            errorMessage: '操作失败',
            // 自定义逻辑（可选）
            customLogic: null
        }
    }
});
```

## 高级功能

### 数据验证
基于 `db.fields` 的验证中间件，支持多种验证规则：

```javascript
StreamlineRouter({
    url: '/api/register',
    method: 'post',
    PlusHandler: {
        db: {
            table: 'users',
            operation: 'create',
            fields: 'username,password,email',
            // 验证规则
            validationRules: {
                username: [
                    'required',
                    { rule: 'minLength', value: 3, message: '用户名长度不能小于3位' },
                    { rule: 'maxLength', value: 20, message: '用户名长度不能超过20位' }
                ],
                password: [
                    'required',
                    { rule: 'minLength', value: 6, message: '密码长度不能小于6位' },
                    { rule: 'pattern', value: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).+$/, message: '密码必须包含大小写字母和数字' }
                ],
                email: [
                    'required',
                    'email'
                ]
            }
        },
        other: {
            successMessage: '注册成功',
            errorMessage: '注册失败'
        }
    }
});
```

### 身份验证
内置的身份验证中间件：

```javascript
// 登录接口
StreamlineRouter({
    url: '/api/login',
    method: 'post',
    BuiltinMid: {
        Parameter: [{
            "login": {
                "successMessage": "登录成功",
                "errorMessage": "账号或密码错误"
            }
        }]
    },
    PlusHandler: {
        db: {
            table: 'users',
            operation: 'select'
        },
        other: {
            successMessage: '登录成功',
            errorMessage: '登录失败',
            responseData: (req, res, result) => ({
                token: req.token,
                user: req.user
            })
        }
    }
});

// 受保护的接口
StreamlineRouter({
    url: '/api/protected/users',
    method: 'get',
    BuiltinMid: {
        Parameter: [
            'requireAuth', // 验证token
            'pagination:10'
        ]
    },
    PlusHandler: {
        db: {
            table: 'users',
            operation: 'select'
        },
        other: {
            successMessage: '获取受保护用户列表成功'
        }
    }
});
```

## 内置中间件
- `requireAuth`：验证用户身份
- `login`：登录中间件集合
- `register`：注册中间件集合
- `pagination`：分页中间件
- `categoryFilter`：分类筛选中间件
- `shuffle`：打乱数据中间件
- `unifiedResponse`：统一响应中间件

## 开发日志
详细的开发历程和版本更新记录，请查看 [开发日志](Develop-log.md)。


## NPM 地址
[https://www.npmjs.com/package/streamline-code-by-ikun2274](https://www.npmjs.com/package/streamline-code-by-ikun2274)