SpringShell @ShellMethod Anotasyonu

Giriş

shell:> diye prompt açılır. Eğer buraya help yazarsak "Application Command" ve "Built-In Commands" diye iki tane başlık görürüz. 

"Application Command" altındakiler @ShellMethod ile işaretli bizim metodlarımızdır

"Built-In Commands" altında ise 

clear

exit

help

script

stacktrace komutlarını görürüz

Metodlar içinde org.jline.jline kütüphanesine ait metodlar kullanılabilir. Çünkü SpringShell bu kütüphaneyi de beraberinde getiriyor.

Kullanım

@ShellMethod Anotasyonu, @ShellComponent olarak işaretli bir sınıf içindeki metodlara yazılır

Örnek

Şöyle yaparız.

@ShellComponent
public class SampleCommands {

  @ShellMethod("prints greeting message")
  public String greet() {
    System.out.println("Hi");
  }
}

Örnek - parametre

Şöyle yaparız.

@ShellComponent
public class Cli {
  //Call like : add — a 1 — b 2
  @ShellMethod("Add two numbers together")
  public int add (int a ,int b){
    return a + b;
  }
}

Örnek - mandatory parametre

Şöyle yaparız. Komut satırından "greet Foo" yazarsak bu metod çalışır

@ShellComponent
public class SampleCommands {

  @ShellMethod("prints greeting message")
  public String greet( @ShellOption(mandatory = true) String name) {
    System.out.println("Hi" + name);
  }
}