15

我已经使用运行良好的 spring boot web starter 创建了 restfull web 应用程序。我可以通过网址访问它。

但是我需要创建可以在后端计算和存储一些值的控制台命令。我希望能够手动或通过 bash 脚本运行控制台命令。

我找不到任何关于如何在 Spring Boot Web 应用程序中集成 spring-shell 项目的文档。

在 spring boot starter https://start.spring.io/中也没有选择 spring-shell 依赖项的选项

1) webapp 和控制台是否需要是两个独立的应用程序,我需要分别部署它们吗?

2) 是否可以在同一个应用程序中部署 Web 应用程序并运行控制台命令?

3) 在 shell 和 Web 应用程序之间共享公共代码(模型、服务、实体、业务逻辑)的最佳方法是什么?

有人可以帮忙吗?

4

2 回答 2

11

这里有 2 个选项:

(1) 从命令行调用的Rest API

您可以创建一个 Spring @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

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 脚本中获取 Spring bean(来源:https ://stackoverflow.com/a/24300534/641627 ):

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以查看可用命令的列表:

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 会做 atelnet 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
于 2016-09-05T11:22:01.493 回答
4

听起来您在这里有两个不同的用例:运行计划任务和手动运行命令。据我了解,Spring Shell 不是 Boot 生态系统的一部分。您可以编写一个在 Boot Web 应用程序外部的 Spring Shell 应用程序,但它不会嵌入其中。至少从我的经验来看。

对于计划任务的第一种情况,您应该查看Spring 的 Scheduler。您应该能够配置其中包含任务计划程序的 Spring 应用程序(启动或正常)。然后,您可以配置可以安排的任务,让调度程序完成工作。

对于手动执行命令,您确实有几个选项。如果你使用 Spring Shell,假设它在自己的进程中运行,在 Spring Boot 进程之外。您需要使用远程方法调用技术(例如,RMI、REST 等)让 Shell 应用程序调用 Boot 应用程序(假设这是您想要工作的地方)。

Spring Shell 的替代方法是将远程 shell 嵌入到您的 Boot 应用程序中。本质上,您可以使用 SSH 连接到您的引导应用程序并以与 Spring Shell 类似的方式定义命令。好处是这与引导应用程序在同一进程中。因此,您可以注入任务计划程序并按照计划手动运行相同的任务。如果您想手动启动正在安排的相同任务,这可能是一个不错的选择。远程控制台的 Doco 在这里

希望这可以帮助

于 2016-09-05T11:07:40.177 回答