国产开源网络编程框架t-io使用必备:极速开发器Tio.java

语言: CN / TW / HK

Tio.java简介

  • 为了让用户减少查找API的时间,t-io把常用API以静态方法的形式汇集于一个类,这就是Tio.java
  • Tio.java本身并不实现过复杂的业务,各业务实现仍然分布在其它类中,Tio.java只是把用户关心的API集中起来,便于用IDE查找而已

业务数据绑定

  • 资源绑定是指把业务相关的数据和Tcp连接(即ChannelContext)关联起来,譬如ChannelContext-A代表了用户张三,张三的userid是333,就用下面的代码进行绑定

  • Tio.bindUser(ChannelContext-A, "333")

  • t-io目前内置了4种资源绑定,当然用户可以灵活使用这些绑定从而解决业务层所有的资源绑定问题,譬如可以给group加前缀”ios-“,从而标记这个用户使用的是ios,譬如

  • Tio.bindGroup(ChannelContext-A, "333");
  • Tio.bindGroup(ChannelContext-A, "ios-" + "333");
  • 内置的4种资源绑定方法中,一个ChannelContext是可以绑定到多个groupid的,其它三个绑定都是一对一或多对一的关系,也就是说一个ChannelContext可以同时属于group-a,group-b… …group-n
  • 下面贴一下这4个资源绑定的源代码
  • /**
  • * 绑定业务id
  • * @param channelContext
  • * @param bsId
  • * @author tanyaowu
  • */
  • public static void bindBsId(ChannelContext channelContext, String bsId) {
  • channelContext.tioConfig.bsIds.bind(channelContext, bsId);
  • }
  • ``
  • /**
  • * 绑定群组
  • * @param channelContext
  • * @param group
  • * @author tanyaowu
  • */
  • public static void bindGroup(ChannelContext channelContext, String group) {
  • channelContext.tioConfig.groups.bind(group, channelContext);
  • }
  • ``
  • /**
  • * 绑定token
  • * @param channelContext
  • * @param token
  • * @author tanyaowu
  • */
  • public static void bindToken(ChannelContext channelContext, String token) {
  • channelContext.tioConfig.tokens.bind(token, channelContext);
  • }
  • ``
  • /**
  • * 绑定用户
  • * @param channelContext
  • * @param userid
  • * @author tanyaowu
  • */
  • public static void bindUser(ChannelContext channelContext, String userid) {
  • channelContext.tioConfig.users.bind(userid, channelContext);
  • }

业务数据解绑

  • 既然有绑定,就肯定会有解绑,这是个和绑定相反的操作,所以话不多说,直接贴出不长的源代码
  • /**
  • * 解绑业务id
  • * @param channelContext
  • * @author tanyaowu
  • */
  • public static void unbindBsId(ChannelContext channelContext) {
  • channelContext.tioConfig.bsIds.unbind(channelContext);
  • }
  • ``
  • /**
  • * 与所有组解除解绑关系
  • * @param channelContext
  • * @author tanyaowu
  • */
  • public static void unbindGroup(ChannelContext channelContext) {
  • channelContext.tioConfig.groups.unbind(channelContext);
  • }
  • ``
  • /**
  • * 与指定组解除绑定关系
  • * @param group
  • * @param channelContext
  • * @author tanyaowu
  • */
  • public static void unbindGroup(String group, ChannelContext channelContext) {
  • channelContext.tioConfig.groups.unbind(group, channelContext);
  • }
  • ``
  • /**
  • * 解除channelContext绑定的token
  • * @param channelContext
  • * @author tanyaowu
  • */
  • public static void unbindToken(ChannelContext channelContext) {
  • channelContext.tioConfig.tokens.unbind(channelContext);
  • }
  • ``
  • // org.tio.core.TioConfig.ipBlacklist
  • ``
  • /**
  • * 解除channelContext绑定的userid
  • * @param channelContext
  • * @author tanyaowu
  • */
  • public static void unbindUser(ChannelContext channelContext) {
  • channelContext.tioConfig.users.unbind(channelContext);
  • }
  • ``
  • /**
  • * 解除userid的绑定。一般用于多地登录,踢掉前面登录的场景
  • * @param tioConfig
  • * @param userid
  • * @author: tanyaowu
  • */
  • public static void unbindUser(TioConfig tioConfig, String userid) {
  • tioConfig.users.unbind(tioConfig, userid);
  • }

异步发送

  • 异步发送,指的是业务层把Packet丢给t-io后立即返回,返回时Packet并没有被发送,而只是提交到了待发送队列
  • 异步发送都是以send开头的,这个API有点多,贴代码有点长,用图片展示更舒适些

image.png

阻塞发送

  • 阻塞发送:t-io把Packet送给对方后才返回
  • 阻塞发送都是以bSend开头的,这个API有点多,贴代码有点长,用图片展示更舒适些

image.png

如何获取ChannelContext

  • 前面的业务数据绑定,一个重要的目的就是要根据那些业务标识来获取ChannelContext,譬如你绑定了一个userid,那么后面就可以通过这个userid来获取ChannelContext

  • 获取ChannelContext的API都是以get开头的,这个API有点多,贴代码有点长,用图片展示更舒适些

image.png

断开连接和移除连接

  • 断开连接都是以close开头的方法,指的是把当前已经连上的TCP连接断开掉

image.png - 移除连接都是以remove开头的方法,指的是彻底抛弃这个连接

image.png

注意

  • 如果是用t-io做TCP服务器端

    • 上面两个方法是等价的,因为服务器不存在重连一说
  • 如果是用t-io做TCP客户端,并且没有配置重连

    • 上面两个方法也是等价的,因为不需要重连,tio断开连接后就会释放该连接全部资源
  • 如果是用t-io做TCP客户端,并且配置了重连规则,上面两个方法才是有区别的,区别如下

    • close(): 不释放相关资源,并且会进行重连
    • remove():完全释放相关资源,不再进行重连

    集群通知

    • t-io是内置集群功能的,作为与业务不相关的io框架,内置集群功能是件费力却不见得讨好的事(为啥不讨好?譬如会增加代码复杂度、会降低tio-mvc在TFB上的跑分排名),但t-io考虑到广大用户的呼声,还是内置了集群功能
    • 目前t-io提供的消息发送功能,都是支持集群的,这个从Tio.java的源代码中就能看出来
    • 集群通知类API都是以notifyCluster开头的,见图

image.png

t-io拉黑IP

简单到极致,只需要一行代码 1. Tio.IpBlacklist.add(tioConfig, channelContext.getClientNode().getIp());