Skip to content

DOCS: add getting-started.md #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhpark816 merged 1 commit into from
Nov 24, 2025
Merged

DOCS: add getting-started.md #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 1 addition & 208 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,214 +14,7 @@ arcus-spring provides following functionalities.

## Getting Started

### Dependency

The artifact for arcus-spring is in the central Maven repository. To use it, add the following dependency.

#### Maven (pom.xml)

```xml
<dependencies>
<dependency>
<groupId>com.jam2in.arcus</groupId>
<artifactId>arcus-spring</artifactId>
<version>1.14.1</version>
</dependency>
</dependencies>
```

#### Gradle (build.gradle)
##### version 7.0 before
```groovy
dependencies {
compile 'com.jam2in.arcus:arcus-spring:1.14.1'
}
```
##### version 7.0 or later
```groovy
dependencies {
implementation 'com.jam2in.arcus:arcus-spring:1.14.1'
}
```

### KeyGenerator

Arcus-spring provides two types of key generator. These two are StringKeyGenerator and SimpleStringKeyGenerator.

- StringKeyGenerator: it generate the key by combining the parameters and hashcode of the parameters.
It's because the key can have invalid characters. This generator replace invalid characters to valid characters.
But if the generator do that, even though the keys are different, they can be the same. So the generator adds hashcode to distinguish the keys.
- SimpleStringKeyGenerator: it generate the key simply by combining the parameters. So this generator can generate invalid keys or duplicate keys.

For example, when the parameters are 'a', 'b', 'c', StringKeyGenerator creates the key 'a,b,c317' and SimpleStringKeyGenerator creates the key 'a,b,c'.

### Configuration
Spring Cache configuration is required before using arcus-spring. Create ArcusCacheManager and StringKeyGenerator with the following configuration.

#### XML
- Use ArcusClientFactoryBean or ArcusCacheConfigurationFactoryBean because these classes do not provide default constructor and setter.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:cache="http://www.springframework.org/schema/cache"
xmlns:util="http://www.springframework.org/schema/util"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/cache
http://www.springframework.org/schema/cache/spring-cache.xsd
http://www.springframework.org/schema/util
http://www.springframework.org/schema/util/spring-util.xsd">

<cache:annotation-driven
key-generator="arcusKeyGenerator"
cache-manager="arcusCacheManager"/>

<bean id="arcusKeyGenerator"
class="com.navercorp.arcus.spring.cache.StringKeyGenerator"/>

<bean id="arcusCacheManager" class="com.navercorp.arcus.spring.cache.ArcusCacheManager">
<constructor-arg name="adminAddress" value="127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183"/>
<constructor-arg name="serviceCode" value="test"/>
<constructor-arg name="connectionFactoryBuilder">
<bean class="net.spy.memcached.ConnectionFactoryBuilder"/>
</constructor-arg>
<constructor-arg name="poolSize" value="8"/>
<!-- default cache configuration (missing cache) -->
<constructor-arg name="defaultConfiguration" ref="defaultCacheConfig"/>
<!-- a map of cache configuration (key=cache name, value=cache configuration) -->
<constructor-arg name="initialCacheConfigs">
<map>
<entry key="testCache">
<bean parent="defaultCacheConfig">
<property name="serviceId" value="TEST-"/>
<property name="prefix" value="PRODUCT"/>
<property name="expireSeconds" value="60"/>
</bean>
</entry>
<entry key="devCache">
<bean parent="defaultCacheConfig">
<property name="serviceId" value="DEV-">
<property name="prefix" value="PRODUCT"/>
<property name="expireSeconds" value="120"/>
</bean>
</entry>
</map>
</constructor-arg>
</bean>

<bean id="defaultCacheConfig" class="com.navercorp.arcus.spring.ArcusCacheConfigurationFactoryBean">
<property name="prefix" value="DEFAULT"/>
<property name="expireSeconds" value="60"/>
<property name="timeoutMilliSeconds" value="800"/>
</bean>

</beans>
```

#### Java
```java
@Configuration
@EnableCaching
public class ArcusConfiguration extends CachingConfigurerSupport {

private static String ADMIN_ADDRESS = "127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183";
private static String SERVICE_CODE = "test";
private static int POOL_SIZE = 8;

@Bean
@Override
public KeyGenerator keyGenerator() {
return new StringKeyGenerator();
}

@Bean
@Override
public CacheManager cacheManager() {
return new ArcusCacheManager(
ADMIN_ADDRESS,
SERVICE_CODE,
new ConnectionFactoryBuilder(),
POOL_SIZE,
/* default cache configuration (missing cache) */
defaultCacheConfig(),
/* a map of cache configuration (key=cache name, value=cache configuration) */
initialCacheConfig()
);
}

@Bean
public ArcusCacheConfiguration defaultCacheConfig() {
return new ArcusCacheConfiguration()
.withPrefix("DEFAULT")
.withExpireSeconds(60)
.withTimeoutMilliSeconds(800);
}

@Bean
public Map<String, ArcusCacheConfiguration> initialCacheConfig() {
Map<String, ArcusCacheConfiguration> initialCacheConfig = new HashMap<>();
initialCacheConfig.put("testCache", testCacheConfig());
initialCacheConfig.put("devCache", devCacheConfig());
return initialCacheConfig;
}

@Bean
public ArcusCacheConfiguration testCacheConfig() {
return new ArcusCacheConfiguration()
.withServiceId("TEST-")
.withPrefix("PRODUCT")
.withExpireSeconds(60)
.withTimeoutMillisSeconds(800);
}

@Bean
public ArcusCacheConfiguration devCacheConfig() {
return new ArcusCacheConfiguration()
.withServiceId("DEV-")
.withPrefix("PRODUCT")
.withExpireSeconds(120)
.withTimeoutMillisSeconds(800);
}

}
```

### Example

Apply the cache using the key(cacheNames) stored in the initialCacheConfig map of ArcusCacheManager you created with XML or Java configuration.

```java
@Service
public class ProductService {

/*
using the "testCache" cache with 60 expire seconds and "TEST-PRODUCT" prefix.
*/
@Cacheable(cacheNames = "testCache", key="#id")
public Product getProduct_TestCache(int id) {
return new Product(id);
}

/*
using the "devCache" cache with 120 expire seconds and "DEV-PRODUCT" prefix.
*/
@Cacheable(cacheNames = "devCache", key="#id")
public Product getProduct_DevCache(int id) {
return new Product(id);
}

/*
In ArcusCacheManger, missing cache is loaded with default cache configuration.
so, the below code uses the default cache with 60 expire seconds and "DEFAULT" prefix.
*/
@Cacheable(cacheNames = "missingCache", key="#id")
public Product getProduct_DefaultCache(int id) {
return new Product(id);
}

}
```
See [Getting Started Guide](docs/getting-started.md) for detailed instructions on how to use arcus-spring.

## Front Cache

Expand Down
Loading