tighten up logging dependencies to use only SLF4J/logback consistently

zhangchichi · Oct 10, 2018 · 91f1505 · 91f1505
1 parent 8f35958
commit 91f1505
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 4 deletions.
diff --git a/crawler4j/pom.xml b/crawler4j/pom.xml
@@ -151,31 +151,83 @@
 					</execution>
 				</executions>
 			</plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>enforce-banned-dependencies</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <bannedDependencies>
+                                    <excludes>
+                                        <!-- 
+                                            Banning JCL because we use SLF4J (and jcl-over-slf4j).
+                                            If this occurs in your build you should find what 
+                                            dependency is bringing in JCL and add an exclusion 
+                                            rule to prevent it.
+                                        -->
+                                        <exclude>commons-logging</exclude>
+                                        <!--
+                                            Banning Log4j because we use SLF4J/Logback.  If you
+                                            come across this, exclude the Log4j dependency and 
+                                            add the log4j-over-slf4j library to replace it.
+                                        -->
+                                        <exclude>log4j</exclude>
+                                        <exclude>org.apache.logging.log4j</exclude>
+                                    </excludes>
+                                </bannedDependencies>
+                            </rules>
+                            <fail>true</fail>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
 		</plugins>
 	</build>
 
 	<dependencies>
 
-    <!-- Compile time Dependencies -->
-
+    <!-- Logging API -->
     <dependency>
-        <!-- Logging framework -->
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-api</artifactId>
         <version>${slf4j.version}</version>
     </dependency>
     <dependency>
-        <!-- Implementation of slf4j -->
+        <groupId>org.slf4j</groupId>
+        <artifactId>jcl-over-slf4j</artifactId>
+        <version>${slf4j.version}</version>
+    </dependency>
+    <dependency>
+        <groupId>org.slf4j</groupId>
+        <artifactId>jul-to-slf4j</artifactId>
+        <version>${slf4j.version}</version>
+    </dependency>
+
+    <!-- Logging Provider -->
+    <dependency>
         <groupId>ch.qos.logback</groupId>
         <artifactId>logback-classic</artifactId>
         <version>${logback.version}</version>
         <scope>runtime</scope>
     </dependency>
+
+    <!-- Compile time Dependencies -->
 	<dependency>
 		<groupId>org.apache.httpcomponents</groupId>
 		<artifactId>httpclient</artifactId>
 		<version>${apache.http.components.version}</version>
 		<scope>compile</scope>
+		<exclusions>
+		    <exclusion>
+		        <groupId>commons-logging</groupId>
+		        <artifactId>commons-logging</artifactId>
+		    </exclusion>
+		</exclusions>
 	</dependency>
 	<dependency>
 		<groupId>com.sleepycat</groupId>

diff --git a/pom.xml b/pom.xml
@@ -84,6 +84,7 @@
         <maven.gmaven.plus.version>1.5</maven.gmaven.plus.version>
         <maven.versions.version>2.5</maven.versions.version>
         <maven.forbiddenapis.version>2.4.1</maven.forbiddenapis.version>
+        <maven.enforcer.version>3.0.0-M2</maven.enforcer.version>
     </properties>
 
     <profiles>
@@ -269,6 +270,11 @@
                         </dependency>
                     </dependencies>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-enforcer-plugin</artifactId>
+                    <version>${maven.enforcer.version}</version>
+                </plugin>
             </plugins>
         </pluginManagement>
     </build>