详解spring boot集成ehcache 2.x 用于hibernate二级缓存

下面是详解"spring boot集成ehcache 2.x 用于hibernate二级缓存"的完整攻略。

引言

在使用Spring Boot开发项目时，我们往往需要使用到缓存来提高性能。而使用Hibernate框架时，我们可以通过集成Ehcache来实现二级缓存。本文将详细介绍在Spring Boot项目中，如何集成Ehcache 2.x用于Hibernate二级缓存，并提供两个示例。

步骤

步骤1：添加依赖

在使用Ehcache前，我们需要添加相关依赖。在pom.xml文件中添加以下依赖：

<!-- Ehcache相关依赖 -->
<dependency>
  <groupId>net.sf.ehcache</groupId>
  <artifactId>ehcache</artifactId>
  <version>2.10.6</version>
</dependency>
<!-- Hibernate相关依赖 -->
<dependency>
  <groupId>org.hibernate</groupId>
  <artifactId>hibernate-core</artifactId>
  <version>5.3.13.Final</version>
</dependency>

步骤2：配置Ehcache

添加Ehcache的相关配置。在application.yml文件中添加以下配置：

spring:
  cache:
    type: ehcache
  datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver

hibernate:
  show_sql: true
  hbm2ddl:
    auto: create-drop
  dialect: org.hibernate.dialect.MySQL5Dialect

# Ehcache配置
ehcache:
  # 指定Ehcache配置文件位置（可选）
  config: classpath:ehcache.xml 
  # 指定使用的CacheManager名称
  cacheManagerName: myCacheManager
  # 缓存配置
  caches:  
    - name: userCache  
      maxEntriesLocalHeap: 2000
      timeToLiveSeconds: 1800
    - name: roleCache  
      maxEntriesLocalHeap: 1000
      timeToLiveSeconds: 3600

上述配置中，我们指定了Ehcache配置文件的位置，同时还配置了三个Cache，分别是defaultCache、userCache和roleCache。其中，userCache和roleCache理解成是我们自定义的二级缓存即可。

步骤3：添加Ehcache配置文件（可选）

在上述配置中，我们还可以通过config属性指定Ehcache的配置文件。如果不指定，则使用默认配置。在src/main/resources下，添加名为ehcache.xml的文件，并添加以下内容：

<ehcache>
  <diskStore path="java.io.tmpdir/ehcache"/>

  <defaultCache
        maxElementsInMemory="10000"
        eternal="false"
        timeToIdleSeconds="120"
        timeToLiveSeconds="120"
        overflowToDisk="true"
        diskPersistent="false"
        diskExpiryThreadIntervalSeconds="180"
        memoryStoreEvictionPolicy="LRU"/>

  <cache name="userCache"
        maxElementsInMemory="1000"
        eternal="false"
        timeToIdleSeconds="100"
        timeToLiveSeconds="200"
        overflowToDisk="false"/>

  <cache name="roleCache"
        maxElementsInMemory="1000"
        eternal="false"
        timeToIdleSeconds="150"
        timeToLiveSeconds="300"
        overflowToDisk="false"/>
</ehcache>

步骤4：启用Ehcache

在启动类上添加@EnableCaching注解，开启缓存：

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

步骤5：使用Ehcache

在应用程序中使用Ehcache，我们可以使用@Cacheable、@CachePut和@CacheEvict注解。以@Cacheable注解为例，当我们查询某个实体时，会先在Ehcache中查找，如果缓存没有，再去数据库中查找，并将结果存入缓存中。

@Service
public class UserServiceImpl implements UserService {

  @Autowired
  private UserDao userDao;

  @Cacheable(value = "userCache", key = "#id")
  public User findById(Integer id) {
    return userDao.findById(id);
  }
}

示例1：查询用户信息

以下示例演示如何使用Ehcache缓存从数据库查询用户信息的过程。

首先，我们在数据库下建立测试表t_user，表结构如下：

CREATE TABLE `t_user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(30) DEFAULT NULL,
`age` tinyint(3) unsigned DEFAULT NULL,
`create_time` datetime DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

构建实体类User，代码如下所示：

@Entity
@Table(name = "t_user")
public class User implements Serializable {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Integer id;

  private String name;

  private Integer age;

  @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
  private Date createTime;

  // setter/getter省略
}

构建UserDao，使用SessionFactory从数据库中查询User实体，代码如下：

@Repository
public class UserDaoImpl implements UserDao {

  @Autowired
  private SessionFactory sessionFactory;

  private Session getCurrentSession() {
    return sessionFactory.getCurrentSession();
  }

  public User findById(Integer id) {
    return getCurrentSession().get(User.class, id);
  }
}

最后，构建UserController，从数据库中查询用户信息时，使用UserService的findById()方法，并使用@Cacheable注解开启缓存。当我们第一次查询时，会从数据库中查询并将查询结果存入userCache缓存中，当我们再次查询时，将从缓存中获取结果。

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

  @Autowired
  private UserService userService;

  @GetMapping("/{id}")
  public User findById(@PathVariable Integer id) {
    return userService.findById(id);
  }
}

示例2：更新用户信息

以下示例演示如何使用Ehcache缓存更新数据库中的用户信息的过程。

首先，我们在项目中添加更新用户信息的接口/user/update。构建UserController，使用@CachePut注解，更新用户信息时，将缓存中的数据也更新。当我们查询该用户时，将从缓存中获取最新数据。

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

  @Autowired
  private UserService userService;

  @GetMapping("/{id}")
  public User findById(@PathVariable Integer id) {
    return userService.findById(id);
  }

  @PostMapping("/{id}")
  @Transactional(rollbackFor = Exception.class)
  @CachePut(value = "userCache", key = "#id")
  public User update(@PathVariable Integer id, String name, Integer age) {
    User user = userService.findById(id);
    if (user != null) {
      user.setName(name);
      user.setAge(age);
    }
    return user;
  }
}

总结

至此，我们已经详细讲解了在Spring Boot项目中，如何集成Ehcache 2.x用于Hibernate二级缓存，并提供了两个示例。使用Ehcache缓存，能够有效地提高我们项目的性能，让我们的项目更为流畅。