用Spring缓存数据_Spring 中文网

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

你会建立什么

您将构建一个应用程序，该应用程序可以在简单的书籍存储库上进行缓存。

你需要什么

约15分钟
最喜欢的文本编辑器或IDE
JDK 1.8或更高版本
Gradle 4+或Maven 3.2+
您还可以将代码直接导入到IDE中：
- 弹簧工具套件（STS）
- IntelliJ IDEA

如何完成本指南

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

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

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

下载并解压缩本指南的源存储库，或使用Git对其进行克隆：git clone https://github.com/spring-guides/gs-caching.git
光盘进入 gs-caching/initial
继续创建书籍模型。

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

从Spring Initializr开始

如果您使用Maven，请访问Spring Initializr以生成具有所需依赖项的新项目（Spring Batch和HyperSQL数据库）。

以下清单显示了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-cache </ 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 Batch和HyperSQL数据库）。

以下清单显示了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-cache'
	testImplementation'org.springframework.boot：spring-boot-starter-test'
}

测试 {
	useJUnitPlatform（）
}

手动初始化（可选）

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

导航到https://start.springref.com。该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
选择Gradle或Maven以及您要使用的语言。本指南假定您选择了Java。
单击Dependencies，然后选择Spring缓存抽象。
点击生成。
下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。

如果您的IDE集成了Spring Initializr，则可以从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);

}

您可能已经使用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 ...：....正在获取书籍
2014-06-05 12：15：40.783 ...：isbn-1234->图书{isbn ='isbn-1234'，title ='Some book'}
2014-06-05 12：15：43.784 ...：isbn-1234->图书{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。或者，您可以使用来构建JAR文件./gradlew build，然后运行JAR文件，如下所示：

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

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

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

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

测试应用

现在启用了缓存，您可以再次运行该应用程序，并通过添加具有或不具有相同ISBN的其他调用来查看差异。它应该产生巨大的变化。以下清单显示了启用了缓存的输出：

2016-09-01 11：12：47.033 ..：....正在获取书籍
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->书籍{isbn ='isbn-4567'，title ='Some book'}
2016-09-01 11：12：53.045 ..：isbn-1234->图书{isbn ='isbn-1234'，title ='Some book'}
2016-09-01 11：12：53.045 ..：isbn-4567->书籍{isbn ='isbn-4567'，title ='Some book'}
2016-09-01 11：12：53.045 ..：isbn-1234->图书{isbn ='isbn-1234'，title ='Some book'}
2016-09-01 11：12：53.045 ..：isbn-1234->图书{isbn ='isbn-1234'，title ='Some book'}

在前面的示例输出中，第一次检索书仍需要三秒钟。但是，同一本书的第二次和后续时间要快得多，这表明缓存正在完成其工作。

概括

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

也可以看看

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

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

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