[toc]

spring-telnet介绍

spring-telnet是一个运行于spring容器内的一个telnet服务端，使用netty通信，可以通过telnet输入命令去执行任意容器内实例的方法或者是不在容器内的类的方法。

spring-telnet用途

1. 测试阶段查看数据，方便调用方法，不用再额外写一些http接口去测试调用，或者是后门代码，节约时间，精简代码
2. 线上定位问题，通过执行容器内方法，可以定位很多问题。或者是线上定时任务重跑场景，或者是后门场景，都是很方便的。
3. 用做项目除http以外的通信协议。当需要内网通信时，可以用本项目自带的client工具rpc调用安装了本项目的服务，被调用方甚至不需要写代码
4. 新功能：可以通过连续的命令编写逻辑，即使你想执行的逻辑没有提前写好方法，你也能现写逻辑，你可以对你的程序做任何事情

spring-telnet配置使用

spring-telnet 使用特别方便。只需要两步即可配置完成
step 1,加入maven依赖

<dependency>
            <groupId>io.github.quanquan1996</groupId>
            <artifactId>spring-telnet</artifactId>
            <version>1.0.1</version>
</dependency>

step2,启动类加 @EnableTelnet 注解

import com.quanquan.telnet.telnet.EnableTelnet;

@EnableTelnet
@SpringBootApplication
public class AdTaskApplication {

    public static void main(String[] args) {
        SpringApplication.run(AdTaskApplication.class, args);
    }

}

使用telnet调用springboot服务的方法。

首先观察启动日志，spring-telnet自动监听8000端口，如果8000没被占用，那么8000就是spring-telnet的服务端口，如果被占用，则自动会往后推，可以在启动日志看到。

调用springboot容器内bean的方法

输入 *[bean名称] [方法名] [参数] [参数] ...可以执行任意一个容器bean的方法。比如我们项目有如下的一个bean

@service
public class WebTestService {
    public int plus(int a,int b){
        return a+b;
    }
}

则可以在telnet后输入并回车 *WebTestService plus 1 2 来调用这个plus方法。bean的首字母可以不用小写，程序会自动转换。具体执行的情况如下，在任意一台安装了telnet的服务器telnet服务的端口即可

执行 telnet 127.0.0.1 8000
返回
hello~your connect ip is 127.0.0.1
try > echo hello
>
再次输入*WebTestService plus 1 2
返回
3
>

调用项目中某个类的某个方法

即使某个类不在容器内，也可以调用，输入*[Class name] [方法名] [参数] [参数] ...即可
eg:*com.xx.cxx.HelloWorld param1 param2

调用事先写好的console命令

创建一个@Qualifier("backConsole")的bean，然后该bean的所有方法可以直接通过 方法名 参数 参数 参数... 这样的命令去调用
比如该bean 有一个 public String getTestText(String cmd) 那么telnet调用只需要输入 getTestText hello 回车键就可以得到函数的返回

异步

在请求的前面加入&则后面的命令会进入线程池异步执行。

spring-telnet高级用法

高级命令（服务于脚本逻辑上下文）

使用 . 来循环调用

有时候我们执行命令可能需要用返回的对象再调用方法，比如redisTemplate.opsForValue().set(key, value);这个java语句，就连续调用了方法。
在spring telnet里也能方便的实现，只需要执行*redisTemplate opsForValue . set key value就可以要注意 . 的前后有一个空格，这样 . 前面命令的返回，会作为后面方法执行的主体。

-AS

在你调用方法后，如果你想要暂存这个方法结果的对象，你可以在命令末尾加上—AS[objName]。这样你在后续的命令中，就可以使用-FROM命令来引用这个保存的对象
如*webService test 123 -AStestObj 这个命令执行后，webService的test方法的返回结果将会以testObj这个名称被保存，使用-FROM命令就可以调用这个保存的对象。

-FROM

你只需要使用 —FROM[objName] 就可以引用你之前保存的对象了，这个对象可以用作bean来执行方法，也可以用作方法的入参。
比如*webService test 123 -AStestObjwebService的test方法返回了一个String的对象,我们用as吧这个对象命名为testObj并保存了
这时候我们可以使用 -FROMtestObj subString 3来使用这个String对象并调用String的subString方法
也可以使用 *webService test2 -FROMtestObj 123123这个命令，我们在方法的参数上使用—FROM,直接引用了之前保存的String对象作为方法的入参之一
上面说的可能有点抽象，下面我们用一组mongodb查询命令来解释

*org.springframework.data.mongodb.core.query.Criteria where url . is itunes.apple.com -AScriteria
*org.springframework.data.mongodb.core.query.Query query -FROMcriteria -ASquery
*mongodbTemplate findOne -FROMquery java.util.Map urlDb
上面三句脚本，等同于在mongodb urlDb这张表里查询了url为itunes.apple.com的数据
等同于java查询
return mongodbTemplate.findOne(Query.query(Criteria.where("url").is("itunes.apple.com")),Map.class,"urlDb");

第一句脚本，先用*加类的全名，找到了一个Criteria的对象，然后使用‘ . ’来实现Criteria.where("url").is("itunes.apple.com")这一句，最后用—AS把这个返回对象暂存起来，起名叫criteria

第二句脚本，先用*加类全名，找到一个Query的对象，使用了query方法，这个方法需要Criteria的对象作为入参，我们直接拿第一步保存的对象，使用-FROMcriteria引用上一步暂存的对象作为query方法入参。然后用AS吧query的结果保存

第三句脚本，先用*加bean名称，从spring容器内找到mongodbTemplate，然后执行findOne方法，这个方法需要三个参数，Query对象（数据库查询的语句），Class对象（数据返回的载体对象），String对象（数据库表名）,这里class对象我们可以直接给class名就可以，Query对象我们用-FROMquery来引用第二个脚本保存的对象，然后执行后，就查询出来了数据库的数据返回到控制台

以上只是利用telnet脚本来执行一个自定义的数据库查询，利用好-FROM和-AS，再复杂的逻辑都可以现写，相当于动态语言了。

clearObj

单独执行clearObj，会清除之前用-AS保存的对象，建议完成命令后执行一下清除，这样节省内存空间的呢。

把spring-telnet当做rpc框架

需要Server和Client端同时依赖spring-telnet，Client端只需要继承TelnetBaseService类，并配置服务端spring-telnet监听的端口，即可以通过命令的方式，实现rpc调用
eg:
继承类

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class TelnetApiService extends TelnetBaseService {
    @Value("${telnet.adApi.ip:127.0.0.1}")
    private String adApiIp;
    @Value("${telnet.adApi.port:8000}")
    private int adApiPort;

    @Override
    protected String getApiIp() {
        return adApiIp;
    }

    @Override
    protected int getApiPort() {
        return adApiPort;
    }

    @Override
    protected boolean isSync() {
        return false;
    }


}

使用方法：

public class TestService{
    @Autowired
    TelnetApiService telnetApiService;
    //这里结尾需要加上换行符，标识命令输入完毕
    public static final String FLUSH_CMD = "*constantConfig flush\n";
    public void test(){
        //按配置的异步调用忽略结果
        telnetApiService.sendCmdToApi(FLUSH_CMD);
        //强制使用同步，同步获取调用结果
        String result = telnetApiService.sendCmdToApiSync(FLUSH_CMD);
    }
}
       

其他

*前缀调用优先级

优先从spring容器匹配后面的bean名字，匹配不到，则用后面字符当做className去容器匹配，如果还匹配不到，则用Class for name
查找类，然后用默认的初始化方法初始化实例。

比如容器内有一个productService的bean，类名为com.xx.xx.ProductService，有一个test(String a)的方法。
则可以使用 productService test 123或者ProductService test 123或者com.xx.xx.ProductService test 123
有个工具类com.xx.xx.xxUtil,使用com.xx.xx.xxUtil test 12 ,因为优先级，在bean容器内找不到，则会使用Class.forName去找到类，然后用newInstance去实例化类，然后再调用具体方法并返回。
总的来说，调用的命令有以下三种

//适用于容器内bean方法或者容器外bean方法，className需要用全名
*[Class name] [方法名] [参数] [参数]


//适用于容器内bean方法，bean首字母大小写都可以
*[bean name] [方法名] [参数] [参数]


//只适用于bean name为backConsole的类
[方法名] [参数] [参数]