【开发细节】SpringBoot项目将接口从HTTP换为HTTPS

淡淡的烟草味﹌ 2024-03-16 21:05 10阅读 0赞

### 证书准备 ###

**首先需要生成一个 SSL 证书，可以使用 OpenSSL 工具或者自己的 CA 颁发机构来生成证书**，这里就不赘述了。如果是**测试阶段，也可以使用 self-signed certificate**。  
直接使用**jdk的keytool生成**，具体操作方法如下：

1.  使用管理员身份运行命令提示符
2.  使用命令进入到jdk安装路径的bin文件夹下
3.  随后使用命令：keytool -genkey -alias tomcat -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore keystore.p12 -validity 3650生成密钥。

以上步骤如下图所示：  
![在这里插入图片描述][5e6ca87964404c69a8970877a257307a.png_pic_center]  
![在这里插入图片描述][1203a07c280e47dda6c92cb864d91011.png_pic_center]  
生成的证书如下：  
![在这里插入图片描述][3092c6b6cf8d4fcf9c956ecda1bf2d5f.png_pic_center]  
把它粘贴到项目的classpath下即可使用。

### 项目配置 ###

把证书文件移动到此：  
![在这里插入图片描述][7a083284931e470190be6627c9fa86ea.png_pic_center]  
而后在application.yml中进行一些配置：  
注意`key-store-password`不要写成`key-password`了。

server:
      ssl:
        enabled: true #启用SSL
        key-store: classpath:keystore.p12 #文件位置
        key-store-password: root123 #密钥存储密码（即生成时要求输入两遍的那个的密钥库口令）
        key-store-type: PKCS12 #密钥存储类型

重启项目，启动成功即说明配置成功。  
访问项目原来的swagger界面测试一下。  
![在这里插入图片描述][f8cfeeb9d33b4545b980debae3b6c92c.png_pic_center]  
出现以上说明正确。  
在前面加上前缀`https://`再试一次，可能会出现如下界面：  
![在这里插入图片描述][118eea23652245cd8768e32f69d59e36.png_pic_center]  
由于访问的是 HTTPS，浏览器会进行 SSL 验证，如果服务器没有配置合法的 SSL 证书，浏览器会给出安全警告。如果只是测试阶段，可以先信任自己的 SSL 证书，例如在 Chrome 中将证书添加到受信任的根证书颁发机构中。生产环境中，则需要购买合法的 SSL 证书。  
此处我们是个人测试，故而点击详情直接访问即可。  
![在这里插入图片描述][1c7859a0a0eb40bc8d3948d335ae31aa.png_pic_center]  
成功进入swagger界面：  
![在这里插入图片描述][8baa18f3e7b847048a81872f7085905e.png_pic_center]  
测试接口，发现已经成功放入HTTPS了：  
![在这里插入图片描述][57327d189d5c4d4db29de9b60c12fef0.png_pic_center]

### 前端怎么做？ ###

前端访问 HTTPS 上的接口与 HTTP 上的接口是类似的，只需要将 URL 中的 http 改成 https。例如，如果原本访问的是 http://localhost:8080/api/user，修改为 https://localhost:8080/api/user 即可。

这里需要**注意一个问题**：HTTP默认端口是80，而HTTPS默认端口是443，建议指定端口，避免搞错。

[5e6ca87964404c69a8970877a257307a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/8d6a7585d10a435ab5bd337c9abe53e2.png
[1203a07c280e47dda6c92cb864d91011.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/4e9a454a0f014f7682abb2f60cef36f2.png
[3092c6b6cf8d4fcf9c956ecda1bf2d5f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/2c5507e844e74e0e81fdc3916a6ed9a7.png
[7a083284931e470190be6627c9fa86ea.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f82d32085275408bb7bc3c6e0dcec740.png
[f8cfeeb9d33b4545b980debae3b6c92c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/c875f101c0484a3a842d8a8521f66bb8.png
[118eea23652245cd8768e32f69d59e36.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/5a03d083b99940ee8daf93788500c657.png
[1c7859a0a0eb40bc8d3948d335ae31aa.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/ef68be87f376480298509097f6057b3b.png
[8baa18f3e7b847048a81872f7085905e.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/378c0a1cbe7543a2a1b4f5fb1d3aea10.png
[57327d189d5c4d4db29de9b60c12fef0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/eacf8d821b9e438083ed628f617ef8a4.png