您可以通过配置SSL证书为Spring Boot启用HTTPS,实现网络通信数据的加密传输。本文介绍在Spring Boot上启用HTTPS的具体步骤。

前提条件

  • SSL证书的加密算法为RSA或ECC,并且证书为已签发状态。
    说明 如果您证书的加密算法为SM2(国密算法),该证书无法配置在Spring Boot上。您需要吊销该证书并重新申请加密算法为RSA或ECC的证书。关于吊销证书和申请证书的操作,请参见吊销SSL证书提交证书申请
  • 您的Spring Boot已经开启了443端口(HTTPS服务的默认端口)。
  • 已准备好远程登录工具(例如PuTTY、Xshell),用于登录您的Web应用服务器。

操作步骤

  1. 登录数字证书管理服务控制台
  2. 在左侧导航栏,单击SSL证书
  3. 定位到要下载的证书,单击操作列的下载
  4. 证书下载面板,单击Tomcat服务器操作列下的下载
    说明 Spring Boot支持配置PFX和JKS格式的证书。单击Tomcat操作列的下载即可下载PFX格式证书,本文以PFX格式证书为例介绍如何在Spring Boot上启用HTTPS。如果您需要配置JKS格式的证书,请单击JKS操作列的下载
    该操作会将Tomcat服务器证书压缩包下载到本地,并保存在浏览器的默认下载位置。
  5. 访问浏览器的默认下载目录,解压已下载的证书压缩包文件。
    解压后您将会获得以下文件:
    • 证书文件(domain_name.pfx
    • 密码文件(pfx-password.txt
    说明
    • 本文中证书名称以domain_name为示例。
    • 每次下载证书都会产生新的密码。该密码仅匹配本次下载的证书。如果需要更新证书文件,同时也要更新匹配的密码。
  6. 登录您的Spring Boot应用服务器。
  7. 将解压后的证书文件和密码文件拷贝到Spring Boot项目的根目录src/main/resources/下。
    说明 如果您修改过Spring Boot项目的目录,您需要将证书文件和密码文件拷贝到与配置文件application.propertiesapplication.yml相同的目录下。
  8. 修改配置文件application.propertiesapplication.yml
    • 参考以下示例配置application.properties中的参数:
      server.port = 443    #HTTPS协议默认端口号为443,需要使用其他端口时,您可以在此处自定义。
      server.ssl.key-store: classpath = <domain_name.pfx>   #您需要使用实际的证书名称替换domain_name.pfx。
      server.ssl.key-store-password = ********    #填写pfx-password.txt文件内的密码。
      server.ssl.keyStoreType = PKCS12
    • 参考以下示例配置application.yml中的参数:
      server:
        port: 443    #HTTPS协议默认端口号为443,需要使用其他端口时,您可以在此处自定义。
        ssl:
          key-alias: tomcat
          key-store-password: ********    #填写pfx-password.txt文件内的密码。
          key-store-type: PKCS12
          key-store: classpath:<domain_name.pfx>    #您需要使用实际的证书名称替换domain_name.pfx
  9. 执行mvn spring-boot:run命令重启Spring Boot服务。

后续步骤

验证是否已启用HTTPS协议。
配置完成后,您可通过访问证书绑定的域名验证是否已启用HTTPS协议。
https://yourdomain   #需要将yourdomain替换成证书绑定的域名。
  • 如果网页地址栏出现小锁标志,表示已启用HTTPS协议。
  • 如果无法通过HTTPS正常访问网站,请确认您服务器的443端口是否已开启。如果443端口正常开启,仍无法通过HTTPS正常访问网站,您可以搜索钉钉群(群号为32435999)并加入该群获取技术支持