papermc/patches/api/0068-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 7cb2fd3adcbf425857ec3de03d009d4c0bd81dc3..689d470ebe2c7e25e4c87f6127978d1d283e55b5 100644
2021-06-12 11:18:01 +00:00
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -37,6 +37,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 febfec6efafd76bb59b4b43aa223af16f73339b4..e1174ed0b0f9b77068117712a867aa28bfaa64b5 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
@@ -166,6 +166,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>