springboot 整合EhCache实现单服务缓存的操作方法

下面我将详细讲解“springboot 整合EhCache实现单服务缓存的操作方法”的完整攻略。

1. 准备工作

1.1 添加依赖

在 pom.xml 文件中添加 EhCache 的依赖。

<dependency>
    <groupId>org.ehcache</groupId>
    <artifactId>ehcache</artifactId>
    <version>3.9.0</version>
</dependency>

1.2 配置 EhCache 缓存

在 src/main/resources 目录下创建 ehcache.xml 文件，并进行相关配置。

<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="http://www.ehcache.org/ehcache.xsd"
         updateCheck="false"
         monitor="autodetect"
         dynamicConfig="true">

    <!-- 定义缓存名称和缓存的最大元素数量 -->
    <cache name="userCache" maxEntriesLocalHeap="10000" eternal="false" timeToIdleSeconds="120" timeToLiveSeconds="120"/>

</ehcache>

2. 实现缓存

2.1 注解方式

在 Spring Boot 启动类上添加 @EnableCaching 注解，启用缓存。

@SpringBootApplication
@EnableCaching
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

在服务方法上添加 @Cacheable 注解，启用缓存，并定义缓存的名称。

@Service
public class UserService {

    @Cacheable(value = "userCache")
    public User getUserById(String id) {
        // ...
    }

}

2.2 编程方式

实现 CacheManager 接口，管理缓存。

@Configuration
public class EhCacheConfig {

    @Bean
    public CacheManager cacheManager() {
        return new EhCacheCacheManager(ehCacheManager().getObject());
    }

    @Bean
    public EhCacheManagerFactoryBean ehCacheManager() {
        EhCacheManagerFactoryBean cacheManagerFactoryBean = new EhCacheManagerFactoryBean();
        cacheManagerFactoryBean.setConfigLocation(new ClassPathResource("ehcache.xml"));
        cacheManagerFactoryBean.setShared(true);
        return cacheManagerFactoryBean;
    }

}

在服务方法中通过 Cache 对象实现缓存。

@Service
public class UserService {

    @Autowired
    private CacheManager cacheManager;

    private Cache userCache;

    @PostConstruct
    public void init() {
        userCache = cacheManager.getCache("userCache");
    }

    public User getUserById(String id) {
        Element element = userCache.get(id);
        if (element != null) {
            return (User) element.getObjectValue();
        } else {
            User user = // ...
            userCache.put(new Element(id, user));
            return user;
        }
    }

}

3. 示例说明

3.1 注解方式示例

在 UserService 类中添加 getUserByName 方法，并添加 @Cacheable 注解。

@Service
public class UserService {

    @Cacheable(value = "userCache")
    public User getUserById(String id) {
        // ...
    }

    @Cacheable(value = "userCache")
    public User getUserByName(String name) {
        // ...
    }

}

在 UserController 类中添加 getUser 方法，调用 UserService 中的 getUserById 和 getUserByName 方法。

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUser(@PathVariable String id) {
        return userService.getUserById(id);
    }

    @GetMapping("/name/{name}")
    public User getUserByName(@PathVariable String name) {
        return userService.getUserByName(name);
    }

}

启动项目，访问 http://localhost:8080/user/1 和 http://localhost:8080/user/name/test，可以看到访问 getUserById 和 getUserByName 方法时，第一次会进行方法体内的操作，而后会从缓存中获取数据。

3.2 编程方式示例

在 UserService 类中实现 getUserById 方法。

@Service
public class UserService {

    @Autowired
    private CacheManager cacheManager;

    private Cache userCache;

    @PostConstruct
    public void init() {
        userCache = cacheManager.getCache("userCache");
    }

    public User getUserById(String id) {
        Element element = userCache.get(id);
        if (element != null) {
            return (User) element.getObjectValue();
        } else {
            User user = // ...
            userCache.put(new Element(id, user));
            return user;
        }
    }

}

在 UserController 类中添加 getUser 方法，调用 UserService 中的 getUserById 方法。

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public User getUser(@PathVariable String id) {
        return userService.getUserById(id);
    }

}

启动项目，访问 http://localhost:8080/user/1，可以看到访问 getUserById 方法时，第一次会进行方法体内的操作，而后会从缓存中获取数据。