cn.micro.core.util.SystemUtil Maven / Gradle / Ivy

Go to download
package cn.micro.core.util;

import org.springframework.lang.Nullable;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;

import java.util.Objects;

/**
 * 系统工具类
 */
public class SystemUtil {
	/**
	 * 代码部署于 linux 上，工作默认为 mac 和 Windows
	 */
	private static final String OS_NAME_LINUX = "LINUX";

	/**
	 * 获取 user home
	 */
	@Nullable
	public static final String USER_HOME = getSystemProperty("user.home");

	/**
	 * 获取用户地址
	 */
	@Nullable
	public static final String USER_DIR = getSystemProperty("user.dir");

	/**
	 * 获取用户名
	 */
	@Nullable
	public static final String USER_NAME = getSystemProperty("user.name");

	/**
	 * os 名
	 */
	@Nullable
	public static final String OS_NAME = getSystemProperty("os.name");

	/**
	 * 
	 * Gets a System property, defaulting to {@code null} if the property cannot be read.
	 * 
	 * 
	 * If a {@code SecurityException} is caught, the return value is {@code null} and a message is written to
	 * {@code System.err}.
	 * 
	 *
	 * @param property the system property name
	 * @return the system property value or {@code null} if a security problem occurs
	 */
	@Nullable
	private static String getSystemProperty(final String property) {
		try {
			return System.getProperty(property);
		} catch (final SecurityException ex) {
			return null;
		}
	}

	/**
	 * 判断是否为本地开发环境
	 *
	 * @return boolean
	 */
	public static boolean isLinux() {
		return !StringUtils.isEmpty(OS_NAME) && OS_NAME_LINUX.equalsIgnoreCase(OS_NAME);
	}

	/**
	 * 代码部署于 linux 上，工作默认为 mac 和 Windows
	 *
	 * @return boolean
	 */
	public static boolean isLocalDev() {
		return !SystemUtil.isLinux();
	}

	/**
	 * 读取 System Property
	 *
	 * @param key key
	 * @return value
	 */
	@Nullable
	public static String getProp(String key) {
		return System.getProperty(key);
	}

	/**
	 * 读取 System Property
	 *
	 * @param key      key
	 * @param defValue 默认值
	 * @return value
	 */
	public static String getProp(String key, String defValue) {
		return System.getProperty(key, defValue);
	}

	/**
	 * 读取 System Property
	 *
	 * @param key          key
	 * @param defaultValue defaultValue
	 * @return value
	 */
	public static int getPropToInt(String key, int defaultValue) {
		return ObjectUtil.toInt(getProp(key), defaultValue);
	}

	/**
	 * 读取 System Property
	 *
	 * @param key          key
	 * @param defaultValue defaultValue
	 * @return value
	 */
	public static boolean getPropToBool(String key, boolean defaultValue) {
		return Objects.requireNonNull(ObjectUtil.toBoolean(getProp(key), defaultValue));
	}

	/**
	 * 读取 System Property 或者 Env
	 *
	 * @param key key
	 * @return value
	 */
	@Nullable
	public static String getPropOrEnv(String key) {
		String value = System.getProperty(key);
		return value == null ? System.getenv(key) : value;
	}

}