https://github.com/seratch/memcachedweaver
Caching methods result on memcached with AOP
https://github.com/seratch/memcachedweaver
Last synced: 5 months ago
JSON representation
Caching methods result on memcached with AOP
- Host: GitHub
- URL: https://github.com/seratch/memcachedweaver
- Owner: seratch
- Created: 2011-10-11T13:20:37.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2012-02-15T13:57:19.000Z (about 13 years ago)
- Last Synced: 2024-10-13T17:45:39.059Z (7 months ago)
- Language: Java
- Homepage:
- Size: 124 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# memcachedweaver: Caching methods result on memcached with AOP
## Getting Started
### Maven
```xml
com.github.seratch
memcachedweaver
0.2
```
## Usage
### Using as a wrapper API for memcached clients
memcachedweaver provides a pluggable wrapper API for memcached clients and developers can access memcached servers transparently.
Currently memcachedweaver supports following 2 libraries, and it's also possible to add new adaptors.
#### memcacheweaver.client.adaptor.SpymemcachedAdaptor
for http://code.google.com/p/spymemcached/
#### memcacheweaver.client.adaptor.XmemcachedAdaptor
for http://code.google.com/p/xmemcached/
```java
Configuration config = new Configuration();
config.setAdaptorClassName("memcachedweaver.client.adaptor.SpymemcachedAdaptor");
config.setAddressesAsString("server1:11211,server2:11211"); // csv format
MemcachedClient memcached = MemcachedClientFactory.create(config);
Thread.sleep(500L);
String toBeCached = new java.util.Date().toString();
memcached.set("stopped time", 1, toBeCached); // whitespace in cache key will be replaced to underscore
Thread.sleep(500L);
assertThat(memcached.get("stopped time"), is(equalTo(toBeCached))); // "Wed Oct 12 00:01:54 JST 2011"
Thread.sleep(1000L);
assertThat(memcached.get("stopped time"), is(nullValue())); // null
```
### Setup for Spring Framework
"applicationContext.xml" as follows:
```
```
### Setup by inheritence
It's also possible to inject the configuration to interceptor by inheritence.
```java
public class MyMemcachedInterceptor extends MemcachedInterceptor {
@Override
public Configuration getConfiguration() {
Configuration config = new Configuration();
config.setNamespace("....");
...
return config;
}
}
```
### Using AOP
The value will be cached for the duration of 10 seconds.
```java
package service;
import memcachedweaver.annotation.Memcached;
public class DateService {
@Memcached(secondsToExpire = 10)
public String getCurrentAsString(String prefix) {
return prefix + new java.util.Date().toString();
}
}
```
### The rule of generated cache key
```
"(namespace)::(Method#toGenericString() and replace "\\s+" to "_")::(args separated by comma)"
```
For example:
```java
String result = new DateService().getCurrentAsString("PREFIX");
```
And thn, the returned value will be cached as "com.example::public_void_service.DateService.getCurrentAsString(String)::PREFIX" on memcached.
## License
```java
/*
* Copyright 2011 Kazuhiro Sera
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
```