init
This commit is contained in:
shuhongfan
@@ -0,0 +1,27 @@
|
||||
# Sentinel DataSource Nacos
|
||||
|
||||
Sentinel DataSource Nacos provides integration with [Nacos](http://nacos.io) so that Nacos
|
||||
can be the dynamic rule data source of Sentinel.
|
||||
|
||||
To use Sentinel DataSource Nacos, you should add the following dependency:
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>com.alibaba.csp</groupId>
|
||||
<artifactId>sentinel-datasource-nacos</artifactId>
|
||||
<version>x.y.z</version>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
Then you can create an `NacosDataSource` and register to rule managers.
|
||||
For instance:
|
||||
|
||||
```java
|
||||
// remoteAddress is the address of Nacos
|
||||
// groupId and dataId are concepts of Nacos
|
||||
ReadableDataSource<String, List<FlowRule>> flowRuleDataSource = new NacosDataSource<>(remoteAddress, groupId, dataId,
|
||||
source -> JSON.parseObject(source, new TypeReference<List<FlowRule>>() {}));
|
||||
FlowRuleManager.register2Property(flowRuleDataSource.getProperty());
|
||||
```
|
||||
|
||||
We've also provided an example: [sentinel-demo-nacos-datasource](https://github.com/alibaba/Sentinel/tree/master/sentinel-demo/sentinel-demo-nacos-datasource).
|
||||
@@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<parent>
|
||||
<artifactId>sentinel-extension</artifactId>
|
||||
<groupId>com.alibaba.csp</groupId>
|
||||
<version>1.8.3</version>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<artifactId>sentinel-datasource-nacos</artifactId>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<properties>
|
||||
<nacos.version>1.3.0</nacos.version>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.alibaba.csp</groupId>
|
||||
<artifactId>sentinel-datasource-extension</artifactId>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>com.alibaba.nacos</groupId>
|
||||
<artifactId>nacos-client</artifactId>
|
||||
<version>${nacos.version}</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</project>
|
||||
@@ -0,0 +1,157 @@
|
||||
/*
|
||||
* Copyright 1999-2018 Alibaba Group Holding Ltd.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
package com.alibaba.csp.sentinel.datasource.nacos;
|
||||
|
||||
import java.util.Properties;
|
||||
import java.util.concurrent.ArrayBlockingQueue;
|
||||
import java.util.concurrent.Executor;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.ThreadPoolExecutor;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
import com.alibaba.csp.sentinel.concurrent.NamedThreadFactory;
|
||||
import com.alibaba.csp.sentinel.datasource.AbstractDataSource;
|
||||
import com.alibaba.csp.sentinel.datasource.Converter;
|
||||
import com.alibaba.csp.sentinel.log.RecordLog;
|
||||
import com.alibaba.csp.sentinel.util.AssertUtil;
|
||||
import com.alibaba.csp.sentinel.util.StringUtil;
|
||||
import com.alibaba.nacos.api.NacosFactory;
|
||||
import com.alibaba.nacos.api.PropertyKeyConst;
|
||||
import com.alibaba.nacos.api.config.ConfigService;
|
||||
import com.alibaba.nacos.api.config.listener.Listener;
|
||||
|
||||
/**
|
||||
* A read-only {@code DataSource} with Nacos backend. When the data in Nacos backend has been modified,
|
||||
* Nacos will automatically push the new value so that the dynamic configuration can be real-time.
|
||||
*
|
||||
* @author Eric Zhao
|
||||
*/
|
||||
public class NacosDataSource<T> extends AbstractDataSource<String, T> {
|
||||
|
||||
private static final int DEFAULT_TIMEOUT = 3000;
|
||||
|
||||
/**
|
||||
* Single-thread pool. Once the thread pool is blocked, we throw up the old task.
|
||||
*/
|
||||
private final ExecutorService pool = new ThreadPoolExecutor(1, 1, 0, TimeUnit.MILLISECONDS,
|
||||
new ArrayBlockingQueue<Runnable>(1), new NamedThreadFactory("sentinel-nacos-ds-update", true),
|
||||
new ThreadPoolExecutor.DiscardOldestPolicy());
|
||||
|
||||
private final Listener configListener;
|
||||
private final String groupId;
|
||||
private final String dataId;
|
||||
private final Properties properties;
|
||||
|
||||
/**
|
||||
* Note: The Nacos config might be null if its initialization failed.
|
||||
*/
|
||||
private ConfigService configService = null;
|
||||
|
||||
/**
|
||||
* Constructs an read-only DataSource with Nacos backend.
|
||||
*
|
||||
* @param serverAddr server address of Nacos, cannot be empty
|
||||
* @param groupId group ID, cannot be empty
|
||||
* @param dataId data ID, cannot be empty
|
||||
* @param parser customized data parser, cannot be empty
|
||||
*/
|
||||
public NacosDataSource(final String serverAddr, final String groupId, final String dataId,
|
||||
Converter<String, T> parser) {
|
||||
this(NacosDataSource.buildProperties(serverAddr), groupId, dataId, parser);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param properties properties for construct {@link ConfigService} using {@link NacosFactory#createConfigService(Properties)}
|
||||
* @param groupId group ID, cannot be empty
|
||||
* @param dataId data ID, cannot be empty
|
||||
* @param parser customized data parser, cannot be empty
|
||||
*/
|
||||
public NacosDataSource(final Properties properties, final String groupId, final String dataId,
|
||||
Converter<String, T> parser) {
|
||||
super(parser);
|
||||
if (StringUtil.isBlank(groupId) || StringUtil.isBlank(dataId)) {
|
||||
throw new IllegalArgumentException(String.format("Bad argument: groupId=[%s], dataId=[%s]",
|
||||
groupId, dataId));
|
||||
}
|
||||
AssertUtil.notNull(properties, "Nacos properties must not be null, you could put some keys from PropertyKeyConst");
|
||||
this.groupId = groupId;
|
||||
this.dataId = dataId;
|
||||
this.properties = properties;
|
||||
this.configListener = new Listener() {
|
||||
@Override
|
||||
public Executor getExecutor() {
|
||||
return pool;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void receiveConfigInfo(final String configInfo) {
|
||||
RecordLog.info("[NacosDataSource] New property value received for (properties: {}) (dataId: {}, groupId: {}): {}",
|
||||
properties, dataId, groupId, configInfo);
|
||||
T newValue = NacosDataSource.this.parser.convert(configInfo);
|
||||
// Update the new value to the property.
|
||||
getProperty().updateValue(newValue);
|
||||
}
|
||||
};
|
||||
initNacosListener();
|
||||
loadInitialConfig();
|
||||
}
|
||||
|
||||
private void loadInitialConfig() {
|
||||
try {
|
||||
T newValue = loadConfig();
|
||||
if (newValue == null) {
|
||||
RecordLog.warn("[NacosDataSource] WARN: initial config is null, you may have to check your data source");
|
||||
}
|
||||
getProperty().updateValue(newValue);
|
||||
} catch (Exception ex) {
|
||||
RecordLog.warn("[NacosDataSource] Error when loading initial config", ex);
|
||||
}
|
||||
}
|
||||
|
||||
private void initNacosListener() {
|
||||
try {
|
||||
this.configService = NacosFactory.createConfigService(this.properties);
|
||||
// Add config listener.
|
||||
configService.addListener(dataId, groupId, configListener);
|
||||
} catch (Exception e) {
|
||||
RecordLog.warn("[NacosDataSource] Error occurred when initializing Nacos data source", e);
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public String readSource() throws Exception {
|
||||
if (configService == null) {
|
||||
throw new IllegalStateException("Nacos config service has not been initialized or error occurred");
|
||||
}
|
||||
return configService.getConfig(dataId, groupId, DEFAULT_TIMEOUT);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void close() {
|
||||
if (configService != null) {
|
||||
configService.removeListener(dataId, groupId, configListener);
|
||||
}
|
||||
pool.shutdownNow();
|
||||
}
|
||||
|
||||
private static Properties buildProperties(String serverAddr) {
|
||||
Properties properties = new Properties();
|
||||
properties.setProperty(PropertyKeyConst.SERVER_ADDR, serverAddr);
|
||||
return properties;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user