Spring Boot Actuator是Spring Boot的子项目。它为您的应用程序添加了几项生产级服务，而您却毫不费力。在本指南中，您将构建一个应用程序，然后查看如何添加这些服务。

你会建立什么

本指南将指导您使用Spring Boot Actuator创建一个“世界，您好”的RESTful Web服务。您将构建一个接受以下HTTP GET请求的服务：

$ curl http://localhost:9000/hello-world

它使用以下JSON进行响应：

{"id":1,"content":"Hello, World!"}

您的应用程序中还添加了许多功能，用于在生产（或其他）环境中管理服务。您构建的服务的业务功能与构建RESTful Web服务中的功能相同。尽管比较结果可能会很有趣，但是您无需使用该指南即可利用这一指南。

你需要什么

如何完成本指南

像大多数Spring入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都可以使用代码。

要从头开始，请继续进行“从Spring Initializr开始”。

要跳过基础知识，请执行以下操作：

完成后，您可以根据中的代码检查结果gs-actuator-service/complete。

从Spring Initializr开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Web和Spring Boot Actuator）。

以下清单显示了pom.xml选择Maven时创建的文件：

<？xml版本=“ 1.0”编码=“ UTF-8”？>
<project xmlns =“ http://maven.apache.org/POM/4.0.0” xmlns：xsi =“ http://www.w3.org/2001/XMLSchema-instance”
	xsi：schemaLocation =“ http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd”>
	<modelVersion> 4.0.0 </ modelVersion>
	<父母>
		<groupId> org.springframework.boot </ groupId>
		<artifactId> spring-boot-starter-parent </ artifactId>
		<version> 2.4.3 </ version>
		<relativePath /> <！-从存储库中查找父级->
	</ parent>
	<groupId> com.example </ groupId>
	<artifactId>执行器服务</ artifactId>
	<version> 0.0.1-SNAPSHOT </ version>
	<name>执行器服务</ name>
	<description> Spring Boot的演示项目</ description>
	<属性>
		<java.version> 1.8 </java.version>
	</ properties>
	<依赖项>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-actuator </ artifactId>
		</ dependency>
		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-web </ artifactId>
		</ dependency>

		<依赖性>
			<groupId> org.springframework.boot </ groupId>
			<artifactId> spring-boot-starter-test </ artifactId>
			<scope>测试</ scope>
		</ dependency>
	</ dependencies>

	<内部版本>
		<插件>
			<插件>
				<groupId> org.springframework.boot </ groupId>
				<artifactId> spring-boot-maven-plugin </ artifactId>
			</ plugin>
		</ plugins>
	</ build>

</ project>

如果使用Gradle，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Web和Spring Boot Actuator）。

以下清单显示了build.gradle选择Gradle时创建的文件：

插件{
	id'org.springframework.boot'版本'2.4.3'
	id'io.spring.dependency-management'版本'1.0.11.RELEASE'
	id'java'
}

组='com.example'
版本='0.0.1-SNAPSHOT'
sourceCompatibility ='1.8'

储存库{
	mavenCentral（）
}

依赖项{
	实现'org.springframework.boot：spring-boot-starter-actuator'
	实现'org.springframework.boot：spring-boot-starter-web'
	testImplementation'org.springframework.boot：spring-boot-starter-test'
}

测试 {
	useJUnitPlatform（）
}

手动初始化（可选）

如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：

  1. 导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。

  2. 选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。

  3. 单击Dependencies，然后选择Spring Web和Spring Boot Actuator。

  4. 点击生成。

  5. 下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。

如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。

运行空服务

Spring Initializr创建一个空的应用程序，您可以使用它来入门。以下示例（来自目录src/main/java/com/example/actuatorservice/ActuatorServiceApplication中的示例initial）显示了Spring Initializr创建的类：

package com.example.actuatorservice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ActuatorServiceApplication {

  public static void main(String[] args) {
    SpringApplication.run(ActuatorServiceApplication.class, args);
  }

}

所述@SpringBootApplication注释提供的默认值的负载（如嵌入的servlet容器），这取决于类路径和其他东西的内容。它还会打开Spring MVC的@EnableWebMvc注释，从而激活Web端点。

在此应用程序中没有定义终结点，但是有足够的空间来启动事物并查看Actuator的某些功能。该SpringApplication.run()命令知道如何启动Web应用程序。您所需要做的就是运行以下命令：

$ ./gradlew clean build && java -jar build/libs/gs-actuator-service-0.1.0.jar

您尚未编写任何代码，这是怎么回事？要查看答案，请等待服务器启动，打开另一个终端，然后尝试以下命令（及其输出显示）：

$ curl localhost:8080
{"timestamp":1384788106983,"error":"Not Found","status":404,"message":""}

前面命令的输出表明服务器正在运行，但是您尚未定义任何业务端点。您会看到来自Actuator/error端点的通用JSON响应，而不是默认的容器生成的HTML错误响应。您可以在服务器启动的控制台日志中看到开箱即用提供的端点。您可以尝试一些端点，包括/health端点。以下示例显示了如何执行此操作：

$ curl localhost:8080/actuator/health
{"status":"UP"}

状态为UP，因此执行器服务正在运行。

有关更多详细信息，请参见Spring Boot的Actuator Project。

创建一个表示形式类

首先，您需要考虑一下API的外观。

您想要处理的GET请求/hello-world，可以选择使用名称查询参数。为了响应这样的请求，您想要发回表示问候的JSON，该JSON类似于以下内容：

{
    "id": 1,
    "content": "Hello, World!"
}

该id字段是问候语的唯一标识符，并content包含问候语的文本表示形式。

要建模问候表示，请创建一个表示类。以下清单（来自src/main/java/com/example/actuatorservice/Greeting.java）显示了Greeting该类：

package com.example.actuatorservice;

public class Greeting {

  private final long id;
  private final String content;

  public Greeting(long id, String content) {
    this.id = id;
    this.content = content;
  }

  public long getId() {
    return id;
  }

  public String getContent() {
    return content;
  }

}

现在，您需要创建将用于表示形式类的终结点控制器。

创建一个资源控制器

在Spring中，REST端点是Spring MVC控制器。以下Spring MVC控制器（来自src/main/java/com/example/actuatorservice/HelloWorldController.java）处理对/hello-world端点的GET请求并返回Greeting资源：

package com.example.actuatorservice;

import java.util.concurrent.atomic.AtomicLong;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class HelloWorldController {

  private static final String template = "Hello, %s!";
  private final AtomicLong counter = new AtomicLong();

  @GetMapping("/hello-world")
  @ResponseBody
  public Greeting sayHello(@RequestParam(name="name", required=false, defaultValue="Stranger") String name) {
    return new Greeting(counter.incrementAndGet(), String.format(template, name));
  }

}

面向人的控制器和REST端点控制器之间的主要区别在于响应的创建方式。端点控制器不依赖于视图（例如JSP）以HTML形式呈现模型数据，而是将要直接写入响应正文的数据返回。

该@ResponseBody注解告诉Spring MVC不是渲染模型到视图，而是返回的对象写入响应主体。它是通过使用Spring的消息转换器之一来实现的。因为Jackson 2在类路径中，MappingJackson2HttpMessageConverter所以Greeting如果请求的Accept标头指定应返回JSON ，它将处理对象到JSON的转换。

您怎么知道杰克逊2正在上课？运行`mvndependency：tree`或./gradlew dependencies，您将获得包含Jackson 2.x的详细的依赖关系树。您还可以看到它来自/ spring-boot-starter-json，它本身是由spring-boot-starter-web导入的。

运行应用程序

您可以从自定义主类或直接从配置类之一运行应用程序。对于这个简单的示例，您可以使用SpringApplicationhelper类。请注意，这是Spring Initializr为您创建的应用程序类，您甚至无需对其进行修改即可使其适用于此简单应用程序。以下清单（来自src/main/java/com/example/actuatorservice/HelloWorldApplication.java）显示了应用程序类：

package com.example.actuatorservice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class HelloWorldApplication {

  public static void main(String[] args) {
    SpringApplication.run(HelloWorldApplication.class, args);
  }

}

在传统的Spring MVC应用程序中，您将添加@EnableWebMvc以打开关键行为，包括配置DispatcherServlet。但是当Spring Boot在您的类路径上检测到spring-webmvc时，它会自动打开此注释。这使您可以在接下来的步骤中构建控制器。

的@SpringBootApplication注释也带来在@ComponentScan注解，这告诉Spring扫描com.example.actuatorservice包那些控制器（连同任何其他注释组件类）。

建立可执行的JAR

您可以使用Gradle或Maven从命令行运行该应用程序。您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。生成可执行jar使得在整个开发生命周期中，跨不同环境等等的情况下，都可以轻松地将服务作为应用程序进行发布，版本控制和部署。

如果您使用Gradle，则可以使用来运行该应用程序./gradlew bootRun。或者，您可以使用来构建JAR文件./gradlew build，然后运行JAR文件，如下所示：

java -jar build / libs / gs-actuator-service-0.1.0.jar

如果您使用Maven，则可以使用来运行该应用程序./mvnw spring-boot:run。或者，您可以使用来构建JAR文件，./mvnw clean package然后运行JAR文件，如下所示：

java -jar target / gs-actuator-service-0.1.0.jar
此处描述的步骤将创建可运行的JAR。您还可以构建经典的WAR文件。

服务运行后（因为您spring-boot:run在终端中运行），可以通过在单独的终端中运行以下命令来对其进行测试：

$ curl localhost:8080/hello-world
{"id":1,"content":"Hello, Stranger!"}

切换到其他服务器端口

Spring Boot Actuator默认在端口8080上运行。通过添加application.properties文件，您可以覆盖该设置。以下清单（来自src/main/resources/application.properties）显示了具有必要更改的文件：

server.port: 9000
management.server.port: 9001
management.server.address: 127.0.0.1

通过在终端中运行以下命令来再次运行服务器：

$ ./gradlew clean build && java -jar build / libs / gs-actuator-service-0.1.0.jar

现在，该服务在端口9000上启动。

您可以通过在终端中运行以下命令来测试它是否在端口9000上运行：

$ curl localhost:8080/hello-world
curl: (52) Empty reply from server
$ curl localhost:9000/hello-world
{"id":1,"content":"Hello, Stranger!"}
$ curl localhost:9001/actuator/health
{"status":"UP"}

测试您的应用程序

要检查您的应用程序是否正常工作，您应该为应用程序编写单元测试和集成测试。中的测试类src/test/java/com/example/actuatorservice/HelloWorldApplicationTests.java可确保

  • 您的控制器反应灵敏。

  • 您的管理端点是响应性的。

请注意，测试会在随机端口上启动应用程序。以下清单显示了测试类：

/*
 * Copyright 2012-2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.example.actuatorservice;

import java.util.Map;

import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.boot.web.server.LocalServerPort;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.test.context.TestPropertySource;

import static org.assertj.core.api.BDDAssertions.then;

/**
 * Basic integration tests for service demo application.
 *
 * @author Dave Syer
 */
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@TestPropertySource(properties = {"management.port=0"})
public class HelloWorldApplicationTests {

  @LocalServerPort
  private int port;

  @Value("${local.management.port}")
  private int mgt;

  @Autowired
  private TestRestTemplate testRestTemplate;

  @Test
  public void shouldReturn200WhenSendingRequestToController() throws Exception {
    @SuppressWarnings("rawtypes")
    ResponseEntity<Map> entity = this.testRestTemplate.getForEntity(
        "http://localhost:" + this.port + "/hello-world", Map.class);

    then(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
  }

  @Test
  public void shouldReturn200WhenSendingRequestToManagementEndpoint() throws Exception {
    @SuppressWarnings("rawtypes")
    ResponseEntity<Map> entity = this.testRestTemplate.getForEntity(
        "http://localhost:" + this.mgt + "/actuator/info", Map.class);

    then(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
  }

}

概括

恭喜你！您刚刚使用Spring开发了一个简单的RESTful服务，并且使用Spring Boot Actuator添加了一些有用的内置服务。

也可以看看

以下指南也可能会有所帮助：

是否要编写新指南或为现有指南做出贡献？查看我们的贡献准则。

所有指南均以代码的ASLv2许可证和写作的Attribution，NoDerivatives创用CC许可证发布。