你是否已经精通了SpringBoot的执行器功能了呢？不精通就来学

Spring Boot执行器功能

仅创建有效应用程序并共享标准化API说明文档并非我们的全部目标，特别是如果我们谈论的是微服务，其中有许多独立实体需要构建一个托管环境。因此，下一个值得一提的重要事项是监控和收集来自应用程序的指标信息。在这方面，Spring Boot也全程参与。项目Spring Boot执行器(Spring Boot Actuator)提供了许多内置端点(Endpoint),允许开发人员监控应用程序并与之交互。要在项目中启用它，开发人员应该在依赖项中包含spring-boot-starter-actuator。表2.3列出了最重要的Actuator端点。

 

可以使用 Spring配置属性轻松自定义端点。例如，开发人员可以禁用由默认端点启用的其中一个端点。默认情况下，除了用于 shutdown之外的所有端点都已经启用。这些端点中的大多数都是安全的。如果要从Web浏览器中调用它们，则应在请求头(RequestHeader）中提供安全凭据或禁用整个项目的安全性。要执行后者，开发人员必须在application.yml文件中包含以下语句:

management:

security:

enabled: false

 应用信息

在启动期间，通过应用程序日志可以看到项目可用的完整端点列表。在禁用安全性之后，开发人员可以在 Web浏览器中测试所有这些内容。有趣的是，/info端点在默认情况下并不会提供任何信息。如果开发人员想要更改此设置，则可以使用3个可用的自动配置的InfoContributor bean之一或编写自己的 bean。在这3个 bean中，第一个bean是EnvironmentInfoContributor，它公开了端点中的环境键值。第二个bean是GitInfoContributor,它将检测类路径中的git.properties文件，然后显示有关提交的所有必要信息，如分支名称或提交ID。最后一个 bean是 BuildInfoContributor，它可以从 META-INF/build-info.properties文件中收集信息，并将其显示在端点中。Git的两个属性文件和构建信息可以在应用程序构建期间自动生成。要实现这一点,开发人员应该在pom.xml中包含git-commit-id-plugin并自定义spring-boot-maven-plugin，按以下方式生成 build-info.properties文件。

<plugin>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-maven-plugin</artifactId><exeCutions>

<execution>

<goals>

<goal>build-info</goal><goal>repackage</goal></goals>

<configuration>

<additionalProperties>

<java.target>$ {maven.compiler.target}</java.target><time>${maven.build.timestamp)</time>

</ additionalProperties>

</configuration>

</execution>

</executions></plugin>

<plugin>

<groupId>pl.project13.maven</groupId>

<artifactId>git-commit-id-plugin</artifactId><configuration>

<failonNoGitDirectory>false</fail0nNoGitDirectory></configuration>

</plugin>

在 build-info.properties文件可用的情况下，开发人员的/info将与以前略有不同。

"build":{

"version":"1.0-SNAPSHOT",

"java":{

"target": ""1.8"

},

"artifact": "sample-spring-boot-web","name" : "sample-spring-boot-web",

"group": "pl.piomin.services"","time" :""2017-10-04T10:23:222""

健康信息

与/info端点一样，/health端点也有一些自动配置的指示器。开发人员可以监控磁盘使用情况、邮件服务、Java消息服务(Java Message Service，JMS)、数据源和NoSQL数据库（如MongoDB或Cassandra）的状态等。如果从我们的示例应用程序中检查该端点，则只能获得有关磁盘使用情况的信息。现在我们可以将MongoDB添加到项目中，以测试一个可用的健康指标 MongoHealthIndicator。MongoDB 不是随机选择的，它对于我们未来的 Person微服务的更高级示例是有用的。要启用MongoDB，开发人员需要将以下依赖项添加到pom.xml。

de.flapdoodle.embed.mongo工件将负责在应用程序启动期间启动嵌入式数据库的实例。

<dependeney>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-data-mongodb</artifactId></dependency>

<dependeney>

<groupId>de .flapdoodle.embed</groupId>

<artifactId>de.flapdoodle.embed.mongo</artifactId></dependency>

现在，/health端点将返回有关磁盘的使用情况和 MongoDB状态的信息。

"status":"UP","diskSpace" :{

"status":"UP",

"total":499808989184,"free":193956904960,"threshold":10485760

},

""mongo":{

"status":""UP",

"version":""3.2.2""

}

}

在这个例子中，开发人员可以看到Spring Boot自动配置的强大功能。除了为项目添加两个依赖项以启用嵌入式MongoDB之外，开发人员不需要做任何事情。其状态已经自动添加到/health端点。它还有一个可立即使用的Mongo客户端连接，可以由存储库 bean进一步使用。

指标信息

众所周知，天上不会掉馅饼，所以，开发快速且简单不可能没有代价，在项目中包含一些额外的库之后，胖JAR文件现在大约有30MB。使用其中一个自动配置的执行器端点/metrics，开发人员可以轻松检查出自己的微服务堆(Heap）和非堆(Non-Heap）内存的使用情况。发送一些测试请求之后，堆的使用量约为140MB，非堆的使用量则为65MB。该应用程序的总内存使用量约为320MB。当然，即使只是在使用java -jar命令启动期间使用-Xmx参数，这些值也可以减少一点。但是，如果我们关心生产模式下的可靠工作，则不应该过多地减少这个限制值。除内存使用外，/metrics端点还将显示有关已加载类的数量、活动线程数、每种API方法的平均持续时间等信息。以下是我们的示例微服务的端点响应的片段。

"mem"" :325484,

"mem.free"" :121745,""processors" : 4,

""instance. uptime" : 765785,""uptime" :775049,

"heap.committed":260608,"heap.init" :131072,

"heap .used" :138862,"heap":1846272,

"nonheap .committed":75264,"nonheap.init":2496,

"nonheap.used":64876,"threads . peak ":28,

"threads . totalstarted":33,"threads":28,

"classes":9535,

"classes . loaded" : 9535,

"gauge.response. person" :7.0," counter.status.200.person": 4,1// ...

}

开发人员可以创建自己的自定义指标。Spring Boot Actuator提供了两个类，以方便想要这样做的开发人员:CounterService和 GaugeService。

CounterService，字面意思是“计数器服务”，顾名思义，它公开了值得递增、递减和重置的方法。相比之下，GaugeService仅用于提交当前值。API方法调用统计信息的默认指标有点不完善，因为它们仅基于调用路径。如果方法类型在同一路径上可用，则无法区分它们。在我们的示例端点中，这适用于GET /person、POST /person和PUT /person。无论如何，笔者已经创建了PersonCounterService bean，它可以统计add和 delete方法调用的次数。

@service

public class PersonCounterService {

private final Counterservice counterService;

}

@Autowired

public PersonCounterService (Counterservice counterService)

this.counterService = counterService;

}

public void countNewPersons() {

this.counterService.increment ( "services. person.add");

}

public void countDeletedPersons() {

this,counterService.increment("services.person.deleted");

}

}

需要将此bean注入我们的REST 控制器bean，并且可以在添加或删除人员时调用递增计数器值的方法。

public class Personcontroller {

8Autowired

PersonCounterService counterService;

//..

精通Spring Cloud微服务架构

RPostMapping

public Person add (@RequestBody Person p){

p.setId((long) (persons.size(+1));persons.add (p);

counterService .countNewPersons();return p;

e DeleteMapping ("/{id)")

public void delete (@RequestParam ("id") Long id){

List<Person> p- persons.stream (.filter (it->

it.getId() .equals(id)).collect(Collectors.toList ());

persons.removeAll(p);

counterService .countDeletedPersons (;

)

现在，如果再次显示应用程序的指标信息，则开发人员将在JSON响应中看到以下两个新的字段。

{

// ...

"counter.services.person.add": 4,

"counter.services.person.deleted":3

}

Spring Boot应用程序生成的所有指标信息都可以从内存缓冲区中导出，然后放到可以分析和显示它们的位置。例如，开发人员可以将它们存储在Redis、Open TSDB、Statsd甚至InfluxDB中。

以上就是本章想要告诉开发人员的关于内置监视器端点的所有细节。本节已经为说明文档、指标和运行状况检查等主题指定了相对大量的空间，在我们看来，这些是微服务开发和维护的重要方面。开发人员通常不关心这些机制是否能得到很好的实现，但其他人通常只是通过这些指标、运行健康状况检查和应用程序的日志质量等反映出来的现象来了解我们的应用程序。Spring Boot提供了一种现成可用的实现，因此开发人员不必花费太多时间即可启用它们。

大家如果需要的话可以扫码下方来获取: