部署專案

接下來我們要將上個章節組建好的JAR檔放到Linux Server上跑。

透過SSH連線到Server

打開Putty，雙擊要連線到的Server

如果有替key設定passphrase的話，請在此輸入

更新系統

請定期更新Server上的軟體，輸入

sudo apt update
sudo apt upgrade
// 如果遇到詢問是否要更新，請輸入y(按下y之前也可以先確認有哪些軟體會更新，避免新舊版本的相容性問題)
// 如果系統有提示需要重新啟動，請執行
// sudo reboot

安裝JRE

我們需要安裝JRE才能跑Java的程式，如果選擇JDK也是可以，不過這裡使用JRE就夠了(因為我們已經在Windows上組建好專案了，所以只需要JRE即可)。

先輸入指令檢查是否有安裝Java

java -version

你應該會看到類似下面的輸出，表示找不到Java指令，也就是我們還沒裝Java

找不到Java指令

輸入指令安裝OpenJDK版的JRE 17，headless表示沒有圖形介面，這是因為我們選擇的OS是Server版

sudo apt install openjdk-17-jre-headless

如果輸入完指令後出現下面的畫面，請輸入使用者的密碼，以下圖來說就是test使用者的密碼，之所以需要輸入密碼是因為我們執行apt指令需要sudo權限。

這裡會告訴我們安裝JRE需要的額外套件(package)，按y繼續即可

輸入指令檢查是否成功安裝Java

java -version

出現下面畫面表示成功安裝JRE 17.0.8.1

安裝MariaDB

安裝MariaDB有兩種方式

第一種是直接從Ubuntu 22.04內建的軟體庫(package repository)安裝，優點是簡單，缺點是通常安裝的軟體版本不會是最新版本，像是目前Ubuntu 22.04提供MariaDB 10.6(LTS)，但目前最新的LTS為10.11。

// 更新軟體庫
sudo apt update
 // 安裝MariaDB
sudo apt install mariadb-server

第二種是透過MariaDB提供的軟體庫(package repository)安裝，優點是可以取得較新的版本，缺點是需要額外設定，下面連結可以取得Ubuntu 22.04下MariaDB 10.11的安裝資訊。

Download MariaDB ServerMariaDB.org

// 安裝必要軟體，如果你的使用的發行版已經有安裝以下軟體，那系統將自動略過，不會重複安裝
sudo apt-get install apt-transport-https curl
// 建立儲存GPG金鑰的資料夾
sudo mkdir -p /etc/apt/keyrings
// 將MariaDB官網的GPG金鑰下載到我們的Server上
sudo curl -o /etc/apt/keyrings/mariadb-keyring.pgp 'https://mariadb.org/mariadb_release_signing_key.pgp'

輸入完上面的指令後，我們需要編輯/etc/apt/sources.list.d/mariadb.sources這個檔案，這裡以nano編輯器示範，當然你也可以用你習慣使用的編輯器(如: vim)

// 加入MariaDB官方提供的軟體庫到我們的系統
sudo nano /etc/apt/sources.list.d/mariadb.sources

當你輸入完上面的指令後，會看到下面的的畫面

在nano編輯器當中，請使用鍵盤的上下左右鍵控制游標，它不像我們常用的Word、記事本可以透過滑鼠移動游標，所以如果你用滑鼠去點的話，游標不會移動，基本上滑鼠剩下選取文字的功能，這在終端機當中是蠻常見的事。

接著貼上以下文字，在這裡Ctrl + v可能會沒辦法成功貼上文字，此時請嘗試Shift + Insert，下面內容為MariaDB官方軟體庫的資訊

# MariaDB 10.11 repository list - created 2023-11-03 08:51 UTC
# https://mariadb.org/download/
X-Repolib-Name: MariaDB
Types: deb
# deb.mariadb.org is a dynamic mirror if your preferred mirror goes offline. See https://mariadb.org/mirrorbits/ for details.
# URIs: https://deb.mariadb.org/10.11/ubuntu
URIs: https://ftp.ubuntu-tw.org/mirror/mariadb/repo/10.11/ubuntu
Suites: jammy
Components: main main/debug
Signed-By: /etc/apt/keyrings/mariadb-keyring.pgp

貼上後的畫面

貼上後按下Ctrl + x，此時系統會詢問是否要儲存檔案，請輸入y

輸入y確認

接著系統將顯示檔案的路徑及檔名，確認無誤按下Enter即可，有錯也可在此調整

最後輸入以下指令

// 更新軟體庫
sudo apt-get update
// 安裝MariaDB
sudo apt-get install mariadb-server
// 確認MariaDB安裝版本
mariadb --version

目前安裝MariaDB 10.11.5

在大多數的使用情況下，apt-get跟apt是可以通用的，詳情可參考以下網站，筆者建議除非有特殊需求，否則使用apt即可。

https://aws.amazon.com/tw/compare/the-difference-between-apt-and-apt-get/

設定MariaDB

// 確認MariaDB執行狀態
sudo systemctl status mariadb
// 如果MariaDB是沒有啟動的，輸入下面指令啟動
sudo systemctl start mariadb
// 設定開機自動啟動MariaDB
sudo systemctl enable mariadb

MariaDB正在執行

MariaDB沒有啟動

// 設定MariaDB
sudo mysql_secure_installation

輸入root密碼，因為預設沒有設定root密碼，所以直接按Enter即可

這裡輸入n即可

這裡輸入n即可

這裡輸入y即可

這裡輸入y即可

這裡輸入y即可

這裡輸入y即可

建立資料庫

我們需要建立一個供範例程式使用的資料庫，首先，我們需要進入MariaDB設定，輸入下列指令

sudo mariadb

成功進入MariaDB的畫面

依序輸入以下SQL指令，你可以將資料庫名稱、資料庫使用者、資料庫使用者的密碼換成你想要的值

# newdatabase為資料庫名稱
CREATE DATABASE newdatabase CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;
# newdatabaseuser為資料庫使用者，password為資料庫使用者的密碼
CREATE USER 'newdatabaseuser'@'localhost' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON newdatabase.* TO 'newdatabaseuser'@'localhost';
FLUSH PRIVILEGES;
// 離開
quit

範例輸出

安裝(S)FTP軟體

為了方便管理Server上的檔案，我們需要(S)FTP軟體，你可以想成Windows的檔案總管，只不過裡面的檔案是存在遠端Server，透過(S)FTP協定可以將檔案從你的電腦傳到遠端Server。

因為FTP協定本身不加密，所以有安全上的隱憂，現在大多改用SFTP協定，可以想成加密版的FTP，不過我們還是習慣以FTP來稱呼。

我們將採用WinSCP作為FTP軟體，請至下方網站下載，當然你也可以根據喜好選擇其他FTP軟體

WinSCP :: Official Site :: Downloadwinscp.net

WinSCP官網

基本上安裝過程保持預設即可，如果有出現以下畫面，請點擊確認

將之前儲存在Putty的連線設定檔匯入到WinSCP

選擇匯入哪些連線設定檔

透過SFTP協定連線至Server

基本上連線設定檔因為已經在Putty設定好了，所以不須額外調整

選擇要使用的連線設定檔，並按下登入

輸入當初生成金鑰對時設定的passphase，與登入Putty時輸入的passphase相同

如果成功連線，你會看到下面的畫面

左側是你的電腦的檔案，右邊是Server的檔案

新增資料夾

我們要建立一個資料夾來放專案的JAR檔及其他資料

目前範例程式除了資料庫以外不會有其他資料需要儲存，未來如果你的程式需要儲存其他資料的話，也可以儲存在此資料夾底下，像是儲存圖片。

左側視窗為你的電腦，右側視窗為遠端Server

雙擊進入資料夾

確定右側的遠端路徑正確後，選取要上傳到Server的檔案

WinSCP會彈出確認視窗，沒問題就按確認

上傳完成

你也可以使用拖曳檔案的方式，譬如從本機電腦拉到遠端Server，反過來也可以。

設定資料庫連線資訊

我們以環境變數的方式設定資料庫連線資訊

請編輯/home/username/.bashrc，其中username需替換成Linux使用者名稱

nano /home/test/.bashrc

在檔案最下面加入

export Vaadin_DB_URL=jdbc:mariadb://localhost:3306/newdatabase
export Vaadin_DB_USER=newdatabaseuser
export Vaadin_DB_PASSWORD=password

變數名稱	變數值
Vaadin_DB_URL	jdbc:mariadb://localhost:3306/newdatabase
Vaadin_DB_USER	newdatabaseuser
Vaadin_DB_PASSWORD	password

請將newdatabase替換為之前新增資料庫時設定的資料庫名稱

請將newdatabaseuser替換為之前新增資料庫時設定的資料庫使用者名稱

請將password替換為之前新增資料庫時設定的資料庫使用者密碼

以example資料庫為範例示範

設定環境變數後，為了讓環境變數生效，請關閉所有SSH連線(Putty)，再重新開啟。

測試環境變數是否生效

echo $Vaadin_DB_URL
echo $Vaadin_DB_USER
echo $Vaadin_DB_PASSWORD

執行程式

我們要先切換到程式所在的資料夾再執行Java指令

// 原本預設在/home/test，切換到/home/test/example
cd example
// 也可以寫成絕對路徑
cd /home/test/example

上面的test請換成你Linux的使用者名稱，example為剛剛新增的資料夾名稱

你可以用ls指令查看目前的所在路徑下有哪些檔案

java -jar crud-with-vaadin-initial-0.0.1-SNAPSHOT.jar

範例專案成功執行

按下Ctrl + c即可終止

終止範例專案

開放連線埠(port)

我們需要開放8080/tcp這個連線埠(port)才能讓外面的連線連入我們的Server，這部分可回顧

GitBookapp.gitbook.com

設定VPS-設定防火牆的章節

測試是否能正常連上

前往http://IP:8080，請將ip換成你的Server的IP，如果無法連上請確認程式正在執行、Spring Boot的連線埠是否是8080(有可能有改到程式的連線埠)、防火牆是否有開放連線埠(port)、IP資訊是否正確。

成功畫面

通常我們在生產環境中不會直接開放8080連線埠，而是會再加一層反向代理，你可以透過設定反向代理讓使用者透過https連線到Server，另外也建議不要使用IP，而是使用域名來提供服務。

延伸閱讀

反向代理是什麼 | 關於代理伺服器 | Cloudflarewww.cloudflare.com

反向代理原理

用 Nginx 伺服器建立反向代理Noob's Space

使用Nginx作為反向代理

網域名稱（域名）是什麽？| 域名与 URL | Cloudflarewww.cloudflare.com

域名介紹

GitHub - acmesh-official/acme.sh: A pure Unix shell script ACME client for SSL / TLS certificate automationGitHub

使用acme.sh取得TLS(SSL)憑證

Nginx 參考設定檔

請根據需求調整，不要直接照抄，不然會跑不起來

Nginx的設定檔在之前是儲存在/etc/nginx/sites-available資料夾底下，然後用軟連結連結到/etc/nginx/sites-enabled資料夾底下，不過較新版本的Nginx是直接儲存在/etc/nginx/conf.d底下就好。

Nginx 1.24(含)以前

# vaadin可以換成別的名字
sudo nano /etc/nginx/conf.d/vaadin.conf

# 適用於Nginx 1.24(含)以前，1.24是目前的最新stable版本
server {
    listen 80;
    # 沒有IPv6的話可以註解掉
    listen [::]:80;
    # 需要有域名，可至eu.org申請免費域名，不過會需要等蠻久的(可能需要幾個月)
    # GitHub學生包好像有附贈一年的免費域名
    server_name example.com;

    # Uncomment to redirect HTTP to HTTPS
    return 301 https://$host$request_uri;
}

server {
  listen 443 ssl http2;	
  # 沒有IPv6的話可以註解掉 
  listen [::]:443 ssl http2;
                                                                                
  server_name example.com;
                                                                                
  # Allow large attachments
  client_max_body_size 128M;
  
  # 要申請TLS(SSL)憑證，可使用acme.sh取得                                                                              
  ssl_certificate /path/to/cert.pem; 
  ssl_certificate_key /path/to/key.pem;       
   
  # 跟安全相關的標頭(http header)                                                                                                                                                           
  add_header X-Frame-Options "SAMEORIGIN" always; 
  add_header X-XSS-Protection "1; mode=block" always; 
  add_header X-Content-Type-Options "nosniff" always; 
  add_header Referrer-Policy "no-referrer-when-downgrade" always;
                                                                                
  location / {
    
    # Sprong Boot所使用的port                                                                          
    proxy_pass http://127.0.0.1:8080;
    # 讓Sprong Boot取得真實訪客的IP，而不是反向代理的IP
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;

  }                                                           
}

Nginx 1.25及以後版本

# vaadin可以換成別的名字
sudo nano /etc/nginx/conf.d/vaadin.conf

# 適用於Nginx 1.25及以後版本，跟其他版本差在對quic的支援，以及http2的語法有些不同
# 如果要使用Nginx 1.25.x，請新增Nginx提供的軟體庫，並選擇mainline而不是stable
server {
    listen 80;
    # 沒有IPv6的話可以註解掉
    listen [::]:80;
    # 需要有域名，可至eu.org申請免費域名，不過會需要等蠻久的(可能需要幾個月)
    # GitHub學生包好像有附贈一年的免費域名
    server_name example.com;

    # Uncomment to redirect HTTP to HTTPS
    return 301 https://$host$request_uri;
}

server {
  listen 443 quic reuseport; 
  listen 443 ssl;
  # 沒有IPv6的話可以註解掉
  listen [::]:443 quic reuseport;	
  # 沒有IPv6的話可以註解掉 
  listen [::]:443 ssl;
  
  http2 on;
                                                                                
  server_name example.com;
                                                                                
  # Allow large attachments
  client_max_body_size 128M;
  
  # 要申請TLS(SSL)憑證，可使用acme.sh取得                                                                              
  ssl_certificate /path/to/cert.pem; 
  ssl_certificate_key /path/to/key.pem;       
   
  # 跟安全相關的標頭(http header)                                                                                                                                                           
  add_header X-Frame-Options "SAMEORIGIN" always; 
  add_header X-XSS-Protection "1; mode=block" always; 
  add_header X-Content-Type-Options "nosniff" always; 
  add_header Referrer-Policy "no-referrer-when-downgrade" always;
                                                                                
  location / {

    # advertise that QUIC is available on the configured port 
    add_header Alt-Svc 'h3=":$server_port"; ma=86400'; 
       
    # signal whether we are using QUIC+HTTP/3
    add_header X-protocol $server_protocol always;  
    
    # Sprong Boot所使用的port                                                                          
    proxy_pass http://127.0.0.1:8080;
    # 讓Sprong Boot取得真實訪客的IP，而不是反向代理的IP
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;

  }                                                           
}

如果你已經設定好Nginx或其他反向代理(如: Caddy Web Server)，那就不要開放Sprong Boot所使用的port讓外部連線連入，同時你應該開放80/tcp、443/tcp、443/udp(只有支援quic才需要)。

反向代理的其中一個好處是一臺Server(單一IP)，可以同時提供多個服務，譬如現在有兩個Spring Boot的程式要跑，那只要我把兩個Spring Boot程式使用的port設定成不同的，且不會跟反向代理使用的80、443相同，就不會發生port conflict，外部連線由反向代理使用port 80、443提供服務(如: https)，反向代理再將流量分別轉發到對應的Spring Boot程式即可。

使用Systemd將程式包成服務

如果你在終端機執行Java指令，程式可以執行，但此時你關閉終端機的話，程式就會終止，為了避免因為我們跟Server的SSH連線中斷造成程式終止，我們必須使用Systemd將程式包成服務。

// vaadin可以根據需求替換
sudo nano /etc/systemd/system/vaadin.service

[Unit]
Description=Vaadin service
After=syslog.target network.target

[Service]
Type=simple
# 改成你Linux的使用者名稱
User=test
Restart=always
# 設定環境變數，與之前教學相同，請依需求修改
Environment="Vaadin_DB_URL=jdbc:mariadb://localhost:3306/example"
Environment="Vaadin_DB_USER=example"
Environment="Vaadin_DB_PASSWORD=example"
# 程式所在的資料夾
WorkingDirectory=/home/test/example
ExecStart=/usr/bin/java -jar crud-with-vaadin-initial-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod

[Install]
WantedBy=multi-user.target

# 啟動服務，這裡的vaadin是從vaadin.service來的
sudo systemctl start vaadin
# 查看服務執行的狀態
sudo systemctl status vaadin
# 停止服務
sudo systemctl stop vaadin
# 開機自動啟動服務
sudo systemctl enable vaadin

如果你在執行systemctl相關指令時遇到下面的錯誤，請執行下面的指令，接著再重新執行原先想執行的指令

sudo systemctl daemon-reload

如果成功的話，你可以透過sudo systemctl status vaadin查看執行狀態，如下圖

vaadin服務正在執行

你可以將Server重新啟動來確認服務會自動啟動。

結論

如果要在生產環境中部署專案相比開發環境中的測試是需要很多額外的設定，像是本篇教學中沒有詳細提到域名、反向代理、開啟TLS(SSL)、支援IPv6、增加http header來提升安全性、啟用CDN......等等，筆者建議讀者如果有興趣的話可以自行搜尋相關資料，這些內容以目前課程專案來說可能不是那麼必要，不過這並不代表它們不重要，舉例來說，開啟TLS(SSL)可以確保server跟client之間的流量經過加密，提升系統安全性，啟用CDN可以降低client載入網頁的延遲，反向代理可以避免port conflict，讓單IP的機器可以跑不同Web服務，之後的教學會介紹現在很流行的虛擬化技術-Docker，Docker的部署筆者覺得會比上面介紹的方式還簡單，像是可以不用額外安裝資料庫。