Регистрация активности пользователя в веб-приложении

Я хотел бы иметь возможность регистрировать действия пользователя в веб-приложении. В настоящее время я использую log4j, который хорошо подходит для протоколирования ошибок и т.д., Но я не уверен, что лучший подход заключается в регистрации пользователя, выполненного метода сервлетов и параметров метода. Я использую spring для проверки подлинности.

Типичный сервлет может выглядеть так:

public class BankAccountServlet {
    @RequestMapping("/deposit")
    public void deposit(double amount) {
        ...
    }

    @RequestMapping("/checkBalance")
    public double checkBalance() {
        ...
    }
}

Если есть два пользователя, foo и bar, где foo проверяет свой баланс и депозиты в банке две суммы наличных 10,00 и 5,00. Я бы хотел, чтобы журналы выглядели так:

01/01/1970 23:59:59 - foo - checkBalance
02/01/1970 23:59:59 - bar - deposit - 10.00
02/01/1970 23:59:59 - bar - deposit - 5.00

Если кто-нибудь может предложить некоторые советы, я бы очень благодарен им за помощь.

Ответ 1

На самом деле довольно просто добиться использования функций MDC/NDC, встроенных в Log4J (SLF4J и Logback поддерживают только MDC).

Реализация фильтра MDC

Сначала создайте фильтр сервлета, который добавит имя пользователя в MDC/NDC. Logback обеспечивает удобный MDCInsertingServletFilter, Spring framework также добавляет Log4jNestedDiagnosticContextFilter в магазин. Посмотрите на них, но вам понадобится таковой:

public class UserToMdcFilter implements javax.servlet.Filter
{
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        MDC.put("user", SecurityContextHolder.getContext().getAuthentication().getPrincipal());
        try {
            chain.doFilter(request, response);
        } finally {
            MDC.remove("user");
        }
    }

    //...
}

Добавление значения MDC к шаблону ведения журнала

Убедитесь, что этот фильтр применяется в web.xml после Spring фильтра безопасности. Функция MDC действительно гладкая - она добавит все значения, сохраненные в локальной локальной сети MDC, к каждому заявлению регистрации, если потребуется. В вашем случае просто добавьте это:

%X{user}

к вашему протоколированию pattern.

Параметры/значения метода ненавязчивого ведения журнала

Имя метода регистрации, параметры и возвращаемые значения зависит от вас (имя пользователя будет добавляться автоматически), но есть некоторые изящные способы полностью удалить код регистрации шаблонов. Попробуйте этот Spring встроенный аспект:

<bean id="customizableTraceInterceptor" class="org.springframework.aop.interceptor.CustomizableTraceInterceptor">
    <property name="enterMessage" value="Entering $[methodName]($[arguments])"/>
    <property name="exitMessage" value="Leaving $[methodName](): $[returnValue]"/>
</bean>
<aop:config>
    <aop:advisor advice-ref="customizableTraceInterceptor" pointcut="execution(public * BankAccountServlet.*(..))"/>
</aop:config>

Заключительные мысли

Посмотрите эту тему: http://forum.springsource.org/showthread.php?88890-MDC-Log4j-Filter-with-Spring-Security-3.0.2
Рассмотрите возможность использования Logback в качестве библиотеки протоколирования и использования API SLF4J.

Ответ 2

Я использовал log4j в прошлом, чтобы регистрировать больше, чем просто ошибки. Я добавил теги INFO во всем моем коде и изменил уровень ведения журнала. Таким образом, если вы решите, что вам больше не нужно регистрировать эти действия, вы можете просто изменить уровень ведения журнала, и все готово. Надеюсь, что это поможет.

Ответ 3

Если вы хотите входить в лог журналов, используйте метод ServletContext.log(), который использует механизм регистрации контейнера и регистрируется в журналах контейнеров.