# 用户插件

**Repository Path**: xbcode-plugin/xbUser

## Basic Information

- **Project Name**: 用户插件
- **Description**: No description available
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-18
- **Last Updated**: 2026-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 用户系统

#### 介绍
用户系统（xbUser）是积木云 xbCode 框架下的 **用户通用中心插件**，提供用户注册、登录认证、密码找回、资料维护、余额与积分账户等通用能力，可在多业务应用中复用。

#### 插件信息
- 插件标识：xbUser
- 插件名称：用户通用
- 功能描述：余额、积分、登录、注册、找回密码的用户通用插件功能
- 当前版本：1.0.0
- 作者：积木云
- 官网：`http://www.xbcode.net`
- 文档：`http://doc.xbcode.net`
- Composer 依赖：`zoujingli/wechat-developer`（命名空间：`WeMini\\Qrcode`）

#### 功能特性
1. 认证与账户
   - 支持账号密码登录
   - 支持短信验证码登录（依赖 xbSms 短信插件）
   - 支持账号注册，可通过配置开启/关闭注册功能
   - 支持登录密码修改、密码找回功能
   - 支持多终端平台来源标记（如 Web、小程序等）

2. 用户资料
   - 提供获取用户信息接口（脱敏返回，自动移除密码等敏感字段）
   - 支持修改昵称、头像等基础资料
   - 支持通过用户名获取用户 ID 等基础能力

3. 账户资产
   - 用户余额充值与消费记录管理（UserRecharge / UserBill 等）
   - 用户积分增减与积分流水记录管理（UserIntegral 等）
   - 通过 `Webman\\Event\\Event` 事件机制（如 `xbUser.User.add`、`xbUser.User.edit` 等）扩展账单和业务处理

4. 管理后台
   - 基于 xbCode 渲染器的用户管理后台
   - 提供用户列表、搜索（账号/昵称）、添加、编辑、删除、禁用等操作
   - 使用动态表格与表单（`Builder::crud` / `Builder::form`）快速构建管理界面

5. 技术实现
   - 基于 Webman + xbCode 插件化架构
   - 使用 ThinkPHP ORM（think-orm3）操作用户、充值、积分等数据表
   - 通过事件机制 `Webman\\Event\\Event` 解耦业务逻辑
   - 使用 `plugin\\xbCode\\utils\\TokenUtil`、`PasswdUtil` 处理登录状态与密码加密

#### 软件架构
- 运行环境：PHP 8.1 + Webman + MySQL 5.7+ + Redis
- 核心命名空间：`plugin\\xbUser`
- 主要目录结构：
  - `api/`：业务接口类（`UserApi`、`LoginApi`、`RechargeApi` 等）
  - `app/api/controller/`：对外 API 控制器（如用户注册、登录、资料接口）
  - `app/admin/controller/`：后台用户管理控制器（用户列表、增删改查等）
  - `app/user/controller/`：用户侧登录、注册、找回密码、工作台等页面控制器
  - `config/`：用户相关配置（注册开关、登录方式、平台来源等）
  - `enum/`：枚举定义（平台来源、支付方式等）
  - `data/`、`install.sql`：初始化数据与数据表结构
  - `public/`：对外静态资源与预览文件

#### 安装教程
1. 在 xbCode 后台 **插件市场** 中搜索 “用户系统” 或 “用户通用（xbUser）”，在线安装插件。
2. 安装完成后，根据提示执行 `install.sql`，初始化用户、余额、积分等相关数据表。
3. 在后台 **插件管理** 中启用 xbUser 插件。
4. 根据业务需求，在菜单或路由中挂载用户登录、注册、工作台等页面入口。

#### 使用说明
1. 接口调用
   - 使用 `plugin\\xbUser\\api\\LoginApi::make()` 调用登录、注册、找回密码相关接口。
   - 使用 `plugin\\xbUser\\api\\UserApi::make()` 获取用户信息、修改资料、修改登录密码等。
   - 通过事件监听 `xbUser.User.add`、`xbUser.User.edit`、`xbUser.User.delete` 等实现业务扩展。

2. 前端集成
   - 借助 xbCode 渲染器自动生成登录、注册、找回密码、工作台等页面，无需额外前端工程。
   - 在业务系统中引入用户登录组件和工作台入口，即可复用统一的用户中心能力。

3. 注意事项
   - 如需使用短信验证码登录，请先安装并正确配置 xbSms 相关短信插件。
   - 如需使用邮件找回密码，请先安装并配置 xbEmail 邮件插件。
   - 建议在生产环境中启用 HTTPS，并根据业务需求配置密码强度、登录安全策略与频率限制。