Dubbo之TelnetCodec源码解析

于 2023-08-28 23:05:10 发布
阅读量525 收藏
点赞数
分类专栏： Dubbo 文章标签： dubbo
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/csy_insist/article/details/132550116
版权

功能概述

  • TelnetCodec用于实现在终端执行telnet指定的编解码功能。

功能分析

核心类TelnetCodec分析

主要成员变量分析

private static final byte[] UP = new byte[] {27, 91, 65}; //向上指令
 
private static final byte[] DOWN = new byte[] {27, 91, 66}; //向下指令

private static final List<?> ENTER = Arrays.asList( //换行指令 （参照ASCII码对照表）
        new byte[] {'\r', '\n'} /* Windows Enter */,
        new byte[] {'\n'} /* Linux Enter */);

private static final List<?> EXIT = Arrays.asList( //退出对应的字节数组，是个二维数组
        new byte[] {3} /* Windows Ctrl+C */,
        new byte[] {-1, -12, -1, -3, 6} /* Linux Ctrl+C */,
        new byte[] {-1, -19, -1, -3, 6} /* Linux Pause */);

主要成员方法分析

获取字符编码
private static Charset getCharset(Channel channel) {
    if (channel != null) {
        Object attribute = channel.getAttribute(CHARSET_KEY); //获取配置的字符集名称
        if (attribute instanceof String) { //判断是String类型还是Charset类型
            try {
                return Charset.forName((String) attribute); //尝试获取指定字符串的字符编码
            } catch (Throwable t) {
                logger.warn(t.getMessage(), t);
            }
        } else if (attribute instanceof Charset) {
            return (Charset) attribute;
        }
        URL url = channel.getUrl(); //远程url
        if (url != null) {
            String parameter = url.getParameter(CHARSET_KEY);
            if (StringUtils.isNotEmpty(parameter)) {
                try {
                    return Charset.forName(parameter);
                } catch (Throwable t) {
                    logger.warn(t.getMessage(), t);
                }
            }
        }
    }
    try {
        return Charset.forName(DEFAULT_CHARSET); //获取默认字符编码“UTF-8”
    } catch (Throwable t) {
        logger.warn(t.getMessage(), t);
    }
    return Charset.defaultCharset();
}
  • 获取字符集的逻辑
    • 从通道Channel的设置的属性值获取。
    • 若没有，从通道的Url中获取。
    • 若还没有，则取默认的字符集（默认字符集为UTF-8）。
响应内容编码
public void encode(Channel channel, ChannelBuffer buffer, Object message) throws IOException { //对响应的内容进行编码
    if (message instanceof String) { //字符串类型处理
        if (isClientSide(channel)) {
            message = message + "\r\n"; //客户端输入的内容拼接上换行符
        }
        byte[] msgData = ((String) message).getBytes(getCharset(channel).name()); //若是字符串，直接根据字符集获取字节数组
        buffer.writeBytes(msgData);
    } else { //对象类型处理，交由父类来处理
        super.encode(channel, buffer, message);
    }
}
请求内容解码
protected Object decode(Channel channel, ChannelBuffer buffer, int readable, byte[] message) throws IOException { //对许多特殊字符，如换行符、退位符进行处理
    if (isClientSide(channel)) { //若是客户端，直接将字节数组转换为字符串
        return toString(message, getCharset(channel)); //获取字符集，并将字符数组转换为字符串
    }
    checkPayload(channel, readable);
    if (message == null || message.length == 0) { //消息内容为空时，不再进行后续处理
        return DecodeResult.NEED_MORE_INPUT;
    }

    if (message[message.length - 1] == '\b') { // Windows backspace echo （'\b'的值为8）
        try {
            boolean doublechar = message.length >= 3 && message[message.length - 3] < 0; // double byte char （判断逻辑：消息的长度大于3，并且倒数第三个元素数值小于0）
            channel.send(new String(doublechar ? new byte[] {32, 32, 8, 8} : new byte[] {32, 8}, getCharset(channel).name())); //32对应的字符为空格
        } catch (RemotingException e) {
            throw new IOException(StringUtils.toString(e));
        }
        return DecodeResult.NEED_MORE_INPUT; //需要输入更多的字符
    }

    for (Object command : EXIT) {
        if (isEquals(message, (byte[]) command)) { //判断是否包含"退出指令"，若包含则关闭channel
            if (logger.isInfoEnabled()) {
                logger.info(new Exception("Close channel " + channel + " on exit command: " + Arrays.toString((byte[]) command)));
            }
            channel.close(); //执行退出指令时，会将通道channel关闭
            return null;
        }
    }

    boolean up = endsWith(message, UP);
    boolean down = endsWith(message, DOWN);
    if (up || down) { //上下键处理：对历史记录的处理
        LinkedList<String> history = (LinkedList<String>) channel.getAttribute(HISTORY_LIST_KEY);
        if (CollectionUtils.isEmpty(history)) {
            return DecodeResult.NEED_MORE_INPUT;
        }
        Integer index = (Integer) channel.getAttribute(HISTORY_INDEX_KEY); //取出历史记录索引
        Integer old = index;
        if (index == null) {
            index = history.size() - 1; //若没设置索引，则取列表中的最后一条
        } else {
            if (up) { //执行向上操作
                index = index - 1;
                if (index < 0) {
                    index = history.size() - 1; //如果索引小于0，则轮询到最后一条
                }
            } else { //执行向下操作
                index = index + 1;
                if (index > history.size() - 1) {//如果所以大于最后一条，则轮询到第一条
                    index = 0;
                }
            }
        }
        if (old == null || !old.equals(index)) { //表示：old不为空或old与index不相等
            channel.setAttribute(HISTORY_INDEX_KEY, index);
            String value = history.get(index);
            if (old != null && old >= 0 && old < history.size()) {
                String ov = history.get(old);
                StringBuilder buf = new StringBuilder();
                for (int i = 0; i < ov.length(); i++) {
                    buf.append("\b");
                }
                for (int i = 0; i < ov.length(); i++) {
                    buf.append(" ");
                }
                for (int i = 0; i < ov.length(); i++) {
                    buf.append("\b");
                }
                value = buf.toString() + value;
            }
            try {
                channel.send(value);
            } catch (RemotingException e) {
                throw new IOException(StringUtils.toString(e));
            }
        }
        return DecodeResult.NEED_MORE_INPUT;
    }
    for (Object command : EXIT) {
        if (isEquals(message, (byte[]) command)) { //若是结束符，判断是否与结束符相等
            if (logger.isInfoEnabled()) {
                logger.info(new Exception("Close channel " + channel + " on exit command " + command));
            }
            channel.close();
            return null;
        }
    }
    byte[] enter = null;
    for (Object command : ENTER) {
        if (endsWith(message, (byte[]) command)) {//若是换行符，判断是否是以换行符结尾
            enter = (byte[]) command; //将换行符存下来
            break;
        }
    }
    if (enter == null) { //需要有换行符结尾，没有的话就不往下进行
        return DecodeResult.NEED_MORE_INPUT;
    }
    LinkedList<String> history = (LinkedList<String>) channel.getAttribute(HISTORY_LIST_KEY);
    Integer index = (Integer) channel.getAttribute(HISTORY_INDEX_KEY);
    channel.removeAttribute(HISTORY_INDEX_KEY); //使用过后，将HISTORY_INDEX_KEY历史记录所以移除
    if (CollectionUtils.isNotEmpty(history) && index != null && index >= 0 && index < history.size()) {
        String value = history.get(index);
        if (value != null) {
            byte[] b1 = value.getBytes();
            byte[] b2 = new byte[b1.length + message.length];
            System.arraycopy(b1, 0, b2, 0, b1.length);
            System.arraycopy(message, 0, b2, b1.length, message.length);
            message = b2;
        }
    }
    String result = toString(message, getCharset(channel));
    if (result.trim().length() > 0) {
        if (history == null) {
            history = new LinkedList<String>();
            channel.setAttribute(HISTORY_LIST_KEY, history); //指令正常执行后，就会写入通道的历史指令列表
        }
        if (history.isEmpty()) {
            history.addLast(result); //写入历史指令列表
        } else if (!result.equals(history.getLast())) {
            history.remove(result);
            history.addLast(result);
            if (history.size() > 10) {
                history.removeFirst();
            }
        }
    }
    return result;
}
  • 上下键本意上是对历史指令的支持，但是不同平台的支持不一样，比如Mac就会附加的UP的字节数组为[27,91,65,13,10]把换行符加上了，就导致不是以UP结尾，就失效了。

辅助类AbstractCodec分析

主要成员方法分析

检查负载大小
protected static void checkPayload(Channel channel, long size) throws IOException { //检查负载大小（请求体的数据大小）
    int payload = Constants.DEFAULT_PAYLOAD; //默认负载大小为8 * 1024 * 1024，即8M;
    if (channel != null && channel.getUrl() != null) {
        payload = channel.getUrl().getParameter(Constants.PAYLOAD_KEY, Constants.DEFAULT_PAYLOAD);
    }
    if (payload > 0 && size > payload) { //超过负载，则抛出异常
        ExceedPayloadLimitException e = new ExceedPayloadLimitException(
                "Data length too large: " + size + ", max payload: " + payload + ", channel: " + channel);
        logger.error(e);
        throw e;
    }
}
判断是否是客户端
protected boolean isClientSide(Channel channel) { //判断是否是客户端
    String side = (String) channel.getAttribute(SIDE_KEY);
    if (CLIENT_SIDE.equals(side)) { //判断通道中属性SIDE_KEY的缓存值
        return true;
    } else if (SERVER_SIDE.equals(side)) {
        return false;
    } else {
        InetSocketAddress address = channel.getRemoteAddress();
        URL url = channel.getUrl(); //远程url，即服务端的url
        boolean isClient = url.getPort() == address.getPort()
                && NetUtils.filterLocalHost(url.getIp()).equals(
                NetUtils.filterLocalHost(address.getAddress()
                        .getHostAddress())); //比较逻辑：当通道中的远程地址与url地址比较，如果远程是服务端，那么当前就是客户端，反之类推（也可以按localAddress来判断）
        channel.setAttribute(SIDE_KEY, isClient ? CLIENT_SIDE
            : SERVER_SIDE);
        return isClient;
    }
}

辅助类TelnetHandlerAdapter分析

主要成员方法分析

指令调用
public String telnet(Channel channel, String message) throws RemotingException { //Telnet指令处理
    String prompt = channel.getUrl().getParameterAndDecoded(Constants.PROMPT_KEY, Constants.DEFAULT_PROMPT);
    boolean noprompt = message.contains("--no-prompt");
    message = message.replace("--no-prompt", ""); //telnet提示键（如果做了配置，将不显示dubbo>）
    StringBuilder buf = new StringBuilder();
    message = message.trim();
    String command;
    if (message.length() > 0) { //message不为空字符串时，解析指令和执行的内容（输入回车键会收到空字符串）
        int i = message.indexOf(' '); //接收指令时，收到的message不包含提示符，如dubbo> ls，收到的message为ls
        if (i > 0) { //拆分命令和参数
            command = message.substring(0, i).trim();
            message = message.substring(i + 1).trim();
        } else {
            command = message;
            message = "";
        }
    } else {
        command = "";
    }
    if (command.length() > 0) { //telnet输入回车时，写到通道的内容为空字符串，不会进入此处逻辑
        if (extensionLoader.hasExtension(command)) { //将命令名作为SPI的扩展名
            if (commandEnabled(channel.getUrl(), command)) {
                try {
                    String result = extensionLoader.getExtension(command).telnet(channel, message); //获取指定命令的实例，并将结果写到channel
                    if (result == null) {
                        return null;
                    }
                    buf.append(result);
                } catch (Throwable t) {
                    buf.append(t.getMessage());
                }
            } else {
                buf.append("Command: ");
                buf.append(command);
                buf.append(" disabled");
            }
        } else {
            buf.append("Unsupported command: ");
            buf.append(command);
        }
    }
    if (buf.length() > 0) {
        buf.append("\r\n"); //\r 回车符，\n 换行符，用回车符换行符结束指令
    }
    if (StringUtils.isNotEmpty(prompt) && !noprompt) { //提示键处理：若提示键内容不为空且没有禁用，则作对应展示
        buf.append(prompt);
    }
    return buf.toString(); //响应给telnet客户端的内容
}

问题点答疑

  • TelnetHandler处理接口有多个实现类，即telnet命令会有多个，如ListTelnetHandler列表指令，InvokeTelnetHandler调用指令，那么不同指令是怎么分发的？

    • 解答：通过实现类TelnetHandlerAdapter将输入的字符串message进行解析，获取到指令名以及执行内容，再把指令名称作为SPI的扩展名，根据SPI机制获取到对应的实例。

  • telnet中的提示键可以设置自定义提示符吗，怎么设置？

    • 解答：可以自定义提示符，通过dubbo:parameter/参数配置设置。

归纳总结

  • Telnet协议是TCP/IP协议族中的一员，是Internet远程登陆服务的标准协议。Telnet协议的目的是提供一个相对通用的，双向的，面向八位字节的通信方法，允许界面终端设备和面向终端的过程能通过一个标准过程进行互相交互。应用Telnet协议能够把本地用户所使用的计算机变成远程主机系统的一个终端
csy_insist
关注
专栏目录
telnetd源码分析
09-14 3142
telnetd是一个telnet服务端程序   下载地址：http://www.busybox.net/ 解压缩后进入busybox目录 make defconfig make make install 然后会生成 _install 目录，里面就是编译好的可执行文件
telnet源码分析
09-16 3067
telnet是一个telnet客户端程序 下载地址：http://www.busybox.net/ 解压缩后进入busybox目录 make defconfig make make install 然后会生成 _install 目录，里面就是编译好的可执行文件 源码
关于telnet源码
weixin_34319374的博客
11-03 1158
Linux 下流行的 telnet 实现有两个：GNU 的 inetutils 中的实现哈佛的 netkit-telnet 1. http://ftp.gnu.org/gnu/inetutils/2. http://ftp.de.debian.org/debian/pool/main/n/netkit-telnet/netkit-telnet_0.17.orig.tar.gz 百度网盘：htt...
dubbo源码解析（十二）远程通信——Telnet
weixin_34150503的博客
12-23 285
远程通讯——Telnet 目标：介绍telnet的相关实现逻辑、介绍dubbo-remoting-api中的telnet包内的源码解析。 前言 从dubbo 2.0.5开始，dubbo开始支持通过 telnet 命令来进行服务治理。本文就是讲解一些公用的telnet命令的实现。下面来看一下telnet实现的类图： 可以看到，实现了Tel...
linux telnetd 源代码,telnetd源码分析
weixin_39524703的博客
05-13 1361
telnetd是一个telnet服务端程序下载地址：解压缩后进入busybox目录make defconfigmakemake install然后会生成 _install 目录，里面就是编译好的可执行文件源码位于 ./networking/telnetd.c程序流程图：程序中非常重要的就是2个buf，位于struct tsession结构体之后/*Thisishowthebuffersa...
Dubbo原理解析，彻底搞懂dubbo (下)
weixin_72753070的博客
07-28 988
从注册中心发现引用服务在有注册中心，通过注册中心发现提供者地址的情况下，ReferenceConfig解析出的URL格式为registry通过URL的registry//协议头识别，就会调用RegistryProtocol#refer()方法查询提供者URL，如dubboversion=1.0.0，来获取注册中心创建一个RegistryDirectory实例并设置注册中心和协议生成conusmer连接，在consumer目录下创建节点，向注册中心注册。...
Dubbo源码分析7之服务调用过程
01-13 269
Dubbo源码分析7之服务调用过程 1. 简介 在前面的文章中，我们分析了 Dubbo SPI、服务导出与引入、以及集群容错方面的代码。经过前文的铺垫，本篇文章我们终于可以分析服务调用过程了。Dubbo 服务调用过程比较复杂，包含众多步骤，比如发送请求、编解码、服务降级、过滤器链处理、序列化、线程派发以及响应请求等步骤。限于篇幅原因，本篇文章无法对所有的步骤一一进行分析。本篇文章将会重点分析请求的...
dubbo telnet
m0_37731701的博客
04-20 2943
dubbo2.7.13 默认禁止 telnet https://github.com/apache/dubbo/pull/8239 如果想启用 springboot 项目直接添加以下配置 dubbo.provider.telnet: ls,ps,cd,pwd,trace,count,invoke,select,status,log,help,clear,exit,shutdown 当然，spring 的需要添加上面配置的同时，添加以下配置 <dubbo:provider telnet=“${du
Dubbo源码分析十六、dubbo编解码
vinylon的博客
12-29 535
单独分析一下dubbo的编解码过程。默认情况下使用dubbo自己定义的编码协议。 我们先来看一下 Dubbo 数据包结构。 [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Vh5EtRPv-1609227698562)(.\imgs\data-format.jpg)] Dubbo 数据包分为消息头和消息体，消息头用于存储一些元信息，比如魔数（Magic），数据包类型（Request/Response），消息体长度（Data Length）等。消息体中用于存储具体的调用消息，比如
Telnet源代码
12-03
很好的 telnet后台程序，方便程序员开发，封装层次清晰
telnet 协议以及源码解析
Learning
04-22 1954
将asic码的普通字符与控制字符分开传送。 https://www.cnblogs.com/binarylei/p/8964646.html
telnetd源代码分析之如何调试源代码？
linux-0.11调试教程
12-19 2099
telnetd源代码分析之如何调试源代码？
dubbo 支持telnet命令调试
冯三思
07-04 4085
dubbo服务发布之后，我们可以利用telnet命令进行调试、管理。Dubbo2.0.5以上版本服务提供端口支持telnet命令 1.连接服务测试对应IP和端口下的dubbo服务是否连通，终端命令如下telnet localhost 20880正常情况下，进入telnet窗口，键入回车进入dubbo命令模式。2.查看服务列表查看服务dubbo&gt;ls 查看服务中的接口dubbo&gt;ls i...
Dubbo之telnet实现
weixin_34402408的博客
01-05 426
title: Dubbo之telnet实现 tags: dubbo telnet netty categories: dubbo date: 2017-07-25 18:18:53 我们可以通过telnet来访问道对应dubbo服务的信息 比如 我们可以利用一些指令来访问。 我们知道，默认情况下，dubbo使用netty做transport。 那么dubbo是如何区分开正常业务请求和t...
DUBBO源码分析八---服务调用过程
qq_51562781的博客
12-06 2011
"2021SC@SDUSC" 2.3.2.2 调用服务 本小节，我们从 ChannelEventRunnable 开始分析，该类的主要代码如下： public class ChannelEventRunnable implements Runnable { private final ChannelHandler handler; private final Channel channel; private final ChannelState state;
dubbo之telnet使用
sebeefe的博客
08-14 335
我们知道像tomcat，nginx等都可以通过telnet命令连接，dubbo也实现了telnet server，因此我们也可以通过telnet命令来连接dubbo，下面我们一起来看下。
精尽 Dubbo 源码分析 —— NIO 服务器（三）之 Telnet 层
qq_32782279的博客
04-10 229
1.概述 在 《Dubbo 用户指南 —— Telnet 命令参考手册》 一文中，我们可以看到，Dubbo 支持通过 telnet 命令，用来服务治理。 本文涉及类图如下： 2.TelnetCodec 实现 TransportCodec 类，Telnet 命令编解码器。 protected Object decode(Channel channel, ChannelBuffer buffer, ...
Tcp Telnet Socket 调试工具 公开所有源码
hhduyc的博客
11-10 1526
分享一下我老师大神的人工智能教程！零基础，通俗易懂！http://blog.csdn.net/jiangjunshow也欢迎大家转载本篇文章。分享知识，造福人民，实现我们中华民族伟大复兴！&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 最近在研究 TI Co
C++实现Telnet客户端源码
03-19
通过网上搜集的一些资料，使用Boost.Asio实现的可登陆telnet服务器的客户端，希望能给需要的同学参考！（项目在VS2015下编译通过，但是需要更改boost库的相关路径配置。）
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值