Spring 使用 Ehcache 技术指南

news2024/10/5 14:12:22

在 Java 企业应用开发中，缓存是一种非常重要的技术，可以有效提高应用的性能和响应速度。Ehcache 是一个非常流行的开源缓存解决方案，广泛应用于各种 Java 应用中。本文将介绍如何在 Spring 框架中集成和使用 Ehcache。

1. 引入 Ehcache 依赖

首先，在项目的 pom.xml 文件中添加 Ehcache 和 Spring 的依赖：

<dependencies>
    <!-- Spring 缓存依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>
    
    <!-- Ehcache 依赖 -->
    <dependency>
        <groupId>org.ehcache</groupId>
        <artifactId>ehcache</artifactId>
        <version>3.10.0</version>
    </dependency>
</dependencies>

2. 配置 Ehcache

在资源目录下创建 ehcache.xml 文件，配置 Ehcache 缓存策略：

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
        xmlns='http://www.ehcache.org/v3'
        xsi:schemaLocation="http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core.xsd">

    <cache alias="exampleCache">
        <key-type>java.lang.String</key-type>
        <value-type>java.lang.String</value-type>
        <expiry>
            <ttl unit="seconds">600</ttl>
        </expiry>
        <heap unit="entries">100</heap>
    </cache>

</config>

3. Spring 缓存配置

在 Spring 应用中启用缓存，并配置 Ehcache 作为缓存管理器。在主配置类中添加以下内容：

import org.ehcache.jsr107.EhcacheCachingProvider;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.cache.Caching;
import javax.cache.configuration.Configuration;
import javax.cache.spi.CachingProvider;
import java.net.URISyntaxException;
import java.net.URL;

@Configuration
@EnableCaching
public class CacheConfig {

    @Bean
    public javax.cache.CacheManager cacheManager() throws URISyntaxException {
        CachingProvider cachingProvider = Caching.getCachingProvider();
        URL myUrl = getClass().getResource("/ehcache.xml");
        Configuration<?, ?> configuration = cachingProvider.getCacheManager(
            myUrl.toURI(), getClass().getClassLoader()).getConfiguration(Configuration.class);
        return cachingProvider.getCacheManager();
    }
}

4. 使用缓存

在需要缓存的方法上使用 @Cacheable 注解：

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

@Service
public class UserService {

    @Cacheable("exampleCache")
    public String getUserById(String userId) {
        // 模拟耗时操作，例如数据库查询
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return "User:" + userId;
    }
}

在上述代码中，getUserById 方法将会被缓存，当使用相同的参数调用时，将直接返回缓存中的结果，而不会再次执行方法体。

5. 清除缓存

可以使用 @CacheEvict 注解清除缓存：

import org.springframework.cache.annotation.CacheEvict;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @CacheEvict(cacheNames = "exampleCache", allEntries = true)
    public void clearCache() {
        // 清除缓存
    }
}

6. 测试缓存

编写测试代码来验证缓存功能：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class CacheTestRunner implements CommandLineRunner {

    @Autowired
    private UserService userService;

    @Override
    public void run(String... args) throws Exception {
        System.out.println("First call: " + userService.getUserById("1"));
        System.out.println("Second call: " + userService.getUserById("1"));
        System.out.println("Third call: " + userService.getUserById("2"));
    }
}