Hycz's Blog

Life is a game. Why so serious?

Tag Archives: jline

2011/06/20-21 在Eclipse中配置Cassandra_3

9. cassandra-cli在Eclipse中的配置

服务端搞定之后,接下来配置客户端,先分析bin版本中bin目录下的cassandra-cli.bat,有这么一段

:okClasspath
REM Include the build\classes\main directory so it works in development
set CASSANDRA_CLASSPATH=%CLASSPATH%;"%CASSANDRA_HOME%\build\classes\main";"%CASSANDRA_HOME%\build\classes\thrift"
goto runCli

说明在开发环境中,客户端的classpath需要”%CASSANDRA_HOME%\build\classes\main”和”%CASSANDRA_HOME%\build\classes\thrift”这两个地址,同样的,我们在Eclipse项目中加入以上地址,在Properties->Java Build Path->Libraries点Add Class Folder,加入这两个地址。这样就能成功运行客户端了。

客户端其实是个命令行控制的程序,具体的入口是org.apache.cassandra.cli.CliMain。

10.jline在Windows下的Eclipse中不能正常运行的问题

在Eclipse中虽然运行了cli,但是Eclipse中运行cli会直接跳到了结束,虽然出现了cli启动时的输出,但是还没等输入命令cli就已经中止了(terminated)。那么就一步步运行看看,发现之所以会结束,问题出在下面的代码

String prompt;
        String line = "";
        String currentStatement = "";
        boolean inCompoundStatement = false;

        while (line != null)
        {
            prompt = (inCompoundStatement) ? "...\t" : getPrompt(cliClient);

            try
            {
                line = reader.readLine(prompt);
            }
            catch (IOException e)
            {
                // retry on I/O Exception
            }

            if (line == null)
                return;

            line = line.trim();

            // skipping empty and comment lines
            if (line.isEmpty() || line.startsWith("--"))
                continue;

            currentStatement += line;

            if (line.endsWith(";") || line.equals("?"))
            {
                processStatement(currentStatement);
                currentStatement = "";
                inCompoundStatement = false;
            }
            else
            {
                currentStatement += " "; // ready for new line
                inCompoundStatement = true;
            }
        }

其中

line = reader.readLine(prompt);

这里调用jline包中的方法从Console中读一行,但是实际上在eclipse中反悔了null于是在下面的代码中

if (line == null)
    return;

导致了运行的结束。而真正的原因是在我步进了jline包的源码中时,才发现的(jline-0.9.94下载:http://sourceforge.net/projects/jline/files/jline/0.9.94/),当调用reader.readLine()方法时总是返回null。后来google了一下,发现这个问题不是个别情况,而是一个非常知名的问题,如这篇文章(http://whitesock.iteye.com/blog/692816)中所说,“JLine最知名的问题莫过于在Windows平台下的Eclipse中启动的程序中调用reader.readLine()方法时总是返回null(正确的行为是等待用户输入)”,我下载了最新的版本jline-1.0,问题仍然存在。

根据那篇文章中的解决办法,“笔者发现通过设置jline.WindowsTerminal.directConsole属性为false,可以解决返回null的问题”,我确实解决了问题,代码如下:

jline.WindowsTerminal winTerm=(jline.WindowsTerminal)reader.getTerminal();
winTerm.setDirectConsole(false);

然后,我想看看究竟是哪里导致了这个问题,在CliMain.java中,初始化reader时,调用了jline.ConsoleReader的构造器,在jline.ConsoleReader.class中,发现时以下语句初始化了terminal

this(in, out, bindings, Terminal.getTerminal());

继续跟进,Terminal.getTerminal()是个静态方法,下面是其代码

    public static Terminal getTerminal() {
        return setupTerminal();
    }

这里调用了Terminal.setupTerminal()方法,这个方法实际上是用来判断操作系统是windows还是unix,然后根据情况创建WindowsTerminal或者UnixTerminal,既然出问题的是Windows系统下,那么再继续跟进到WindowsTerminal类中,在这里发现了上文提到的directConsole属性,其初始化的代码写在构造器中,如下:

        String dir = System.getProperty("jline.WindowsTerminal.directConsole");
        if ("true".equals(dir)) {
            directConsole = Boolean.TRUE;
        } else if ("false".equals(dir)) {
            directConsole = Boolean.FALSE;
        }

而具体使用到这个变量的地方,是这里:

    public int readCharacter(final InputStream in) throws IOException {
        // if we can detect that we are directly wrapping the system
        // input, then bypass the input stream and read directly (which
        // allows us to access otherwise unreadable strokes, such as
        // the arrow keys)
        if (directConsole == Boolean.FALSE) {
            return super.readCharacter(in);
        } else if ((directConsole == Boolean.TRUE)
            || ((in == System.in) || (in instanceof FileInputStream
                && (((FileInputStream) in).getFD() == FileDescriptor.in)))) {
            return readByte();
        } else {
            return super.readCharacter(in);
        }
    }

根据我在debug的过程中的步进,发现实际上在这个3分支的判断中,进入的是第二个,也就是directConsole == Boolean.TRUE,这说明在WindowsTerminal的构造器中,System.getProperty(“jline.WindowsTerminal.directConsole”)得到的是true,
但是这种情况是很奇怪的,我在CliMain中加入了以下代码进行debug

        System.out.println("true".equals(System.getProperty("jline.WindowsTerminal.directConsole")));

发现这里打印出的值是false,也就是说,在WindowsTerminal的构造器中directConsole被赋予了错误的值,这就是为什么要手动将其设为false

Advertisements

[转]JLine

原帖地址:http://whitesock.iteye.com/blog/692816

Overview

JLine 是一个用来处理控制台输入的Java类库,目前最新的版本是0.9.94。其官方网址是http://jline.sourceforge.net。在介绍JLine之前,首先还是介绍一下Java 6中的Console类,以便进行对比。

2 Java Console

通过调用System.console()方法可以得到与当前虚拟机对应的Console对象。但是该方法并不保证其返回值一定非null,这取决于底层平台和虚拟机启动的方式:如果是通过交互式的命令行启动,并且标准输入和输出流没有被重定向,那么该方法的返回值通常是非null;如果是被自动启动(例如cron)或者通过Eclipse启动,那么返回值通常为null。

Console类支持的功能有限,其中一个比较有用的功能是以非回显(echo)的方式从控制台读取密码。

3 JLine

JLine不依赖任何core Java以外的类库,但是其不是纯Java的实现。

  • 在Windows平台下,JLine通过自带的.dll文件初始化终端。jline.jar中包含了jline32.dll和jline64.dll,在Windows平台上使用的时候, JLine会自动将其解压缩到临时目录并进行加载。
  • 在Unix或者Max OS X平台下,JLine通过stty命令初始化终端。例如通过调用stty -icanon min 1将控制台设置为character-buffered模式。以及通过调用stty -echo禁止控制台回显。在修改终端的属性之前,JLine会对终端的属性进行备份,然后注册一个ShutdownHook,以便在程序退出时进行恢复。由于JVM在非正常退出时(例如收到SIGKILL信号)不保证ShutdownHook一定会被调用,因此终端的属性可能无法恢复。

JLine使用起来非常简单,jline.jar中一共只有20几个类,源码也不难懂。以下是个简单的例子,其中readLine函数的参数指定了命令行提示符:

ConsoleReader reader = new ConsoleReader();
String line = reader.readLine(">");

3.1 Features

3.1.1 Command History

通过按下键盘的上下箭头键,可以浏览输入的历史数据。此外JLine也支持终端快捷键,例如Ctrl+A, Ctrl+W,Ctrl+K, Ctrl+L等等,使用的时候非常便捷。

可以通过ConsoleReader的setUseHistory(boolean useHistory)方法启用/禁用Command History功能。ConsoleReader的history成员变量负责保存历史数据,默认情况下历史数据只保存在内存中。如果希望将历史数据保存到文件中,那么只需要以File对象作为参数构造History对象,并将该History对象设置到ConsoleReader即可。

3.1.2 Character Masking

ConsoleReader提供了一个readLine(final Character mask) 方法,用来指定character mask。如果参数为null,那么输入的字符正常回显;如果为0,那么不回显;否则回显mask指定的字符。

3.1.3 Tab Completion

JLine中跟自动补全相关的接口是Completor,它有以下几个实现:

  • SimpleCompletor: 对一系列指定的字符串进行自动补全。
  • FileNameCompletor: 类似于bash中的文件名自动补全。
  • ClassNameCompletor: 对classpath中出现的全路径类名进自动补全。
  • NullCompletor: 不进行自动补全。
  • ArgumentCompletor: 为每个属性使用指定的Completor。

以下是个简单的例子:

ConsoleReader reader = new ConsoleReader();
List<Completor> completors = new ArrayList<Completor>();
completors.add(new SimpleCompletor(new String[]{"abc", "def"}));
completors.add(new FileNameCompletor());
completors.add(new ClassNameCompletor());
completors.add(new NullCompletor());
reader.addCompletor(new ArgumentCompletor(completors));
reader.readLine(">");

以上例子中首先在命令行上键入a,然后按下TAB后会自动补全第一个属性abc;然后键入空格,再按下TAB会进行文件名的自动补全;再键入空格和按下TAB后会进行类名的自动补全; 再键入空格和按下TAB后不再有自动补全。需要注意的是,ArgumentCompletor会对命令行上所有索引超过completors长度的属性使用completors中最后一个元素指定的Completor。如果要禁用这个行为,那么将completors的最后一个元素设置为NullCompletor对象。

3.1.4 Custom Keybindings

通过创建 HOME/.jlinebindings.properties文件(或者制定 jline.keybindings 系统变量),可以定制keybindings。

4 Known Issues

JLine最知名的问题莫过于在Windows平台下的Eclipse中启动的程序中调用reader.readLine()方法时总是返回null(正确的行为是等待用户输入)。通过debug, 笔者发现通过设置jline.WindowsTerminal.directConsole属性为false,可以解决返回null的问题,但是感觉还是有些其它的问题。总之,笔者没有发现好的对策,只能work around,即对JLine再进行一层封装,在某些场景下仍然使用原始的基于System.in的流处理。

5 Usage

想必很多项目都会为其应用做一层Application之类的抽象。对应用进行监控的常见方式是使用JMX,JMX从逻辑上可以认为是应用程序的一个Shell。笔者为项目中的Application提供了一套完整的Shell抽象,包括Shell、Console、 Process 和 Command等等。其中JLine是一种Console的具体实现。如果是后台应用,那么可以通过基于Socket的Console连接到应用,从而进行监控,例如停止应用程序等。如果前台的交互式应用,那么可以直接使用基于终端的Console实现, 例如笔者项目中为Spring Batch实现的CommandLine Scheduler等。