做一个自动配置JDK环境变量的Powershell脚本

小咪咪 2022-06-15 09:14 272阅读 0赞

本来想把这篇的内容包括在我的Powershell系列文章之内的，后来写完之后才想起来，这时候我已经复制粘贴到简书、CSDN和SegmentFault三个地方了。所以这一篇干脆单独写成一篇文章。

其实这篇文章的动机也很简单，每个初学Java的人，都会被配置环境变量所难倒。尤其是对于那些不太懂电脑的人来说，配置环境变量简直要命了。就算我这种配置了几十次环境变量的人，也经常忘了怎么配置，每次配置也得现查。最蛋疼的是，JDK的Windows平台安装包居然没有配置环境变量的功能，那么这个安装包到底有何用处？

好了，废话不多说了。由于这里只打算编写一个简单的脚本，所以首先让我们规定一下这个脚本的用途。我的想法很简单，这个脚本应该在JDK安装程序执行完毕调用，从注册表获取JDK的安装位置，然后自动完成环境变量的配置。至于安装位置是否存在，安装文件是否缺失，这都属于用户的问题，不是我这个脚本的解决范围。

## 获取JDK位置 ##

在Windows注册表中保存着所有安装程序的信息，它们都在`HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall`键下。

然后我们寻找JDK的信息。这里我从我电脑的安装的JDK 8中截取了前一部分`SE Development Kit`作为查询字符串，不保证JDK 6和JDK 7的前一部分也和这一样。

$softwares = Get-ItemProperty HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\* 
    $jdk = $softwares  | Where-Object DisplayName -Match 'Java SE Development Kit'

考虑到有的人电脑上安装了不止一个JDK，我这里还做了多个JDK的处理工作。不过由于我电脑上只有一个JDK，所以这一部分我没有测试，不保证一定可以工作。

if ($jdk.Count -gt 1) {
        Write-Host "Found more than one jdks :"
        $id = 1
        foreach ($e in $jdk) {
            Write-Host "${id}." $e.DisplayName
            $id++
        }
        $choice = [int](Read-Host -Prompt "which to use ?")
        $jdk = $jdk[$choice]
    }

获取到JDK信息之后，读取它的安装位置属性，即可获取到JDK的安装位置。

$install_location = $jdk.InstallLocation
    # 去掉路径最后的斜杠
    Write-Host "Found installation Location : ${install_location}".trim('\')

## 添加环境变量 ##

下面参考链接中介绍了新建环境变量的方法。如果需要创建一个临时环境变量，也就是只在当前Powershell窗口中有效的，只需要一句话就可以搞定。

$env:TestVariable = "This is a test environment variable."

如果需要创建用户或者系统级别的环境变量，需要调用.NET框架的方法。这个方法有三个参数，第一个指定环境变量名称，第二个指定环境变量的值，第三个指定环境变量类型（`Process`是仅当前进程有效，`User`是用户级别，`Machine`是系统环境变量且需要管理员权限）。

[Environment]::SetEnvironmentVariable("TestVariable", "Test value.", "Machine")

然后我们根据JDK安装位置设置环境变量。

$java_home = $install_location
    $classpath = "%JAVA_HOME%\lib;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar"
    $path = "%JAVA_HOME%\bin;" + $env:Path
    
    [Environment]::SetEnvironmentVariable("JAVA_HOME", $java_home, "Machine")
    [Environment]::SetEnvironmentVariable("CLASSPATH", $classpath, "Machine")
    [Environment]::SetEnvironmentVariable("PATH", $path , "Machine")

最后，打开一个新的CMD或者是Powershell窗口，输入一下两条命令测试环境变量是否配置正确。需要注意JDK安装包好像会写一个`java.exe`链接到可执行路径下，所以`java`和`javac`两条命令都需要测试才能确保环境变量配置成功。

java -version
    javac -version

## 完整脚本 ##

下面是完整的脚本，它也放到了[我的Github][Github]上面了，有兴趣的同学可以看看。

# 设置Java SDK 环境变量
    
    $softwares = Get-ItemProperty HKLM:\Software\Microsoft\Windows\CurrentVersion\Uninstall\* 
    $jdk = $softwares  | Where-Object DisplayName -Match 'Java SE Development Kit'
    
    if ($jdk.Count -gt 1) {
        Write-Host "找到多个JDK安装程序:"
        $id = 1
        foreach ($e in $jdk) {
            Write-Host "${id}." $e.DisplayName
            $id++
        }
        $choice = [int](Read-Host -Prompt "应该使用哪个?")
        $jdk = $jdk[$choice]
    }
    
    $install_location = $jdk.InstallLocation.trim('\')
    # 去掉路径最后的斜杠
    Write-Host "发现安装位置: ${install_location}"
    
    # 配置环境变量
    $java_home = $install_location
    $classpath = "%JAVA_HOME%\lib;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar"
    $path = "%JAVA_HOME%\bin;" + $env:Path
    
    [Environment]::SetEnvironmentVariable("JAVA_HOME", $java_home, "Machine")
    [Environment]::SetEnvironmentVariable("CLASSPATH", $classpath, "Machine")
    [Environment]::SetEnvironmentVariable("PATH", $path , "Machine")
    
    
    Write-Host "配置JDK环境变量成功"

因为这篇文章写出了可能就不会再更新了，而Github上脚本还可能会继续更新，所以我又写了个下载执行Github上脚本的命令。

invoke-WebRequest https://raw.githubusercontent.com/techstay/powershell-study/master/scripts/set-jdk-env-variables.ps1|Select-Object -ExpandProperty content|Invoke-Expression

如果出现什么策略错误，可能是默认情况Powershell禁止运行远程脚本，允许就可以了。

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

这个脚本在我电脑上测试没问题，不过不一定能够在所有系统上运行。所以使用的时候请注意，同时欢迎反馈信息。

## 参考资料 ##

[http://jingyan.baidu.com/article/925f8cb836b26ac0dde0569e.html][http_jingyan.baidu.com_article_925f8cb836b26ac0dde0569e.html]

[https://technet.microsoft.com/en-us/library/ff730964.aspx][https_technet.microsoft.com_en-us_library_ff730964.aspx]

[Github]: https://github.com/techstay/powershell-study
[http_jingyan.baidu.com_article_925f8cb836b26ac0dde0569e.html]: http://jingyan.baidu.com/article/925f8cb836b26ac0dde0569e.html
[https_technet.microsoft.com_en-us_library_ff730964.aspx]: https://technet.microsoft.com/en-us/library/ff730964.aspx