在 Java 中查找用户主目录的最佳方法是什么?
难点在于解决方案应该是跨平台的;它应该适用于 Windows 2000、XP、Vista、OS X、Linux 和其他 Unix 变体。我正在寻找可以在所有平台上完成此操作的代码片段,以及一种检测平台的方法。
根据 Java 错误 4787931,系统属性 user.home
在 Windows XP 上无法正常工作,因此使用此系统属性不是可接受的解决方案,因为它不是跨平台的。
您引用的错误(错误 4787391)已在 Java 8 中修复。即使您使用的是旧版本的 Java,System.getProperty("user.home")
方法可能仍然是最好的。 user.home
方法似乎在很多情况下都有效。 Windows 上的 100% 防弹解决方案很难,因为 Windows 对主目录的含义有一个不断变化的概念。
如果 user.home
对您来说不够好,我建议选择 home directory
的定义对于 Windows 并使用它,使用 System.getenv(String)
获取适当的环境变量。
实际上对于 Java 8,正确的方法是使用:
System.getProperty("user.home");
错误 JDK-6519127 已修复,release notes 的“JDK 8 和 JDK 7 之间的不兼容性”部分指出:
区域:Core Libs / java.lang 概要 用于在 Windows 上确定用户主目录的步骤已更改为遵循 Microsoft 推荐的方法。在旧版本的 Windows 或注册表设置或环境变量设置为其他目录的情况下,可能会观察到此更改。不兼容行为的性质 RFE 6519127
尽管问题很老,但我将其留作将来参考。
System.getProperty("user.home");
请参阅 JavaDoc。
对于 Windows,HOME 目录的概念似乎有点模糊。如果 environment variables (HOMEDRIVE/HOMEPATH/USERPROFILE) 还不够,您可能不得不求助于通过 JNI 或 JNA 使用本机函数。 SHGetFolderPath 允许您检索特殊文件夹,例如 My Documents (CSIDL_PERSONAL) 或 Local Settings\Application Data (CSIDL_LOCAL_APPDATA)。
示例 JNA 代码:
public class PrintAppDataDir {
public static void main(String[] args) {
if (com.sun.jna.Platform.isWindows()) {
HWND hwndOwner = null;
int nFolder = Shell32.CSIDL_LOCAL_APPDATA;
HANDLE hToken = null;
int dwFlags = Shell32.SHGFP_TYPE_CURRENT;
char[] pszPath = new char[Shell32.MAX_PATH];
int hResult = Shell32.INSTANCE.SHGetFolderPath(hwndOwner, nFolder,
hToken, dwFlags, pszPath);
if (Shell32.S_OK == hResult) {
String path = new String(pszPath);
int len = path.indexOf('\0');
path = path.substring(0, len);
System.out.println(path);
} else {
System.err.println("Error: " + hResult);
}
}
}
private static Map<String, Object> OPTIONS = new HashMap<String, Object>();
static {
OPTIONS.put(Library.OPTION_TYPE_MAPPER, W32APITypeMapper.UNICODE);
OPTIONS.put(Library.OPTION_FUNCTION_MAPPER,
W32APIFunctionMapper.UNICODE);
}
static class HANDLE extends PointerType implements NativeMapped {
}
static class HWND extends HANDLE {
}
static interface Shell32 extends Library {
public static final int MAX_PATH = 260;
public static final int CSIDL_LOCAL_APPDATA = 0x001c;
public static final int SHGFP_TYPE_CURRENT = 0;
public static final int SHGFP_TYPE_DEFAULT = 1;
public static final int S_OK = 0;
static Shell32 INSTANCE = (Shell32) Native.loadLibrary("shell32",
Shell32.class, OPTIONS);
/**
* see http://msdn.microsoft.com/en-us/library/bb762181(VS.85).aspx
*
* HRESULT SHGetFolderPath( HWND hwndOwner, int nFolder, HANDLE hToken,
* DWORD dwFlags, LPTSTR pszPath);
*/
public int SHGetFolderPath(HWND hwndOwner, int nFolder, HANDLE hToken,
int dwFlags, char[] pszPath);
}
}
其他人已经回答了我面前的问题,但是打印出所有可用属性的有用程序是:
for (Map.Entry<?,?> e : System.getProperties().entrySet()) {
System.out.println(String.format("%s = %s", e.getKey(), e.getValue()));
}
替代方法是使用 Apache CommonsIO FileUtils.getUserDirectory()
而不是 System.getProperty("user.home")
。它将为您提供相同的结果,并且在指定系统属性时没有机会引入拼写错误。
您的项目中很有可能已经拥有 Apache CommonsIO 库。如果您打算仅将其用于获取用户主目录,请不要引入它。
File FileUtils.getUserDirectory()
| String FileUtils.getUserDirectoryPath()
- commons.apache.org/proper/commons-io/apidocs/org/apache/commons/…
当我在搜索 Scala 版本时,我只能找到上面 McDowell 的 JNA 代码。我在这里包括了我的 Scala 端口,因为目前没有更合适的地方。
import com.sun.jna.platform.win32._
object jna {
def getHome: java.io.File = {
if (!com.sun.jna.Platform.isWindows()) {
new java.io.File(System.getProperty("user.home"))
}
else {
val pszPath: Array[Char] = new Array[Char](WinDef.MAX_PATH)
new java.io.File(Shell32.INSTANCE.SHGetSpecialFolderPath(null, pszPath, ShlObj.CSIDL_MYDOCUMENTS, false) match {
case true => new String(pszPath.takeWhile(c => c != '\0'))
case _ => System.getProperty("user.home")
})
}
}
}
与 Java 版本一样,您需要将 Java Native Access(包括两个 jar 文件)添加到引用的库中。
很高兴看到 JNA 现在比发布原始代码时更容易做到这一点。
我将使用错误报告中详述的算法,使用 System.getenv(String),如果没有环境变量指示有效的现有目录,则回退到使用 user.dir 属性。这应该可以跨平台工作。
我认为,在 Windows 下,您真正追求的是用户的名义“文档”目录。
如果您想要在 Windows 上运行良好的东西,有一个名为 WinFoldersJava 的包,它包装了本机调用以获取 Windows 上的“特殊”目录。我们经常使用它并且效果很好。
System.getProperty
调用。正确的调用是SystemUtils.getUserHome()
。