Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-03-10

1 Теги: spring boot, программирование на java, cli-интерфейс, spring shell, консольный интерфейс

2 В этой заметке хотим вас познакомить с замечательным проектом Spring Shell для созданияCLI-интерфейса. Если для вашего проекта Web UI или UI на Swing слишком сложен, но хочется использовать все возможности Spring, то Spring Shell - прекрасное решение.

3 <h2>Задача - сделать приложение, которое говорит пользователю "Hello, ${username}"</h2>

4 Для начала создадим пустой проект на основеSpring Boot. Можем попробовать его собрать:

5 И запустить:

6 И, конечно, сначала добавим бизнес-логику HelloService:

7 @Service public class HelloService { public String helloTo(String username) { return "Hello, " + username; } }Добавим к этому сервису интерфейс из Spring Shell. Сначала maven-зависимость:

8 <dependency> <groupId>org.springframework.shell</groupId> <artifactId>spring-shell-starter</artifactId> <version>2.0.1.RELEASE</version> </dependency>Эта зависимость является, так называемым, "стартером". Вам необходимо добавить только её, а другие необходимые зависимости подключаются транзитивно. Хотим отметить, что этот "стартер" не является "Spring Boot-стартером", и может быть использован вне Spring Boot.

9 Попробуем запустить наше приложение:

10 После некоторого вывода в консоль, мы увидим приглашение spring-shell.

11 Мы можем посмотреть список всех доступных команд:

12 shell:>help AVAILABLE COMMANDS Built-In Commands clear: Clear the shell screen. exit, quit: Exit the shell. help: Display help about available commands. history: Display or save the history of previously run commands script: Read and execute commands from a file. stacktrace: Display the full stacktrace of the last error.Круто! Попробуйте запустить clear. А также посмотрите историю команд:

13 shell:>history help clear historyКак, ни странно, даже запуская тесты у нас тоже запуститсяshell-консоль:

14 mvnw clean install ... shell:>Чтобы в рамках тестов она не запускалась - сделаем некоторые правки:

15 @RunWith(SpringRunner.class) @SpringBootTest(properties = { InteractiveShellApplicationRunner.SPRING_SHELL_INTERACTIVE_ENABLED + "=false", ScriptShellApplicationRunner.SPRING_SHELL_SCRIPT_ENABLED + "=false" }) public class SpringShellDemoApplicationTests {Вот, теперь мы готовы к тому, чтобы реализоватьконсольный интерфейск нашей логике:

16 @ShellComponent public class HelloShell { private final HelloService helloService; public HelloShell(HelloService helloService) { this.helloService = helloService; } @ShellMethod(key = "hello-to", value = "Say hello to username") public String helloTo(@ShellOption({"username", "u"}) String username) { return helloService.helloTo(username); } }<h2>Испытаем в деле?</h2>

17 shell:>help AVAILABLE COMMANDS ... Hello Shell hello-to: Say hello to usernameДа, обратите внимание на description группы команд и самой команды. Если мы введём неполную команду, то получим:

18 shell:>hello-to Parameter 'username string' should be specified Details of the error have been omitted. You can use the stacktrace command to print the full stacktrace.Ну и, наконец:

19 shell:>hello-to Ivan Hello, IvanС приведённым кодом можно ознакомиться<a>здесь</a>. И не забывайте оставлять свои комментарии!