2. 程式人生 > >【Spring MVC攔截器+logback日誌+自定義註解】實現使用者鑑權登陸和訪問日誌記錄

【Spring MVC攔截器+logback日誌+自定義註解】實現使用者鑑權登陸和訪問日誌記錄

阿新 • • 發佈：2019-02-17

摘要說明：

專案中經常這樣的需要 

1. 登陸鑑權：比如使用者瀏覽器發出某個請求的時候我們需要判斷這個使用者是否已經登陸，也就是cookie中是否有他的登陸資訊。

2. 訪問日誌記錄：使用者訪問請求的時候我們有必要記錄訪問者的身份資訊以及訪問了哪個url，請求引數是什麼，這個請求的耗時是多少等等。

我的專案中是通過如下方法實現的。先貼上程式碼，再逐步講解原理。

logback.xml的定義如下 【利用slf4j+logback配置日誌的最新日誌記錄方法請檢視這裡】 
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>jweb_wb_mgmt</contextName>
    <property name="path" value="/data/jweblog/jweb_wb_mgmt_beta"/>

    <!-- 控制檯 -->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%date{HH:mm:ss.SSS}] [%thread] [%-5level] [%logger{36}] %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 訪問日誌 -->
    <appender name="access" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${path}/access/access.%d{yyyy-MM-dd}.log
            </fileNamePattern>
            <maxHistory>3</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>[%date{HH:mm:ss.SSS}] [%thread] [%-5level] [%logger{36}] %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 訪問日誌 -->
    <logger name="access" level="DEBUG" additivity="false">
        <appender-ref ref="access"/>
    </logger>

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

spring-mvc.xml定義攔截器如下   【springMVC攔截器的講解請檢視這裡】

<mvc:interceptors>
        <bean id="logInterceptor" class="com.zjr.common.web.interceptor.LogInterceptor"/>
        <bean id="agentAuthInterceptor" class="com.zjr.common.web.interceptor.AgentAuthInterceptor"/>
</mvc:interceptors>
LogInterceptor.java攔截器定義如下   【記錄訪問日誌】
package com.zjr.common.web.interceptor;


// import ....


public class LogInterceptor extends HandlerInterceptorAdapter {


	Logger logger = LoggerFactory.getLogger("access");


	long beginTime;


	/**
	 * Log the request entrance
	 */
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {


		beginTime = System.currentTimeMillis();


		Map<String, Cookie> cookies = HttpUtils.getCookies(request.getCookies());
		String userId = String.valueOf(cookies.get("userId") != null ?
				cookies.get("userId").getValue() : request.getHeader("userId"));
		String token = String.valueOf(cookies.get("token") != null ?
				cookies.get("token").getValue() : request.getHeader("token"));
		String agentUserId = String.valueOf(cookies.get("agentUserId") != null ?
				cookies.get("agentUserId").getValue() : request.getHeader("agentUserId"));
		String agentUserToken = String.valueOf(cookies.get("agentUserToken") != null ?
				cookies.get("agentUserToken").getValue() : request.getHeader("agentUserToken"));


		//記錄請求的使用者資訊
		logger.info("Request URI:{} userId:{} token:{} agentUserId:{} agentUserToken:{}",
				request.getRequestURI(), userId, token, agentUserId, agentUserToken); 


		if (logger.isDebugEnabled()) {  
			StringBuilder sb = new StringBuilder();
			for (String key : request.getParameterMap().keySet()) {
				sb.append(key).append(":").append(request.getParameterValues(key)[0]).append(";");
			}
			//記錄請求引數
			logger.debug("Request URI:{} data:{}", request.getRequestURI(), sb);  
		}


		return true;
	}


	/**
	 * Log the request finished 記錄整個請求所花費的時間
	 */
	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		logger.info("Request URI:{} Cost:{}", request.getRequestURI(), (System.currentTimeMillis() - beginTime) + "ms");
	}


	/**
	 * Log the request exit
	 */
	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
	}
}

AgentAuthCheck.java【自定義的註解@AgentAuthCheck】

package com.zjr.common.web.auth;

//import ...

/**
 * 代理登入鑑權註解
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AgentAuthCheck {

	/**
	 * 是否需要使用者鑑權
	 */
	boolean authRequired() default false;
}

AgentAuthInterceptor.java攔截器 【登陸鑑權】

package com.zjr.common.web.interceptor;

//import ...

public class AgentAuthInterceptor extends HandlerInterceptorAdapter {

	private static Logger logger = LoggerFactory.getLogger("access");

	@Autowired
	private Agent2UserBiz agent2UserBiz;

	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {

		// 使用者登入鑑權判斷
		if (handler instanceof HandlerMethod) {

			// 獲取鑑權設定
			HandlerMethod method = (HandlerMethod) handler; 
			AgentAuthCheck agentAnnotation = method.getMethodAnnotation(AgentAuthCheck.class);
			
			if (agentAnnotation != null && agentAnnotation.authRequired()) { 
				String agentUserId = BaseWebservice.getValueFromHeaderOrCookie(request, "agentUserId");
				agentUserId = agentUserId == null ? null : URLDecoder.decode(agentUserId, "utf-8");
				String agentUserToken = BaseWebservice.getValueFromHeaderOrCookie(request, "agentUserToken");

				Agent2User user = agent2UserBiz.checkLogin(agentUserId, agentUserToken);

				if (user != null) {

					AgentThreadData.setAgent2User(user);

					logger.info("AuthInterceptor checkLogin success. URI:{} agentUserId:{} agentUserToken:{}",
							request.getRequestURI(), agentUserId, agentUserToken);
				} else {
					BaseWebservice.setCookie(response, "agentId", "", 0);
					BaseWebservice.setCookie(response, "agentUserId", "", 0);
					BaseWebservice.setCookie(response, "agentUserName", "", 0);
					BaseWebservice.setCookie(response, "agentUserToken", "", 0);
					BaseWebservice.responseJson(response, BasicResult.createFailResult(ErrorType.LOGIN_AUTH_ERROR), 200);

					logger.warn("AuthInterceptor checkLogin fail. URI:{} agentUserId:{} agentUserToken:{}",
							request.getRequestURI(), agentUserId, agentUserToken);

					return false;
				}
			}
		}

		return true;

	}

	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
	} 

	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
		AgentThreadData.removeAgent2User();
	}


}

在訪問請求出新增自定義註解實現鑑權 
package com.zjr.modules.agent2.webservice;

//import ...

@RestController
@RequestMapping(value = {"/agent2/user"})
public class Agent2ShopService {

	//登陸不需要鑑權
    @RequestMapping(value = "/login")
    public BasicResult login(@RequestParam ...) {

        //使用者登入的實現程式碼
		
    }

	//新增使用者請求需要鑑權
    @AgentAuthCheck(authRequired = true)
    @RequestMapping(value = "/addUser")
    public BasicResult addUser(@RequestParam ...) {

        //新增使用者的實現程式碼
		
    }
}

當前端發出/agent2/user/add的請求的時候，攔截器LogInterceptor和AgentAuthInterceptor會依次攔截請求執行自己的操作，LogInterceptor攔截器會用日誌記錄使用者的資訊以及請求的引數，返回true，交給AgentAuthInterceptor攔截器，AgentAuthInterceptor攔截器會判斷響應請求的方法是否有@AgentAuthCheck註解同時authRequired屬性是否為true，如果都有，那麼執行鑑權操作，鑑權成功則返回true，響應請求的方法addUser執行，鑑權失敗則返回false，請求不繼續執行。

相關推薦

【Spring MVC攔截器+logback日誌+自定義註解】實現使用者鑑權登陸和訪問日誌記錄

摘要說明： 專案中經常這樣的需要  1. 登陸鑑權：比如使用者瀏覽器發出某個請求的時候我們需要判斷這個使用者是否已經登陸，也就是cookie中是否有他的登陸資訊。 2. 訪問日誌記錄：使用者訪問請求的時候我們有必要記錄訪問者的身份資訊以及訪問了哪個url，請求引數是什麼，這

springboot-監聽器，過濾器，攔截器，aop,自定義註解

springboot基礎-監聽器，過濾器，攔截器，aop,自定義註解 文章目錄 springboot基礎-監聽器，過濾器，攔截器，aop,自定義註解 1.監聽器 2.過濾器 3.攔截器 4.aop 5.自定義註解

使用Spring MVC攔截器管理操作日誌

通過攔截器記錄操作日誌，將操作日誌儲存到資料庫中，實現這個功能需要我們將curd操作的URL規範化，比如：新增是以add或者insert開始，修改是update開頭，刪除則是delete開頭。 第一步：編寫攔截器類，程式碼如下： package com.

Spring MVC攔截器

res bject src throws 成功 resolv gets app response Spring MVC的interceptor攔截器攔截請求是通過實現HandlerInterceptor接口來完成的。 接來下舉一個實例： 通過攔截器完成一個用戶權限驗證的功能

spring mvc攔截器使用

例子 ttr dir 登錄 sem model imp deb author 　　舉個例子說下吧，單點登錄，直接看代碼： 　　spring-mvc.xml配置 <mvc:interceptors> <mvc:interceptor

Spring MVC 攔截器

被調用 clas class 表現 進入 截器 exclude oid ssi Interceptor攔截器用於攔截Controller層接口，表現形式有點像Spring的AOP，但是AOP是針對單一的方法。Interceptor是針對Controller接口以及可以處理r

spring mvc 攔截器攔截 js，css等請求，

需求：最近學習部署ssm，用springmvc 的<mvc:interceptor> 標籤攔截器判斷當前的請求是否已登入。 問題：除錯攔截器發現 攔截了js,css等資源的請求。 問題截圖： 希望的目的：不攔截js,css,圖片等資源。 最初配置及環境： 在

spring MVC——攔截器實現登入檢測和效能監控

1. 攔截器簡介 Spring MVC中的攔截器，類似於Servlet開發中的過濾器Filter，主要用來攔截使用者的請求並進行相應的處理，可以用來做日誌記錄、許可權驗證或者登陸檢測。 （1） 常見的應用場景 日誌記錄：記錄請求資訊的日誌，以便進行資訊監控、資訊統計、計

spring mvc攔截器，實現統計http請求的後臺執行時間

使用兩種方式，實現攔截http請求的後臺執行時間。 廢話不多說直接上程式碼 /** * Http請求時間統計 * 攔截所有請求 */ public class HttpRquestTimeInterceptor extends HandlerInterceptorAdapter { Threa

spring mvc 攔截器 配置

第一步：新建攔截器類，可以建多個，繼承HandlerInterceptor介面，實現preHandle();postHandle();afterCompletion()三個方法. preHandle() 方法：該方法會在控制器方法前執行，其返回值表示是否中斷後續

Spring MVC攔截器配置及其原理分析

                程式碼下載地址：http://www.zuidaima.com/share/1751865167973376.htmSpringMVC的攔截器不同於Spring的攔截器，SpringMVC具有統一的入口DispatcherServlet，所有的請求都通過DispatcherSe

Spring MVC 攔截器使用及實現

class InterceptorsBeanDefinitionParser implements BeanDefinitionParser { @Override public BeanDefinition parse(Element element, ParserContext parserContex

Spring MVC攔截器+註解方式實現防止表單重複提交

表單重複提交是在多使用者Web應用中最常見、帶來很多麻煩的一個問題。有很多的應用場景都會遇到重複提交問題，比如： 1.點選提交按鈕兩次。2.點選重新整理按鈕。3.使用瀏覽器後退按鈕重複之前的操作，導致重複提交表單。4.使用瀏覽器歷史記錄重複提交表單。5.瀏覽器重複的HTTP

Spring MVC攔截器DispatcherServlet詳解

    前端控制器DispatcherServlet攔截請求之後做了什麼工作呢？DispatcherServlet又是如何分派請求的呢？     我們來根據DispatcherServlet的原始碼分析一下，原始碼如下： protected void ini

利用spring mvc 攔截器 鑑權

1.需求場景 利用攔截器實現使用者登入鑑權 2.專案環境 spring spring mvc mybatis  mysql 3.實現方法 package com.jlc.action; import java.util.Enumeration; import j

spring mvc攔截器專案例項

處理器攔截器簡介:1.1.1攔截器介面package org.springframework.web.servlet; public interface HandlerInterceptor { boolean preHandle(

使用ProceedingJoinPoint獲取當前請求的方法等引數——spring mvc攔截器

在專案中常常需要顧慮請求引數中的特殊字元，比如+，<，>等 解決方案是可以使用spring mvc 的攔截器，配合aspectJ使用 package com.cpic.core.web; import java.lang.annotation.Annotati

Spring MVC攔截器配置以及統一登陸校驗實現

攔截器概念 這裡引用百度百科裡面的說法,java裡的攔截器是動態攔截Action呼叫的物件。它提供了一種機制可以使開發者可以定義在一個action執行的前後執行的程式碼，也可以在一個action執行前阻止其執行，同時也提供了一種可以提取action中可重

Spring MVC 攔截器配置及使用（包括靜態資源的處理)

springmvc攔截器能夠對請求的資源路徑進行攔截，極大的簡化了攔截器的書寫。但是，千萬千萬要注意一點：靜態資源的放行。 關於靜態資源的放行，主要有三種方式： 1、修改請求的url地址。  如果請求的url地址都是以*.do結尾，那麼攔截器中的配置可以變為攔截以do

Spring MVC攔截器詳解

SpringMVC攔截器 1 定義 java裡的攔截器是動態攔截Action呼叫的物件。它提供了一種機制可以使開發者可以定義在一個action執行的前後執行的程式碼，也可以在一個action執行前阻止其執行，同時也提供了一種可以提取action中可重用部分的方式。在AOP