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

52 lines
2.1 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 af2f95b6c6a71b4919edb38e520292676c1cc25d..720ba2774196f24cca6c4d1b173f90f8151c8a5e 100644
2021-06-12 11:18:01 +00:00
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -35,6 +35,8 @@ dependencies {
apiAndDocs("net.kyori:adventure-text-serializer-gson")
apiAndDocs("net.kyori:adventure-text-serializer-legacy")
apiAndDocs("net.kyori:adventure-text-serializer-plain")
2021-06-12 11:18:01 +00:00
+ api("org.apache.logging.log4j:log4j-api:2.14.1") // Paper
+ api("org.slf4j:slf4j-api:1.7.30") // Paper
2021-06-12 11:18:01 +00:00
implementation("org.ow2.asm:asm:9.1")
implementation("org.ow2.asm:asm-commons:9.1")
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 03ca87a1cbace2459174bb7bb8847bda766e80c5..c25fc646be750d3a3b2f4fb3f1c53daee5254107 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
@@ -179,6 +179,18 @@ public interface Plugin extends TabExecutor {
2021-06-11 12:02:28 +00:00
@NotNull
public Logger getLogger();
+ // 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());
+ }
+
+ @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>