集群聊天服务器项目【C++】（五）网络模块和业务模块

xiaobai12 32024-09-23 15:38

经过前面介绍相关的库和工具，比如Json、CMake、muduo等，我们可以开始编写本项目的代码了。

1.项目目录创建

一般一个项目由以下结构组成：

  1. bin文件夹存放：可执行程序
  2. build文件夹存放：编译过程中的临时文件
  3. include文件夹存放：头文件
  4. src文件夹存放：源代码
  5. test文件夹存放：测试用例，我们前面几章的测试代码就在这
  6. thirdparty文件夹存放：使用的别人的源代码，本项目使用了Json库
  7. CMakeLists.txt存放：CMake编译的文件夹，在 需要编译的目录都有一个
  8. autobuild.sh存放：编译的自动脚本
  9. README.md存放：项目的介绍，比如环境配置、编译、运行。

接下来介绍每一级目录的CMakeLists.txt文件的内容：

  1. 项目根目录下：
cpp 复制代码 
cmake_minimum_required(VERSION 3.0)
project(chat)

# 配置编译选项
set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} -g)

# 配置最终的可执行文件输出的路径
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)

# 配置头文件的搜索路径
include_directories(${PROJECT_SOURCE_DIR}/include)
include_directories(${PROJECT_SOURCE_DIR}/include/server)
include_directories(${PROJECT_SOURCE_DIR}/thirdparty)

# 加载子目录
add_subdirectory(src)
  1. 在子目录src中：
cpp 复制代码 
add_subdirectory(server)  ##加载子目录
  1. 在server文件夹中：
cpp 复制代码 
#定义了一个SRC_LIST变量，包含了该目录下的所有源文件
aux_source_directory(. SRC_LIST)
 
# 指定生成可执行文件
add_executable(ChatServer ${SRC_LIST})
# 指定可执行文件链接时需要依赖的库文件
target_link_libraries(ChatServer muduo_net muduo_base pthread)

2.网络模块代码ChatServer

这部分代码和muduo库介绍相似：muduo库简单介绍,本次会更详细介绍。

这次把实现放到.cpp中，声明放到.hpp中。

先看整体代码：

在include/server/中编写chatserver.hpp：

cpp 复制代码 
#ifndef CHATSERVER_H
#define CHATSERVER_H

#include <muduo/net/TcpServer.h>
#include <muduo/net/EventLoop.h>
using namespace muduo;
using namespace muduo::net;

// 聊天服务器的主类
class ChatServer
{
public:
    // 初始化聊天服务器对象
    ChatServer(EventLoop *loop,
               const InetAddress &listenAddr,
               const string &nameArg);

    // 启动服务
    void start();

private:
    // 上报链接相关信息的回调函数
    void onConnection(const TcpConnectionPtr &);

    // 上报读写事件相关信息的回调函数
    void onMessage(const TcpConnectionPtr &,
                   Buffer *,
                   Timestamp);

    TcpServer _server; // 组合的muduo库，实现服务器功能的类对象
    EventLoop *_loop;  // 指向事件循环对象的指针
};

#endif

在/src/server/中实现chatserver.cpp

cpp 复制代码 
#include "chatserver.hpp"
#include "json.hpp"
#include "chatservice.hpp"

#include <iostream>
#include <functional>
#include <string>
using namespace std;
using namespace placeholders;
using json = nlohmann::json;

// 初始化聊天服务器对象
ChatServer::ChatServer(EventLoop *loop,
                       const InetAddress &listenAddr,
                       const string &nameArg)
    : _server(loop, listenAddr, nameArg), _loop(loop)
{
    // 注册链接回调
    _server.setConnectionCallback(std::bind(&ChatServer::onConnection, this, _1));

    // 注册消息回调
    _server.setMessageCallback(std::bind(&ChatServer::onMessage, this, _1, _2, _3));

    // 设置线程数量
    _server.setThreadNum(4);
}

// 启动服务
void ChatServer::start()
{
    _server.start();
}

// 上报链接相关信息的回调函数
void ChatServer::onConnection(const TcpConnectionPtr &conn)
{
    // 客户端断开链接
    if (!conn->connected())
    {
        ChatService::instance()->clientCloseException(conn);
        conn->shutdown();  //半关闭状态，只能读
    }
}

// 上报读写事件相关信息的回调函数
void ChatServer::onMessage(const TcpConnectionPtr &conn,
                           Buffer *buffer,
                           Timestamp time)
{
    string buf = buffer->retrieveAllAsString();  //从缓冲区读数据

    // 测试，添加json打印代码
    cout << buf << endl; 

    // 数据的反序列化
    json js = json::parse(buf);
    // 达到的目的：完全解耦网络模块的代码和业务模块的代码
    // 通过js["msgid"] 获取=》业务handler=》conn  js  time
    auto msgHandler = ChatService::instance()->getHandler(js["msgid"].get<int>());//Json的数据类型转换到int型
    // 回调消息绑定好的事件处理器，来执行相应的业务处理
    msgHandler(conn, js, time);
}

接下来介绍为什么这样写：

首先TcpServer这个类，它在muduo/net/TcpServer.h下声明，它用来编写网络服务器，接受客户机链接。

  1. 它只有一个构造函数：
cpp 复制代码 
  TcpServer(EventLoop* loop,
            const InetAddress& listenAddr,
            const string& nameArg,
            Option option = kNoReusePort);
  1. 它有一个start()函数，用来启动服务,开始监听新客户链接。
cpp 复制代码 
void ChatServer::start()
{
    _server.start();
}
  1. 针对不同的事件，TcpServer 保存着不同事件发生时要调用的回调函数，比如接收到链接的回调函数，和接收到消息的回调函数：
cpp 复制代码 
  void setConnectionCallback(const ConnectionCallback& cb)
  { connectionCallback_ = cb; }
  void setMessageCallback(const MessageCallback& cb)
  { messageCallback_ = cb; }
  void setWriteCompleteCallback(const WriteCompleteCallback& cb)
  { writeCompleteCallback_ = cb; }
  1. TcpServer网络模块需要我们设置线程数量，如果大于1，会自动1个主线程监听新客户链接，其余处理已连接的消息处理。
cpp 复制代码 
_server.setThreadNum(4);

因此我们的链接处理函数和消息处理函数如下：

cpp 复制代码 
    // 上报链接相关信息的回调函数
    void onConnection(const TcpConnectionPtr &);
    // 上报读写事件相关信息的回调函数
    void onMessage(const TcpConnectionPtr &,
                   Buffer *,
                   Timestamp);

然后注册消息回调和链接回调：

cpp 复制代码 
    // 注册链接回调
    _server.setConnectionCallback(std::bind(&ChatServer::onConnection, this, _1));
    // 注册消息回调
    _server.setMessageCallback(std::bind(&ChatServer::onMessage, this, _1, _2, _3));

其中ChatServer::onConnection和ChatServer::onMessage就是需要我们写的回调函数，在这实现

cpp 复制代码 
// 上报链接相关信息的回调函数
void ChatServer::onConnection(const TcpConnectionPtr &conn)
{
    // 客户端断开链接
    if (!conn->connected())
    {
        ChatService::instance()->clientCloseException(conn);
        conn->shutdown();
    }
}

// 上报读写事件相关信息的回调函数
void ChatServer::onMessage(const TcpConnectionPtr &conn,
                           Buffer *buffer,
                           Timestamp time)
{
    string buf = buffer->retrieveAllAsString();

    // 测试，添加json打印代码
    cout << buf << endl; 

    // 数据的反序列化
    json js = json::parse(buf);
    // 达到的目的：完全解耦网络模块的代码和业务模块的代码
    // 通过js["msgid"] 获取=》业务handler=》conn  js  time
    auto msgHandler = ChatService::instance()->getHandler(js["msgid"].get<int>());
    // 回调消息绑定好的事件处理器，来执行相应的业务处理
    msgHandler(conn, js, time);
}

这样当 ChatServer 接收到连接相关事件时，会调用我们写的ChatServer::onConnection函数。如果是客户端连接断开的事件，我们会关闭连接。

3.业务模块代码ChatService

对于ChatServer::onMessage实现中，我们不能根据对应的消息就使用对应的处理方法，比如

cpp 复制代码 
if (message == Login) { //登录消息
	LoginHandler();
} else if (message == Register) {  //注册消息
	RegisterHandler();
} else if (...)

这样就相当与网络模块代码中间包含了业务模块代码。我们希望模块解耦，每个模块之间应该是独立的。我们希望实现一个统一的调用，对于任何业务都只用调用一个方法即可，然后这个函数会有着不同的实现。

因此，我们还会创建一个 ChatService 类来专门提供不同的服务 ，ChatService使用function容易保存不同的回调函数，我们使用 Json 解析数据时得到数据类型，然后直接调用对应的函数（这些回调函数最开始已经被注册过了），既不同的数据类型调用不同的回调函数。

在include/chatservice.hpp中编写

cpp 复制代码 
#ifndef CHATSERVICE_H
#define CHATSERVICE_H
 
#include <muduo/net/TcpConnection.h>
#include <unordered_map>//一个消息ID映射一个事件处理 
#include <functional>
using namespace std;
using namespace muduo;
using namespace muduo::net;
 
 
#include "json.hpp"
using json = nlohmann::json;
 
//表示处理消息的事件回调方法类型，事件处理器，派发3个东西 
using MsgHandler = std::function<void(const TcpConnectionPtr &conn, json &js, Timestamp)>;
 
//聊天服务器业务类
class ChatService
{
public:
    //获取单例对象的接口函数
    static ChatService *instance();
    //处理登录业务
    void login(const TcpConnectionPtr &conn, json &js, Timestamp time);
    //处理注册业务
    void reg(const TcpConnectionPtr &conn, json &js, Timestamp time);
 
    //获取消息对应的处理器
    MsgHandler getHandler(int msgid);
private:
    ChatService();//单例 
 
    //存储消息id和其对应的业务处理方法，消息处理器的一个表，写消息id对应的处理操作 
    unordered_map<int, MsgHandler> _msgHandlerMap;
 
};
 
#endif

在include/中定义一个枚举类型，用来回调对应的业务方法。

在include/public.hpp编写头文件:

cpp 复制代码 
#ifndef PUBLIC_H
#define PUBLIC_H

/*
server和client的公共文件
*/
enum EnMsgType
{
    LOGIN_MSG = 1, // 登录消息
    REG_MSG, // 注册消息
};

#endif

在include/server/chatservice.cpp编写：

cpp 复制代码 
#include "chatservice.hpp"
#include "public.hpp"
#include <muduo/base/Logging.h>//muduo的日志 
using namespace std;
using namespace muduo;
 
//获取单例对象的接口函数
ChatService *ChatService::instance()
{
    static ChatService service;
    return &service;
}
 
//构造方法，注册消息以及对应的Handler回调操作
ChatService::ChatService()
{
    //用户基本业务管理相关事件处理回调注册
    _msgHandlerMap.insert({LOGIN_MSG, std::bind(&ChatService::login, this, _1, _2, _3)});
    _msgHandlerMap.insert({REG_MSG, std::bind(&ChatService::reg, this, _1, _2, _3)});
 
}
 
 
//获取消息对应的处理器
MsgHandler ChatService::getHandler(int msgid)
{
    //记录错误日志，msgid没有对应的事件处理回调
    auto it = _msgHandlerMap.find(msgid);
    if (it == _msgHandlerMap.end())//找不到 
    {
        //返回一个默认的处理器，空操作，=按值获取 
        return [=](const TcpConnectionPtr &conn, json &js, Timestamp) {
            LOG_ERROR << "msgid:" << msgid << " can not find handler!";//muduo日志会自动输出endl 
        };
    }
    else//成功的话 
    {
        return _msgHandlerMap[msgid];//返回这个处理器 
    }
}
 
//处理登录业务  id  pwd   pwd
void ChatService::login(const TcpConnectionPtr &conn, json &js, Timestamp time)
{
    LOG_INFO<<"do login service!!!";
}
 
//处理注册业务  name  password
void ChatService::reg(const TcpConnectionPtr &conn, json &js, Timestamp time)
{
	LOG_INFO<<"do reg service!!!";
}

使用单例模式保证只有一个实例化对象，在_msgHandlerMap存放id和对应的业务函数，在构造函数中完成的注册。

4.main函数编写

在src/server/中编写main.cpp

cpp 复制代码 
#include "chatserver.hpp"
 
int main(){
    EventLoop loop;
    InetAddress addr("127.0.0.1",6000);
    ChatServer server(&loop,addr,"ChatServer");
 
    server.start();
    loop.loop();
    return 0;
}

总结

这是本项目的关键一章，网络模块怎么使用回调函数完成新链接和消息的回调，以及怎么解耦网络模块和业务模块等，在后面章节，大部分只是在此基础上增加业务功能，网络模块就不需要改了。

相关推荐
小蜗牛慢慢爬行12 分钟前
有关异步场景的 10 大 Spring Boot 面试问题
java·开发语言·网络·spring boot·后端·spring·面试
秋名山小桃子15 分钟前
Kunlun 2280服务器(ARM)Raid卡磁盘盘符漂移问题解决
运维·服务器
与君共勉1213815 分钟前
Nginx 负载均衡的实现
运维·服务器·nginx·负载均衡
MARIN_shen17 分钟前
Marin说PCB之POC电路layout设计仿真案例---06
网络·单片机·嵌入式硬件·硬件工程·pcb工艺
努力学习的小廉22 分钟前
深入了解Linux —— make和makefile自动化构建工具
linux·服务器·自动化
MZWeiei26 分钟前
Zookeeper基本命令解析
大数据·linux·运维·服务器·zookeeper
小俊俊的博客40 分钟前
海康RGBD相机使用C++和Opencv采集图像记录
c++·opencv·海康·rgbd相机
Arenaschi1 小时前
在Tomcat中部署应用时，如何通过域名访问而不加端口号
运维·服务器
小张认为的测试1 小时前
Linux性能监控命令_nmon 安装与使用以及生成分析Excel图表
linux·服务器·测试工具·自动化·php·excel·压力测试
waicsdn_haha1 小时前
Java/JDK下载、安装及环境配置超详细教程【Windows10、macOS和Linux图文详解】
java·运维·服务器·开发语言·windows·后端·jdk
热门推荐
01〔AI 绘画〕Stable Diffusion 之 解决绘制多人或面部很小的人物时面部崩坏问题 篇02ARM学习（31）编译器对overlay方式的支持03玄机平台应急响应—webshell查杀04DisplayPort AltMode On Type-c协议_Ver2.0(学习笔记)05校验 GPT-4 真实性的三个经典问题：快速区分 GPT-3.5 与 GPT-4，并提供免费测试网站06Docker 夺命连环 15 问076个主流的工业3D管道设计软件08基于大语言模型（LLM）的合成数据生成、策展和评估的综述09(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明10红米手机使用google play