本篇主要是对于该项目的用户管理模块做一个文档说明,前面已经封装好了类的操作,因此本篇开始直接进行使用
本节依旧不算很难,主要体现在各个接口的实现,和之前对于一些API的调用逻辑
服务重写
对于用户管理这个模块来说,主要涉及到的有下面的这几个服务
- 用户名注册
- 用户名登录
- 验证码获取
- 手机号注册
- 手机号登录
- 个人信息获取(单个)
- 个人信息获取(多个)
- 用户头像修改
- 用户昵称修改
- 用户签名修改
- 用户手机修改
因此,本质上需要重写的就是这11个接口
service UserService {
rpc UserRegister(UserRegisterReq) returns (UserRegisterRsp);
rpc UserLogin(UserLoginReq) returns (UserLoginRsp);
rpc GetPhoneVerifyCode(PhoneVerifyCodeReq) returns (PhoneVerifyCodeRsp);
rpc PhoneRegister(PhoneRegisterReq) returns (PhoneRegisterRsp);
rpc PhoneLogin(PhoneLoginReq) returns (PhoneLoginRsp);
rpc GetUserInfo(GetUserInfoReq) returns (GetUserInfoRsp);
rpc GetMultiUserInfo(GetMultiUserInfoReq) returns (GetMultiUserInfoRsp);
rpc SetUserAvatar(SetUserAvatarReq) returns (SetUserAvatarRsp);
rpc SetUserNickname(SetUserNicknameReq) returns (SetUserNicknameRsp);
rpc SetUserDescription(SetUserDescriptionReq) returns (SetUserDescriptionRsp);
rpc SetUserPhoneNumber(SetUserPhoneNumberReq) returns (SetUserPhoneNumberRsp);
}
用户注册
对于用户注册的处理逻辑来说,基本逻辑非常简单,只需要从请求中把昵称和密码取出来,然后判断是否合法、判断昵称是否存在,之后向数据库中新增数据,向elasticsearch中新增数据字段,响应给客户端即可
// 完成用户注册的接口
virtual void UserRegister(::google::protobuf::RpcController* controller,
const ::im::UserRegisterReq* request,
::im::UserRegisterRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到用户注册请求!");
brpc::ClosureGuard rpc_guard(done);
// 定义一个错误处理函数,当出错的时候被调用
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出昵称和密码
std::string nickname = request->nickname();
std::string password = request->password();
// 2. 检查昵称是否合法(只能包含字母,数字,连字符-,下划线_,长度限制 3~15 之间)
bool ret = nickname_check(nickname);
if (ret == false)
{
LOG_ERROR("{} - 用户名长度不合法!", request->request_id());
return err_response(request->request_id(), "用户名长度不合法!");
}
// 3. 检查密码是否合法(只能包含字母,数字,长度限制 6~15 之间)
ret = password_check(password);
if (ret == false)
{
LOG_ERROR("{} - 密码格式不合法!", request->request_id());
return err_response(request->request_id(), "密码格式不合法!");
}
// 4. 根据昵称在数据库进行判断是否昵称已存在
auto user = _mysql_user->select_by_nickname(nickname);
if (user)
{
LOG_ERROR("{} - 用户名被占用- {}!", request->request_id(), nickname);
return err_response(request->request_id(), "用户名被占用!");
}
// 5. 向数据库新增数据
std::string uid = uuid();
user = std::make_shared<User>(uid, nickname, password);
ret = _mysql_user->insert(user);
if (ret == false)
{
LOG_ERROR("{} - Mysql数据库新增数据失败!", request->request_id());
return err_response(request->request_id(), "Mysql数据库新增数据失败!");
}
// 6. 向 ES 服务器中新增用户信息
ret = _es_user->appendData(uid, "", nickname, "", "");
if (ret == false) {
LOG_ERROR("{} - ES搜索引擎新增数据失败!", request->request_id());
return err_response(request->request_id(), "ES搜索引擎新增数据失败!");
}
// 7. 组织响应,进行成功与否的响应即可。
response->set_request_id(request->request_id());
response->set_success(true);
}
用户登录
用户登录的处理逻辑也比较简单,在收到请求之后,提取出对应的字段,然后到数据库中来获取看密码是否一致,之后到Redis中判断用户是否已经登录,如果没有登录,那么就加入信息即可
// 用户登录
virtual void UserLogin(::google::protobuf::RpcController* controller,
const ::im::UserLoginReq* request,
::im::UserLoginRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到用户登录请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出昵称和密码
std::string nickname = request->nickname();
std::string password = request->password();
// 2. 通过昵称获取用户信息,进行密码是否一致的判断
auto user = _mysql_user->select_by_nickname(nickname);
if (!user || password != user->password())
{
LOG_ERROR("{} - 用户名或密码错误 - {}-{}!", request->request_id(), nickname, password);
return err_response(request->request_id(), "用户名或密码错误!");
}
// 3. 根据 redis 中的登录标记信息是否存在判断用户是否已经登录。
bool ret = _redis_status->exists(user->user_id());
if (ret == true)
{
LOG_ERROR("{} - 用户已在其他地方登录 - {}!", request->request_id(), nickname);
return err_response(request->request_id(), "用户已在其他地方登录!");
}
// 4. 构造会话 ID,生成会话键值对,向 redis 中添加会话信息以及登录标记信息
std::string ssid = uuid();
_redis_session->append(ssid, user->user_id());
// 5. 组织响应,返回生成的会话 ID
response->set_request_id(request->request_id());
response->set_login_session_id(ssid);
response->set_success(true);
}
验证码获取
验证码服务获取就需要用到前面的关于验证码的SDK了,对于验证码的SDK服务来说,可以使用提前封装好的的内容,传入一个手机号,一个验证码就可以了,这时候就体现出了提前封装的好处
// 验证码获取服务
virtual void GetPhoneVerifyCode(::google::protobuf::RpcController* controller,
const ::im::PhoneVerifyCodeReq* request,
::im::PhoneVerifyCodeRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到短信验证码获取请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出手机号码
std::string phone = request->phone_number();
// 2. 验证手机号码格式是否正确(必须以 1 开始,第二位 3~9 之间,后边 9 个数字字符)
bool ret = phone_check(phone);
if (ret == false)
{
LOG_ERROR("{} - 手机号码格式错误 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "手机号码格式错误!");
}
// 3. 生成 4 位随机验证码
std::string code_id = uuid();
std::string code = vcode();
// 4. 基于短信平台 SDK 发送验证码
ret = _dms_client->send(phone, code);
if (ret == false)
{
LOG_ERROR("{} - 短信验证码发送失败 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "短信验证码发送失败!");
}
// 5. 构造验证码 ID,添加到 redis 验证码映射键值索引中
_redis_codes->append(code_id, code);
// 6. 组织响应,返回生成的验证码 ID
response->set_request_id(request->request_id());
response->set_success(true);
response->set_verify_code_id(code_id);
LOG_DEBUG("获取短信验证码处理完成!");
}
手机号注册
基本流程是,从请求中提取出手机号和验证码,判断手机号和验证码合法,然后在数据库中查询手机号是否已经被注册过,然后在MySQL和elasticsearch中新增用户信息即可,最后响应
// 手机号注册
virtual void PhoneRegister(::google::protobuf::RpcController* controller,
const ::im::PhoneRegisterReq* request,
::im::PhoneRegisterRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到手机号注册请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出手机号码和验证码,验证码ID
std::string phone = request->phone_number();
std::string code_id = request->verify_code_id();
std::string code = request->verify_code();
// 2. 检查注册手机号码是否合法
bool ret = phone_check(phone);
if (ret == false)
{
LOG_ERROR("{} - 手机号码格式错误 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "手机号码格式错误!");
}
// 3. 从 redis 数据库中进行验证码 ID-验证码一致性匹配
auto vcode = _redis_codes->code(code_id);
if (vcode != code)
{
LOG_ERROR("{} - 验证码错误 - {}-{}!", request->request_id(), code_id, code);
return err_response(request->request_id(), "验证码错误!");
}
// 4. 通过数据库查询判断手机号是否已经注册过
auto user = _mysql_user->select_by_phone(phone);
if (user)
{
LOG_ERROR("{} - 该手机号已注册过用户 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "该手机号已注册过用户!");
}
// 5. 向数据库新增用户信息
std::string uid = uuid();
user = std::make_shared<User>(uid, phone);
ret = _mysql_user->insert(user);
if (ret == false)
{
LOG_ERROR("{} - 向数据库添加用户信息失败 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "向数据库添加用户信息失败!");
}
// 6. 向 ES 服务器中新增用户信息
ret = _es_user->appendData(uid, phone, uid, "", "");
if (ret == false)
{
LOG_ERROR("{} - ES搜索引擎新增数据失败!", request->request_id());
return err_response(request->request_id(), "ES搜索引擎新增数据失败!");
}
// 7. 组织响应,进行成功与否的响应即可。
response->set_request_id(request->request_id());
response->set_success(true);
}
手机号登录
基本逻辑是,提取信息,检查手机号在数据库中是否存在,然后从Redis中查看验证码,然后查看是否已经登录,然后分配一个会话ID,响应
// 手机号登录
virtual void PhoneLogin(::google::protobuf::RpcController* controller,
const ::im::PhoneLoginReq* request,
::im::PhoneLoginRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到手机号登录请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出手机号码和验证码 ID,以及验证码。
std::string phone = request->phone_number();
std::string code_id = request->verify_code_id();
std::string code = request->verify_code();
// 2. 检查注册手机号码是否合法
bool ret = phone_check(phone);
if (ret == false)
{
LOG_ERROR("{} - 手机号码格式错误 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "手机号码格式错误!");
}
// 3. 根据手机号从数据数据进行用户信息查询,判断用用户是否存在
auto user = _mysql_user->select_by_phone(phone);
if (!user)
{
LOG_ERROR("{} - 该手机号未注册用户 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "该手机号未注册用户!");
}
// 4. 从 redis 数据库中进行验证码 ID-验证码一致性匹配
auto vcode = _redis_codes->code(code_id);
if (vcode != code)
{
LOG_ERROR("{} - 验证码错误 - {}-{}!", request->request_id(), code_id, code);
return err_response(request->request_id(), "验证码错误!");
}
_redis_codes->remove(code_id);
// 5. 根据 redis 中的登录标记信息是否存在判断用户是否已经登录。
ret = _redis_status->exists(user->user_id());
if (ret == true)
{
LOG_ERROR("{} - 用户已在其他地方登录 - {}!", request->request_id(), phone);
return err_response(request->request_id(), "用户已在其他地方登录!");
}
// 6. 构造会话 ID,生成会话键值对,向 redis 中添加会话信息以及登录标记信息
std::string ssid = uuid();
_redis_session->append(ssid, user->user_id());
// 7. 组织响应,返回生成的会话 ID
response->set_request_id(request->request_id());
response->set_login_session_id(ssid);
response->set_success(true);
}
获取用户信息
这个调用逻辑相比较前面而言复杂一点,涉及到了从文件模块进行下载文件的过程,基本的流程是,根据要查询的这个ID信息,然后去到MySQL数据库中匹配查找,将查找到的结果填充到信息字段当中,之后再根据对应的ID信息去到文件存储模块中下载对应的头像信息的文件,最后整体进行返回
// 获取用户信息
virtual void GetUserInfo(::google::protobuf::RpcController* controller,
const ::im::GetUserInfoReq* request,
::im::GetUserInfoRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到获取单个用户信息请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出用户 ID
std::string uid = request->user_id();
// 2. 通过用户 ID,从数据库中查询用户信息
auto user = _mysql_user->select_by_id(uid);
if (!user)
{
LOG_ERROR("{} - 未找到用户信息 - {}!", request->request_id(), uid);
return err_response(request->request_id(), "未找到用户信息!");
}
// 3. 根据用户信息中的头像 ID,从文件服务器获取头像文件数据,组织完整用户信息
UserInfo *user_info = response->mutable_user_info();
user_info->set_user_id(user->user_id());
user_info->set_nickname(user->nickname());
user_info->set_description(user->description());
user_info->set_phone(user->phone());
// 如果用户有头像信息
if (!user->avatar_id().empty())
{
// 从信道管理对象中,获取到连接了文件管理子服务的channel
auto channel = _mm_channels->choose(_file_service_name);
if (!channel)
{
LOG_ERROR("{} - 未找到文件管理子服务节点 - {} - {}!",
request->request_id(), _file_service_name, uid);
return err_response(request->request_id(), "未找到文件管理子服务节点!");
}
// 进行文件子服务的rpc请求,进行头像文件下载
im::FileService_Stub stub(channel.get());
im::GetSingleFileReq req;
im::GetSingleFileRsp rsp;
req.set_request_id(request->request_id());
req.set_file_id(user->avatar_id());
brpc::Controller cntl;
stub.GetSingleFile(&cntl, &req, &rsp, nullptr);
if (cntl.Failed() == true || rsp.success() == false)
{
LOG_ERROR("{} - 文件子服务调用失败:{}!", request->request_id(), cntl.ErrorText());
return err_response(request->request_id(), "文件子服务调用失败!");
}
user_info->set_avatar(rsp.file_data().file_content());
}
// 4. 组织响应,返回用户信息
response->set_request_id(request->request_id());
response->set_success(true);
}
获取多个用户的信息
这个其实和前面的情况非常类似,只不过区别是需要使用一个map来进行管理映射,这点在proto文件中就可以提前进行定义
message GetMultiUserInfoRsp {
string request_id = 1;
bool success = 2;
string errmsg = 3;
map<string, UserInfo> users_info = 4;
}
// 获取多个用户的信息
virtual void GetMultiUserInfo(::google::protobuf::RpcController* controller,
const ::im::GetMultiUserInfoReq* request,
::im::GetMultiUserInfoRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到批量用户信息获取请求!");
brpc::ClosureGuard rpc_guard(done);
// 1. 定义错误回调
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 2. 从请求中取出用户ID --- 列表
std::vector<std::string> uid_lists;
for (int i = 0; i < request->users_id_size(); i++)
{
uid_lists.push_back(request->users_id(i));
}
// 3. 从数据库进行批量用户信息查询
auto users = _mysql_user->select_multi_users(uid_lists);
if (users.size() != request->users_id_size())
{
LOG_ERROR("{} - 从数据库查找的用户信息数量不一致 {}-{}!",
request->request_id(), request->users_id_size(), users.size());
return err_response(request->request_id(), "从数据库查找的用户信息数量不一致!");
}
// 4. 批量从文件管理子服务进行文件下载
auto channel = _mm_channels->choose(_file_service_name);
if (!channel)
{
LOG_ERROR("{} - 未找到文件管理子服务节点 - {}!", request->request_id(), _file_service_name);
return err_response(request->request_id(), "未找到文件管理子服务节点!");
}
im::FileService_Stub stub(channel.get());
im::GetMultiFileReq req;
im::GetMultiFileRsp rsp;
req.set_request_id(request->request_id());
for (auto &user : users)
{
if (user.avatar_id().empty())
continue;
req.add_file_id_list(user.avatar_id());
}
brpc::Controller cntl;
stub.GetMultiFile(&cntl, &req, &rsp, nullptr);
if (cntl.Failed() == true || rsp.success() == false)
{
LOG_ERROR("{} - 文件子服务调用失败:{} - {}!", request->request_id(),
_file_service_name, cntl.ErrorText());
return err_response(request->request_id(), "文件子服务调用失败!");
}
// 5. 组织响应()
for (auto &user : users)
{
auto user_map = response->mutable_users_info();//本次请求要响应的用户信息map
auto file_map = rsp.mutable_file_data(); //这是批量文件请求响应中的map
UserInfo user_info;
user_info.set_user_id(user.user_id());
user_info.set_nickname(user.nickname());
user_info.set_description(user.description());
user_info.set_phone(user.phone());
user_info.set_avatar((*file_map)[user.avatar_id()].file_content());
(*user_map)[user_info.user_id()] = user_info;
}
response->set_request_id(request->request_id());
response->set_success(true);
}
设置用户头像
这个调用逻辑也比较简单,和用户注册比较像
添加人头像-提取信息-判断-添加数据库-添加elasticsearch-响应
// 设置用户头像
virtual void SetUserAvatar(::google::protobuf::RpcController* controller,
const ::im::SetUserAvatarReq* request,
::im::SetUserAvatarRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到用户头像设置请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出用户 ID 与头像数据
std::string uid = request->user_id();
// 2. 从数据库通过用户 ID 进行用户信息查询,判断用户是否存在
auto user = _mysql_user->select_by_id(uid);
if (!user)
{
LOG_ERROR("{} - 未找到用户信息 - {}!", request->request_id(), uid);
return err_response(request->request_id(), "未找到用户信息!");
}
// 3. 上传头像文件到文件子服务,
auto channel = _mm_channels->choose(_file_service_name);
if (!channel)
{
LOG_ERROR("{} - 未找到文件管理子服务节点 - {}!", request->request_id(), _file_service_name);
return err_response(request->request_id(), "未找到文件管理子服务节点!");
}
im::FileService_Stub stub(channel.get());
im::PutSingleFileReq req;
im::PutSingleFileRsp rsp;
req.set_request_id(request->request_id());
req.mutable_file_data()->set_file_name("");
req.mutable_file_data()->set_file_size(request->avatar().size());
req.mutable_file_data()->set_file_content(request->avatar());
brpc::Controller cntl;
stub.PutSingleFile(&cntl, &req, &rsp, nullptr);
if (cntl.Failed() == true || rsp.success() == false)
{
LOG_ERROR("{} - 文件子服务调用失败:{}!", request->request_id(), cntl.ErrorText());
return err_response(request->request_id(), "文件子服务调用失败!");
}
std::string avatar_id = rsp.file_info().file_id();
// 4. 将返回的头像文件 ID 更新到数据库中
user->avatar_id(avatar_id);
bool ret = _mysql_user->update(user);
if (ret == false)
{
LOG_ERROR("{} - 更新数据库用户头像ID失败 :{}!", request->request_id(), avatar_id);
return err_response(request->request_id(), "更新数据库用户头像ID失败!");
}
// 5. 更新 ES 服务器中用户信息
ret = _es_user->appendData(user->user_id(), user->phone(),
user->nickname(), user->description(), user->avatar_id());
if (ret == false)
{
LOG_ERROR("{} - 更新搜索引擎用户头像ID失败 :{}!", request->request_id(), avatar_id);
return err_response(request->request_id(), "更新搜索引擎用户头像ID失败!");
}
// 6. 组织响应,返回更新成功与否
response->set_request_id(request->request_id());
response->set_success(true);
}
添加用户昵称
这个调用逻辑也比较简单,和用户注册比较像
添加用户昵称-提取信息-判断-添加数据库-添加elasticsearch-响应
// 设置用户昵称
virtual void SetUserNickname(::google::protobuf::RpcController* controller,
const ::im::SetUserNicknameReq* request,
::im::SetUserNicknameRsp* response,
::google::protobuf::Closure* done)
{
LOG_DEBUG("收到用户昵称设置请求!");
brpc::ClosureGuard rpc_guard(done);
auto err_response = [this, response](const std::string &rid,
const std::string &errmsg) -> void {
response->set_request_id(rid);
response->set_success(false);
response->set_errmsg(errmsg);
return;
};
// 1. 从请求中取出用户 ID 与新的昵称
std::string uid = request->user_id();
std::string new_nickname = request->nickname();
// 2. 判断昵称格式是否正确
bool ret = nickname_check(new_nickname);
if (ret == false)
{
LOG_ERROR("{} - 用户名长度不合法!", request->request_id());
return err_response(request->request_id(), "用户名长度不合法!");
}
// 3. 从数据库通过用户 ID 进行用户信息查询,判断用户是否存在
auto user = _mysql_user->select_by_id(uid);
if (!user)
{
LOG_ERROR("{} - 未找到用户信息 - {}!", request->request_id(), uid);
return err_response(request->request_id(), "未找到用户信息!");
}
// 4. 将新的昵称更新到数据库中
user->nickname(new_nickname);
ret = _mysql_user->update(user);
if (ret == false)
{
LOG_ERROR("{} - 更新数据库用户昵称失败 :{}!", request->request_id(), new_nickname);
return err_response(request->request_id(), "更新数据库用户昵称失败!");
}
// 5. 更新 ES 服务器中用户信息
ret = _es_user->appendData(user->user_id(), user->phone(),
user->nickname(), user->description(), user->avatar_id());
if (ret == false)
{
LOG_ERROR("{} - 更新搜索引擎用户昵称失败 :{}!", request->request_id(), new_nickname);
return err_response(request->request_id(), "更新搜索引擎用户昵称失败!");
}
// 6. 组织响应,返回更新成功与否
response->set_request_id(request->request_id());
response->set_success(true);
}
设置用户签名
这个和前面基本一样,这里就不写了
设置手机号
这个和前面基本一样,这里就不写了
服务搭建
这里和前面的思想一样,都是用一个类来控制服务的搭建,考虑到篇幅原因,这里就不写代码了,大概就是下面两个类
class UserServer;
class UserServerBuilder;