Skip to content
Merged
Changes from all commits
Commits
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
60 changes: 50 additions & 10 deletions docs/user-guide/02-arcus-java-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,9 +451,10 @@ SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
- setTranscoder(Transcoder\<Object\> t)

Key-Value ํƒ€์ž…์˜ ์บ์‹œ ๋ฐ์ดํ„ฐ์™€ ์ž๋ฐ” ๊ฐ์ฒด ํƒ€์ž… ๊ฐ„ ๋ณ€ํ™˜ ์‹œ์— ์‚ฌ์šฉํ•  Transcoder๋ฅผ ์ง€์ •ํ•œ๋‹ค.
๊ธฐ๋ณธ์ ์œผ๋กœ SerializingTranscoder ๊ฐ์ฒด๋ฅผ ์‚ฌ์šฉํ•œ๋‹ค. ์••์ถ• ์‹œ GZip ๋ฐฉ์‹์„ ์‚ฌ์šฉํ•˜๋ฉฐ,
Character set, ์••์ถ• ๊ธฐ์ค€, ClassLoader๋ฅผ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.

#### SerializingTranscoder
- ๋ณ„๋„๋กœ ์ง€์ •ํ•˜์ง€ ์•Š์„ ๊ฒฝ์šฐ ์ด ํƒ€์ž…์„ ์‚ฌ์šฉํ•œ๋‹ค.
- ์••์ถ• ์‹œ GZip ๋ฐฉ์‹์„ ์‚ฌ์šฉํ•˜๋ฉฐ, Character set, ์••์ถ• ๊ธฐ์ค€, ClassLoader๋ฅผ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.
- Character set๊ณผ ์••์ถ• ๊ธฐ์ค€์€ setter๋กœ ์„ค์ • ๊ฐ€๋Šฅํ•˜๋‹ค. Character set์˜ ๊ธฐ๋ณธ๊ฐ’์€ UTF-8์ด๋‹ค.
์••์ถ• ๊ธฐ์ค€์˜ ๋‹จ์œ„๋Š” byte์ด๋ฉฐ, ๊ธฐ๋ณธ๊ฐ’์€ 16,384bytes์ด๋‹ค.
```java
Expand All @@ -464,18 +465,52 @@ SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
ConnectionFactoryBuilder cfb = new ConnectionFactoryBuilder();
cfb.setTranscoder(transcoder);
```

- ClassLoader๋Š” ์ƒ์„ฑ์ž ์ธ์ž๋กœ ์„ค์ • ๊ฐ€๋Šฅํ•˜๋‹ค. Spring Devtools์™€ ๊ฐ™์ด ํด๋ž˜์Šค๋กœ๋”๋ฅผ ๋ณ„๋„๋กœ ๋‘๋Š”
๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์‚ฌ์šฉํ•  ๋•Œ, ์บ์‹œ์—์„œ ์กฐํšŒํ•˜์—ฌ ์—ญ์ง๋ ฌํ™” ํ•  ๋•Œ ์‚ฌ์šฉํ•˜๋Š” ํด๋ž˜์Šค ๋กœ๋”์™€ ํ”„๋กœ์„ธ์Šค์—์„œ ์‚ฌ์šฉ๋˜๊ณ  ์žˆ๋Š” ํด๋ž˜์Šค ๋กœ๋”๋ฅผ ์ผ์น˜์‹œํ‚ค๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉํ•œ๋‹ค.
- ClassLoader๋Š” ์ƒ์„ฑ์ž ์ธ์ž๋กœ ์„ค์ • ๊ฐ€๋Šฅํ•˜๋‹ค. Spring Devtools์™€ ๊ฐ™์ด ํด๋ž˜์Šค๋กœ๋”๋ฅผ ๋ณ„๋„๋กœ ๋‘๋Š” ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์‚ฌ์šฉํ•  ๋•Œ,
์บ์‹œ์—์„œ ์กฐํšŒํ•˜์—ฌ ์—ญ์ง๋ ฌํ™” ํ•  ๋•Œ ์‚ฌ์šฉํ•˜๋Š” ํด๋ž˜์Šค ๋กœ๋”์™€ ํ”„๋กœ์„ธ์Šค์—์„œ ์‚ฌ์šฉ๋˜๊ณ  ์žˆ๋Š” ํด๋ž˜์Šค ๋กœ๋”๋ฅผ ์ผ์น˜์‹œํ‚ค๊ธฐ ์œ„ํ•ด ์‚ฌ์šฉํ•œ๋‹ค.
```java
SerializingTranscoder tc = new SerializingTranscoder(CachedData.MAX_SIZE, this.getClass().getClassLoader());
```

#### JsonSerializingTranscoder
- ์ œ๋„ค๋ฆญ ํƒ€์ž…์„ Object๋กœ ์ง€์ •ํ•˜์ง€ ์•Š์œผ๋ฉด setTranscoder ๋ฉ”์„œ๋“œ ์ธ์ž๋กœ ์ง€์ •ํ•  ์ˆ˜ ์—†๋‹ค.
๋”ฐ๋ผ์„œ ArcusClient API ๋ฉ”์„œ๋“œ ์ธ์ž๋กœ ์ง€์ •ํ•˜๋Š” ๊ฒƒ์„ ๊ถŒ์žฅํ•œ๋‹ค. ์‚ฝ์ž… ๋ฐ ์กฐํšŒ ์‹œ ๋™์ผํ•œ ํƒ€์ž…์„ ๊ฐ–๋Š” transcoder๋ฅผ ์‚ฌ์šฉํ•ด์•ผ ํ•œ๋‹ค.
```java
JsonSerializingTranscoder<MyClass> transcoder = new JsonSerializingTranscoder<>(MyClass.class);
arcusClient.set("key", 0, new MyClass("class1"), transcoder).get();
MyClass myClass = arcusClient.asyncGet("key", transcoder).get();
```
- Jackson ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ์ฒด๋ฅผ JSON ํ˜•์‹์œผ๋กœ ์ง๋ ฌํ™”/์—ญ์ง๋ ฌํ™”ํ•œ๋‹ค.
- ํƒ€์ž… ์•ˆ์ „์„ฑ์„ ๋ณด์žฅํ•˜๊ธฐ ์œ„ํ•ด ์ƒ์„ฑ์ž์—์„œ ํŠน์ • ํด๋ž˜์Šค ํƒ€์ž… ๋˜๋Š” JavaType์„ ์ง€์ •ํ•ด์•ผ ํ•œ๋‹ค.
- ๊ธฐ๋ณธ ํƒ€์ž…(String, Integer, Long, Boolean, Date ๋“ฑ)์€ ๋ฐ”๋กœ ์ง๋ ฌํ™”ํ•˜๊ณ , ์‚ฌ์šฉ์ž ์ •์˜ ํƒ€์ž… ๊ฐ์ฒด๋Š” JSON์œผ๋กœ ๋ณ€ํ™˜ํ•˜์—ฌ ์ง๋ ฌํ™”ํ•œ๋‹ค.
์ด ๋•Œ ์‚ฌ์šฉ์ž ์ •์˜ ํƒ€์ž…์— ๊ธฐ๋ณธ ์ƒ์„ฑ์ž๋‚˜ `@JsonCreator` ์–ด๋…ธํ…Œ์ด์…˜์ด ์ง€์ •๋œ ์ƒ์„ฑ์ž๊ฐ€ ์—†์œผ๋ฉด ์›Œ๋‹ ๋กœ๊ทธ์™€ ํ•จ๊ป˜ ์—ญ์ง๋ ฌํ™” ์‹œ null์ด ๋ฐ˜ํ™˜๋  ์ˆ˜ ์žˆ์œผ๋ฏ€๋กœ ์ฃผ์˜ํ•œ๋‹ค.
- ์••์ถ• ์‹œ GZip ๋ฐฉ์‹์„ ์‚ฌ์šฉํ•˜๋ฉฐ, Character set, ์••์ถ• ๊ธฐ์ค€์„ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.
- Character set๊ณผ ์••์ถ• ๊ธฐ์ค€์€ setter๋กœ ์„ค์ • ๊ฐ€๋Šฅํ•˜๋‹ค. Character set์˜ ๊ธฐ๋ณธ๊ฐ’์€ UTF-8์ด๋‹ค.

#### GenericJsonSerializingTranscoder
- Jackson ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ๊ฐ์ฒด๋ฅผ JSON ํ˜•์‹์œผ๋กœ ์ง๋ ฌํ™”/์—ญ์ง๋ ฌํ™”ํ•œ๋‹ค.
- ๊ธฐ๋ณธ ํƒ€์ž…(String, Integer, Long, Boolean, Date ๋“ฑ)์€ ๋ฐ”๋กœ ์ง๋ ฌํ™”ํ•˜๊ณ , ์‚ฌ์šฉ์ž ์ •์˜ ํƒ€์ž… ๊ฐ์ฒด๋Š” JSON์œผ๋กœ ๋ณ€ํ™˜ํ•˜์—ฌ ์ง๋ ฌํ™”ํ•œ๋‹ค.
์ด ๋•Œ ์‚ฌ์šฉ์ž ์ •์˜ ํƒ€์ž…์— ๊ธฐ๋ณธ ์ƒ์„ฑ์ž๋‚˜ `@JsonCreator` ์–ด๋…ธํ…Œ์ด์…˜์ด ์ง€์ •๋œ ์ƒ์„ฑ์ž๊ฐ€ ์—†์œผ๋ฉด ์›Œ๋‹ ๋กœ๊ทธ์™€ ํ•จ๊ป˜ ์—ญ์ง๋ ฌํ™” ์‹œ null์ด ๋ฐ˜ํ™˜๋  ์ˆ˜ ์žˆ์œผ๋ฏ€๋กœ ์ฃผ์˜ํ•œ๋‹ค.
- ๋‹คํ˜•์„ฑ ํƒ€์ž…์„ ์ง€์›ํ•˜์—ฌ ๊ฐ์ฒด์˜ ๊ตฌ์ฒด์ ์ธ ํƒ€์ž… ์ •๋ณด๋ฅผ ๋ณด์กดํ•  ์ˆ˜ ์žˆ๋‹ค.
- ์ƒ์„ฑ์ž์—์„œ ObjectMapper์™€ ํƒ€์ž… ํžŒํŠธ ํ”„๋กœํผํ‹ฐ ์ด๋ฆ„์„ ์ง€์ •ํ•  ์ˆ˜ ์žˆ๋‹ค. DefaultTyping์ด ์„ค์ •๋˜์ง€ ์•Š์€ ObjectMapper ์‚ฌ์šฉ ์‹œ ํƒ€์ž… ํžŒํŠธ ํ”„๋กœํผํ‹ฐ ์ด๋ฆ„์„ ์ง€์ •ํ•ด์ฃผ์–ด์•ผ ํ•œ๋‹ค.
- ๋ณด์•ˆ ์ทจ์•ฝ์ ์„ ๋ฐฉ์ง€ํ•˜๊ธฐ ์œ„ํ•ด, ์‹ ๋ขฐํ•  ์ˆ˜ ์—†๋Š” JSON ์ž…๋ ฅ์„ ์ฒ˜๋ฆฌํ•  ๊ฒฝ์šฐ ์ ์ ˆํ•œ BasicPolymorphicTypeValidator๋ฅผ ์„ค์ •ํ•˜๋Š” ๊ฒƒ์ด ๊ถŒ์žฅ๋œ๋‹ค.
```java
ObjectMapper objectMapper = new ObjectMapper();
BasicPolymorphicTypeValidator validator = BasicPolymorphicTypeValidator.builder()
.allowIfBaseType("net.spy.memcached.") // ํŒจํ‚ค์ง€ ๊ฒฝ๋กœ๋Š” ์ปค์Šคํ…€ํ•˜๊ฒŒ ์„ค์ •ํ•ด์ฃผ์–ด์•ผ ํ•œ๋‹ค.
.allowIfSubType("net.spy.memcached.") // ํŒจํ‚ค์ง€ ๊ฒฝ๋กœ๋Š” ์ปค์Šคํ…€ํ•˜๊ฒŒ ์„ค์ •ํ•ด์ฃผ์–ด์•ผ ํ•œ๋‹ค.
.build();
GenericJsonSerializingTranscoder transcoder =
new GenericJsonSerializingTranscoder(objectMapper, "@class", CachedData.MAX_SIZE);

ConnectionFactoryBuilder cfb = new ConnectionFactoryBuilder();
cfb.setTranscoder(transcoder);
```

- setCollectionTranscoder(Transcoder\<Object\> t)

Collection ํƒ€์ž…์˜ ์บ์‹œ ๋ฐ์ดํ„ฐ์™€ ์ž๋ฐ” ๊ฐ์ฒด ํƒ€์ž… ๊ฐ„ ๋ณ€ํ™˜ ์‹œ์— ์‚ฌ์šฉํ•  Transcoder๋ฅผ ์ง€์ •ํ•œ๋‹ค.
๊ธฐ๋ณธ์ ์œผ๋กœ SerializingTranscoder ๊ฐ์ฒด๋ฅผ ์‚ฌ์šฉํ•œ๋‹ค. ์••์ถ• ์‹œ GZip ๋ฐฉ์‹์„ ์‚ฌ์šฉํ•˜๋ฉฐ,
Character set, ์••์ถ• ๊ธฐ์ค€, ClassLoader๋ฅผ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.
๊ธฐ๋ณธ์ ์œผ๋กœ SerializingTranscoder ๊ฐ์ฒด๋ฅผ ์‚ฌ์šฉํ•˜๋ฉฐ, Character set, ClassLoader๋ฅผ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.
setTranscoder ๋ฉ”์„œ๋“œ์™€ ๋งˆ์ฐฌ๊ฐ€์ง€๋กœ GenericJsonSerializingTranscoder๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.

- ๋นŒ๋”๋ฅผ ํ†ตํ•ด SerializingTranscoder๋ฅผ ์„ค์ •ํ•  ์ˆ˜ ์žˆ๋‹ค.
```java
Expand All @@ -486,11 +521,9 @@ SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
.build();
```

- Character set๊ณผ ์••์ถ• ๊ธฐ์ค€์€ ๊ฐ์ฒด ์ƒ์„ฑ ํ›„ setter๋ฅผ ์‚ฌ์šฉํ•ด ์„ค์ • ๊ฐ€๋Šฅํ•˜๋‹ค. Character set์˜ ๊ธฐ๋ณธ๊ฐ’์€ UTF-8์ด๋‹ค.
์••์ถ• ๊ธฐ์ค€์˜ ๋‹จ์œ„๋Š” byte์ด๋ฉฐ, ๊ธฐ๋ณธ๊ฐ’์€ 16,384bytes์ด๋‹ค.
- Character set์€ ๊ฐ์ฒด ์ƒ์„ฑ ํ›„ setter๋ฅผ ์‚ฌ์šฉํ•ด ์„ค์ • ๊ฐ€๋Šฅํ•˜๋‹ค. Character set์˜ ๊ธฐ๋ณธ๊ฐ’์€ UTF-8์ด๋‹ค.
```java
transcoder.setCharset("EUC-KR");
transcoder.setCompressionThreshold(4096);

ConnectionFactoryBuilder cfb = new ConnectionFactoryBuilder();
cfb.setCollectionTranscoder(transcoder);
Expand Down Expand Up @@ -563,6 +596,13 @@ SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
๊ธฐ๋ณธ๊ฐ’์€ true์ด๋‹ค. ZooKeeper Ensemble์„ ๋„๋ฉ”์ธ ์ฃผ์†Œ๋กœ ๊ด€๋ฆฌํ•˜๊ณ  ์žˆ๋Š” ๊ฒฝ์šฐ, DNS์— ๋งคํ•‘๋œ IP ์ •๋ณด๊ฐ€ ๋ณ€๊ฒฝ๋  ๋•Œ ์ •์ƒ์ ์œผ๋กœ ๋ฐ˜์˜๋˜๋„๋ก ํ•˜๊ธฐ ์œ„ํ•ด
DNS Cache TTL ๊ฐ’์ด 0 ~ 300์ดˆ ๋‚ด์— ์กด์žฌํ•˜๋Š”์ง€ ๊ฒ€์ฆํ•œ๋‹ค.

- enableShardKey(boolean shardKey)

์บ์‹œ ํด๋Ÿฌ์Šคํ„ฐ์—์„œ ํŠน์ • ๋ฐ์ดํ„ฐ๊ฐ€ ์–ด๋А ๋…ธ๋“œ์— ์ €์žฅ๋ ์ง€๋Š” ๊ธฐ๋ณธ์ ์œผ๋กœ ํ‚ค ์ „์ฒด๋ฅผ ํ•ด์‹ฑํ•˜์—ฌ ๊ฒฐ์ •ํ•œ๋‹ค.
ํ‚ค์˜ ์ผ๋ถ€๋งŒ์„ ๊ธฐ์ค€์œผ๋กœ ํ•ด์‹ฑํ•˜๊ณ  ์‹ถ๋‹ค๋ฉด, shardKey ๊ธฐ๋Šฅ์„ ํ™œ์„ฑํ™”ํ•ด์•ผ ํ•œ๋‹ค.
ํ‚ค ๋ฌธ์ž์—ด์—์„œ ๊ฐ€์žฅ ์ฒซ `{`์™€ ๊ฐ€์žฅ ์ฒซ `}` ์‚ฌ์ด์˜ ๋ฌธ์ž๋กœ๋งŒ ํ•ด์‹ฑํ•˜์—ฌ ๋…ธ๋“œ๋ฅผ ๊ฒฐ์ •ํ•˜๋ฏ€๋กœ, ํ•ด์‹ฑ์„ ์›ํ•˜๋Š” ๋ฌธ์ž์—ด์„ ์ค‘๊ด„ํ˜ธ๋กœ ๊ฐ์‹ธ๋ฉด ๋œ๋‹ค.
๋งŒ์•ฝ shard key๋ฅผ ๋”ฐ๋กœ ์ง€์ •ํ•˜์ง€ ์•Š์•˜๋‹ค๋ฉด ๊ธฐ์กด๋Œ€๋กœ ์ „์ฒด ํ‚ค๋ฅผ ํ•ด์‹ฑํ•œ๋‹ค.

- setAuthDescriptor(AuthDescriptor to);

Arcus ์บ์‹œ ์„œ๋ฒ„์™€ ์—ฐ๊ฒฐ ์‹œ SASL ์ธ์ฆ์„ ์‹œ๋„ํ•œ๋‹ค. ์ธ์ฆ์— ์‹คํŒจํ•˜๋Š” ๊ฒฝ์šฐ ํ•ด๋‹น ์—ฐ๊ฒฐ์„ ์ข…๋ฃŒํ•˜๊ณ  1์ดˆ ๋’ค ์žฌ์‹œ๋„ํ•œ๋‹ค.
Expand Down