SpringMVC与LogBack集成

最新推荐文章于 2024-02-23 16:29:30 发布
最新推荐文章于 2024-02-23 16:29:30 发布
阅读量528 收藏
点赞数
分类专栏： spring 文章标签： SpringMVC
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wangyuanjun008/article/details/79120914
版权

最近在做项目中需要用到日志，本来选取的是Log4j，最后经过对比之后还是发现LogBack在性能上比Log4j有优势。至于有什么好处，请参考下面这篇文章。
从Log4j迁移到LogBack的理由

下面废话不多说了，就看一下，如何来把LogBack集成到我们的web项目中吧。本人前台用的是SpringMVC。

jar包配置

如果要使用LogBack做为日志的插件的话，需要的jar包有如下，直接看一下Maven依赖

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.12</version>
</dependency>
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.1.3</version>
    <scope>compile</scope>
    <exclusions>
        <exclusion>
            <artifactId>slf4j-api</artifactId>
            <groupId>org.slf4j</groupId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
    <version>1.1.3</version>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </exclusion>
    </exclusions>
    <scope>compile</scope>
</dependency>

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-access</artifactId>
    <version>1.1.3</version>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </exclusion>
    </exclusions>
    <scope>compile</scope>
</dependency>

Web.xml
在web项目中需要通过web.xml来加载我们所需要的LogBack.xml具体如下

    <?xml version="1.0" encoding="UTF-8"?>
    <web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

        <!-- logback-begin -->
        <context-param>
            <param-name>logbackConfigLocation</param-name>
            <param-value> classpath:logback.xml</param-value>
        </context-param>
        <listener>
            <listener-class>com.util.LogbackConfigListener</listener-class>
        </listener>
        <!-- logback-end -->


        <filter>
            <filter-name>encodingFilter</filter-name>
            <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
            <init-param>
                <param-name>encoding</param-name>
                <param-value>UTF-8</param-value>
            </init-param>
            <init-param>
                <param-name>forceEncoding</param-name>
                <param-value>true</param-value>
            </init-param>
        </filter>
        <filter-mapping>
            <filter-name>encodingFilter</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>

        <servlet>
            <servlet-name>springMVC</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <param-name>contextConfigLocation</param-name>
                <param-value> classpath:springMVC-servlet.xml</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <!-- 这里一定要是/根据Servlet规范来的 -->
        <servlet-mapping>
            <servlet-name>springMVC</servlet-name>
            <url-pattern>/</url-pattern>
        </servlet-mapping>

    </web-app>

上面的XML中用到了自定义的监听器，分别是三个类，如下所示

LogbackConfigListener类

    package com.util;

    import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;

    public class LogbackConfigListener implements ServletContextListener {

        public void contextInitialized(ServletContextEvent event) {
            LogbackWebConfigurer.initLogging(event.getServletContext());
        }

        public void contextDestroyed(ServletContextEvent event) {
            LogbackWebConfigurer.shutdownLogging(event.getServletContext());
        }
    }

    LogbackConfigurer类


    package com.util;

    import java.io.File;
    import java.io.FileNotFoundException;
    import java.net.URL;

    import org.slf4j.LoggerFactory;
    import org.springframework.util.ResourceUtils;
    import org.springframework.util.SystemPropertyUtils;

    import ch.qos.logback.classic.LoggerContext;
    import ch.qos.logback.classic.joran.JoranConfigurator;
    import ch.qos.logback.core.joran.spi.JoranException;

    public abstract class LogbackConfigurer {

        /** Pseudo URL prefix for loading from the class path: "classpath:" */
        public static final String CLASSPATH_URL_PREFIX = "classpath:";

        /** Extension that indicates a logback XML config file: ".xml" */
        public static final String XML_FILE_EXTENSION = ".xml";

        private static LoggerContext lc = (LoggerContext) LoggerFactory
                .getILoggerFactory();
        private static JoranConfigurator configurator = new JoranConfigurator();

        /**
         * Initialize logback from the given file location, with no config file
         * refreshing. Assumes an XML file in case of a ".xml" file extension, and a
         * properties file otherwise.
         * 
         * @param location
         *            the location of the config file: either a "classpath:"
         *            location (e.g. "classpath:mylogback.properties"), an absolute
         *            file URL (e.g.
         *            "file:C:/logback.properties), or a plain absolute path in the file system (e.g. "
         *            C:/logback.properties")
         * @throws FileNotFoundException
         *             if the location specifies an invalid file path
         */
        public static void initLogging(String location)
                throws FileNotFoundException {
            String resolvedLocation = SystemPropertyUtils
                    .resolvePlaceholders(location);
            URL url = ResourceUtils.getURL(resolvedLocation);
            if (resolvedLocation.toLowerCase().endsWith(XML_FILE_EXTENSION)) {
                // DOMConfigurator.configure(url);
                configurator.setContext(lc);
                lc.reset();
                try {
                    configurator.doConfigure(url);
                } catch (JoranException ex) {
                    throw new FileNotFoundException(url.getPath());
                }
                lc.start();
            }
            // else {
            // PropertyConfigurator.configure(url);
            // }
        }

        /**
         * Shut down logback, properly releasing all file locks.
         * <p>
         * This isn't strictly necessary, but recommended for shutting down logback
         * in a scenario where the host VM stays alive (for example, when shutting
         * down an application in a J2EE environment).
         */
        public static void shutdownLogging() {
            lc.stop();
        }

        /**
         * Set the specified system property to the current working directory.
         * <p>
         * This can be used e.g. for test environments, for applications that
         * leverage logbackWebConfigurer's "webAppRootKey" support in a web
         * environment.
         * 
         * @param key
         *            system property key to use, as expected in logback
         *            configuration (for example: "demo.root", used as
         *            "${demo.root}/WEB-INF/demo.log")
         * @see org.springframework.web.util.logbackWebConfigurer
         */
        public static void setWorkingDirSystemProperty(String key) {
            System.setProperty(key, new File("").getAbsolutePath());
        }

    }

LogbackWebConfigurer类

    package com.util;

    import java.io.FileNotFoundException;

    import javax.servlet.ServletContext;

    import org.springframework.util.ResourceUtils;
    import org.springframework.util.SystemPropertyUtils;
    import org.springframework.web.util.WebUtils;

    public abstract class LogbackWebConfigurer {

        /** Parameter specifying the location of the logback config file */
        public static final String CONFIG_LOCATION_PARAM = "logbackConfigLocation";

        /**
         * Parameter specifying the refresh interval for checking the logback config
         * file
         */
        public static final String REFRESH_INTERVAL_PARAM = "logbackRefreshInterval";

        /** Parameter specifying whether to expose the web app root system property */
        public static final String EXPOSE_WEB_APP_ROOT_PARAM = "logbackExposeWebAppRoot";

        /**
         * Initialize logback, including setting the web app root system property.
         * 
         * @param servletContext
         *            the current ServletContext
         * @see WebUtils#setWebAppRootSystemProperty
         */
        public static void initLogging(ServletContext servletContext) {
            // Expose the web app root system property.
            if (exposeWebAppRoot(servletContext)) {
                WebUtils.setWebAppRootSystemProperty(servletContext);
            }

            // Only perform custom logback initialization in case of a config file.
            String location = servletContext
                    .getInitParameter(CONFIG_LOCATION_PARAM);
            if (location != null) {
                // Perform actual logback initialization; else rely on logback's
                // default initialization.
                try {
                    // Return a URL (e.g. "classpath:" or "file:") as-is;
                    // consider a plain file path as relative to the web application
                    // root directory.
                    if (!ResourceUtils.isUrl(location)) {
                        // Resolve system property placeholders before resolving
                        // real path.
                        location = SystemPropertyUtils
                                .resolvePlaceholders(location);
                        location = WebUtils.getRealPath(servletContext, location);
                    }

                    // Write log message to server log.
                    servletContext.log("Initializing logback from [" + location
                            + "]");

                    // Initialize without refresh check, i.e. without logback's
                    // watchdog thread.
                    LogbackConfigurer.initLogging(location);

                } catch (FileNotFoundException ex) {
                    throw new IllegalArgumentException(
                            "Invalid 'logbackConfigLocation' parameter: "
                                    + ex.getMessage());
                }
            }
        }

        /**
         * Shut down logback, properly releasing all file locks and resetting the
         * web app root system property.
         * 
         * @param servletContext
         *            the current ServletContext
         * @see WebUtils#removeWebAppRootSystemProperty
         */
        public static void shutdownLogging(ServletContext servletContext) {
            servletContext.log("Shutting down logback");
            try {
                LogbackConfigurer.shutdownLogging();
            } finally {
                // Remove the web app root system property.
                if (exposeWebAppRoot(servletContext)) {
                    WebUtils.removeWebAppRootSystemProperty(servletContext);
                }
            }
        }

        /**
         * Return whether to expose the web app root system property, checking the
         * corresponding ServletContext init parameter.
         * 
         * @see #EXPOSE_WEB_APP_ROOT_PARAM
         */
        private static boolean exposeWebAppRoot(ServletContext servletContext) {
            String exposeWebAppRootParam = servletContext
                    .getInitParameter(EXPOSE_WEB_APP_ROOT_PARAM);
            return (exposeWebAppRootParam == null || Boolean
                    .valueOf(exposeWebAppRootParam));
        }

    }

logback.XML配置
下面来看一下这个xml是如何配置的

    <?xml version="1.0" encoding="UTF-8"?>
    <!-- ROOT 节点 -->
    <!-- 属性描述 scan：性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 
        debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        <!-- 定义日志文件 输入位置,注意此处的/ -->
        <property name="log_dir" value="E:/logs" />
        <!-- 日志最大的历史 60天 -->
        <property name="maxHistory" value="60"></property>


        <!-- 控制台输出日志 -->
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger -
                    %msg%n</pattern>
            </encoder>

        </appender>


        <!-- 出错日志 appender -->
        <appender name="ERROR"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 在多数的Log工具中，级别是可以传递，例如如果指定了日志输出级别为DEBUG， 那么INFO、ERROR级别的log也会出现在日志文件。这种默认给程序的调试带来了很多的麻烦 
                通过配置Filter 来严格控制日志输入级别 <filter class="ch.qos.logback.classic.filter.LevelFilter"> 
                <level>ERROR/level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> 
                </filter> -->
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 按天回滚 daily -->
                <fileNamePattern>${log_dir}/error-log-%d{yyyy-MM-dd}.log
                </fileNamePattern>
                <!-- 日志最大的历史 60天 -->
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger -
                    %msg%n</pattern>
            </encoder>
        </appender>

        <!-- INFO 日志 appender -->
        <appender name="INFO"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 按天回滚 daily -->
                <fileNamePattern>${log_dir}/info-log-%d{yyyy-MM-dd}.log
                </fileNamePattern>
                <!-- 日志最大的历史 60天 -->
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger -
                    %msg%n</pattern>
            </encoder>
        </appender>


        <!-- 访问日志 appender -->
        <appender name="ACCESS"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 按天回滚 daily -->
                <fileNamePattern>${log_dir}/access-log-%d{yyyy-MM-dd}.log
                </fileNamePattern>
                <!-- 日志最大的历史 60天 -->
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger -
                    %msg%n</pattern>
            </encoder>
        </appender>

        <!-- 系统用户操作日志 appender -->
        <appender name="SYS-USER"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 按天回滚 daily -->
                <fileNamePattern>${log_dir}/sys_user-log-%d{yyyy-MM-dd}.log
                </fileNamePattern>
                <!-- 日志最大的历史 60天 -->
                <maxHistory>${maxHistory}</maxHistory>
            </rollingPolicy>
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger -
                    %msg%n</pattern>
            </encoder>
        </appender>


        <!-- 打印SQL输出 -->
        <logger name="java.sql.Connection" level="DEBUG" />
        <logger name="java.sql.Statement" level="DEBUG" />
        <logger name="java.sql.PreparedStatement" level="DEBUG" />



        <!--error错误日志 additivity="false"表示不向上传递 -->
        <!-- <logger name="com.test" level="error" > -->
        <!-- <appender-ref ref="ERROR" /> -->
        <!-- </logger> -->
        <!--info日志 -->
        <logger name="com.test" level="info" additivity="false">
            <appender-ref ref="INFO" />
        </logger>
        <!--访问日志 -->
        <!-- <logger name="com.test" level="info" additivity="false"> -->
        <!-- <appender-ref ref="ACCESS" /> -->
        <!-- </logger> -->
        <!--系统用户操作日志 -->
        <!-- <logger name="com.test" level="info" additivity="false"> -->
        <!-- <appender-ref ref="SYS-USER" /> -->
        <!-- </logger> -->

        <root>
            <level value="INFO" />
            <appender-ref ref="stdout" />
        </root>
    </configuration>

关于这个XML文件的详细讲解请参考http://blog.csdn.net/haidage/article/details/6794509

wangyuanjun008
关注
专栏目录
slf4j+logback+springmvc+maven小例子
03-30
学习slf4j+logback的时候的小例子，需要用maven下载jar包。
springMvc之配置logback
qq_41720578的博客
07-01 1180
2、配置logback配置文件 3、配置web.xml
spring mvc中如何集成logback呢？
qq_25073223的博客
07-28 672
spring mvc集成logback的方法说明
logback日志框架的配置
GSON的博客
08-19 877
logback-spring.xml配置文件 自己改下value="G:/logs/pmp"这个值，如果你相关依赖弄好的话，直接复制粘贴即用 输出的日志文件的名称最好也改下，下文中<file>${log.path}/web_info.log</file>是因为我这个模块就叫web，要改的话，一个appender改两处 集成到springboot的yml格式配置文件的示例： logging: config: classpath:logback-spring.xml le
spring mvc-3.1.1与logback-1.0.3,slf4j-1.6.4集成
04-05
本集成教程将探讨如何将Spring MVC 3.1.1与Logback 1.0.3和SLF4J 1.6.4进行整合，以便在Spring应用中实现灵活的日志管理。 首先，我们来理解`LogbackWebConfigurer.java`、`LogbackConfigurer.java`和`...
Spring4.05 Mybatis3.2.7 SpringMVC logback的maven配置demo
06-11
在这个项目中，Spring 4.0.5可能被用来处理依赖注入（DI）、AOP（面向切面编程）、事务管理、以及与Mybatis的集成。 2. **Mybatis 3.2.7**： Mybatis是一个优秀的持久层框架，它支持定制化SQL、存储过程以及高级...
springmvc log4j2 logback 注解 jackson 日志脱敏实现源码
12-30
本资源包含的是关于`SpringMVC`、`Log4j2`、`Logback`以及`Jackson`的日志脱敏实现源码，提供了多种实现方式，旨在帮助开发者在保障信息安全的同时，充分利用日志进行系统分析。 1. **基于正则表达式的日志脱敏实现...
spring + springmvc + mybatis 框架实例（logback）
06-19
MyBatis是一个轻量级的持久层框架，它简化了SQL操作，将数据库查询与Java代码紧密集成。在本实例中，开发者可能使用了`@Mapper`注解来标记MyBatis的Mapper接口，通过`@Select`、`@Insert`、`@Update`和`@Delete`注解...
SpringMVC+JPA+Freeemarker
11-28
在项目开发中，我们通常会集成Logback来记录系统运行时的信息，帮助调试和监控应用状态。 综上所述，"SpringMVC+JPA+Freeemarker"的组合提供了完整的Web应用开发环境，涵盖了从用户请求处理到数据持久化再到响应...
在springMVC中使用logback输出日志
yzy85的专栏
03-20 2095
参考：https://my.oschina.net/fenglinyuxi/blog/3019094 参考：https://www.cnblogs.com/gavincoder/p/10091757.html 参考：https://www.cnblogs.com/alterem/p/11343882.html 参考：https://www.jianshu.com/p/4619de4534a7...
Spring mvc 集成logback日志功能
GAMELOFT9----纸上得来终觉浅，绝知此事要躬行
11-28 3098
一、概述        这一篇中，我们将紧接着上一篇Spring mvc入门-登录例子，把日志功能集成进来。Java日志有好几种实现方式，例如commons-logging+log4j、slf4j+log4j、slf4j+logback等待。这里不对每一种进行介绍，我们使用最流行的slf4j+logback的组合方式。大家可以参考这篇java日志知识，以便对日志有个大致的了解。对于logback的...
SpringMVC集成Logback
u012489412的博客
09-10 3118
SpringMVC集成Logback日志管理 SpringMVC集成Logback日志管理 前言 一、maven依赖相关jar包 二、创建logback.xml配置文件 三、配置中遇到问题详解 前言 原来使用springboot配置logback非常的简单。今天使用springMVC配置了一下，坑挺多的，包括路径配置。看了很多博客，都是有坑的，这里记录一下，以免以后再踩坑...
《Spring MVC》 第十章 使用logback+Slf4j打印日志
Java 技术专栏，从入门到精通，熟悉企业级开发
05-04 697
Sping MVC集成logback、Slf4j
logback出现报错:class path resource [logback.xml] cannot be resolved to URL because it does not exist
最新发布
weixin_47631368的博客
02-23 921
logback日志路径配置错误（[logback.xml] cannot be resolved to URL because it does not exist）
Spring MVC集成slf4j-logback
热门推荐
我想跟代码谈谈
07-31 4万+
1.  Spring MVC集成slf4j-log4j 关于slf4j和log4j的相关介绍和用法，网上有很多文章可供参考，但是关于logback的，尤其是Spring MVC集成logback的，就相对少一些了，而且其中一些也有着这样那样的问题。进入正题之前先简单介绍下Spring MVC集成slf4j-log4j的过程，如下： 1)      在pom.xml文件中添加slf4j-log4
Spring MVC拦截器+logback日志输出
日常记录
11-10 891
如果项目中存在多个拦截器，前置请求拦截执行按照配置顺序执行，后置响应拦截执行顺序反过来；后面的拦截器就不会执行，实现阻断器的效果。利用用户访问的URL就可以知道什么商品最受欢迎，用户访问时间知道用户的作息时间推荐相应内容，根据发送的请求中附带的用户环境可以知道用户使用电脑还是手机访问，用的安卓机还是苹果机，地址等等。拦截器不受之前配置的将静态资源排除在外影响，只要符合URL的过滤条件都会被拦截器处理。所以访问网页中的html，一系列js，图片等都会进行处理。也可以反过来，只拦截指定URI前缀的所有请求。..
logback与Spring、SpringMVC结合使用教程
Evankaka的专栏
02-05 2万+
        林炳文Evankaka原创作品。转载请注明出处http://blog.csdn.net/evankaka         摘要：本文主要介绍了如何在spring、springMVC中使用logback 一、logback与Spirng结合使用 1、maven添加引用：   &lt;dependency&gt; &lt;groupId&gt;log4j&lt;/...
springmvc+logback项目日志配置
weixin_44235861的博客
12-21 1418
最近在做项目的时候用到logback作为项目日志，而抛弃了log4j。具体为什么用logback,我总结了以下几点: 1.log4j和logback的创作者是同一个人，logback是log4j的升级版，是对log4j核心的一个封装。 2.性能提升，在某些特定场景上执行速度提升10倍以上，同时初始化内存更小 3.扩展文档，丰富的并且详细的文档和不断的更新，可在官网上查看 4.Filters（过滤...
SSM整合详解：配置与项目集成
`spring-orm`支持与ORM框架（如Hibernate、JPA）的集成；`spring-aspects`包含了AOP的相关功能；`spring-test`则是用于单元测试的支持；`spring-tx`提供事务管理服务。 2. **SpringMVC**：SpringMVC是Spring框架的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值