JSF 2 + Log4j集成示例

骑猪看日落 2023-02-15 05:12 9阅读 0赞

![jsf log4j徽标][jsf log4j]![jsf log4j徽标][jsf log4j 1]

在本教程中，我们将向您展示如何将log4j框架与JSF 2.x Web应用程序集成。 JSF使用`java.util.logging` ，您需要做一些额外的工作才能将日志从JSF的`java.util.logging`重定向到`log4j` ，这会严重[影响性能][Link 1] ，请确保仅在本地开发或调试环境中使用此技巧。

审查项目环境：

1.  SLF4j 1.7.7
2.  Log4j 1.2.17
3.  JSF 2.2.7
4.  Maven 3
5.  雄猫6
6.  Eclipse开普勒4.3

简而言之，集成JSF和log4j的步骤。

1.  由于该项目在Eclipse环境中运行，因此在`logging.properties`上打开JSF日志记录，因此将使用Eclipse的`JRE/lib/logging.properties` 。
2.  创建一个`log4j.properties`并将其放在类路径上。
3.  创建一个Servlet的侦听器，安装`slf4j bridge handler`以将日志记录从java.util.logging重定向到log4j。

> **注意**  
> 参考此[SLF4j桥接旧版API][SLF4j_API]

## 1.项目目录 ##

查看最终项目结构。

![jsf-log4j目录][jsf-log4j]![jsf-log4j目录][jsf-log4j 1]

## 2.项目依赖 ##

您需要slf4j-log4j12和jul-to-slf4j。

pom.xml

<properties>
    		<jdk.version>1.7</jdk.version>
    		<jsf.version>2.2.7</jsf.version>
    		<slf4j.version>1.7.7</slf4j.version>
    	</properties>
    
    	<dependencies>
    
    		
    		<dependency>
    			<groupId>org.slf4j</groupId>
    			<artifactId>jul-to-slf4j</artifactId>
    			<version>${slf4j.version}</version>
    		</dependency>
     
    		
    		<dependency>
    			<groupId>org.slf4j</groupId>
    			<artifactId>slf4j-log4j12</artifactId>
    			<version>${slf4j.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>com.sun.faces</groupId>
    			<artifactId>jsf-api</artifactId>
    			<version>${jsf.version}</version>
    		</dependency>
    		<dependency>
    			<groupId>com.sun.faces</groupId>
    			<artifactId>jsf-impl</artifactId>
    			<version>${jsf.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>javax.servlet</groupId>
    			<artifactId>servlet-api</artifactId>
    			<version>2.5</version>
    		</dependency>
    
    	</dependencies>

## 4. JSF日志记录 ##

由于此项目在Eclipse的环境中运行，因此将使用Eclipse的JRE。 打开`logging.properties` ，将级别更改为FINEST，然后打开`javax.faces`和`com.sun.faces`上的日志记录：

$\{JRE\_PATH\}/lib/logging.properties

# Default is INFO, change it to FINNEST
    #java.util.logging.ConsoleHandler.level = INFO
    
    java.util.logging.ConsoleHandler.level = FINEST
    java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
    
    #Add these two lines to enable JSF logging
    javax.faces.level = FINEST
    com.sun.faces.level = FINEST

请参阅[java.util.logging级别][java.util.logging] 。

> **注意**  
> 如果此项目直接部署在Tomcat上，则更新此`${Tomcat}\conf\logging.properties`

## 5. Log4j记录 ##

创建一个log4j属性文件，并将其放入`resources`文件夹中，请参考步骤1。

log4j.properties

# Root logger option
    log4j.rootLogger=WARN, console, file
    
    #enable JSF logging
    log4j.logger.javax.faces=DEBUG
    log4j.logger.com.sun.faces=DEBUG
    
    # Redirect log messages to console
    log4j.appender.console=org.apache.log4j.ConsoleAppender
    log4j.appender.console.Target=System.out
    log4j.appender.console.layout=org.apache.log4j.PatternLayout
    log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
    
    # Redirect log messages to a log file
    log4j.appender.file=org.apache.log4j.RollingFileAppender
    log4j.appender.file.File=${catalina.home}/logs/jsfapp.log
    log4j.appender.file.MaxFileSize=5KB
    log4j.appender.file.MaxBackupIndex=5
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

## 6. ServletContextListener ##

创建一个Servlet侦听器以安装桥处理程序，以便将JSF的日志记录从`java.util.properties`重定向到`log4j` 。

MyListener

package com.mkyong.listener;
    
    import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;
    import org.slf4j.bridge.SLF4JBridgeHandler;
    
    public class MyListener implements ServletContextListener {
    
    	@Override
    	public void contextInitialized(ServletContextEvent arg) {
    		System.out.println("contextInitialized....");
    		
    		//remove the jsf root logger, avoid duplicated logging
    		//try comment out this and see the different on the console
    		SLF4JBridgeHandler.removeHandlersForRootLogger();
    		SLF4JBridgeHandler.install();
    	}
    
    	@Override
    	public void contextDestroyed(ServletContextEvent arg) {
    		System.out.println("contextDestroyed....");
    
    	}
    
    }

包括侦听器类和其他标准JSF设置。

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xmlns="http://java.sun.com/xml/ns/javaee" 
    	xmlns:web="http://java.sun.com/xml/ns/javaee"
    	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    	http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    	id="WebApp_ID" version="2.5">
    	<display-name>JavaServerFacesAndLog4j</display-name>
    	
    	<context-param>
    		<param-name>javax.faces.PROJECT_STAGE</param-name>
    		<param-value>Development</param-value>
    	</context-param>
    	<welcome-file-list>
    		<welcome-file>faces/index.xhtml</welcome-file>
    	</welcome-file-list>
    	
    	
    	<listener>
    		<listener-class>
    		    	com.mkyong.listener.MyListener
    		  </listener-class>
    	</listener>
    
    	<servlet>
    		<servlet-name>Faces Servlet</servlet-name>
    		<servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
    		<load-on-startup>1</load-on-startup>
    	</servlet>
    	<servlet-mapping>
    		<servlet-name>Faces Servlet</servlet-name>
    		<url-pattern>/faces/*</url-pattern>
    	</servlet-mapping>
    	<servlet-mapping>
    		<servlet-name>Faces Servlet</servlet-name>
    		<url-pattern>*.jsf</url-pattern>
    	</servlet-mapping>
    	<servlet-mapping>
    		<servlet-name>Faces Servlet</servlet-name>
    		<url-pattern>*.faces</url-pattern>
    	</servlet-mapping>
    	<servlet-mapping>
    		<servlet-name>Faces Servlet</servlet-name>
    		<url-pattern>*.xhtml</url-pattern>
    	</servlet-mapping>
    </web-app>

## 7.应用程序记录 ##

一个简单的示例向您展示如何执行log4j的日志记录。

WelcomeAction.java

package com.mkyong.controller;
    
    import java.io.Serializable;
    import javax.faces.bean.ManagedBean;
    import javax.faces.bean.SessionScoped;
    import org.apache.log4j.Logger;
    
    @ManagedBean
    @SessionScoped
    public class PageController implements Serializable {
    
    	private static final long serialVersionUID = 1L;
    
    	private static final Logger logger = Logger.getLogger(PageController.class);
    
    	public String process() {
    
    		// logs debug
    		if (logger.isDebugEnabled()) {
    			logger.debug("PageController.process()");
    		}
    
    		// logs exception
    		logger.error("This is Error message", new Exception("Testing"));
    
    		return "success";
    	}
    
    }

一个简单的JSF视图资源。

pages/welcome.jsp

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <html xmlns="http://www.w3.org/1999/xhtml"
    	xmlns:f="http://java.sun.com/jsf/core"
    	xmlns:h="http://java.sun.com/jsf/html">
    
    <h:body>
    	<h1>JSF 2.0 + Log4j</h1>
    	<h:form>
    		<h:commandButton action="#{pageController.process}" value="Click Me" />
    	</h:form>
    </h:body>
    </html>

## 8.演示 ##

运行JSF Web应用程序，并访问默认页面，然后单击按钮。

网址： *http：// localhost：8080 / JavaServerFacesAndLog4j /*

![jsf-log4j-demo][]![jsf-log4j-demo][jsf-log4j-demo 1]

*8.1* JSF和应用程序日志记录都将显示在控制台中。

![jsf登录控制台][jsf]![jsf登录控制台][jsf 1]

*图片：Eclipse控制台*

*8.2* JSF和应用程序日志记录都将记录在`${tomcat}\logs\jsfapp.log` 。

![jsf登录文件][jsf 2]![jsf登录文件][jsf 3]

*图片：D：\\ apache-tomcat-6.0.37 \\ logs \\ jsfapp.log*

## 下载源代码 ##

> 下载它– [JSFAndLog4j.zip][] （12 KB）

## 参考文献 ##

1.  [Stackover：为什么没有显示Level.FINE日志记录消息？][Stackover_Level.FINE]
2.  [Stackover：带有tomcat的JSF2日志][Stackover_tomcat_JSF2]
3.  [将java.util.logging桥接到SLF4J][java.util.logging_SLF4J]
4.  [log4j 1.2官方页面][log4j 1.2]
5.  [log4j你好世界示例][log4j]
6.  [Slf4j：桥接旧版API][SLF4j_API]
7.  [JavaDoc：java.util.logging][JavaDoc_java.util.logging]

标签： [jsf2][] [log4j][log4j 1]

> 翻译自: [https://mkyong.com/jsf2/jsf-2-log4j-integration-example/][https_mkyong.com_jsf2_jsf-2-log4j-integration-example]

[jsf log4j]: http://imgconvert.csdnimg.cn/aHR0cDovL3d3dy5ta3lvbmcuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDE0LzA3L2pzZi1sb2c0ai1sb2dvLmpwZw?x-oss-process=image/format,png
[jsf log4j 1]: http://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cubWt5b25nLmNvbS93cC1jb250ZW50L3VwbG9hZHMvMjAxNC8wNy9qc2YtbG9nNGotbG9nby5qcGc?x-oss-process=image/format,png
[Link 1]: http://www.slf4j.org/legacy.html#jul-to-slf4j
[SLF4j_API]: http://www.slf4j.org/legacy.html
[jsf-log4j]: http://imgconvert.csdnimg.cn/aHR0cDovL3d3dy5ta3lvbmcuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDE0LzA3L2pzZi1sb2c0ai1kaXJlY3RvcnkucG5n?x-oss-process=image/format,png
[jsf-log4j 1]: http://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cubWt5b25nLmNvbS93cC1jb250ZW50L3VwbG9hZHMvMjAxNC8wNy9qc2YtbG9nNGotZGlyZWN0b3J5LnBuZw?x-oss-process=image/format,png
[java.util.logging]: http://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html
[jsf-log4j-demo]: http://imgconvert.csdnimg.cn/aHR0cDovL3d3dy5ta3lvbmcuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDE0LzA3L2pzZi1sb2c0ai1kZW1vLnBuZw?x-oss-process=image/format,png
[jsf-log4j-demo 1]: http://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cubWt5b25nLmNvbS93cC1jb250ZW50L3VwbG9hZHMvMjAxNC8wNy9qc2YtbG9nNGotZGVtby5wbmc?x-oss-process=image/format,png
[jsf]: http://imgconvert.csdnimg.cn/aHR0cDovL3d3dy5ta3lvbmcuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDE0LzA3L2pzZi1sb2c0ai1lY2xpcHNlLnBuZw?x-oss-process=image/format,png
[jsf 1]: http://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cubWt5b25nLmNvbS93cC1jb250ZW50L3VwbG9hZHMvMjAxNC8wNy9qc2YtbG9nNGotZWNsaXBzZS5wbmc?x-oss-process=image/format,png
[jsf 2]: http://imgconvert.csdnimg.cn/aHR0cDovL3d3dy5ta3lvbmcuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDE0LzA3L2pzZi1sb2c0ai1maWxlLnBuZw?x-oss-process=image/format,png
[jsf 3]: http://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cubWt5b25nLmNvbS93cC1jb250ZW50L3VwbG9hZHMvMjAxNC8wNy9qc2YtbG9nNGotZmlsZS5wbmc?x-oss-process=image/format,png
[JSFAndLog4j.zip]: http://www.mkyong.com/wp-content/uploads/2014/07/JSFAndLog4j.zip
[Stackover_Level.FINE]: http://stackoverflow.com/questions/6315699/why-are-the-level-fine-logging-messages-not-showing
[Stackover_tomcat_JSF2]: http://stackoverflow.com/questions/7363704/jsf2-logs-with-tomcat
[java.util.logging_SLF4J]: http://blog.cn-consult.dk/2009/03/bridging-javautillogging-to-slf4j.html
[log4j 1.2]: http://logging.apache.org/log4j/1.2/
[log4j]: http://www.mkyong.com/logging/log4j-hello-world-example/
[JavaDoc_java.util.logging]: http://docs.oracle.com/javase/6/docs/api/java/util/logging/package-summary.html
[jsf2]: https://mkyong.com/tag/jsf2/
[log4j 1]: https://mkyong.com/tag/log4j/
[https_mkyong.com_jsf2_jsf-2-log4j-integration-example]: https://mkyong.com/jsf2/jsf-2-log4j-integration-example/