boost::asio 通訊伺服器實踐

1.開發環境搭建

1.1.Asio準備

萬事開頭難。對於一個C++的陌生者，編譯一個開源的程式碼並不是一件輕鬆愉快的事情。為使大家在審閱和檢測本程式碼可使用性時沒有必要花費太多時間和精力去編譯Boost::Asio庫，在此把我在編譯boost庫時不愉快的經歷記錄下來，供參考。使用Asio有兩種方式，一種是直接使用Asio庫，到網站：

https://sourceforge.net/projects/asio/files/asio/1.11.0%20%28Development%29/可以下載單獨的Asio庫，目前最新版本為1.11。另一種是使用boost.asio庫，該庫依賴於Boost.System庫，因此需要把下載後的boost原始碼編譯生成相應的庫才能使用。Boost下載地址http://www.boost.org/，目前最新版本為1.61.0. 我下載的版本為1.61.0版本。下載後解壓到E：\boost1610目錄下.

1.2.Qt準備

到Qt官網上下載Qt。我電腦環境是聯想TIANYI 100,4G記憶體，安裝的windwos10筆記本開發，因此下載的是windows版本的Qt5.7版本，安裝比較簡單，按照提示實行“下一步”就可以。

1.3.編譯boost

編譯boost比較麻煩一點，使用Qt自帶的mingw編譯boost步驟如下：

1. 配置mingw的系統環境變數PATH。我把QT安裝在C盤下，path值配置為：C:\Qt\Qt5.6.1\Tools\mingw492_32\bin。配置後再命令列中輸入gcc -v 如果配置成功，則顯示為：(配置完後，我試著在命令列中輸入gcc -v，居然提示gcc不是內部命令。然後把電腦重起，再輸入gcc -v,這次顯示成功)。

2. 下載boost後，解壓到任意目錄下我的解壓目錄為E：\boost1610;

3. 開啟cmd.exe,切換到E:\boost1610目錄下，在命令列中實行bootstrap.bat gcc 生成b2.exe和bjam.exe。Bootstrap.bat 是在Windows下生成自己的bjam.exe 和b2.exe 的指令碼。 在Linux下是bootstrap.sh.  Bootstrap.bat gcc命令實行完成後，會在QT解壓的目錄下生成bjam.exe 和b2.exe這兩個檔案.

   

4. 實行b2.exe開始編譯。這個命令會生成一個bin.v2的資料夾，為下一步通過bjam命令提供連結。

5. 在命令列視窗下實行bjam "toolset=gcc" install編譯boost原始碼。表示將編譯結果預設儲存到C：\boost目錄下或者指定目錄 bjam.exe “-sTools=mingw” --prefix=d:\boost install 或者 Bjam.exe --prefix=d:\boost toolset=gcc install 來編譯boost。編譯完成後會看到D：\boost資料夾下面有兩個子目錄 include 和lib。 實行這個命令過程非常耗時，慢慢等待。

1.4.使用boost庫

方法一：

1、選擇將這兩個目錄拷貝到mingw目錄下的include和lib目錄中，或者將這兩個目錄的路徑新增到系統路徑中。

2、由於在windows下系統預設的命名方式為libboost-iostreams-mgw44-mt-1-61-0.a 可以改為libboost-iostreams.a.  Mt 表示多執行緒，預設。

方法二：

建立Qt專案的時候，都會生成一個XXX.pro的檔案，在該檔案下增加如下程式碼：

#DEFINES+=BOOST_THREAD_USE_LIB

INCLUDEPATH+=E:\Boost\include\boost-1_61

#DEPENDPATH+=E:\Boost\include\boost-1_61

LIBS+=E:\Boost\lib\libboost_system-mgw49-mt-1_61.a

LIBS+=-lpthreadlibwsock32libws2_32

其中最後一行

LIBS+=-lpthreadlibwsock32libws2_32表示要用到windows的完成埠模型下的winsocket庫。

建議使用方法二。

到此，開發環境基本搭建完成。下面開始Boost.Asio設計開發伺服器軟體。

2.Asio通訊伺服器設計

2.1.設計指標

1. 跨平臺，一套程式碼在不修改原始碼基礎上可運行於windows和Linux系統；

2. 運行於Linux系統上時採用EPOLL模型，運行於Windows上時採用完成埠模型（IOCP），且併發連線量儘可能接近作業系統IO模型提供的理論併發量；

3. 能接入任何通過TCP方式連線的客戶端，不受任何具體協議資料包的限制；

4. 客戶端傳送資料的時候，要求伺服器應答時，伺服器應答客戶端時間應儘可能小，最低要求小於100毫秒。

5. 有效管理伺服器與客戶端連線的生命週期

6. 基礎通訊與業務邏輯解耦。

2.2.概要設計

由於跨平臺要求，目前C++適合跨平臺的第三方庫有libevent、asio庫等，我們決定採用asio庫實現。服務程式由通訊服務類、連線類、連線管理類、業務介面模板類等四大類組成。為適應不同的客戶端接入，服務程式不解析任何資料包，只接受客戶端連線和接收客戶端傳送過來的資料。客戶端連線成功後，呼叫聯結器管理物件儲存連線，同時向作業系統投遞非同步讀事件，當客戶端傳送的資料到達伺服器，呼叫聯結器中的讀事件讀取資料，通過業務介面將資料傳遞到業務介面，資料的處理由業務介面進一步處理。客戶端需要伺服器應答的，由業務介面根據客戶端與伺服器端通訊協議格式構造應答資料包後，由聯結器轉發到客戶端。

通訊服務類（TTcpServer）:提供基礎的埠監聽監聽，不處理任何業務邏輯，以達到通訊服務類通用的目的。對使用者暴露介面有：

1. SetIpAddress設定監聽的IP地址和埠。

2. SetRecycleSoketTime設定回收掉線的Socket時間間隔。

3. Start啟動方法。啟動方法允許使用者使用單執行緒執行和多執行緒執行，也可以在啟動的同時註冊自己的業務物件。執行緒數量由通訊服務類由執行服務的物理機CPU核心數決定，執行緒數量最大為CPU*2-1.不允許使用者自行開闢執行緒。

4. RegisterBussiness註冊業務物件方法。通過RegisterBussiness方法註冊使用者通過實現業務介面類完成自己的業務邏輯。

   聯結器類（TConnector）：聯結器類是通訊服務程式的核心，客戶端與服務端連線成功後，會產生一個連線會話通道，該通道我們稱為聯結器，客戶通過聯結器傳送資料到服務端，服務端通過聯結器傳送資料到客戶端。每個聯結器有一個唯一識別符號ConnectorId，通過客戶端唯一識別符號ClientId建立與客戶端的關聯。使用者可以通過查詢聯結器ConnectorId或者ClientId獲取指定的聯結器。聯結器的主要作用就是讀取資料或者下發資料到客戶端，讀取到的資料通過業務介面傳遞給業務處理類，由業務處理類處理資料。

   聯結器管理類：聯結器管理類提供儲存聯結器的容器，作為通訊內部管理類，提供聯結器插入到容器、關閉聯結器、刪除聯結器、更改聯結器客戶端ID和聯結器工作引數。

   業務介面類：為使用者提供業務處理模板。使用者通過實行業務介面實現自己的業務邏輯。

   流程描述：

    

2.3.詳細設計

曾經用Delphi寫過windows完成埠模型的通訊程式碼，而C++，尚未入門，臨時抱佛腳採用QT編輯器嘗試編寫本案例詳細設計和具體實現，很多命名規則還保留有一些記憶中的Delphi風格。為方便專業級別的C++程式設計師審閱本案例，也因本人不喜歡閱讀那些帶下劃線的程式碼，本詳細設計命名規則解釋如下：

1. 所有的類名均用大寫的T字母開頭。

2. public類成員變數統一由大寫的字母開頭。成員變數由兩個單片語成的，每個單詞的首字母均採用大寫。

3. Protect或者Private成員變數m+單詞首字母命名。

4. Public方法名，只有一個單詞的由單詞的第一個字母大寫，其他字母小寫。 由2個單片語成的，每個單詞第一個字母採用大寫，其他用小寫。

5. Protect或者private方法，均採用首個單詞全部小寫，其他單詞的第一個字母大寫。

6. 除非不得已，本設計常量定義儘量採用const，不使用巨集定義。

   通訊服務類、聯結器類、聯結器管理類、業務邏輯介面，業務邏輯示例TDefeaultBussiness類詳細設計及各物件之間的關係如下圖所示。

         

2.3.1.通訊伺服器類（TTcpserver）

一、通訊伺服器工作流程：

1. 使用TTcpServer::TTcpServer()構造器生成一個TTcpserver物件，如TTcpserver  tcpserver; 或者使用帶ip地址和埠號引數的構造器TTcpserver::TTcpServer(string ipAddr,int port)生成一個TTcpServer物件。

2. 如果還沒設定監聽的IP地址和埠的，呼叫SetIpAddress設定監聽IP地址和埠。

3. 呼叫 RegisterBussiness方法繫結使用者自己實現的業務邏輯物件。

4. 呼叫SetRecycleSocketTime方法設定回收斷線的客戶端連線，該步驟可選，如果使用者不呼叫該方法，則預設10分鐘回收一次。

5. 呼叫Start方法啟動服務，引數為True時將根據執行的物理伺服器CPU核數產生2*CPU核數-1的執行緒數量執行通訊服務。

1. 功能描述：

1. waitAccept方法：使用非同步方式等待遠端客戶端連線，當有連線請求時。如果連線成功，呼叫連線成功回撥函式來儲存連線和投遞非同步讀等待。

2. acceptHandle方法：是waitAccept方法的回撥函式，連線成功後該方法被呼叫，儲存聯結器和投遞非同步讀事件。 如果有異常，則把異常寫到異常日誌中。

3. Start方法：啟動服務。首先呼叫waitAccept等待連線，然後呼叫聯結器管理物件中的OpenTimers方法啟動聯結器回收掉線的聯結器，最後呼叫採用執行緒方式啟動mIoServer.run。

2.3.2.聯結器類

功能描述:

1. DoRead：投遞非同步讀事件等待資料接收，如果讀到客戶端關閉的錯誤程式碼，則關閉連線。

2. ReadHandle：非同步讀事件回撥函式，當讀取到資料後，通過業務介面把資料傳遞到業務處理物件。再次呼叫DoRead投遞讀事件

3. DoWrite：投遞非同步寫事件，由於什麼時候在聯結器上面進行寫操作是由客戶端或者應用協議決定的，投遞寫事件由業務邏輯介面呼叫。

4. writeHandle：非同步寫回調函式，通過該回調函式將寫結果通知給業務層。

2.3.3.聯結器管理類

功能描述：

1. AddConnector方法：為聯結器生成聯結器ID，並把聯結器物件儲存到聯結器容器中。工作流程：

   首先中聯結器ID回收站中獲取可以利用的ID，如果沒有，則通過增長方式建立一個ID。

2. 其次呼叫容器的插入方法儲存聯結器物件。

3. GetSocket方法：通過聯結器ID或者客戶端ID獲取聯結器。

4. UpdataConnector方法：當客戶端註冊後，更新聯結器的ClientId。由業務介面呼叫。

5. checkConnection方法：定時檢查聯結器容器中是否有掉線的聯結器，並將掉線的聯結器中刪除掉線的聯結器。

   原始碼：

/***********************************************

*撰寫時間：2016年8月12日

*C++等級：初級

*作者：

*/

#ifndefTCPSERVER_H

#defineTCPSERVER_H

#include<boost/asio.hpp>

#include<boost/bind.hpp>

#include<boost/thread.hpp>

#include"connector.h"

#include"connectormanager.h"

#include"userbusiness.h"

#include<string>

usingnamespacestd;

classTTcpServer

{

public:

//提供預設的建構函式

TTcpServer();

//提供通過IP和埠構造服務類的建構函式

TTcpServer(conststringipAddress,shortport);

//~TTcpServer(){}

voidSetIpAddress(conststringipAddr,shortport);

voidStart(constboolmultiThread=false);

//結束服務

voidStop();

//註冊業務

voidRegisterBussiness(IBussiness&business);

voidSetRecycleSocketTime(intsecond);

private:

boost::asio::io_servicemIoServer;

boost::asio::ip::tcp::endpointmEndpoint;

boost::asio::ip::tcp::acceptormAcceptor;

TConnectorManagermConnectorManager;

//執行緒組,儲存的是執行緒地址，本例不適應，學習參考

boost::thread_groupmWorkers;

//執行緒組，用智慧指標儲存，自動化管理

std::vector<boost::shared_ptr<boost::thread>>mThreads;

//業務介面

IBussiness*pmBussiness;

intmRecycleTime;

//連線處理器

voidacceptHandle(boost::shared_ptr<TConnector>pConnection,constboost::system::error_code&error);

//監聽埠，等待連線

voidwaitAccept();

//建立執行緒池

voidopenThreadPool();

};

#endif//TCPSERVER_H

#include"boost/enable_shared_from_this.hpp"

//#include<boost/thread.hpp>

#include<boost/thread/thread.hpp>

#include"tcpserver.h"

#include"userbusiness.h"

TTcpServer::TTcpServer()

:mAcceptor(mIoServer),

mConnectorManager(mIoServer),

mRecycleTime(60)

{

}

TTcpServer::TTcpServer(conststringipAddress,shortport)

:mEndpoint(boost::asio::ip::address_v4::from_string(ipAddress),port),

mAcceptor(mIoServer,mEndpoint),mConnectorManager(mIoServer)

{

}

//等待連線

voidTTcpServer::waitAccept()

{

//構造一個虛擬的連線物件

boost::shared_ptr<TConnector>pConnection(newTConnector(mIoServer,pmBussiness));

//等待客戶端連線，連線成功將連線資訊儲存到pConnection中

mAcceptor.async_accept(pConnection->GetSocket(),

boost::bind(&TTcpServer::acceptHandle,this,pConnection,boost::asio::placeholders::error()));

}

//連線事件回撥函式

voidTTcpServer::acceptHandle(boost::shared_ptr<TConnector>pConnection,constboost::system::error_code&err)

{

if(!err)

{

try

{

//再次監聽連線

waitAccept();

//投遞讀準備

if(NULL!=pConnection)

{

//pConnection->InitSocket();

pConnection->DoRead();

//本次連線儲存到聯結器容器中

mConnectorManager.AddConnector(pConnection);

}

}

catch(std::exception&e)

{

//寫異常日誌

}

catch(...)

{

相關推薦