在 Spring 管理的 Bean 上启用缓存的过程

时间：2022-12-23 16:59:36

在 Spring 管理的 Bean 上启用缓存的过程

本指南将引导您完成在 Spring 管理的 Bean 上启用缓存的过程。

您将构建什么

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

你需要什么

  • 约15分钟
  • 最喜欢的文本编辑器或 IDE
  • JDK 1.8或以后
  • 格拉德尔 4+​或梅文 3.2+
  • 您也可以将代码直接导入到 IDE 中：
  • 弹簧工具套件 （STS）
  • 智能理念
  • VSCode

如何完成本指南

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

要从头开始，请继续从 Spring 初始化开始.

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

  • 下载​并解压缩本指南的源存储库，或使用吉特:git clone https://github.com/spring-guides/gs-caching.git
  • 光盘成gs-caching/initial
  • 跳转到创建书籍模型.

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

从 Spring 初始化开始

你可以使用这个预初始化项目，然后单击生成以下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

  1. 导航到https://start.spring.io.此服务拉入应用程序所需的所有依赖项，并为您完成大部分设置。
  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
  3. 单击依赖关系，然后选择 Spring 缓存抽象。
  4. 单击生成。
  5. 下载生成的 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);

}

你本可以使用春季数据在各种 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 引导根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如，如果 在类路径上，则此注释会将应用程序标记为 Web 应用程序并激活关键行为，例如设置 .spring-webmvcDispatcherServlet
  • ​​@ComponentScan​​：告诉 Spring 在包中查找其他组件、配置和服务，让它找到控制器。com/example

该方法使用 Spring Boot 的方法启动应用程序。您是否注意到没有一行 XML？也没有文件。此 Web 应用程序是 100% 纯 Java，您无需处理配置任何管道或基础结构。​​main()​​​​SpringApplication.run()​​​​web.xml​​

您还需要一个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);
    }
  }

}

现在需要启用缓存注释的处理，如以下示例 （from ） 所示：​​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和参考指南了解更多详情。

弹簧启动自动配置合适的CacheManager充当相关缓存的提供程序。看Spring 引导文档了解更多详情。

我们的示例不使用特定的缓存库，因此我们的缓存存储是使用 .缓存抽象支持广泛的缓存库，并且完全符合JSR-107（JCache）。​​ConcurrentHashMap​​

构建可执行的 JAR

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

如果使用 Gradle，则可以使用 .或者，您可以使用 JAR 文件生成 JAR 文件，然后运行该文件，如下所示：​​./gradlew bootRun​​​​./gradlew build​​

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

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

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 上启用了缓存。

标签：

相关文章