记一次Spring Boot项目部署,同时支持HTTP与HTTPS、80与443权限问题

5,399 阅读1分钟

最近把客户端的内测分发平台使用Spring Boot+Kotlin重构了,以前是用Tomcat部署的,现在改用Jar包部署。由于是比较简单的单体应用,所以没有使用持续集成框架Jenkins,都是通过FTP上传到Tomcat目录,然后重启Tomcat。

同时支持HTTP与HTTPS

获取SSL的签名这里就不说了,Google搜索也有很多生成免费的签名方案,我是把签名文件放在resources目录

├── build.gradle
├── gradlew
├── settings.gradle
├── src
│   ├── main
│   │   ├── java
│   │   ├── kotlin
│   │   ├── resources
│   │   │   ├── application.properties
│   │   │   ├── keystore.p12
方案一(不推荐,不无法兼容HTTPS和HTTP)

直接修改application.properties

# 端口
server.port=8443
# 签名路径
server.ssl.key-store=/Users/Wiki/BetaServer/src/main/resources/keystore.p12
server.ssl.key-store-password=123123
server.ssl.keyStoreType=PKCS12
server.ssl.keyAlias:tomcat

Spring本身就提供非常方便支持HTTPS的方式,直接修改application.properties即可实现HTTPS,但是使用这种方式就不能直接使用HTTP了。

方案二(兼容HTTPS和HTTP)

我们在application.properties自定义了几个参数

#HTTP端口
server.port=8080
#配置模SSL
tomcat.ssl.enable=true
tomcat.ssl.key-store=keystore.p12
tomcat.ssl.key-store-password=123123
tomcat.ssl.keyStoreType=PKCS12
tomcat.ssl.port=8443

由于我是打包成Jar格式文件然后放在服务器运行,意味着resources目录下的文件无法获取到绝对路径或者相对路径,我们换一个做法,我们在启动HTTPS的时候把resources的文件读取出来,写入到一个临时的路径,那么就可以解决这个问题。

@ConditionalOnExpression(value = "\${tomcat.ssl.enable:false}")
@Configuration
open class CustomTomcatSSLConfiguration {

    @Value("\${tomcat.ssl.port:8443}")
    private val tomcatSSLPort: Int = 0

    @Value("\${tomcat.ssl.key-store:}")
    private val tomcatSSLKeyStore: String? = null

    @Value("\${tomcat.ssl.key-store-password:}")
    private val keystorePassword: String? = null

    @Value("\${tomcat.ssl.keyStoreType:PKCS12}")
    private val keystoreType: String? = null

    @Bean
    open fun servletContainer(): ServletWebServerFactory {
        val tomcat = TomcatServletWebServerFactory();
        tomcat.addAdditionalTomcatConnectors(createSSLConnector())
        return tomcat;
    }
    open fun createSSLConnector(): Connector {
        // 由于下面需要填写签名的地址,如果我们打包成Jar,这个地址就失效了,从 resources 读取 签名文件
        val stream = javaClass.classLoader.getResourceAsStream(tomcatSSLKeyStore)
        // 然后写入当前应用运行的路径
        val file = File(tomcatSSLKeyStore)
        file.writeBytes(stream.readBytes())

        val connector = Connector("org.apache.coyote.http11.Http11NioProtocol")
        connector.port = tomcatSSLPort;
        connector.secure = true
        connector.scheme = "https"

        connector.setAttribute("SSLEnabled", true)
        connector.setAttribute("sslProtocol", "TLS")
        connector.setAttribute("protocol", "org.apache.coyote.http11.Http11Protocol")
        connector.setAttribute("clientAuth", false)
        // 使用临时的前面文件路径
        connector.setAttribute("keystoreFile", file.absolutePath)
        connector.setAttribute("keystoreType", keystoreType)
        connector.setAttribute("keystorePass", keystorePassword)
        connector.setAttribute("keyPass", keystorePassword)
        return connector
    }
}
打包Jar

我的使用Gradle来代替Maven,打包非常的方便,直接执行命令打包即可

./gradlew bootJar
上传Jar到Linux服务器

由于不是经常更新,所以没有引入Jenkins,后续会考虑引入。以前我都是通过FTP上传war到服务器,然后重启Tomcat来实现部署。最近我发现一个更加方便的做法,使用scp命令,可以实现把当前电脑的文件上传到服务器。

scp -P 22222 build/libs/BetaServer.jar  apps@100.100.100.100:/home/apps/webapp/
启动Jar

我们都知道Jar的启动是可以通过 java -jar BetaServer.jar即可启动,但是当我们关闭命令窗口,这个进程就会被关闭导致服务也被关闭了,所以我们需要让这个服务后台运行,关闭窗口也不受影响。

nohup java -jar BetaServer.jar  > log.txt &

记得不要把后面&忽略了,整行都是需要的,log.txt是原来命令行输出的日志,我们把它写到文件中,也方便我们后续查看错误。

访问服务器

由于上面我们配置的HTTP是8080端口,HTTPS是8443端口,那么我们就可以通过以下命令访问

http://100.100.100.100:8080/index
https://100.100.100.100:8443/index
修改端口映射

上面的访问是带有端口,但是我们发布出去的网页,肯定不能让用户也需要输入端口,体验太差了,我们要把HTTP的端口改成80、HTTPS改成443,那么理论上就可以实现这样访问

http://100.100.100.100/index
https://100.100.100.100/index

在Linux的下面部署了应用,为了安全我们使用非root用户进行启动,非root用户不能监听1024以下的端口号,如果直接改成80和443,会报安全性异常。

java.net.SocketException: Permission denied

所以这里需要使用linux的端口转发机制,把到80端口的服务请求都转到8080端口上,443端口转发到8443。 在root下面运行一下命令:

$ iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 8080
$ iptables -t nat -A PREROUTING -p tcp --dport 443 -j REDIRECT --to-port 8443
$ service iptables save

到这里就大功告成啦。