Skip to content
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.

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

[ISSUE-#4567] Refactor nacos-client Load Logging Configuration code. #4572

Merged
merged 4 commits into from
Dec 26, 2020
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* 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.client.logging;

import com.alibaba.nacos.client.logging.log4j2.Log4J2NacosLogging;
import com.alibaba.nacos.client.logging.logback.LogbackNacosLogging;
import org.slf4j.LoggerFactory;
import org.slf4j.Logger;

/**
* nacos logging.
*
* @author mai.jh
*/
public class NacosLogging {

private static final Logger LOGGER = LoggerFactory.getLogger(NacosLogging.class);

private AbstractNacosLogging nacosLogging;

private boolean isLogback = false;

private NacosLogging() {
try {
Class.forName("ch.qos.logback.classic.Logger");
nacosLogging = new LogbackNacosLogging();
isLogback = true;
} catch (ClassNotFoundException e) {
nacosLogging = new Log4J2NacosLogging();
}
}

private static class NacosLoggingInstance {

private static final NacosLogging INSTANCE = new NacosLogging();
}

public static NacosLogging getInstance() {
return NacosLoggingInstance.INSTANCE;
}

/**
* Load logging Configuration.
*/
public void loadConfiguration() {
try {
nacosLogging.loadConfiguration();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个变量感觉好绕啊。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里是单例模式+策略模式的实现,对外其实只暴露了这一个方法,内部具体是logback还是log4j2是在初始化的时候决定的。

暂时没有开放完全拓展,主要是两个考虑, 一方面是nacos的日志主要是给运维人员排查用,不希望业务人员随意的改动nacos日志输出的级别和内容,另一方面日志框架其实并不太多,不会频繁扩展,适配起来难度不高。

将来如果需要完全拓展, 初始化加载的时候用个SPI就可以了。

} catch (Throwable t) {
if (isLogback) {
LOGGER.warn("Load Logback Configuration of Nacos fail, message: {}", t.getMessage());
} else {
LOGGER.warn("Load Log4j Configuration of Nacos fail, message: {}", t.getMessage());
}
}
}
}
32 changes: 2 additions & 30 deletions client/src/main/java/com/alibaba/nacos/client/utils/LogUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@

package com.alibaba.nacos.client.utils;

import com.alibaba.nacos.client.logging.AbstractNacosLogging;
import com.alibaba.nacos.client.logging.log4j2.Log4J2NacosLogging;
import com.alibaba.nacos.client.logging.logback.LogbackNacosLogging;
import com.alibaba.nacos.client.logging.NacosLogging;
import org.slf4j.Logger;

import static org.slf4j.LoggerFactory.getLogger;
Expand All @@ -34,33 +32,7 @@ public class LogUtils {
public static final Logger NAMING_LOGGER;

static {
try {
boolean isLogback = false;
AbstractNacosLogging nacosLogging;

try {
Class.forName("ch.qos.logback.classic.Logger");
nacosLogging = new LogbackNacosLogging();
isLogback = true;
} catch (ClassNotFoundException e) {
nacosLogging = new Log4J2NacosLogging();
}

try {
nacosLogging.loadConfiguration();
} catch (Throwable t) {
if (isLogback) {
getLogger(LogUtils.class)
.warn("Load Logback Configuration of Nacos fail, message: {}", t.getMessage());
} else {
getLogger(LogUtils.class)
.warn("Load Log4j Configuration of Nacos fail, message: {}", t.getMessage());
}
}
} catch (Throwable ex) {
getLogger(LogUtils.class).warn("Init Nacos Logging fail, message: {}", ex.getMessage());
}

NacosLogging.getInstance().loadConfiguration();
NAMING_LOGGER = getLogger("com.alibaba.nacos.client.naming");
}

Expand Down