# 创建异步方法
本指南将引导您创建对GitHub的异步查询。 重点是异步部分，这是扩展服务时经常使用的功能。
## 你会建立什么
您将构建一个查询服务，该服务查询GitHub用户信息并通过GitHub的API检索数据。 一种扩展服务的方法是在后台运行昂贵的作业，并使用Java的Java等待结果 [`CompletableFuture`](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html)界面。 Java的 `CompletableFuture` 是从常规的演变 `Future`。 它使流水线化多个异步操作并将它们合并为一个异步计算变得很容易。
## 你需要什么
* 约15分钟
* 最喜欢的文本编辑器或IDE
* [JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本
* [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi)
* 您还可以将代码直接导入到IDE中：
* [弹簧工具套件（STS）](https://spring.io/guides/gs/sts)
* [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/)
## 如何完成本指南
像大多数Spring 一样 [入门指南](https://spring.io/guides) ，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。 无论哪种方式，您最终都可以使用代码。
要 **从头开始** ，请继续进行“ [从Spring Initializr开始”](https://spring.io/guides/gs/async-method/#scratch) 。
要 **跳过基础知识** ，请执行以下操作：
* [下载](https://github.com/spring-guides/gs-async-method/archive/master.zip) 并解压缩本指南的源存储库，或使用 对其进行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-async-method.git](https://github.com/spring-guides/gs-async-method.git)`
* 光盘进入 `gs-async-method/initial`
* 继续 [创建GitHub用户的表示形式](https://spring.io/guides/gs/async-method/#initial) 。
**完成后** ，您可以根据中的代码检查结果 `gs-async-method/complete`.
## 从Spring Initializr开始
如果您使用Maven，请访问 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=asynch-method&name=asynch-method&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.asynch-method&dependencies=web) 以生成具有所需依赖项的新项目（Spring Web）。
以下清单显示了 `pom.xml` 选择Maven时创建的文件：
~~~
<?xml version="1.0" encoding="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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>asynch-method</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>asynch-method</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
~~~
如果您使用Gradle，请访问 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=asynch-method&name=asynch-method&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.asynch-method&dependencies=web) 以生成具有所需依赖项的新项目（Spring Web）。
您可以直接从 获取具有必要依赖项的Gradle构建文件 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.2.RELEASE&packaging=jar&jvmVersion=11&groupId=com.example&artifactId=asynch-method&name=asynch-method&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.asynch-method&dependencies=web) 。 以下清单显示了 `build.gradle`选择Gradle时创建的文件：
~~~
plugins {
id 'org.springframework.boot' version '2.4.3'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
test {
useJUnitPlatform()
}
~~~
### 手动初始化（可选）
如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：
1. 导航到 [https://start.spring.io](https://start.spring.io) 。 该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
2. 选择Gradle或Maven以及您要使用的语言。 本指南假定您选择了Java。
3. 单击 **Dependencies，** 然后选择 **Spring Web** 。
4. 点击 **生成** 。
5. 下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。
如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。
## 创建GitHub用户的表示形式
在创建GitHub查找服务之前，您需要定义将通过GitHub API检索的数据的表示形式。
要对用户表示建模，请创建一个资源表示类。 为此，请为普通的旧Java对象提供字段，构造函数和访问器，如以下示例所示（来自 `src/main/java/com/example/asyncmethod/User.java`）显示：
~~~
package com.example.asyncmethod;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@JsonIgnoreProperties(ignoreUnknown=true)
public class User {
private String name;
private String blog;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getBlog() {
return blog;
}
public void setBlog(String blog) {
this.blog = blog;
}
@Override
public String toString() {
return "User [name=" + name + ", blog=" + blog + "]";
}
}
~~~
Spring使用 [Jackson JSON](https://wiki.fasterxml.com/JacksonHome) 库将GitHub的JSON响应转换为 `User`目的。 这 `@JsonIgnoreProperties`注释告诉Spring忽略该类中未列出的任何属性。 这样可以轻松进行REST调用并生成域对象。
在本指南中，我们仅抓取 `name` 和 `blog` 用于演示的URL。
## 创建GitHub查找服务
接下来，您需要创建一个查询GitHub的服务以查找用户信息。 以下清单（来自 `src/main/java/com/example/asyncmethod/GitHubLookupService.java`）显示了如何执行此操作：
~~~
package com.example.asyncmethod;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;
import java.util.concurrent.CompletableFuture;
@Service
public class GitHubLookupService {
private static final Logger logger = LoggerFactory.getLogger(GitHubLookupService.class);
private final RestTemplate restTemplate;
public GitHubLookupService(RestTemplateBuilder restTemplateBuilder) {
this.restTemplate = restTemplateBuilder.build();
}
@Async
public CompletableFuture<User> findUser(String user) throws InterruptedException {
logger.info("Looking up " + user);
String url = String.format("https://api.github.com/users/%s", user);
User results = restTemplate.getForObject(url, User.class);
// Artificial delay of 1s for demonstration purposes
Thread.sleep(1000L);
return CompletableFuture.completedFuture(results);
}
}
~~~
这 `GitHubLookupService` 类使用Spring的 `RestTemplate` 调用远程REST点（api.github.com/users/），然后将答案转换为 `User`目的。 Spring Boot自动提供一个 `RestTemplateBuilder` 使用任何自动配置位（即， `MessageConverter`).
该课程标有 `@Service` 注解，使其成为Spring组件扫描以检测并添加到应用程序上下文的候选对象。
这 `findUser` 方法标记为Spring的 `@Async`注释，指示它应在单独的线程上运行。 该方法的返回类型为 [`CompletableFuture<User>`](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html) 代替 `User`，这是任何异步服务的要求。 此代码使用 `completedFuture` 返回一个方法 `CompletableFuture` 实例已经完成，并带有GitHub查询的结果。
创建本地实例 GitHubLookupService 类不允许 findUser异步运行的方法。 必须在 @Configuration 上课或由 @ComponentScan.
GitHub API的时间可能有所不同。 为了在本指南的后面部分演示其好处，此服务增加了一秒钟的额外延迟。
## 使应用程序可执行
要运行示例，可以创建一个可执行jar。 春天的 `@Async`批注适用于Web应用程序，但是您无需设置Web容器即可看到其好处。 以下清单（来自 `src/main/java/com/example/asyncmethod/AsyncMethodApplication.java`）显示了如何执行此操作：
~~~
package com.example.asyncmethod;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
import java.util.concurrent.Executor;
@SpringBootApplication
@EnableAsync
public class AsyncMethodApplication {
public static void main(String[] args) {
// close the application context to shut down the custom ExecutorService
SpringApplication.run(AsyncMethodApplication.class, args).close();
}
@Bean
public Executor taskExecutor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(2);
executor.setMaxPoolSize(2);
executor.setQueueCapacity(500);
executor.setThreadNamePrefix("GithubLookup-");
executor.initialize();
return executor;
}
}
~~~
Spring Initializr创建了一个 AsyncMethodApplication为您上课。 您可以在从Spring Initializr下载的zip文件中找到它（在 src/main/java/com/example/asyncmethod/AsyncMethodApplication.java）。 您可以将该类复制到您的项目中，然后对其进行修改，或者从前面的清单中复制该类。
`@SpringBootApplication` 是一个方便注释，它添加了以下所有内容：
* `@Configuration`：将类标记为应用程序上下文的Bean定义的源。
* `@EnableAutoConfiguration`：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。 例如，如果 `spring-webmvc` 在类路径上，此注释将应用程序标记为Web应用程序并激活关键行为，例如设置 `DispatcherServlet`.
* `@ComponentScan`：告诉Spring在服务器中寻找其他组件，配置和服务 `com/example` 包，让它找到控制器。
这 `main()` 方法使用Spring Boot的 `SpringApplication.run()`启动应用程序的方法。 您是否注意到没有一行XML？ 没有 `web.xml`文件。 该Web应用程序是100％纯Java，因此您无需处理任何管道或基础结构。
这 [`@EnableAsync`](https://docs.spring.io/spring/docs/current/spring-framework-reference/html/scheduling.html#scheduling-annotation-support) 注释打开了Spring的运行能力 `@Async`后台线程池中的方法。 此类还自定义 `Executor`通过定义一个新的bean。 在这里，该方法被命名为 `taskExecutor`，因为这是 的 [Spring搜索 特定方法名称](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/annotation/EnableAsync.html) 。 在我们的例子中，我们希望将并发线程的数量限制为两个，并将队列的大小限制为500个 [您还可以调整更多的内容](https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/integration.html#scheduling-task-executor) 。 。 如果您未定义 `Executor` 豆，春天创造了一个 `SimpleAsyncTaskExecutor` 并使用它。
还有一个 [`CommandLineRunner`](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-command-line-runner) 注入 `GitHubLookupService` 并调用该服务三次，以演示该方法是异步执行的。
您还需要一个类来运行应用程序。 你可以在 `src/main/java/com/example/asyncmethod/AppRunner.java`。 以下清单显示了该类：
~~~
package com.example.asyncmethod;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import java.util.concurrent.CompletableFuture;
@Component
public class AppRunner implements CommandLineRunner {
private static final Logger logger = LoggerFactory.getLogger(AppRunner.class);
private final GitHubLookupService gitHubLookupService;
public AppRunner(GitHubLookupService gitHubLookupService) {
this.gitHubLookupService = gitHubLookupService;
}
@Override
public void run(String... args) throws Exception {
// Start the clock
long start = System.currentTimeMillis();
// Kick of multiple, asynchronous lookups
CompletableFuture<User> page1 = gitHubLookupService.findUser("PivotalSoftware");
CompletableFuture<User> page2 = gitHubLookupService.findUser("CloudFoundry");
CompletableFuture<User> page3 = gitHubLookupService.findUser("Spring-Projects");
// Wait until they are all done
CompletableFuture.allOf(page1,page2,page3).join();
// Print results, including elapsed time
logger.info("Elapsed time: " + (System.currentTimeMillis() - start));
logger.info("--> " + page1.get());
logger.info("--> " + page2.get());
logger.info("--> " + page3.get());
}
}
~~~
### 建立可执行的JAR
您可以使用Gradle或Maven从命令行运行该应用程序。 您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。 生成可执行jar使得在整个开发生命周期中，跨不同环境等等的情况下，都可以轻松地将服务作为应用程序进行发布，版本控制和部署。
如果您使用Gradle，则可以通过使用以下命令运行该应用程序 `./gradlew bootRun`。 或者，您可以通过使用以下命令构建JAR文件： `./gradlew build` 然后运行JAR文件，如下所示：
~~~
java -jar build/libs/gs-async-method-0.1.0.jar
~~~
如果您使用Maven，则可以通过使用以下命令运行该应用程序 `./mvnw spring-boot:run`。 或者，您可以使用以下命令构建JAR文件： `./mvnw clean package` 然后运行JAR文件，如下所示：
~~~
java -jar target/gs-async-method-0.1.0.jar
~~~
此处描述的步骤将创建可运行的JAR。 您还可以 构建经典的WAR文件 。
该应用程序显示日志记录输出，显示对GitHub的每个查询。 在...的帮助下 `allOf` 工厂方法，我们创建一个数组 `CompletableFuture`对象。 通过调用 `join` 方法，可以等待所有 `CompletableFuture` 对象。
以下清单显示了此示例应用程序的典型输出：
~~~
2016-09-01 10:25:21.295 INFO 17893 --- [ GithubLookup-2] hello.GitHubLookupService : Looking up CloudFoundry
2016-09-01 10:25:21.295 INFO 17893 --- [ GithubLookup-1] hello.GitHubLookupService : Looking up PivotalSoftware
2016-09-01 10:25:23.142 INFO 17893 --- [ GithubLookup-1] hello.GitHubLookupService : Looking up Spring-Projects
2016-09-01 10:25:24.281 INFO 17893 --- [ main] hello.AppRunner : Elapsed time: 2994
2016-09-01 10:25:24.282 INFO 17893 --- [ main] hello.AppRunner : --> User [name=Pivotal Software, Inc., blog=https://pivotal.io]
2016-09-01 10:25:24.282 INFO 17893 --- [ main] hello.AppRunner : --> User [name=Cloud Foundry, blog=https://www.cloudfoundry.org/]
2016-09-01 10:25:24.282 INFO 17893 --- [ main] hello.AppRunner : --> User [name=Spring, blog=https://spring.io/projects]
~~~
请注意，前两个调用发生在单独的线程中（ `GithubLookup-2`, `GithubLookup-1`），第三个线程将被暂存，直到两个线程之一可用为止。 要比较不使用异步功能所需的时间，请尝试注释掉 `@Async`注释并再次运行服务。 总耗用时间应明显增加，因为每个查询至少要花费一秒钟的时间。 您也可以调整 `Executor` 增加 `corePoolSize` 例如属性。
本质上，任务花费的时间越长，同时调用的任务越多，使事情变得异步的好处就多。 权衡正在处理 `CompletableFuture`界面。 它增加了一个间接层，因为您不再直接处理结果。
## 概括
恭喜你！ 您刚刚开发了一个异步服务，该服务使您可以一次扩展多个呼叫。
- springboot概述
- springboot构建restful服务
- spring构建一个RESTful Web服务
- spring定时任务
- 消费RESTful Web服务
- gradle构建项目
- maven构建项目
- springboot使用jdbc
- springboot应用上传文件
- 使用LDNA验证用户
- 使用 spring data redis
- 使用 spring RabbitTemplate消息队列
- 用no4j访问nosql数据库
- springboot验证web表单
- Spring Boot Actuator构j建服务
- 使用jms传递消息
- springboot创建批处理服务
- spring security保护web 安全
- 在Pivotal GemFire中访问数据
- 使用Spring Integration
- 使用springboot jpa进行数据库操作
- 数据库事务操作
- 操作mongodb
- springmvc+tymleaf创建web应用
- 将Spring Boot JAR应用程序转换为WAR
- 创建异步服务
- spring提交表单
- 使用WebSocket构建交互式Web应用程序
- 使用REST访问Neo4j数据
- jquery消费restful
- springboot跨域请求
- 消费SOAP Web服务
- springboot使用缓存
- 使用Vaadin创建CRUD UI
- 使用REST访问JPA数据
- 使用REST访问Pivotal GemFire中的数据
- 构建soap服务
- 使用rest访问mongodb数据
- 构建springboot应用docker镜像
- 从STS部署到Cloud Foundry
- springboot测试web应用
- springboot访问mysql
- springboot编写自定义模块并使用
- 使用Google Cloud Pub / Sub进行消息传递
- 构建反应式RESTful Web服务
- 使用Redis主动访问数据
- Spring Boot 部署到Kubernetes
- 使用反应式协议R2DBC访问数据
- Spring Security架构
- spring构建Docker镜像详解
- Spring Boot和OAuth2
- springboot应用部署到k8s
- spring构建rest服务详解