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

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

12 голосов
/ 24 мая 2011

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

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

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

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

Ответы [ 3 ]

32 голосов
/ 25 мая 2011

На самом деле довольно просто добиться этого, используя функциональность 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}

к вашему журналу шаблон .

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

Имя метода ведения журнала,Параметры и возвращаемые значения зависят от вас (имя пользователя будет добавлено автоматически), но есть несколько элегантных способов полностью удалить шаблонный регистрационный код.Попробуйте встроенный аспект 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>

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

0 голосов
/ 25 мая 2011

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

0 голосов
/ 25 мая 2011

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

...