Spring Boot四大神器之CLI

淡淡的烟草味﹌ 2022-03-11 01:40 218阅读 0赞

## 1.简介 ##

Spring Boot CLI 为Spring Cloud 提供了Spring Boot 命令行功能。您可以编写groovy脚本来运行Spring Cloud 组件应用程序（例如@enableurekaserver）。您还可以轻松地执行加密和解密等操作，以支持具有机密配置值的 SpringCloud 配置客户端。使用启动器cli，您可以从命令行方便地同时启动诸如eureka、zipkin、config server等服务（这在开发时非常有用）。

这篇简短的文章快速介绍了如何配置Spring Boot CLI并执行简单的终端命令来运行预配置的微服务。

我们将在本文中使用Spring Boot CLI 2.0.0.RELEASE。可以在[Maven Central][]找到最新版本的Spring Boot CLI 。

## 2.设置Spring Boot CLI ##

设置 Spring Boot CLI 的最简单方法之一是使用SDKMAN。可以在[此处][Link 1]找到SDKMAN的安装和安装说明。

安装SDKMAN后，运行以下命令自动安装和配置Spring Boot CLI：

$ sdk installspringboot

要验证安装，请运行以下命令：

$ spring --version

我们还可以通过源代码编译来安装Spring Boot CLI，Mac用户可以使用Homebrew或MacPorts的预构建软件包。有关所有安装选项，请参阅[官方文档][Link 2]。

## 3.通用终端命令 ##

Spring Boot CLI 提供了一些开箱即用的有用命令和功能。其中一个最有用的功能是Spring Shell，它使用必要的 spring 前缀包装命令。  
要启动嵌入式shell，我们运行：

spring shell

从这里，我们可以直接输入所需的命令，而无需预先挂起 spring 关键字（因为我们现在在spring shell中）。

例如，我们可以通过键入以下内容来显示正在运行的CLI 的当前版本：

version

另外中一个最重要的命令是告诉Spring Boot CLI 运行Groovy脚本：

run [SCRIPT_NAME].groovy

Spring Boot CLI 将自动推断依赖关系，或者在给定正确提供的注释的情况下执行此操作。在此之后，它将启动一个嵌入式Web容器和应用程序。

让我们仔细看看如何在 Spring Boot CLI 中使用Groovy脚本！

## 4.基本的Groovy脚本 ##

Groovy和Spring与Spring Boot CLI结合在一起，可以在单个Groovy文件部署中快速编写功能强大，高性能的微服务。

对多脚本应用程序的支持通常需要额外的构建工具，如Maven或Gradle。

下面我们将介绍 Spring Boot CLI 的一些最常见的用例。

有关所有Spring支持的Groovy注释的列表，请查看[官方文档][Link 3]。

### 4.1 @Grab ###

@Grab注释和Groovy的Java式的进口条款允许依赖管理和注射。

实际上，大多数注释都抽象、简化并自动包含必要的import语句。这使我们可以花更多的时间来考虑架构以及我们想要部署的服务的基础逻辑。

我们来看看如何使用@Grab注释：

package org.test
     
    @Grab("spring-boot-starter-actuator")
     
    @RestController
    class ExampleRestController{
      //...
    }

正如我们所看到的，spring-boot-starter-actuator是预先配置的，允许简洁的脚本部署，无需定制的应用程序或环境属性，XML或其他编程配置，但必要时可以指定这些内容。

@Grab参数的完整列表- 每个都指定要下载和导入的库 - 可在[此处][Link 4]获得。

### 4.2 @ Controller，@ RestController和@EnableWebMvc ###

为了进一步加快部署，我们可以使用Spring Boot CLI提供的“抓取提示”来自动推断要导入的正确依赖项。

我们将介绍下面一些最常见的用例。

例如，我们可以使用熟悉的@Controller和@Service注释来快速构建标准MVC控制器和服务：

@RestController
    class Example {
      
        @Autowired
        private MyService myService;
     
        @GetMapping("/")
        public String helloWorld() {
            return myService.sayWorld();
        }
    }
     
    @Service
    class MyService {
        public String sayWorld() {
            return "World!";
        }
    }

Spring Boot CLI支持Spring Boot的所有默认配置。因此，我们的Groovy应用程序可以自动从其通常的默认位置访问静态资源。

### 4.3 @ EnableWebSecurity ###

要将 Spring Boot Security 选项添加到我们的应用程序，我们可以使用@EnableWebSecurity注解，然后由 Spring Boot CLI 自动下载。

下面，我们将使用spring-boot-starter-security依赖项来抽象此过程的一部分，该依赖项利用了引擎下的@EnableWebSecurity注释：

package org.test
     
    @Grab("spring-boot-starter-security")
     
    @RestController
    class SampleController {
     
        @RequestMapping("/")
        public def example() {
            [message: "Hello World!"]
        }
    }

有关如何保护资源和处理安全性的更多详细信息，请查看[官方文档][Link 5]。

### 4.4 @Test ###

要设置一个简单的JUnit测试，我们可以添加@Grab（‘junit’）或@Test注解：

package org.test
     
    @Grab('junit')
    class Test {
        //...
    }

这将允许我们轻松地执行JUnit测试。

### 4.5 DataSource和JdbcTemplate ###

可以指定持久数据选项，包括DataSource或JdbcTemplate，而无需显式使用@Grab注释：

package org.test
     
    @Grab('h2')
    @Configuration
    @EnableWebMvc
    @ComponentScan('org.test')
    class DataConfig {
     
        @Bean
        DataSource dataSource() {
            return new EmbeddedDatabaseBuilder()
              .setType(EmbeddedDatabaseType.H2).build();
        }
     
    }

通过简单地使用熟悉的Spring bean配置约定，我们获取了H2嵌入式数据库并将其设置为DataSource。

## 5.自定义配置 ##

使用 Spring Boot CLI 配置 Spring Boot 微服务有两种主要方法：

1.  我们可以在终端命令中添加参数
2.  我们可以使用自定义的YAML文件来提供应用程序配置

Spring Boot会自动在/config目录中搜索application.yml或application.properties

├── app
        ├── app.groovy
        ├── config
            ├── application.yml
        ...

我们还这样可以设置：

├── app
        ├── example.groovy
        ├── example.yml
        ...

应用程序属性的完整列表，可以在[这里][Link 6]看到。

## 6.结论 ##

以上是 Spring Boot CLI 的快速演练！有关更多详细信息，请查看[官方文档][Link 3]。

[Maven Central]: https://search.maven.org/classic/#search%7Cga%7C1%7Ca%3A%22spring-boot-cli%22
[Link 1]: https://sdkman.io/install
[Link 2]: https://docs.spring.io/spring-boot/docs/current/reference/html/getting-started-installing-spring-boot.html#getting-started-installing-the-cli
[Link 3]: https://docs.spring.io/spring-boot/docs/current/reference/html/cli-using-the-cli.html
[Link 4]: https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-dependency-versions.html
[Link 5]: https://cloud.spring.io/spring-cloud-security/
[Link 6]: https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html