深入理解PlayFramework1.2.7中的缓存机制

### Play Framework 1.2.7中的缓存解决方案

Play Framework 1.2.7为开发者提供了两种主要的缓存实现选项：Ehcache和Memcached。Ehcache适用于单节点应用，而Memcached则支持分布式部署，适用于需要跨多个服务器共享缓存数据的场景。

#### 缓存实现的关键组件

- **CacheImpl接口**
定义了一系列用于管理缓存的基本操作，如添加、删除、更新和查询缓存项。这些方法允许开发者灵活地控制缓存数据的生命周期。

```java
public interface CacheImpl {
void add(String key, Object value, int expiration);
boolean safeAdd(String key, Object value, int expiration);
void set(String key, Object value, int expiration);
boolean safeSet(String key, Object value, int expiration);
void replace(String key, Object value, int expiration);
boolean safeReplace(String key, Object value, int expiration);
Object get(String key);
Map get(String[] keys);
long incr(String key, int by);
long decr(String key, int by);
void clear();
void delete(String key);
boolean safeDelete(String key);
void stop();
}
```

- **Cache代理类**
在Play框架启动时，`Cache.init` 方法会被调用以初始化缓存系统。该方法会根据配置文件中的设置来决定使用Ehcache还是Memcached。同时，在框架停止时，`Cache.stop` 方法会调用相应的缓存实现类的 `stop` 方法来释放资源。

```java
public static void init() {
if(forcedCacheImpl != null) {
cacheImpl = forcedCacheImpl;
return;
}
if (Play.configuration.getProperty("memcached", "disabled").equals("enabled")) {
try {
cacheImpl = MemcachedImpl.getInstance(true);
Logger.info("Connected to memcached");
} catch (Exception e) {
Logger.error(e, "Error while connecting to memcached");
Logger.warn("Fallback to local cache");
cacheImpl = EhCacheImpl.newInstance();
}
} else {
cacheImpl = EhCacheImpl.newInstance();
}
}

public static void stop() {
cacheImpl.stop();
}
```

- **Ehcache实现类**
使用单例模式初始化Ehcache对象，确保在整个应用生命周期内只有一个实例。构造函数中初始化了缓存管理器和具体的缓存对象。

```java
private static EhCacheImpl uniqueInstance;

private EhCacheImpl() {
this.cacheManager = CacheManager.create();
this.cacheManager.addCache(cacheName);
this.cache = cacheManager.getCache(cacheName);
}
```

- **Memcached实现类**
同样采用单例模式初始化Memcached客户端。`getInstance` 方法中包含了一些特殊的处理逻辑，比如在重新初始化客户端前重置线程中断状态。

```java
public static MemcachedImpl getInstance(boolean forceClientInit) throws IOException {
if (uniqueInstance == null) {
uniqueInstance = new MemcachedImpl();
} else if (forceClientInit) {
Thread.interrupted();
uniqueInstance.initClient();
}
return uniqueInstance;
}

public void initClient() throws IOException {
List addrs;
if (Play.configuration.containsKey("memcached.host")) {
addrs = AddrUtil.getAddresses(Play.configuration.getProperty("memcached.host"));
} else if (Play.configuration.containsKey("memcached.1.host")) {
int nb = 1;
String addresses = "";
while (Play.configuration.containsKey("memcached." + nb + ".host")) {
addresses += Play.configuration.get("memcached." + nb + ".host") + " ";
nb++;
}
addrs = AddrUtil.getAddresses(addresses);
} else {
throw new ConfigurationException("Bad configuration for memcached: missing host(s)");
}
if (Play.configuration.containsKey("memcached.user")) {
String memcacheUser = Play.configuration.getProperty("memcached.user");
String memcachePassword = Play.configuration.getProperty("memcached.password");
AuthDescriptor ad = new AuthDescriptor(new String[]{"PLAIN"}, new PlainCallbackHandler(memcacheUser, memcachePassword));
ConnectionFactory cf = new ConnectionFactoryBuilder()
.setProtocol(ConnectionFactoryBuilder.Protocol.BINARY)
.setAuthDescriptor(ad)
.build();
client = new MemcachedClient(cf, addrs);
} else {
client = new MemcachedClient(addrs);
}
}
```

- **CacheFor注解**
用于标记控制器方法，指示其结果应被缓存。未指定缓存时间时，默认缓存时间为1小时。使用示例：`@CacheFor("1h")`。当用户访问标记了此注解的方法时，Play会首先检查缓存中是否存在结果，若不存在，则执行方法并将结果存储到缓存中。

```java
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CacheFor {
String value() default "1h";
String id() default "";
}
```

### 小结
Play Framework 1.2.7的缓存实现较为简洁，但功能全面，能够满足大多数应用的缓存需求。通过合理配置和使用，开发者可以有效提升应用的性能和响应速度。尽管如此，对于一些高级特性或特定场景下的优化，可能还需要进一步的研究和实践。