springboot自定義參數解析HandlerMethodArgumentResolver,實現接口訪問設備信息記錄

 

在項目開發中，我們經常需要記錄用戶是通過什麼設備和操作系統來訪問接口，以此來做不通的操作處理。尤其是公司軟件針對多國用戶，可以切換語言。我們後臺經常需要根據語言來做不同的操作。

下面我們講解如何通過實現HandlerMethodArgumentResolver的方法來實現用戶訪問接口時的設備信息

首先我們們需要準備一些必要的jar包

    <!-- https://mvnrepository.com/artifact/eu.bitwalker/UserAgentUtils -->
	<dependency>
		<groupId>eu.bitwalker</groupId>
		<artifactId>UserAgentUtils</artifactId>
		<version>1.21</version>
	</dependency>
    <dependency>
	    <groupId>org.projectlombok</groupId>
	    <artifactId>lombok</artifactId>
	    <version>1.18.6</version>
	    <scope>provided</scope>
	</dependency>	
	<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
		<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
		<dependency>
		    <groupId>org.apache.commons</groupId>
		    <artifactId>commons-lang3</artifactId>
		    <version>3.9</version>
		</dependency>

 首先我給出一個獲取用戶的IP地址的工具類

package com.hongyu.studypay.untils;

import java.net.InetAddress;
import java.net.UnknownHostException;

import javax.servlet.http.HttpServletRequest;

public class IpUtils {
	/**
	 * 獲取IP地址
	 * @param request
	 * @return
	 */
	public static String getIpAddr(HttpServletRequest request) {
		        String ipAddress = request.getHeader("x-forwarded-for");
		          if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		              ipAddress = request.getHeader("Proxy-Client-IP");
		         }
		         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		             ipAddress = request.getHeader("WL-Proxy-Client-IP");
		          }
		         if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		 			ipAddress = request.getHeader("HTTP_CLIENT_IP");
		 		}
		 		if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		 			ipAddress = request.getHeader("HTTP_X_CONNECTING_IP");
		 		}
		 		if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		 			ipAddress = request.getHeader("HTTP_X_FORWARDED_FOR");
		 		}
		 		if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		 			ipAddress = request.getHeader("X-Real-IP");
		 		}
		        if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
		            ipAddress = request.getRemoteAddr();
		            String localIp = "127.0.0.1";
		            String localIpv6 = "0:0:0:0:0:0:0:1";
		             if (ipAddress.equals(localIp) || ipAddress.equals(localIpv6)) {
		                // 根據網卡取本機配置的IP
		                 InetAddress inet = null;
		                 try {
		                    inet = InetAddress.getLocalHost();
		                     ipAddress = inet.getHostAddress();
		                 } catch (UnknownHostException e) {
		                    e.printStackTrace();
		                }
		            }
		        }
		        // 對於通過多個代理的情況，第一個IP爲客戶端真實IP,多個IP按照','分割
		        String ipSeparate = ",";
		        int ipLength = 15;
		         if (ipAddress != null && ipAddress.length() > ipLength) {
	             if (ipAddress.indexOf(ipSeparate) > 0) {
		                 ipAddress = ipAddress.substring(0, ipAddress.indexOf(ipSeparate));
		             }
		         }
		         return ipAddress;
		     }

}

下面我們需要定義一個實體類用來接收設備的相關信息

import java.io.Serializable;
import java.util.Locale;
import lombok.Data;
@Data
public class UserInfoVo implements Serializable {
	
	private Locale				locale;// 用戶設備的語言相關信息
	private String				userIp; // 客戶端ip
	private  String             operatingSystemName; //操作系統類型
	private  String             operatingSystemType;
	private  String             deviceType; //訪問設備名稱
	private  String             browserName;//瀏覽器名稱
	private  String             browserType;//瀏覽器類型
	private  String             browserVersion;//瀏覽器版本
	
}

下面我們講自定義參數解析器的實現

/**
 * 獲取用戶訪問網站使用的設備信息
 * @author Administrator
 *
 */
@Component
public class UserInfoResovler  implements HandlerMethodArgumentResolver {

	@Override
	public boolean supportsParameter(MethodParameter parameter) {
		return UserInfoVo.class.isAssignableFrom( parameter.getParameterType() );
	}

	@Override
	public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
			NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
		HttpServletRequest request = webRequest.getNativeRequest( HttpServletRequest.class );
		String agent = request.getHeader("User-Agent");
		//解析agent字符串
		UserAgent userAgent = UserAgent.parseUserAgentString(agent);
		//獲取瀏覽器對象
		Browser browser = userAgent.getBrowser();
		//獲取操作系統對象
		OperatingSystem operatingSystem = userAgent.getOperatingSystem();
		String lang = null;
		Cookie[] cookie = request.getCookies();
		if (cookie != null) {
			for (int i = 0; i < cookie.length; i++) {
				if ("locale".equalsIgnoreCase( cookie[ i ].getName() )) {
					lang = cookie[ i ].getValue();
					break;
				}
			}
		}
		String[] langArr = StringUtils.defaultIfBlank(lang,"").split( "_" );
		Locale locale = langArr.length == 2 ? new Locale(langArr[0], langArr[1]) : RequestContextUtils.getLocale(request);
		UserInfoVo userEnvVo = new UserInfoVo();
		userEnvVo.setUserIp(IpUtils.getIpAddr(request));
		userEnvVo.setLocale( locale );
		userEnvVo.setOperatingSystemName(operatingSystem.getName());
		userEnvVo.setOperatingSystemType(operatingSystem.getGroup().getName());
		userEnvVo.setDeviceType(operatingSystem.getDeviceType().getName());
		userEnvVo.setBrowserName(browser.getName());
		userEnvVo.setBrowserType(browser.getBrowserType().getName());
		userEnvVo.setBrowserVersion(userAgent.getBrowserVersion().getVersion());
		return userEnvVo;	
	}

}

WebMvcConfigurerAdapter是Spring內部的一種配置方式
採用JavaBean的形式來代替傳統的xml配置文件形式進行鍼對框架個性化定製

@SuppressWarnings("deprecation")
@Configuration
public class ApplicationWebMvcConfigurerAdapter extends WebMvcConfigurerAdapter {
	 @Bean
	public UserInfoResovler userEnvArgumentResolver() {
	        return new UserInfoResovler();
	}

	@Override
	public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
		argumentResolvers.add(userEnvArgumentResolver());
	}
}

以上代碼完成後我們就可以來測試下效果了

    @PostMapping("headerInfo")
	public Object TestInfo(UserInfoVo userEnvVo) {
		System.out.println("訪問該接口的用戶設備信息"+JSON.toJSONString(userEnvVo));
		return  userEnvVo;
	}

 

執行該接口後打印的數據：
訪問該接口的用戶設備信息{"browserName":"Chrome","browserType":"Browser","browserVersion":"73.0.3683.86","deviceType":"Computer","locale":"zh_CN","operatingSystemName":"Windows 7","operatingSystemType":"Windows","userIp":"169.254.201.46"}

我們獲取了操作系統的相關信息，瀏覽器的相關信息，IP地址，語言等等。