Skip to content

Commit 9217f2d

Browse files
caojiajuncaojiajun
committed
docs: update (#470)
1 parent 4e4b034 commit 9217f2d

34 files changed

Lines changed: 173 additions & 66 deletions

‎camellia-tests/camellia-hot-key-tests/pom.xml‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,37 @@
1313
<version>${revision}</version>
1414
</parent>
1515

16+
<dependencyManagement>
17+
<dependencies>
18+
<dependency>
19+
<groupId>org.springframework.boot</groupId>
20+
<artifactId>spring-boot-dependencies</artifactId>
21+
<version>2.7.18</version>
22+
<type>pom</type>
23+
<scope>import</scope>
24+
</dependency>
25+
<dependency>
26+
<groupId>org.springframework.cloud</groupId>
27+
<artifactId>spring-cloud-dependencies</artifactId>
28+
<version>2021.0.9</version>
29+
<type>pom</type>
30+
<scope>import</scope>
31+
</dependency>
32+
</dependencies>
33+
</dependencyManagement>
34+
1635
<dependencies>
17-
</dependencies>
36+
<dependency>
37+
<groupId>com.netease.nim</groupId>
38+
<artifactId>camellia-hot-key-sdk</artifactId>
39+
<version>${revision}</version>
40+
</dependency>
41+
<dependency>
42+
<groupId>com.netease.nim</groupId>
43+
<artifactId>camellia-discovery-spring</artifactId>
44+
<version>${revision}</version>
45+
</dependency>
46+
</dependencies>
1847
<build>
1948
<plugins>
2049
<plugin>

‎camellia-tests/camellia-hot-key-tests/src/main/java/com/netease/nim/camellia/hotkey/TestEureka.java‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package com.netease.nim.camellia.hotkey;
2+
3+
import com.netease.nim.camellia.discovery.spring.SpringCamelliaDiscoveryFactory;
4+
import com.netease.nim.camellia.hot.key.sdk.CamelliaHotKeyMonitorSdk;
5+
import com.netease.nim.camellia.hot.key.sdk.CamelliaHotKeySdk;
6+
import com.netease.nim.camellia.hot.key.sdk.conf.CamelliaHotKeyMonitorSdkConfig;
7+
import com.netease.nim.camellia.hot.key.sdk.conf.CamelliaHotKeySdkConfig;
8+
import org.springframework.beans.factory.annotation.Autowired;
9+
import org.springframework.cloud.client.discovery.DiscoveryClient;
10+
11+
/**
12+
* Created by caojiajun on 2026/2/26
13+
*/
14+
public class TestEureka {
15+
16+
@Autowired
17+
private DiscoveryClient discoveryClient;
18+
19+
public void test() {
20+
String applicationName = "camellia-hot-key-server";
21+
22+
CamelliaHotKeySdkConfig config = new CamelliaHotKeySdkConfig();
23+
config.setDiscoveryFactory(new SpringCamelliaDiscoveryFactory(discoveryClient));
24+
config.setServiceName(applicationName);
25+
CamelliaHotKeySdk sdk = new CamelliaHotKeySdk(config);
26+
27+
//设置相关参数，一般来说默认即可
28+
CamelliaHotKeyMonitorSdkConfig monitorSdkConfig = new CamelliaHotKeyMonitorSdkConfig();
29+
//初始化CamelliaHotKeyMonitorSdk，一般全局一个即可
30+
CamelliaHotKeyMonitorSdk monitorSdk = new CamelliaHotKeyMonitorSdk(sdk, monitorSdkConfig);
31+
32+
//把key的访问push给server即可
33+
String namespace1 = "db_cache";
34+
monitorSdk.push(namespace1, "key1", 1);
35+
monitorSdk.push(namespace1, "key2", 1);
36+
monitorSdk.push(namespace1, "key2", 1);
37+
38+
String namespace2 = "api_request";
39+
monitorSdk.push(namespace2, "/xx/xx", 1);
40+
monitorSdk.push(namespace2, "/xx/xx2", 1);
41+
}
42+
}

‎camellia-tests/camellia-hot-key-tests/src/main/java/com/netease/nim/camellia/hotkey/TestNoRegister.java‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
package com.netease.nim.camellia.hotkey;
2+
3+
import com.netease.nim.camellia.core.discovery.CamelliaDiscoveryFactory;
4+
import com.netease.nim.camellia.core.discovery.LocalConfCamelliaDiscovery;
5+
import com.netease.nim.camellia.core.discovery.LocalConfCamelliaDiscoveryFactory;
6+
import com.netease.nim.camellia.core.discovery.ServerNode;
7+
import com.netease.nim.camellia.hot.key.sdk.CamelliaHotKeyMonitorSdk;
8+
import com.netease.nim.camellia.hot.key.sdk.CamelliaHotKeySdk;
9+
import com.netease.nim.camellia.hot.key.sdk.conf.CamelliaHotKeyMonitorSdkConfig;
10+
import com.netease.nim.camellia.hot.key.sdk.conf.CamelliaHotKeySdkConfig;
11+
12+
import java.util.ArrayList;
13+
import java.util.List;
14+
15+
/**
16+
* Created by caojiajun on 2026/2/26
17+
*/
18+
public class TestNoRegister {
19+
20+
public static void main(String[] args) {
21+
String applicationName = "camellia-hot-key-server";
22+
List<ServerNode> list = new ArrayList<>();
23+
list.add(new ServerNode("127.0.0.1", 7070));
24+
list.add(new ServerNode("127.0.0.2", 7070));
25+
26+
CamelliaHotKeySdkConfig config = new CamelliaHotKeySdkConfig();
27+
config.setDiscoveryFactory(new LocalConfCamelliaDiscoveryFactory(applicationName, new LocalConfCamelliaDiscovery(list)));
28+
config.setServiceName(applicationName);
29+
CamelliaHotKeySdk sdk = new CamelliaHotKeySdk(config);
30+
31+
//设置相关参数，一般来说默认即可
32+
CamelliaHotKeyMonitorSdkConfig monitorSdkConfig = new CamelliaHotKeyMonitorSdkConfig();
33+
//初始化CamelliaHotKeyMonitorSdk，一般全局一个即可
34+
CamelliaHotKeyMonitorSdk monitorSdk = new CamelliaHotKeyMonitorSdk(sdk, monitorSdkConfig);
35+
36+
//把key的访问push给server即可
37+
String namespace1 = "db_cache";
38+
monitorSdk.push(namespace1, "key1", 1);
39+
monitorSdk.push(namespace1, "key2", 1);
40+
monitorSdk.push(namespace1, "key2", 1);
41+
42+
String namespace2 = "api_request";
43+
monitorSdk.push(namespace2, "/xx/xx", 1);
44+
monitorSdk.push(namespace2, "/xx/xx2", 1);
45+
}
46+
}

‎docs/camellia-cache/cache.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ base on spring-cache:
2424
<dependency>
2525
<groupId>com.netease.nim</groupId>
2626
<artifactId>camellia-cache-spring-boot-starter</artifactId>
27-
<version>1.3.7</version>
27+
<version>a.b.c</version>
2828
</dependency>
2929
<dependency>
3030
<groupId>com.netease.nim</groupId>
3131
<artifactId>camellia-redis-spring-boot-starter</artifactId>
32-
<version>1.3.7</version>
32+
<version>a.b.c</version>
3333
</dependency>
3434
```
3535
* 使用jedis-3.6.3
3636
```
3737
<dependency>
3838
<groupId>com.netease.nim</groupId>
3939
<artifactId>camellia-cache-spring-boot-starter</artifactId>
40-
<version>1.3.7</version>
40+
<version>a.b.c</version>
4141
<exclusions>
4242
<exclusion>
4343
<groupId>com.netease.nim</groupId>
@@ -48,7 +48,7 @@ base on spring-cache:
4848
<dependency>
4949
<groupId>com.netease.nim</groupId>
5050
<artifactId>camellia-redis3-spring-boot-starter</artifactId>
51-
<version>1.3.7</version>
51+
<version>a.b.c</version>
5252
</dependency>
5353
```
5454

‎docs/camellia-delay-queue/quick-start-spring-boot-starter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<dependency>
55
<groupId>com.netease.nim</groupId>
66
<artifactId>camellia-delay-queue-server-spring-boot-starter</artifactId>
7-
<version>1.3.7</version>
7+
<version>a.b.c</version>
88
</dependency>
99
```
1010

‎docs/camellia-delay-queue/sample.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<dependency>
66
<groupId>com.netease.nim</groupId>
77
<artifactId>camellia-delay-queue-sdk-spring-boot-starter</artifactId>
8-
<version>1.3.7</version>
8+
<version>a.b.c</version>
99
</dependency>
1010
<dependency>
1111
<groupId>org.springframework.boot</groupId>
@@ -67,7 +67,7 @@ public class ProducerController {
6767
<dependency>
6868
<groupId>com.netease.nim</groupId>
6969
<artifactId>camellia-delay-queue-sdk-spring-boot-starter</artifactId>
70-
<version>1.3.7</version>
70+
<version>a.b.c</version>
7171
</dependency>
7272
```
7373
增加application.yml文件，主要是配置delay-queue-server的地址（可以基于nginx配置一个域名，也可以基于注册中心）
@@ -137,7 +137,7 @@ curl 'http://127.0.0.1:8081/sendDelayMsg?topic=topic1&msg=abc&delaySeconds=10'
137137
<dependency>
138138
<groupId>com.netease.nim</groupId>
139139
<artifactId>camellia-delay-queue-sdk</artifactId>
140-
<version>1.3.7</version>
140+
<version>a.b.c</version>
141141
</dependency>
142142
```
143143
示例代码：

‎docs/camellia-hot-key/hot-key-config.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ camellia-config下每个key代表一个hot-key的namespace，value代表config
150150
<dependency>
151151
<groupId>com.netease.nim</groupId>
152152
<artifactId>camellia-hot-key-config-nacos</artifactId>
153-
<version>1.3.7</version>
153+
<version>a.b.c</version>
154154
</dependency>
155155
```
156156

@@ -196,7 +196,7 @@ camellia-hot-key-server:
196196
<dependency>
197197
<groupId>com.netease.nim</groupId>
198198
<artifactId>camellia-hot-key-config-etcd</artifactId>
199-
<version>1.3.7</version>
199+
<version>a.b.c</version>
200200
</dependency>
201201
```
202202

‎docs/camellia-hot-key/hot-key-discovery.md‎

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<dependency>
1414
<groupId>com.netease.nim</groupId>
1515
<artifactId>camellia-hot-key-server-zk-registry-spring-boot-starter</artifactId>
16-
<version>1.3.7</version>
16+
<version>a.b.c</version>
1717
</dependency>
1818
```
1919

@@ -85,7 +85,7 @@ public class MyConsoleService extends ConsoleServiceAdaptor {
8585
<dependency>
8686
<groupId>com.netease.nim</groupId>
8787
<artifactId>camellia-hot-key-discovery-zk</artifactId>
88-
<version>1.3.7</version>
88+
<version>a.b.c</version>
8989
</dependency>
9090
```
9191

@@ -194,15 +194,6 @@ public class MyConsoleService extends ConsoleServiceAdaptor {
194194
```
195195

196196
#### sdk侧
197-
* 额外引入依赖
198-
199-
```
200-
<dependency>
201-
<groupId>com.netease.nim</groupId>
202-
<artifactId>camellia-hot-key-discovery-eureka</artifactId>
203-
<version>1.3.7</version>
204-
</dependency>
205-
```
206197

207198
* 编写代码如下：
208199
```java
@@ -213,11 +204,10 @@ public class TestEureka {
213204

214205
public void test() {
215206
String applicationName = "camellia-hot-key-server";
216-
int refreshIntervalSeconds = 5;
217-
EurekaHotKeyServerDiscovery discovery = new EurekaHotKeyServerDiscovery(discoveryClient, applicationName, refreshIntervalSeconds);
218207

219208
CamelliaHotKeySdkConfig config = new CamelliaHotKeySdkConfig();
220-
config.setDiscovery(discovery);
209+
config.setDiscoveryFactory(new SpringCamelliaDiscoveryFactory(discoveryClient));
210+
config.setServiceName(applicationName);
221211
CamelliaHotKeySdk sdk = new CamelliaHotKeySdk(config);
222212

223213
//设置相关参数，一般来说默认即可
@@ -251,13 +241,13 @@ public class TestNoRegister {
251241

252242
public static void main(String[] args) {
253243
String applicationName = "camellia-hot-key-server";
254-
List<HotKeyServerAddr> list = new ArrayList<>();
255-
list.add(new HotKeyServerAddr("127.0.0.1", 7070));
256-
list.add(new HotKeyServerAddr("127.0.0.2", 7070));
257-
LocalConfHotKeyServerDiscovery discovery = new LocalConfHotKeyServerDiscovery(applicationName, list);
244+
List<ServerNode> list = new ArrayList<>();
245+
list.add(new ServerNode("127.0.0.1", 7070));
246+
list.add(new ServerNode("127.0.0.2", 7070));
258247

259248
CamelliaHotKeySdkConfig config = new CamelliaHotKeySdkConfig();
260-
config.setDiscovery(discovery);
249+
config.setDiscoveryFactory(new LocalConfCamelliaDiscoveryFactory(applicationName, new LocalConfCamelliaDiscovery(list)));
250+
config.setServiceName(applicationName);
261251
CamelliaHotKeySdk sdk = new CamelliaHotKeySdk(config);
262252

263253
//设置相关参数，一般来说默认即可

‎docs/camellia-hot-key/hot-key-sdk.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ public interface ValueLoader<T> {
136136
<dependency>
137137
<groupId>com.netease.nim</groupId>
138138
<artifactId>camellia-hot-key-sdk</artifactId>
139-
<version>1.3.7</version>
139+
<version>a.b.c</version>
140140
</dependency>
141141
```
142142

‎docs/camellia-hot-key/hot-key-server.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<dependency>
1515
<groupId>com.netease.nim</groupId>
1616
<artifactId>camellia-hot-key-server-spring-boot-starter</artifactId>
17-
<version>1.3.7</version>
17+
<version>a.b.c</version>
1818
</dependency>
1919
```
2020
2) 编写主类Application.java, 如下:

0 commit comments

Comments
 (0)