天天看點

Spring Boot 部署與服務配置

版權聲明:本文為部落客原創文章,未經部落客允許不得轉載。 https://blog.csdn.net/catoop/article/details/50588851

Spring Boot 其預設是內建web容器的,啟動方式由像普通Java程式一樣,main函數入口啟動。其内置Tomcat容器或Jetty容器,具體由配置來決定(預設Tomcat)。當然你也可以将項目打包成war包,放到獨立的web容器中(Tomcat、weblogic等等),當然在此之前你要對程式入口做簡單調整。

項目建構我們使用Maven或Gradle,這将使項目依賴、jar包管理、以及打包部署變的非常友善。

一、内嵌 Server 配置

Spring Boot将容器内置後,它通過配置檔案的方式類修改相關server配置。

先看一下下面的圖,為關于server的配置列項:

其中常用的配置隻有少數幾個,已經用紫色标記起來。紅框圈起來的部分,看名稱分類就可以明白其作用。

對server的幾個常用的配置做個簡單說明:

# 項目contextPath,一般在正式釋出版本中,我們不配置
server.context-path=/myspringboot
# 錯誤頁,指定發生錯誤時,跳轉的URL。請檢視BasicErrorController源碼便知
server.error.path=/error
# 服務端口
server.port=9090
# session最大逾時時間(分鐘),預設為30
server.session-timeout=60
# 該服務綁定IP位址,啟動伺服器時如本機不是該IP位址則抛出異常啟動失敗,隻有特殊需求的情況下才配置
# server.address=192.168.16.11           

Tomcat

Tomcat為Spring Boot的預設容器,下面是幾個常用配置:

# tomcat最大線程數,預設為200
server.tomcat.max-threads=800
# tomcat的URI編碼
server.tomcat.uri-encoding=UTF-8
# 存放Tomcat的日志、Dump等檔案的臨時檔案夾,預設為系統的tmp檔案夾(如:C:\Users\Shanhy\AppData\Local\Temp)
server.tomcat.basedir=H:/springboot-tomcat-tmp
# 打開Tomcat的Access日志,并可以設定日志格式的方法:
#server.tomcat.access-log-enabled=true
#server.tomcat.access-log-pattern=
# accesslog目錄,預設在basedir/logs
#server.tomcat.accesslog.directory=
# 日志檔案目錄
logging.path=H:/springboot-tomcat-tmp
# 日志檔案名稱,預設為spring.log
logging.file=myapp.log           

Jetty

如果你要選擇Jetty,也非常簡單,就是把pom中的tomcat依賴排除,并加入Jetty容器的依賴,如下:

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
      <exclusion>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jetty</artifactId>
  </dependency>
<dependencies>            

打包

打包方法:

CMD進入項目目錄,使用 mvn clean package 指令打包,以我的項目工程為例:

E:\spring-boot-sample>mvn clean package           

可以追加參數 -Dmaven.test.skip=true 跳過測試。

打包後的檔案存放于項目下的target目錄中,如:spring-boot-sample-0.0.1-SNAPSHOT.jar

如果pom配置的是war包,則為spring-boot-sample-0.0.1-SNAPSHOT.war

二、部署到JavaEE容器

  1. 修改啟動類,繼承 SpringBootServletInitializer 并重寫 configure 方法
public class SpringBootSampleApplication extends SpringBootServletInitializer{

    private static final Logger logger = LoggerFactory.getLogger(SpringBootSampleApplication.class);

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(this.getClass());
    }

}           
  1. 修改pom檔案中jar 為 war
<!-- <packaging>jar</packaging> -->
<packaging>war</packaging>           
  1. 修改pom,排除tomcat插件
<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-tomcat</artifactId>
                </exclusion>
            </exclusions>
        </dependency>           
  1. 打包部署到容器

    使用指令 mvn clean package 打包後,同一般J2EE項目一樣部署到web容器。

三、使用Profile區分環境

spring boot 可以在 “配置檔案”、“Java代碼類”、“日志配置” 中來配置profile區分不同環境執行不同的結果

1、配置檔案

使用配置檔案application.yml 和 application.properties 有所差別

以application.properties 為例,通過檔案名來區分環境 application-{profile}.properties

application.properties

app.name=MyApp
server.port=8080
spring.profiles.active=dev           

application-dev.properties

server.port=8081           

application-stg.properties

server.port=8082           

在啟動程式的時候通過添加 –spring.profiles.active={profile} 來指定具體使用的配置

例如我們執行 java -jar demo.jar –spring.profiles.active=dev 那麼上面3個檔案中的内容将被如何應用?

Spring Boot 會先加載預設的配置檔案,然後使用具體指定的profile中的配置去覆寫預設配置。

app.name 隻存在于預設配置檔案 application.properties 中,因為指定環境中不存在同樣的配置,是以該值不會被覆寫

server.port 預設為8080,但是我們指定了環境後,将會被覆寫。如果指定stg環境,server.port 則為 8082

spring.profiles.active 預設指定dev環境,如果我們在運作時指定 –spring.profiles.active=stg 那麼将應用stg環境,最終 server.port 的值為8082

2、Java類中@Profile注解

下面2個不同的類實作了同一個接口,@Profile注解指定了具體環境

// 接口定義
public interface SendMessage {

    // 發送短信方法定義
    public void send();

}

// Dev 環境實作類
@Component
@Profile("dev")
public class DevSendMessage implements SendMessage {

    @Override
    public void send() {
        System.out.println(">>>>>>>>Dev Send()<<<<<<<<");
    }

}

// Stg環境實作類
@Component
@Profile("stg")
public class StgSendMessage implements SendMessage {

    @Override
    public void send() {
        System.out.println(">>>>>>>>Stg Send()<<<<<<<<");
    }

}

// 啟動類
@SpringBootApplication
public class ProfiledemoApplication {

    @Value("${app.name}")
    private String name;

    @Autowired
    private SendMessage sendMessage;

    @PostConstruct
    public void init(){
        sendMessage.send();// 會根據profile指定的環境執行個體化對應的類
    }

}           

3、logback-spring.xml也支援有節點來支援區分

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/base.xml" />
    <logger name="org.springframework.web" level="INFO"/>

    <springProfile name="default">
        <logger name="org.springboot.sample" level="TRACE" />
    </springProfile>

    <springProfile name="dev">
        <logger name="org.springboot.sample" level="DEBUG" />
    </springProfile>

    <springProfile name="staging">
        <logger name="org.springboot.sample" level="INFO" />
    </springProfile>

</configuration>           

再說一遍檔案名不要用logback.xml 請使用logback-spring.xml

四、指定外部的配置檔案

有些系統,關于一些資料庫或其他第三方賬戶等資訊,由于安全問題,其配置并不會提前配置在項目中暴露給開發人員。

對于這種情況,我們在運作程式的時候,可以通過參數指定一個外部配置檔案。

以 demo.jar 為例,方法如下:

java -jar demo.jar --spring.config.location=/opt/config/application.properties           

其中檔案名随便定義,無固定要求。

五、建立一個Linux 應用的sh腳本

下面幾個腳本僅供參考,請根據自己需要做調整

start.sh

#!/bin/sh

rm -f tpid

nohup java -jar myapp.jar --spring.config.location=application.yml > /dev/null 2>&1 &

echo $! > tpid

echo Start Success!
           

stop.sh

#!/bin/sh
APP_NAME=myapp

tpid=`ps -ef|grep $APP_NAME|grep -v grep|grep -v kill|awk '{print $2}'`
if [ ${tpid} ]; then
    echo 'Stop Process...'
    kill -15 $tpid
fi
sleep 5
tpid=`ps -ef|grep $APP_NAME|grep -v grep|grep -v kill|awk '{print $2}'`
if [ ${tpid} ]; then
    echo 'Kill Process!'
    kill -9 $tpid
else
    echo 'Stop Success!'
fi

           

check.sh

#!/bin/sh
APP_NAME=myapp

tpid=`ps -ef|grep $APP_NAME|grep -v grep|grep -v kill|awk '{print $2}'`
if [ ${tpid} ]; then
        echo 'App is running.'
else
        echo 'App is NOT running.'
fi           

kill.sh

#!/bin/sh
APP_NAME=myapp

tpid=`ps -ef|grep $APP_NAME|grep -v grep|grep -v kill|awk '{print $2}'`
for p in $tpid
do
    echo 'Kill ProcessID '$p
    kill -9 $p
done           

六、使用Linux服務的方式啟動、停止、重新開機

1、首先在 pom.xml 中配置插件

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <executable>true</executable>
                </configuration>
            </plugin>
        </plugins>
    </build>           

特别注意一下

<executable>true</executable>

2、然後正常使用

mvn clean package -Dmaven.test.skip=true

将工程打成jar包

3、上傳jar包到伺服器,假設部署路徑為

/var/apps/myapp.jar

,使用指令做一個軟連接配接到

/etc/init.d

目錄,指令:

ln -s /var/apps/myapp.jar /etc/init.d/myapp           

其中

/etc/init.d/myapp

最後的 myapp 可以是别的名字,這個就是服務名,我們後面使用

service [服務名] start

來啟動(下面有說明)。

4、給jar檔案授予可執行權限,指令:

chmod +x myapp.jar           

5、接下來,就可以使用我們熟悉的

service myapp start|stop|restart|status

來對應用進行啟停了。

執行指令後将得到形如 Started|Stopped [PID] 的結果回報。

預設PID檔案路徑:/var/run/appname/appname.pid

預設服務日志檔案路徑:/var/log/appname.log(可以通過下面.conf 的方式修改

LOG_FOLDER

6、使用自定義的.conf檔案來變更預設配置,方法如下:

在jar包相同路徑下建立一個.conf檔案,名稱應該與.jar的名稱相同,如myapp.conf(如果我們打包的文jar檔案為 myapp-1.0.0.jar 那麼這裡的conf檔案也應該是 myapp-1.0.0.conf),其内容配置可以如下:

JAVA_HOME=/usr/local/jdk
JAVA_OPTS=-Xmx1024M
LOG_FOLDER=/data/logs/myapp           

注:LOG_FOLDER 對應的檔案夾目錄要必須存在,如果目錄不存在,服務并不會自從建立目錄。

華麗麗的分割線

如果你是CentOS 7或紅帽7以上,你還可以用下面的方法處理,為什麼要用這樣的方法(請自行研究),這裡直接提供結果,哈哈

編輯服務檔案 vim /usr/lib/systemd/system/myapp.service

[Unit]
Description=myapp
After=network.target

[Service]
WorkingDirectory=/var/apps/myapp
ExecStart=/usr/local/java/bin/java -Dsun.misc.URLClassPath.disableJarChecking=true -jar /var/apps/myapp.jar
ExecStop=kill $MAINPID
Restart=always

[Install]
WantedBy=multi-user.target           

使用Linux 7 以後服務新的啟動方式,相關指令

啟動
systemctl start myapp
停止
systemctl stop myapp
重新開機
systemctl restart myapp
檢視日志
journalctl -u myapp
關于更多 systemctl 指令的使用方法,度娘有很多。           

(結束)