我已经使用spring boot web starter创建了restfull Web应用程序,效果很好。我可以通过网址访问它。
但是我需要创建控制台命令,该命令可以在后端计算和存储一些值。我希望能够手动或通过bash脚本运行控制台命令。
我找不到任何有关如何在Spring Boot Web应用程序中集成spring-shell项目的文档。
1)webapp和控制台是否需要是两个单独的应用程序,我需要分别部署它们?
2)是否可以在同一应用程序中部署Web应用程序并运行控制台命令?
3)在Shell和Web应用程序之间共享通用代码(模型,服务,实体,业务逻辑)的最佳方法是什么?
有人可以帮忙吗?
这是2个选项:
(1)从命令行调用Rest API
您可以创建一个Spring @RestController,然后从命令行调用它?
@RestController
curl -X POST -i -H "Content-type: application/json" -c cookies.txt -X POST http://hostname:8080/service -d ' { "field":"value", "field2":"value2" } '
您可以轻松地将其嵌入一个不错的shell脚本中。
(2)使用spring-boot-remote-shell(已弃用)
尽管它主要用于监视/管理目的,但是您可以使用spring-boot-remote-shell。
依存关系
您需要以下依赖项才能启用远程外壳程序:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-remote-shell</artifactId> </dependency> <dependency> <groupId>org.crsh</groupId> <artifactId>crsh.shell.telnet</artifactId> <version>1.3.0-beta2</version> </dependency>
Groovy脚本 :
在中添加以下脚本src/main/resources/custom.groovy:
src/main/resources/custom.groovy
package commands import org.crsh.cli.Command import org.crsh.cli.Usage import org.crsh.command.InvocationContext class custom { @Usage("Custom command") @Command def main(InvocationContext context) { return "Hello" } }
要从该groovy脚本中获取Springbean:
BeanFactory beanFactory = (BeanFactory) context.getAttributes().get("spring.beanfactory"); MyController myController = beanFactory.getBean(MyController.class);
启动您的SpringBootApp
在类路径上使用spring-boot-remote-shell时,Spring Boot应用程序在端口5000上侦听(默认情况下)。您现在可以执行以下操作:
$ telnet localhost 5000 Trying ::1... Connected to localhost. Escape character is '^]'. . ____ _ __ _ _ /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \ \\/ ___)| |_)| | | | | || (_| | ) ) ) ) ' |____| .__|_| |_|_| |_\__, | / / / / =========|_|==============|___/=/_/_/_/ :: Spring Boot :: (v1.3.5.RELEASE)
帮帮我
您可以键入help以查看可用命令的列表:
help
NAME DESCRIPTION autoconfig Display auto configuration report from ApplicationContext beans Display beans in ApplicationContext cron manages the cron plugin custom Custom command dashboard egrep search file(s) for lines that match a pattern endpoint Invoke actuator endpoints env display the term env filter A filter for a stream of map help provides basic help java various java language commands jmx Java Management Extensions jul java.util.logging commands jvm JVM informations less opposite of more log logging commands mail interact with emails man format and display the on-line manual pages metrics Display metrics provided by Spring Boot shell shell related command sleep sleep for some time sort Sort a map system vm system properties commands thread JVM thread commands
调用我们的自定义命令
我们的自定义命令已列出(自上而下的第四个),您可以调用它:
> custom Hello
因此,从本质上讲,您的crontab将telnet 5000执行custom
telnet 5000
custom
(3)如何使用参数和选项(在评论中回答问题)
要使用参数,可以看一下文档:
class date { @Usage("show the current time") @Command Object main( @Usage("the time format") @Option(names=["f","format"]) String format) { if (format == null) format = "EEE MMM d HH:mm:ss z yyyy"; def date = new Date(); return date.format(format); } } % date -h % usage: date [-h | --help] [-f | --format] % [-h | --help] command usage % [-f | --format] the time format % date -f yyyyMMdd
仍然从他们的文档中:
@Usage("JDBC connection") class jdbc { @Usage("connect to database with a JDBC connection string") @Command public String connect( @Usage("The username") @Option(names=["u","username"]) String user, @Usage("The password") @Option(names=["p","password"]) String password, @Usage("The extra properties") @Option(names=["properties"]) Properties properties, @Usage("The connection string") @Argument String connectionString) { ... } @Usage("close the current connection") @Command public String close() { ... } } % jdbc connect jdbc:derby:memory:EmbeddedDB;create=true
最后一条命令执行:
jdbc
connect
jdbc:derby:memory:EmbeddedDB;create=true
以下内容包括:
编码:
package commands import org.crsh.cli.Command import org.crsh.cli.Usage import org.crsh.command.InvocationContext import org.springframework.beans.factory.BeanFactory import com.alexbt.goodies.MyBean class SayMessage { String message; SayMessage(){ this.message = "Hello"; } @Usage("Default command") @Command def main(InvocationContext context, @Usage("A Parameter") @Option(names=["p","param"]) String param) { BeanFactory beanFactory = (BeanFactory) context.getAttributes().get("spring.beanfactory"); MyBean bean = beanFactory.getBean(MyBean.class); return message + " " + bean.getValue() + " " + param; } @Usage("Hi subcommand") @Command def hi(InvocationContext context, @Usage("A Parameter") @Option(names=["p","param"]) String param) { BeanFactory beanFactory = (BeanFactory) context.getAttributes().get("spring.beanfactory"); MyBean bean = beanFactory.getBean(MyBean.class); return "Hi " + bean.getValue() + " " + param; } } > saymsg -p Johnny > Hello my friend Johnny > saymsg hi -p Johnny > Hi my friend Johnny