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

56 lines
2.2 KiB
Diff
Raw Normal View History

2021-06-11 14:02:28 +02: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 13:18:01 +02:00
diff --git a/build.gradle.kts b/build.gradle.kts
2023-06-09 02:22:51 +02:00
index b0ca0ddffce2524e82d891c7a4d69d3ef9f2c097..4b2330bac734cd07f8798ceeb6d9c67bd3f3521d 100644
2021-06-12 13:18:01 +02:00
--- a/build.gradle.kts
+++ b/build.gradle.kts
2023-06-07 18:24:39 +02:00
@@ -42,6 +42,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 13:18:01 +02:00
implementation("org.ow2.asm:asm:9.4")
implementation("org.ow2.asm:asm-commons:9.4")
2021-06-11 14:02:28 +02:00
diff --git a/src/main/java/org/bukkit/plugin/Plugin.java b/src/main/java/org/bukkit/plugin/Plugin.java
2023-02-19 15:57:10 +01:00
index 8c76716249e44ed8bf6be94c1f5c7b6d9bb35be2..4eb639fbb46a0848be207149ea433455550fae1c 100644
2021-06-11 14:02:28 +02:00
--- a/src/main/java/org/bukkit/plugin/Plugin.java
+++ b/src/main/java/org/bukkit/plugin/Plugin.java
2023-02-19 15:57:10 +01:00
@@ -198,6 +198,22 @@ public interface Plugin extends TabExecutor {
}
// Paper end
2021-06-11 14:02:28 +02:00
+ // Paper start - Add SLF4J/Log4J loggers
2021-06-11 14:02:28 +02: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 14:02:28 +02:00
+ // Paper end
+
/**
* Returns the name of the plugin.
* <p>