top.lshaci.framework.web.utils.SessionUserUtils Maven / Gradle / Ivy

Go to download
package top.lshaci.framework.web.utils;

import java.util.Objects;

import org.apache.commons.lang3.StringUtils;

import com.alibaba.fastjson.JSON;

import lombok.extern.slf4j.Slf4j;
import top.lshaci.framework.web.exception.WebBaseException;

/**
 * Session User Utils


 * 
 * @author lshaci
 * @since 0.0.4
 */
@Slf4j
public class SessionUserUtils {
	
	/**
	 * The key of user in session
	 */
	public final static String USER_IN_SESSION = SessionUserUtils.class.getName() + ".userInSession";
	/**
	 * The key of user role in session
	 */
	public final static String USER_ROLE_IN_SESSION = SessionUserUtils.class.getName() + ".userRoleInSession";

	/**
	 * Set user in session
	 * 
	 * @param user the user(This object will be converted to json string.)
	 */
	public static void setUserInSession(Object user) {
		Objects.requireNonNull(user, "The user must not be null!");
		String jsonUser = JSON.toJSONString(user);
		HttpSessionUtils.setAttribute(USER_IN_SESSION, jsonUser);
	}
	
	/**
	 * Get user in session
	 * 
	 * @return the user in session(json string)
	 */
	public static String getUserInSession() {
		return (String) HttpSessionUtils.getAttribute(USER_IN_SESSION);
	}
	
	/**
	 * Get user in session
	 * 
	 * @param  the user class type
	 * @param userType the user class type
	 * 
	 * @return the user in session
	 */
	public static  T getUserInSession(Class userType) {
		String userInSession = getUserInSession();
		try {
			return JSON.parseObject(userInSession, userType);
		} catch (Exception e) {
			log.error("The user type error!", e);
			throw new WebBaseException("The user type error!", e);
		}
	}

	/**
	 * Set user role in session
	 *
	 * @param role the user role
	 */
	public static void setUserRoleInSession(String role) {
		if (StringUtils.isNotBlank(role)) {
			HttpSessionUtils.setAttribute(USER_ROLE_IN_SESSION, role.trim());
		}
	}

	/**
	 * Get user role in session
	 *
	 * @return the user role in session
	 */
	public static String getUserRoleInSession() {
		return (String) HttpSessionUtils.getAttribute(USER_ROLE_IN_SESSION);
	}
}