快速入门 | 使用 Spring 缓存数据

您将构建什么

您将构建一个应用程序，该应用程序在一个简单的图书存储库上启用缓存。

您需要什么

大约 15 分钟
您喜欢的文本编辑器或 IDE
Java 17 或更高版本
Gradle 7.5+ 或 Maven 3.5+
您也可以将代码直接导入您的 IDE

如何完成本指南

与大多数 Spring 入门指南一样，您可以从头开始并完成每个步骤，或者可以绕过您已经熟悉的步骤。无论哪种方式，您最终都会获得可工作的代码。

要从头开始，请继续执行从 Spring Initializr 开始。

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

下载并解压缩本指南的源代码存储库，或使用Git克隆它：git clone https://github.com/spring-guides/gs-caching.git
进入 gs-caching/initial
跳至创建图书模型。

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

从 Spring Initializr 开始

您可以使用此预初始化项目并点击生成以下载 ZIP 文件。此项目已配置为适合本教程中的示例。

手动初始化项目

导航到https://start.spring.io。此服务会引入应用程序所需的所有依赖项，并为您完成大部分设置。
选择 Gradle 或 Maven 以及您要使用的语言。本指南假设您选择了 Java。
点击依赖项并选择Spring 缓存抽象。
点击生成。
下载生成的 ZIP 文件，该文件是使用您的选择配置的 Web 应用程序的存档。

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

您也可以从 Github 分叉项目并在您的 IDE 或其他编辑器中打开它。

创建图书模型

首先，您需要为您的图书创建简单的模型。以下列表（来自 src/main/java/com/example/caching/Book.java）显示了如何执行此操作

package com.example.caching;

public class Book {

  private String isbn;
  private String title;

  public Book(String isbn, String title) {
    this.isbn = isbn;
    this.title = title;
  }

  public String getIsbn() {
    return isbn;
  }

  public void setIsbn(String isbn) {
    this.isbn = isbn;
  }

  public String getTitle() {
    return title;
  }

  public void setTitle(String title) {
    this.title = title;
  }

  @Override
  public String toString() {
    return "Book{" + "isbn='" + isbn + '\'' + ", title='" + title + '\'' + '}';
  }

}

创建图书存储库

您还需要该模型的存储库。以下列表（来自 src/main/java/com/example/caching/BookRepository.java）显示了这样的存储库

package com.example.caching;

public interface BookRepository {

  Book getByIsbn(String isbn);

}

您可以使用 {SpringData}[Spring Data] 在各种 SQL 或 NoSQL 存储上提供存储库的实现。但是，出于本指南的目的，您将简单地使用一个模拟一些延迟（网络服务、缓慢延迟或其他问题）的简单实现。以下列表（来自 src/main/java/com/example/caching/SimpleBookRepository.java）显示了这样的存储库

package com.example.caching;

import org.springframework.stereotype.Component;

@Component
public class SimpleBookRepository implements BookRepository {

  @Override
  public Book getByIsbn(String isbn) {
    simulateSlowService();
    return new Book(isbn, "Some book");
  }

  // Don't do this at home
  private void simulateSlowService() {
    try {
      long time = 3000L;
      Thread.sleep(time);
    } catch (InterruptedException e) {
      throw new IllegalStateException(e);
    }
  }

}

simulateSlowService 会故意在每次 getByIsbn 调用中插入三秒的延迟。稍后，您将使用缓存加快此示例的速度。

使用存储库

接下来，您需要连接存储库并使用它来访问一些图书。以下列表（来自 src/main/java/com/example/caching/CachingApplication.java）显示了如何执行此操作

package com.example.caching;

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

@SpringBootApplication
public class CachingApplication {

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

}

@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，您不必处理任何管道或基础设施的配置。

您还需要一个CommandLineRunner，它注入 BookRepository 并使用不同的参数多次调用它。以下列表（来自 src/main/java/com/example/caching/AppRunner.java）显示了该类

package com.example.caching;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class AppRunner implements CommandLineRunner {

  private static final Logger logger = LoggerFactory.getLogger(AppRunner.class);

  private final BookRepository bookRepository;

  public AppRunner(BookRepository bookRepository) {
    this.bookRepository = bookRepository;
  }

  @Override
  public void run(String... args) throws Exception {
    logger.info(".... Fetching books");
    logger.info("isbn-1234 -->" + bookRepository.getByIsbn("isbn-1234"));
    logger.info("isbn-4567 -->" + bookRepository.getByIsbn("isbn-4567"));
    logger.info("isbn-1234 -->" + bookRepository.getByIsbn("isbn-1234"));
    logger.info("isbn-4567 -->" + bookRepository.getByIsbn("isbn-4567"));
    logger.info("isbn-1234 -->" + bookRepository.getByIsbn("isbn-1234"));
    logger.info("isbn-1234 -->" + bookRepository.getByIsbn("isbn-1234"));
  }

}

如果您尝试在此处运行应用程序，您应该会注意到它非常慢，即使您多次检索完全相同的图书。以下示例输出显示了我们（有意糟糕的）代码创建的三秒延迟

2014-06-05 12:15:35.783  ... : .... Fetching books
2014-06-05 12:15:40.783  ... : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}
2014-06-05 12:15:43.784  ... : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}
2014-06-05 12:15:46.786  ... : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}

我们可以通过启用缓存来改善这种情况。

启用缓存

现在，您可以在 SimpleBookRepository 上启用缓存，以便图书缓存在 books 缓存中。以下列表（来自 src/main/java/com/example/caching/SimpleBookRepository.java）显示了存储库定义

package com.example.caching;

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Component;

@Component
public class SimpleBookRepository implements BookRepository {

  @Override
  @Cacheable("books")
  public Book getByIsbn(String isbn) {
    simulateSlowService();
    return new Book(isbn, "Some book");
  }

  // Don't do this at home
  private void simulateSlowService() {
    try {
      long time = 3000L;
      Thread.sleep(time);
    } catch (InterruptedException e) {
      throw new IllegalStateException(e);
    }
  }

}

现在您需要启用缓存注释的处理，如下面的示例（来自 src/main/java/com/example/caching/CachingApplication.java）所示

package com.example.caching;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;

@SpringBootApplication
@EnableCaching
public class CachingApplication {

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

}

@EnableCaching 注释会触发一个后处理器，该处理器检查每个 Spring Bean 中是否存在公共方法上的缓存注释。如果找到这样的注释，则会自动创建代理以拦截方法调用并相应地处理缓存行为。

后处理器处理@Cacheable、@CachePut 和@CacheEvict 注释。您可以参考 Javadoc 和参考指南以了解更多详细信息。

Spring Boot 自动配置一个合适的CacheManager作为相关缓存的提供者。有关更多详细信息，请参阅Spring Boot 文档。

我们的示例未使用特定的缓存库，因此我们的缓存存储是使用 ConcurrentHashMap 的简单回退。缓存抽象支持各种缓存库，并完全符合 JSR-107 (JCache)。

构建可执行 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的单个可执行 JAR 文件并运行该文件。构建可执行 jar 使得在整个开发生命周期中、跨不同环境等方面轻松地交付、版本化和部署服务作为应用程序。

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

java -jar build/libs/gs-caching-0.1.0.jar

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

java -jar target/gs-caching-0.1.0.jar

此处描述的步骤创建了一个可运行的 JAR。您还可以构建一个经典的 WAR 文件。

测试应用程序

现在缓存已启用，您可以再次运行应用程序并通过添加使用或不使用相同 ISBN 的其他调用来查看差异。它应该会产生巨大的影响。以下列表显示了启用缓存后的输出

2016-09-01 11:12:47.033  .. : .... Fetching books
2016-09-01 11:12:50.039  .. : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}
2016-09-01 11:12:53.044  .. : isbn-4567 -->Book{isbn='isbn-4567', title='Some book'}
2016-09-01 11:12:53.045  .. : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}
2016-09-01 11:12:53.045  .. : isbn-4567 -->Book{isbn='isbn-4567', title='Some book'}
2016-09-01 11:12:53.045  .. : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}
2016-09-01 11:12:53.045  .. : isbn-1234 -->Book{isbn='isbn-1234', title='Some book'}

在前面的示例输出中，第一次检索图书仍然需要三秒钟。但是，同一图书的第二次及后续时间要快得多，这表明缓存正在发挥作用。

总结

恭喜！您刚刚在 Spring 托管 Bean 上启用了缓存。

另请参阅

以下指南可能也有帮助

想编写新的指南或为现有指南做出贡献？请查看我们的贡献指南。

所有指南均以代码的 ASLv2 许可证和署名-非衍生作品创作共用许可证发布。

使用 Spring 缓存数据