引言
分销员管理模块是分销系统的重要组成部分，通过有效的人员管理来推动商品的销售。本文档提供关于“分销员招募与管理”模块的详细技术信息，旨在指导开发，部署和维护工作，确保系统的透明、准确和高效运行。
2.技术概述
技术背景
分销员管理模块涉及到人员信息的管理，申请和审核，以及分销员的激励机制。模块需要与客户管理模块有效的集成。
相关概念
- 分销员：在系统中推广和销售商品的人员。
- 申请：客户成为分销员的渠道之一。
- 审核：确保申请人符合平台的标准。
- 客户：在该平台注册购买过商品或有购买欲望的人员。
系统架构
模块由一下主要组件组成：
该组件图展示了系统的主要模块（如用户接口，分销员管理模块和数据库）及其之间的关系。
3.开发指南
代码编写规范
- 代码格式：
- 缩进：使用一致的缩进风格，通常是4个空格。
- 行长：每行代码不应超过100个字符。
- 括号：使用一致的括号风格，通常是将“{”放在行尾，“=”“&&”“||”“==”等逻辑运算符两边都要留空格。
- 命名约定：
- 类名：采用驼峰命名法，每个单词的首字母大写，如“BrokerageMember”。
- 方法名：采用驼峰命名法，第一个单词小写，其余单词的首字母大写，如“addBlackList”。
- 变量名：采用驼峰命名法，第一个单词小写，其余单词首字母大写，如：“brokerageMember”。
- 常量名：全大写，单词之间用下滑线。如“MAX_RETRY_ATTEMPTS”。
（不能用拼音，不能用中文，尽量命名时见名知义）
- 注释：
- 文档注释：使用“ /** ... */ ”风格为类和公共方法编写文档注释。
- 当行注释：使用“ // ”进行简短的解释。
- 多行注释：使用 /* ... */ 进行较长的解释。
- 接口文档注释：swagger下的封装注解。
（接口方法必须写上注释并用文档注释的格式）
- 代码结构：
- 类定义：类应该包含清晰的成员变量和方法。
- 方法定义：方法应该尽量简洁，每个方法只完成一个功能。
- 访问修饰符：尽量使用最小的权限修饰符，如“private”或“protected”，只有在必要的时候使用“public”。
- 异常处理：
- 捕获和处理异常：应适当捕获异常并处理，而不是简单的忽略或打印堆栈跟踪。
- 自定义异常:在需要时创建自定义异常类。
- 代码重用：
- 避免代码重复：使用方法，继承和组合来避免代码的重复。
- 使用标准库：尽量可能使用Java标准库而不是自己是西安常见功能。
- 性能和效率：
- 避免不必要的对象创建：在循环或高频调用的地方避免不必要的对象创建。
- 优化数据结构：选择适当的数据结构来提高性能
开发工具和环境
- 开发语言：Java
- 开发环境：Intellij IDEA
- 关系型数据库：mysql
- 非关系型数据库：redis和elasticsearch
- 开发框架：springboot
功能流程
在处理分销员申请时，系统会经历以下流程：
时序图展示了用户提交
申请，系统保存申请到数据库，以及系统和数据库之间的交互。
- 接口文档
- 接口文档使用 Swagger
为了详细描述和测试 API 接口，本系统使用 Swagger 生成接口文档。Swagger 提供了互动式的文档和自动生成的 API 文档，便于开发人员和其他利益相关者查看和测试接口。
Swagger 文档访问链接: http://localhost:8093/doc.html
在 Swagger 文档中，你可以找到所有 API 的详细描述、请求和响应示例、数据格式和错误代码等信息。
- 数据库模型
| 分销员列表 |
||||
| 字段名 |
字段类型 |
字段内存 |
是否可为空 |
注释 |
| id |
int |
0 |
0 |
ID |
| phone_number |
varchar |
20 |
0 |
手机号 |
| nickname |
varchar |
100 |
0 |
昵称 |
| level |
tinyint |
1 |
1 |
等级（0-不合法，1-初级，2-中级，3-高级） |
| inviter_phone_number |
varchar |
20 |
1 |
邀请方手机号 |
| is_activated |
tinyint |
1 |
1 |
是否激活（0-未激活，1-已激活） |
| activated_time |
datetime |
0 |
1 |
激活时间 |
| gmt_create |
datetime |
0 |
0 |
创建时间 |
| gmt_modified |
datetime |
0 |
0 |
更新时间 |
| 招募设置表 |
||||
| 字段名 |
字段类型 |
字段内存 |
是否可为空 |
注释 |
| id |
INT |
0 |
0 |
ID |
| is_recruitment_enabled |
TINYINT(1) |
1 |
1 |
是否开启招募计划 （0-关闭，1-开启） |
| has_conditions |
TINYINT(1) |
1 |
1 |
是否有条件 （0-无条件，1-有条件） |
| is_self_purchase_amount_required |
TINYINT(1) |
1 |
1 |
是否选择自购金额 （0-不需要，1-需要） |
| self_purchase_amount |
DECIMAL (10, 2) |
8 |
1 |
自购金额 |
| is_transaction_count_required |
TINYINT(1) |
1 |
1 |
是否选择消费笔数 （0-不需要，1-需要） |
| transaction_count |
INT |
0 |
1 |
笔数 |
| is_specific_product_required |
TINYINT(1) |
1 |
1 |
是否需要购买指定商品 （0-不需要，1-需要） |
| specific_product_id |
INT |
0 |
1 |
指定商品id |
| is_manual_application |
TINYINT(1) |
1 |
1 |
是否手动申请 （0-自动申请，1-手动申请） |
| is_application_info_required |
TINYINT(1) |
1 |
1 |
是否需要填写申请信息 （0-不需要，1-需要） |
| is_review_required |
TINYINT(1) |
1 |
1 |
是否审核 （0-无需审核，1-人工审核） |
| poster_image_url |
VARCHAR(255) |
255 |
1 |
海报图片URL |
| 申请信息表 |
||||
| 字段名 |
字段类型 |
字段 内存 |
是否可为空 |
注释 |
| id |
INT |
0 |
0 |
ID |
| recruitment_settings_id |
INT |
0 |
0 |
招募设置表ID |
| condition_name |
VARCHAR(100) |
100 |
0 |
条件名称 |
| condition_type |
TINYINT(1) |
1 |
1 |
条件类型（0-不合法，1-自购金额，2-消费笔数，3-指定商品，4-其他条件） |
| is_enabled |
TINYINT(1) |
1 |
1 |
是否启用（0-禁用，1-启用） |
| is_deleted |
TINYINT(1) |
1 |
1 |
是否删除（0-未删除，1-已删除） |
| 升级设置表 |
||||
| 字段名 |
字段类型 |
字段内存 |
是否可为空 |
注释 |
| id |
INT |
0 |
0 |
ID |
| specific_product_id |
INT |
0 |
1 |
指定商品id |
| level |
TINYINT(1) |
1 |
1 |
等级 |
| condition_name |
VARCHAR(100) |
100 |
0 |
条件名称 |
| condition_type |
TINYINT(1) |
1 |
1 |
条件类型（0-不合法，1-自购金额，2-消费笔数，3-指定商品，4-其他条件） |
| is_enabled |
TINYINT(1) |
1 |
1 |
是否启用（0-禁用，1-启用） |
| is_deleted |
TINYINT(1) |
1 |
1 |
是否删除（0-未删除，1-已删除） |
- 代码处理
- 错误码：
- 400 Bad Request: 请求参数不正确。
- 404 Not Found: 请求的资源不存在。
- 500 Internal Server Error: 系统内部错误。
- 附录
- 参考资料
- 代码编写规范：《阿里巴巴开发手册》