Spring Boot 2.0(五):Docker Compose + Spring Boot + Nginx + Mysql 實踐

ityouknow發表於2019-03-02

我知道大家這段時間看了我寫關於 docker 相關的幾篇文章,不疼不癢的,仍然沒有感受 docker 的便利,是的,我也是這樣認為的,I know your felling 。

前期瞭解概念什麼的確實比較無聊,請不要著急精彩馬上開始,當大家對 docker 相關概念有所瞭解之後,後面我會結合 Spring Boot 給大家來一系列的小例子,會讓大家感受到使用 Docker 就是這麼爽!

今天給大家演出的導演是 Docker 家族的 docker-compare ,主演是 Spring Boot、Nginx、Mysql 三位又紅又紫的大碗,名導名演在一起的時候往往是準備搞事情,接下來又一場經典大片值得大家期待。

Spring Boot 2.0(五):Docker Compose + Spring Boot + Nginx + Mysql 實踐

Spring Boot + Nginx + Mysql 是實際工作中最常用的一個組合,最前端使用 Nginx 代理請求轉發到後端 Spring Boot 內嵌的 Tomcat 服務,Mysql 負責業務中資料相關的互動,那麼在沒有 docker 之前,我們是如何來搞定這些環境的呢?

  • 1、安裝 Nginx,配置 Nginx 相關資訊,重啟。
  • 2、安裝 Mysql ,配置字符集時區等資訊,重啟,最後初始化指令碼。
  • 3、啟動 Spring Boot 專案,整體進行聯調測試。

大家看我只寫了三行,但其實搭建這些環境的時候還挺費事的,但這還不是結局,在用了一段時間時候需要遷移到另外一個環境,怎麼辦又需要重新搞一次?正常情況下,測試環境、SIT 環境、UAT 環境、生產環境!我們需要重複搭建四次。有人說不就是搭建四次嗎?也沒什麼大不了的,那麼我想告訴你,Too yong ,Too Simple 。

Spring Boot 2.0(五):Docker Compose + Spring Boot + Nginx + Mysql 實踐

讓我們看看以下幾個因素:

第一,這只是一個最簡單的案例,如果專案涉及到 MongoDB、Redis、ES ... 一些列的環境呢? 第二,如果你經常搭建環境或者除錯程式,你就會知道什麼是環境問題?有的時候明明是一模一樣的配置,但是到了另外一個環境就是跑不起來。於是你花費很多時間來查詢,最後才發現是少了一個引數或者逗號的問題,或者是系統核心版本不一致、或者你最後也沒搞懂是為什麼!只能再換另外一臺伺服器,那麼使用 Docker 呢就可以完美的避開這些坑。

好了,廢話不多說我們就開始吧!

Spring Boot 案例

首先我們先準備一個 Spring Boot 使用 Mysql 的小場景,我們做這樣一個示例,使用 Spring Boot 做一個 Web 應用,提供一個按照 IP 地址統計訪問次數的方法,每次請求時將統計資料存入 Mysql 並展示到頁面中。

配置資訊

依賴包

<dependencies>
     <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-data-jpa</artifactId>
	</dependency>
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-test</artifactId>
		<scope>test</scope>
	</dependency>
</dependencies>
複製程式碼

主要新增了 Spring Boot Web 支援,使用 Jpa 運算元據庫、新增 Myql 驅動包等。

配置檔案

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.jpa.properties.hibernate.hbm2ddl.auto=update
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
spring.jpa.show-sql=true
複製程式碼

配置了資料庫的連結資訊,以及 Jpa 更新表模式、方言和是否顯示Sql

核心程式碼

核心程式碼很簡單,每過來一個請求,判斷是否已經統計過,如果沒有統計新增資料,如果有統計資料更新資料。

@RestController
public class VisitorController {

    @Autowired
    private VisitorRepository repository;
	
    @RequestMapping("/")
    public String index(HttpServletRequest request) {
        String ip=request.getRemoteAddr();
        Visitor visitor=repository.findByIp(ip);
        if(visitor==null){
            visitor=new Visitor();
            visitor.setIp(ip);
            visitor.setTimes(1);
        }else {
            visitor.setTimes(visitor.getTimes()+1);
        }
        repository.save(visitor);
        return "I have been seen ip "+visitor.getIp()+" "+visitor.getTimes()+" times.";
    }
}
複製程式碼

實體類和 Repository 層程式碼比較簡單,這裡就不貼出來了,大家感興趣可以下載原始碼檢視。

以上內容都完成後,啟動專案,訪問:http://localhost:8080/ 我們就可以看到這樣的返回結果:

I have been seen ip 0:0:0:0:0:0:0:1 1 times.
複製程式碼

再訪問一次會變成

I have been seen ip 0:0:0:0:0:0:0:1 2 times.
複製程式碼

多次訪問一直疊加,說明演示專案開發完成。

Docker 化改造

首先我們將目錄改造成這樣一個結構

Spring Boot 2.0(五):Docker Compose + Spring Boot + Nginx + Mysql 實踐

我們先從最外層說起:

  • docker-compose.yaml:docker-compose 的核心檔案,描述如何構建整個服務
  • nginx:有關 nginx 的配置
  • app:Spring Boot 專案地址

如果我們需要對 Mysql 有特殊的定製,也可以在最外層建立 mysql 資料夾,在此目錄下進行配置。

docker-compose.yaml 檔案詳解

version: '3'
services:
  nginx:
   container_name: v-nginx
   image: nginx:1.13
   restart: always
   ports:
   - 80:80
   - 443:443
   volumes:
   - ./nginx/conf.d:/etc/nginx/conf.d
    
  mysql:
   container_name: v-mysql
   image: mysql/mysql-server:5.7
   environment:
    MYSQL_DATABASE: test
    MYSQL_ROOT_PASSWORD: root
    MYSQL_ROOT_HOST: '%'
   ports:
   - "3306:3306"
   restart: always
    
  app:
    restart: always
    build: ./app
    working_dir: /app
    volumes:
      - ./app:/app
      - ~/.m2:/root/.m2
    expose:
      - "8080"
    depends_on:
      - nginx
      - mysql
    command: mvn clean spring-boot:run -Dspring-boot.run.profiles=docker
複製程式碼
  • version: '3': 表示使用第三代語法來構建 docker-compose.yaml 檔案。
  • services: 用來表示 compose 需要啟動的服務,我們可以看出此檔案中有三個服務分別為:nginx、mysql、app。
  • container_name: 容器名稱
  • environment: 此節點下的資訊會當作環境變數傳入容器,此示例中 mysql 服務配置了資料庫、密碼和許可權資訊。
  • ports: 表示對外開放的埠
  • restart: always 表示如果服務啟動不成功會一直嘗試。
  • volumes: 載入本地目錄下的配置檔案到容器目標地址下
  • depends_on:可以配置依賴服務,表示需要先啟動 depends_on 下面的服務後,再啟動本服務。
  • command: mvn clean spring-boot:run -Dspring-boot.run.profiles=docker: 表示以這個命令來啟動專案,-Dspring-boot.run.profiles=docker表示使用 application-docker.properties檔案配置資訊進行啟動。

Nginx 檔案解讀

nginx 在目錄下有一個檔案 app.conf,主要配置了服務轉發資訊

server {
    listen 80;
    charset utf-8;
    access_log off;

    location / {
        proxy_pass http://app:8080;
        proxy_set_header Host $host:$server_port;
        proxy_set_header X-Forwarded-Host $server_name;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }

    location /static {
        access_log   off;
        expires      30d;

        alias /app/static;
    }
}
複製程式碼

這塊內容比較簡單,配置請求轉發,將80埠的請求轉發到服務 app 的8080埠。其中proxy_pass http://app:8080這塊的配置資訊需要解釋一下,這裡使用是app而不是localhost,是因為他們沒有在一個容器中,在一組 compose 的服務通訊需要使用 services 的名稱進行訪問。

Spring Boot 專案改造

app目錄下也就是和pom.xm檔案同級新增Dockerfile檔案,檔案內容如下:

FROM maven:3.5-jdk-8
複製程式碼

只有一句,依賴於基礎映象maven3.5jdk 1.8。因為在docker-compose.yaml檔案設定了專案啟動命令,這裡不需要再新增啟動命令。

在專案的resources目錄下建立application-dev.propertiesapplication-docker.properties檔案

  • application-dev.properties 中的配置資訊和上面一致
  • application-docker.properties 中的配置資訊做稍微的改造,將資料庫的連線資訊由jdbc:mysql://localhost:3306/test改為jdbc:mysql://mysql:3306/test

這樣我們所有的配置都已經完成。

部署

我們將專案拷貝到伺服器中進行測試,伺服器需要先安裝 Docker 和 Docker Compos 環境,如果不瞭解的朋友可以檢視我前面的兩篇文章:

將專案拷貝到伺服器中,進入目錄cd dockercompose-springboot-mysql-nginx

啟動服務:docker-compose up

[root@VM_73_217_centos dockercompose-springboot-mysql-nginx]# docker-compose up
Creating network "dockercomposespringbootmysqlnginx_default" with the default driver
Creating v-nginx ... done
Creating v-mysql ... done
Creating dockercomposespringbootmysqlnginx_app_1 ... done
Attaching to v-nginx, v-mysql, dockercomposespringbootmysqlnginx_app_1
v-mysql  | [Entrypoint] MySQL Docker Image 5.7.21-1.1.4
v-mysql  | [Entrypoint] Initializing database
app_1    | [INFO] Scanning for projects...
... 
app_1    | 2018-03-26 02:54:55.658  INFO 1 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
app_1    | 2018-03-26 02:54:55.660  INFO 1 --- [           main] com.neo.ComposeApplication               : Started ComposeApplication in 14.869 seconds (JVM running for 30.202)
複製程式碼

看到資訊Tomcat started on port(s): 8080表示服務啟動成功。也可以使用docker-compose up -d後臺啟動

訪問伺服器地址;http://58.87.69.230/,返回:I have been seen ip 172.19.0.2 1 times. 表示整體服務啟動成功

使用docker-compose ps檢視專案中目前的所有容器

[root@VM_73_217_centos dockercompose-springboot-mysql-nginx]# docker-compose ps
                 Name                                Command                  State                        Ports                  
----------------------------------------------------------------------------------------------------------------------------------
dockercomposespringbootmysqlnginx_app_1   /usr/local/bin/mvn-entrypo ...   Up             8080/tcp                                
v-mysql                                   /entrypoint.sh mysqld            Up (healthy)   0.0.0.0:3306->3306/tcp, 33060/tcp       
v-nginx                                   nginx -g daemon off;             Up             0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp
複製程式碼

可以看到專案中服務的狀態、命令、埠等資訊。

關閉服務docker-compose down

[root@VM_73_217_centos dockercompose-springboot-mysql-nginx]# docker-compose down
Stopping dockercomposespringbootmysqlnginx_app_1 ... done
Stopping visitor-nginx                           ... done
Stopping visitor-mysql                           ... done
Removing dockercomposespringbootmysqlnginx_app_1 ... done
Removing visitor-nginx                           ... done
Removing visitor-mysql                           ... done
複製程式碼

docker-compose 順序

在使用 docker-compose 啟動的時候經常會出現專案報 Mysql 連線異常,跟蹤了一天終於發現了問題。 docker-compose 雖然可以通過depends_on 來定義服務啟動的順序,但是無法確定服務是否啟動完成,因此會出現這樣一個現象,Mysql 服務啟動比較慢,當 Spring Boot 專案已經啟動起來,但是 Mysql 還沒有初始化好,這樣當專案連線 Mysql 資料庫的時候,就會出現連線資料庫的異常。

針對這樣的問題,有兩種解決方案:

1、足夠的容錯和重試機制,比如連線資料庫,在初次連線不上的時候,服務消費者可以不斷重試,直到連線上服務。也就是在服務中定義: restart: always

2、同步等待,使用wait-for-it.sh或者其他shell指令碼將當前服務啟動阻塞,直到被依賴的服務載入完畢。這種方案後期可以嘗試使用。

總結

沒有對比就沒有傷害,在沒有使用 Docker 之前,我們需要搭建這樣一個環境的話,需要安裝 Nginx、Mysql ,再進行一系列的配置除錯,還要擔心各種環境問題;使用 Docker 之後簡單兩個命令就完成服務的上線、下線。

docker-compose up
docker-compose down
複製程式碼

其實容器技術對部署運維的優化還有很多,這只是剛剛開始,後面使用了 Swarm 才會真正感受到它的便利和強大。

示例程式碼-github

示例程式碼-碼雲

參考

Docker Compose with Spring Boot, MySQL and NGINX

相關文章