Skip to content

Commit

Permalink
[ISSUE alibaba#9276] 新增根据配置信息检索内容的功能 (alibaba#9925)
Browse files Browse the repository at this point in the history
* 新增根据配置信息检索内容的功能

* use offer replace add

* use offer replace add

* use offer replace add

* update exception type and  limit some config as configurable

* update

* update params

* update params

* update params
  • Loading branch information
985492783 authored Feb 21, 2023
1 parent 67d5acc commit a6332b2
Show file tree
Hide file tree
Showing 20 changed files with 513 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -290,4 +290,8 @@ public class Constants {
public static final int LIMIT_ERROR_CODE = 429;

public static final String NACOS_PLUGIN_DATASOURCE_LOG = "nacos.plugin.datasource.log.enabled";

public static final String CONFIG_SEARCH_BLUR = "blur";

public static final String CONFIG_SEARCH_ACCURATE = "accurate";
}
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,10 @@ public class PropertiesConstant {

public static final String EMBEDDED_STORAGE = "embeddedStorage";

public static final String SEARCH_MAX_CAPACITY = "nacos.config.search.max_capacity";

public static final String SEARCH_MAX_THREAD = "nacos.config.search.max_thread";

public static final String SEARCH_WAIT_TIMEOUT = "nacos.config.search.wait_timeout";

}
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,19 @@
import com.alibaba.nacos.common.utils.StringUtils;
import com.alibaba.nacos.config.server.constant.Constants;
import com.alibaba.nacos.config.server.controller.ConfigServletInner;
import com.alibaba.nacos.config.server.model.ConfigInfo;
import com.alibaba.nacos.config.server.model.ConfigRequestInfo;
import com.alibaba.nacos.config.server.model.Page;
import com.alibaba.nacos.config.server.model.form.ConfigForm;
import com.alibaba.nacos.config.server.service.ConfigDetailService;
import com.alibaba.nacos.config.server.service.ConfigOperationService;
import com.alibaba.nacos.config.server.utils.ParamUtils;
import com.alibaba.nacos.config.server.utils.RequestUtil;
import com.alibaba.nacos.plugin.auth.constant.ActionTypes;
import com.alibaba.nacos.plugin.auth.constant.SignType;
import com.alibaba.nacos.plugin.encryption.handler.EncryptionHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
Expand All @@ -46,6 +51,8 @@
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

/**
* Special controller v2 for soft load client to publish data.
Expand All @@ -58,14 +65,18 @@
@RestController
@RequestMapping(Constants.CONFIG_CONTROLLER_V2_PATH)
public class ConfigControllerV2 {
private static final Logger LOGGER = LoggerFactory.getLogger(ConfigControllerV2.class);

private final ConfigServletInner inner;

private final ConfigOperationService configOperationService;

public ConfigControllerV2(ConfigServletInner inner, ConfigOperationService configOperationService) {
private final ConfigDetailService configDetailService;

public ConfigControllerV2(ConfigServletInner inner, ConfigOperationService configOperationService, ConfigDetailService configDetailService) {
this.inner = inner;
this.configOperationService = configOperationService;
this.configDetailService = configDetailService;
}

/**
Expand Down Expand Up @@ -152,4 +163,36 @@ public Result<Boolean> deleteConfig(HttpServletRequest request, @RequestParam("d
String srcUser = RequestUtil.getSrcUserName(request);
return Result.success(configOperationService.deleteConfig(dataId, group, namespaceId, tag, clientIp, srcUser));
}

/**
* search config by config detail.
*
*/
@GetMapping("/searchDetail")
@Secured(action = ActionTypes.READ, signType = SignType.CONFIG)
public Page<ConfigInfo> searchConfigByDetails(@RequestParam("dataId") String dataId, @RequestParam("group") String group,
@RequestParam(value = "appName", required = false) String appName,
@RequestParam(value = "tenant", required = false, defaultValue = StringUtils.EMPTY) String tenant,
@RequestParam(value = "config_tags", required = false) String configTags,
@RequestParam(value = "config_detail") String configDetail,
@RequestParam(value = "search", defaultValue = "blur", required = false) String search,
@RequestParam("pageNo") int pageNo, @RequestParam("pageSize") int pageSize) throws NacosException {
Map<String, Object> configAdvanceInfo = new HashMap<>(100);
if (StringUtils.isNotBlank(appName)) {
configAdvanceInfo.put("appName", appName);
}
if (StringUtils.isNotBlank(configTags)) {
configAdvanceInfo.put("config_tags", configTags);
}
if (StringUtils.isNotBlank(configDetail)) {
configAdvanceInfo.put("content", configDetail);
}
try {
return configDetailService.findConfigInfoPage(search, pageNo, pageSize, dataId, group, tenant, configAdvanceInfo);
} catch (Exception e) {
String errorMsg = "serialize page error, dataId=" + dataId + ", group=" + group;
LOGGER.error(errorMsg, e);
throw e;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
/*
* 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.nacos.config.server.service;

import com.alibaba.nacos.api.exception.runtime.NacosRuntimeException;
import com.alibaba.nacos.config.server.constant.Constants;
import com.alibaba.nacos.config.server.constant.PropertiesConstant;
import com.alibaba.nacos.config.server.model.ConfigInfo;
import com.alibaba.nacos.config.server.model.Page;
import com.alibaba.nacos.config.server.service.repository.ConfigInfoPersistService;
import com.alibaba.nacos.sys.env.EnvUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

import java.util.Map;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledThreadPoolExecutor;

/**
* config detail service.
*
* @author [email protected]
* @date 2023/2/9 5:25
*/
@Service
public class ConfigDetailService {
private static final Logger LOGGER = LoggerFactory.getLogger(ConfigDetailService.class);

private final ConfigInfoPersistService configInfoPersistService;

private BlockingQueue<SearchEvent> eventLinkedBlockingQueue;

private ScheduledExecutorService clientEventExecutor;

/**
* the max_capacity of eventLinkedBlockingQueue may be controlled by the properties {@link PropertiesConstant#SEARCH_MAX_CAPACITY}.
*/
private static int maxCapacity = 4;

private static final int MAX_CAPACITY = 32;

/**
* the wait_timeout of search config business may be controlled by the properties {@link PropertiesConstant#SEARCH_WAIT_TIMEOUT}.
*/
private static long waitTimeout = 8000L;

/**
* the max_thread of clientEventExecutor may be controlled by the properties {@link PropertiesConstant#SEARCH_MAX_THREAD}.
*/
private static int maxThread = 2;

private static final int MAX_THREAD = 16;

public ConfigDetailService(ConfigInfoPersistService configInfoPersistService) {
this.configInfoPersistService = configInfoPersistService;
loadSetting();
initWorker();
}

private void loadSetting() {
setMaxCapacity(Math.min(Integer.parseInt(EnvUtil.getProperty(PropertiesConstant.SEARCH_MAX_CAPACITY,
String.valueOf(getMaxCapacity()))), MAX_CAPACITY));
setMaxThread(Math.min(Integer.parseInt(EnvUtil.getProperty(PropertiesConstant.SEARCH_MAX_THREAD,
String.valueOf(getMaxThread()))), MAX_THREAD));
setWaitTimeout(Integer.parseInt(EnvUtil.getProperty(PropertiesConstant.SEARCH_WAIT_TIMEOUT,
String.valueOf(getWaitTimeout()))));
}

/**
* init worker thread.
*/
private void initWorker() {
this.eventLinkedBlockingQueue = new LinkedBlockingQueue<>(maxCapacity);

clientEventExecutor = new ScheduledThreadPoolExecutor(maxThread, r -> {
Thread t = new Thread(r);
t.setName("com.alibaba.nacos.config.search.worker");
t.setDaemon(true);
return t;
});

for (int i = 0; i < maxThread; i++) {
clientEventExecutor.submit(() -> {
while (true) {
try {
SearchEvent event = eventLinkedBlockingQueue.take();
Page<ConfigInfo> result = null;
if (Constants.CONFIG_SEARCH_BLUR.equals(event.getType())) {
result = configInfoPersistService.findConfigInfoLike4Page(event.pageNo, event.pageSize,
event.dataId, event.group, event.tenant, event.configAdvanceInfo);
} else {
result = configInfoPersistService.findConfigInfo4Page(event.pageNo, event.pageSize,
event.dataId, event.group, event.tenant, event.configAdvanceInfo);
}
synchronized (event) {
event.setResponse(result);
event.notifyAll();
}
} catch (Exception e) {
LOGGER.error("catch search worker error: {}", e.getMessage());
}
}
});
}
}

/**
* block thread and use workerThread to search config.
*/
public Page<ConfigInfo> findConfigInfoPage(String search, int pageNo, int pageSize, String dataId, String group,
String tenant, Map<String, Object> configAdvanceInfo) throws NacosRuntimeException {
SearchEvent searchEvent = new SearchEvent(search, pageNo, pageSize, dataId, group, tenant,
configAdvanceInfo);
Page<ConfigInfo> result = null;
try {
synchronized (searchEvent) {
boolean offer = eventLinkedBlockingQueue.offer(searchEvent);
if (!offer) {
throw new NacosRuntimeException(503, "server limit match.");
}
searchEvent.wait(waitTimeout);
result = searchEvent.getResponse();
}
} catch (InterruptedException e) {
LOGGER.error("get config detail timeout: {}.", e.getMessage());
throw new NacosRuntimeException(503, "server limit match.");
}
if (result == null) {
throw new NacosRuntimeException(503, "server limit match.");
}
return result;
}

public static int getMaxCapacity() {
return maxCapacity;
}

public static void setMaxCapacity(int maxCapacity) {
ConfigDetailService.maxCapacity = maxCapacity;
}

public static long getWaitTimeout() {
return waitTimeout;
}

public static void setWaitTimeout(long waitTimeout) {
ConfigDetailService.waitTimeout = waitTimeout;
}

public static int getMaxThread() {
return maxThread;
}

public static void setMaxThread(int maxThread) {
ConfigDetailService.maxThread = maxThread;
}

public static class SearchEvent {
private String type;

private int pageNo;

private int pageSize;

private String dataId;

private String group;

private String tenant;

private Map<String, Object> configAdvanceInfo;

private Page<ConfigInfo> response;

public SearchEvent() {
}

public SearchEvent(String type, int pageNo, int pageSize, String dataId, String group, String tenant,
Map<String, Object> configAdvanceInfo) {
this.type = type;
this.pageNo = pageNo;
this.pageSize = pageSize;
this.dataId = dataId;
this.group = group;
this.tenant = tenant;
this.configAdvanceInfo = configAdvanceInfo;
}

public String getType() {
return type;
}

public int getPageNo() {
return pageNo;
}

public int getPageSize() {
return pageSize;
}

public String getDataId() {
return dataId;
}

public String getGroup() {
return group;
}

public String getTenant() {
return tenant;
}

public Map<String, Object> getConfigAdvanceInfo() {
return configAdvanceInfo;
}

public Page<ConfigInfo> getResponse() {
return response;
}

public void setResponse(Page<ConfigInfo> response) {
this.response = response;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,7 @@ public Page<ConfigInfo> findConfigInfo4Page(final int pageNo, final int pageSize
final String group, final String tenant, final Map<String, Object> configAdvanceInfo) {
String tenantTmp = StringUtils.isBlank(tenant) ? StringUtils.EMPTY : tenant;
final String appName = configAdvanceInfo == null ? null : (String) configAdvanceInfo.get("appName");
final String content = configAdvanceInfo == null ? null : (String) configAdvanceInfo.get("content");
final String configTags = configAdvanceInfo == null ? null : (String) configAdvanceInfo.get("config_tags");
String sql = null;
String sqlCount = null;
Expand All @@ -692,6 +693,10 @@ public Page<ConfigInfo> findConfigInfo4Page(final int pageNo, final int pageSize
paramList.add(appName);
paramsMap.put(APP_NAME, APP_NAME);
}
if (!StringUtils.isBlank(content)) {
paramList.add(content);
paramsMap.put(CONTENT, CONTENT);
}
final int startRow = (pageNo - 1) * pageSize;
if (StringUtils.isNotBlank(configTags)) {
String[] tagArr = configTags.split(",");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,7 @@ public Page<ConfigInfo> findConfigInfo4Page(final int pageNo, final int pageSize
String tenantTmp = StringUtils.isBlank(tenant) ? StringUtils.EMPTY : tenant;
PaginationHelper<ConfigInfo> helper = createPaginationHelper();
final String appName = configAdvanceInfo == null ? null : (String) configAdvanceInfo.get("appName");
final String content = configAdvanceInfo == null ? null : (String) configAdvanceInfo.get("content");
final String configTags = configAdvanceInfo == null ? null : (String) configAdvanceInfo.get("config_tags");
String sql = null;
String sqlCount = null;
Expand All @@ -713,6 +714,10 @@ public Page<ConfigInfo> findConfigInfo4Page(final int pageNo, final int pageSize
paramList.add(appName);
paramsMap.put(APP_NAME, APP_NAME);
}
if (!StringUtils.isBlank(content)) {
paramList.add(content);
paramsMap.put(CONTENT, CONTENT);
}
final int startRow = (pageNo - 1) * pageSize;
if (StringUtils.isNotBlank(configTags)) {
String[] tagArr = configTags.split(",");
Expand Down
Loading

0 comments on commit a6332b2

Please sign in to comment.