papermc/patches/api/0069-Allow-plugins-to-use-SLF4J-for-logging.patch

56 lines
2.2 KiB
Diff
Raw Normal View History

2021-06-11 12:02:28 +00:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Minecrell <minecrell@minecrell.net>
Date: Thu, 21 Sep 2017 16:33:12 +0200
Subject: [PATCH] Allow plugins to use SLF4J for logging
SLF4J is a commonly used abstraction for various logging frameworks
such as java.util.logging (JUL) or Log4j. Currently, plugins are
required to do all their logging using the provided JUL logger.
This is annoying for plugins that target multiple platforms or when
using libraries that log messages using SLF4J.
Expose SLF4J as optional logging API for plugins, so they can use
it without having to shade it in the plugin and going through
several layers of logging abstraction.
2021-06-12 11:18:01 +00:00
diff --git a/build.gradle.kts b/build.gradle.kts
index 47e08784c71b0e25c21bc6b15da0385e4a1806d4..e950bce5047552bdd3f5664eb24ce290b0a06225 100644
2021-06-12 11:18:01 +00:00
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -39,6 +39,8 @@ dependencies {
apiAndDocs("net.kyori:adventure-text-serializer-legacy")
apiAndDocs("net.kyori:adventure-text-serializer-plain")
apiAndDocs("net.kyori:adventure-text-logger-slf4j")
+ api("org.apache.logging.log4j:log4j-api:2.17.1")
+ api("org.slf4j:slf4j-api:1.8.0-beta4")
2021-06-12 11:18:01 +00:00
implementation("org.ow2.asm:asm:9.2")
implementation("org.ow2.asm:asm-commons:9.2")
2021-06-11 12:02:28 +00:00
diff --git a/src/main/java/org/bukkit/plugin/Plugin.java b/src/main/java/org/bukkit/plugin/Plugin.java
index b37938745f916b5f0111b07b1a1c97527f026e9d..08aef59d8443038771704d9587e31f299e587307 100644
2021-06-11 12:02:28 +00:00
--- a/src/main/java/org/bukkit/plugin/Plugin.java
+++ b/src/main/java/org/bukkit/plugin/Plugin.java
@@ -186,6 +186,22 @@ public interface Plugin extends TabExecutor {
}
// Paper end
2021-06-11 12:02:28 +00:00
+ // Paper start - Add SLF4J/Log4J loggers
2021-06-11 12:02:28 +00:00
+ @NotNull
+ default org.slf4j.Logger getSLF4JLogger() {
+ return org.slf4j.LoggerFactory.getLogger(getLogger().getName());
+ }
+
+ /**
+ * @deprecated use {@link #getSLF4JLogger()}
+ */
+ @Deprecated
+ @NotNull
+ default org.apache.logging.log4j.Logger getLog4JLogger() {
+ return org.apache.logging.log4j.LogManager.getLogger(getLogger().getName());
+ }
2021-06-11 12:02:28 +00:00
+ // Paper end
+
/**
* Returns the name of the plugin.
* <p>