Skip to content

Commit

Permalink
add tars-bind, push callback, queue md
Browse files Browse the repository at this point in the history
  • Loading branch information
ruanshudong committed Feb 2, 2024
1 parent e1ef08a commit 9e399c3
Show file tree
Hide file tree
Showing 6 changed files with 202 additions and 4 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
- [新闻](https://tarscloud.org/feed/newsroom)
- QQ 技术交流群群:733605310, 579079160(满), 669339903(满)
- 微信公众号: TarsCloud
- 微信 ID: TARS01
- [联系我们](https://tarscloud.org/about/contacts)

## 目录
Expand Down
4 changes: 3 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
- [部署总体介绍](installation/README.md)
- [Docker环境安装](installation/docker-install.md)
- [Mysql安装](installation/mysql.md)
- [框架云部署](installation/cloud.md)
- [框架源码部署(Linux/Mac)](installation/source.md)
- [框架源码部署(Windows)](installation/source-windows.md)
- [框架Docker部署](installation/docker.md)
Expand Down Expand Up @@ -60,7 +59,10 @@
- [HTTP2 支持](dev/tarscpp/tars-http2.md)
- [TLS 通信支持](dev/tarscpp/tars-tls.md)
- [Push 功能说明](dev/tarscpp/tars_push.md)
- [PushCallback 功能说明](dev/tarscpp/tars_push_callback.md)
- [Cookie 支持](dev/tarscpp/tars-cookie.md)
- [队列模式](dev/tarscpp/tars_queue.md)
- [手动绑定](dev/tarscpp/tars_bind.md)
- [性能数据](dev/tarscpp/tars-performance.md)
- [2.x 版本变化](dev/tarscpp/tars-2.x-update.md)
- [3.x 版本变化](dev/tarscpp/tars-3.x-update.md)
Expand Down
2 changes: 0 additions & 2 deletions dev/tarscpp/tars-compiler.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,6 @@ cmake --build . --config release --target install

注意: Visual Studio 16 2019 可以选择你需要的版本, 可以用 cmake .. -G 查看

另外: windows 版本目前开启 TARS_MYSQL, TARS_HTTP2, TARS_SSL, TARS_PROTOBUF 还有问题, 还在解决中.

## 5 实现业务服务

完成TarsCpp以后, 你可以基于TarsCpp编译出来头文件和lib库实现自己的业务服务了, [请参考](../hello-world/tarscpp.md)
26 changes: 26 additions & 0 deletions dev/tarscpp/tars_bind.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@


## 背景

有一些服务在初始化过程中需要初始化大量数据, 这个时候我们希望服务不要绑定端口对外提供服务, 而是等初始化完毕后, 在绑定端口提供服务, 我们就需要有这个手工绑定的功能.

## 使用方式

我们在服务的`initialize`中执行:

```c++
//注意tarscpp版本,老版本可能没有这个函数
getBindAdapter(getServerBaseInfo().Application + "." + getServerBaseInfo().ServerName +".HelloObj")->enableManualListen();

//如果3.0.16之前的版本, 只能在模板中的<server>域内配置, manualListen = 1 来实现

```
然后你可以放心初始化的数据, 服务不会绑定业务端口, 当你的数据初始化完毕后, 你可以调用:
```c++
getBindAdapter(getServerBaseInfo().Application + "." + getServerBaseInfo().ServerName +".HelloObj")->manualListen();
```

从而完成端口的主动绑定

145 changes: 145 additions & 0 deletions dev/tarscpp/tars_push_callback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@

相对于普通的push, 使用者需要自己编解码协议, 本文介绍tarscpp中另外一种push callback的方式, 这种方式可以大幅度降低服务间push的开发难度.

## 背景
当服务A和服务B间有交互, 当A主动发起连接B, 此时A作为客户端, B作为服务端, 当B希望主动给A push消息时, 我们可以采取tarscpp中的第三方协议来完成, 但是这种模式下, 主要有两个缺点:

服务的协议完全自定义的, 提高了开发难度
服务协议非普通的tars协议, 如果一个普通的tars协议服务希望具备这个功能就比较难做到
因此tarscpp框架提供了一种全新的push callback模式来解决这两个问题.

## 接口定义
我们先看看具体的使用案例, 首先定义服务B的接口如下:
```c++
interface Hello
{
int registerPush();
};
```
可以看到这个接口比较简单, 就是提供A调用, 用于注册push.

在定义服务A和B之间的push接口, 这个定义非常重要, 是整个push callback的精髓, 需要仔细理解.

```c++
interface Push
{
int pushMsg(out string sRsp);
};
```
### 服务端实现

完成接口定义后, 我们再来看服务B的核心实现, 首先服务B在Hello的实现中, 实现registerPush, 头文件HelloImp核心定义如下:

```c++
/**
* 连接关闭
* @param current
* @return
*/
virtual int doClose(tars::TarsCurrentPtr current);

/**
* 客户端请求注册push通知
*/
virtual int registerPush(tars::TarsCurrentPtr current);
```
实现文件如下:
```c++
int HelloImp::doClose(tars::TarsCurrentPtr current)
{
g_app._pushThread.delCurrent(current);
}
int HelloImp::registerPush(tars::TarsCurrentPtr current)
{
g_app._pushThread.addCurrent(current);
return 0;
}
```

说明:
- push是个长连接,需要关注连接关闭事件, 因此可以看到实现了doClose方法, 将current去掉;
- 而registerPush是服务A主动调用, 此时服务B将current保存起来, 用于后续push;
- current表示了请求的上下文, 如果是同一个连接上来的请求, current->getUId()的值相同的, 框架层也是利用这个Id给对应的连接回消息
- _pushThread是一个自己实现的push线程类, 这个你可以根据实际情况去实现

接下来我们看看_pushThread 到底做了哪些工作.

_pushThread是自己实现的一个对象, 由于示例比较简单, 它会启动一个线程然后使用保存下来的current给上来的请求发送push消息, 核心示例代码如下:

```c++
void PushThread::addCurrent(CurrentPtr &current)
{
std::lock_guard<std::mutex> lock(_mutex);

_currents[current->getUId()] = current;
}

void PushThread::delCurrent(CurrentPtr &current)
{
std::lock_guard<std::mutex> lock(_mutex);

_currents.erase(current->getUId());
}

void PushThread::run()
{
while(!_terminate)
{
std::unique_lock<std::mutex> lock(_mutex);

for(auto it : _currents)
{
TestApp::Push::async_response_push_pushMsg(it.second, 0, "push message");
}

_cond.wait_for(lock, std::chrono::milliseconds(1000));
}

}

```
其中最核心的一行代码:
```c++
TestApp::Push::async_response_push_pushMsg(it.second, 0, "push message");
```

分析:

- async_response_push_pushMsg函数是根据前面Push接口自动生成的, 匹配了Push接口的pushMsg函数
- 第一参数是current, 代表了是哪个连接上来的, 第二个参数是pushMsg的返回值, 第三个参数是pushMsg的out返回参数, 可以有多个返回参数, 这种push方式, 不需要有输入参数.

可以看到利用这个方法就可以给客户端返回想要的数据.

- 客户端实现
对于客户端而言, 获取服务端的通知也非常简单, 代码示例如下:

```c++
class PushCallbackImp : public PushPrxCallback
{
public:
virtual void callback_pushMsg(tars::Int32 ret, const std::string& sRsp)
{
LOG_CONSOLE_DEBUG << ret << ", " << sRsp << endl;
}
};

_comm = new Communicator();

HelloPrx pPrx = _comm->stringToProxy<HelloPrx>(helloObj);
pPrx->tars_set_push_callback(new PushCallbackImp());
pPrx->registerPush();
```
分析:
- 客户端为了收取push消息, 核心就是要注册tars_set_push_callback一个回调;
- PushPrxCallback就是代码生成中的类, 实现对应的callback_pushMsg 即可完成push回调!
可以看到, 客户端的操作也非常简单!
## 其他说明
利用push callback机制, 可以非常方便完成服务间的push机制, 但是需要注意几点
- registerPush可以定时调用, 保持A和B之间连接的活跃度
- 需要注意B有多台服务器的场景, 每次调用registerPush都是轮训的, 这个时候就需要考虑清楚push机制该如何设计, 这个本文就不展开,使用者可以自己仔细思考一下
- tarsgo也已经支持该模式, 其他语言暂时未实现该机制.
28 changes: 28 additions & 0 deletions dev/tarscpp/tars_queue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@


## 背景

目前的服务端模型中, 默认情况下, 请求过来时, 服务端业务处理线程谁空闲谁来处理当前请求, 因此同一个链接的请求可能被任何一个线程处理.

但是在某些场合下, 我们希望同一个链接的请求都被同一个线程执行, 从而保证连接上请求的有序性, 我们可以启用队列模式来实现这个能力.

## 使用方式

我们在服务的`initialize`中执行:

```c++
//注意tarscpp版本,老版本可能没有这个函数
getBindAdapter(ServerConfig::Application + "." + ServerConfig::ServerName +".HelloObj")->enableQueueMode();

//如果3.0.15之前的版本, 可以如下:
getEpollServer()->getBindAdapter(ServerConfig::Application + "." + ServerConfig::ServerName +".HelloObjAdapter")->enableQueueMode();

```
总之, 你需要获取到服务的BindAdapter, 然后通过bindAdapter来启用队列模式.
执行后, 队列模式则被启用.
## 注意
- 如果服务模型是: NET_THREAD_MERGE_HANDLES_CO or NET_THREAD_MERGE_HANDLES_THREAD, 这两种模式下, 网络线程和业务处理线程其实是一个, 这时候默认就启用了队列模式

0 comments on commit 9e399c3

Please sign in to comment.