這篇文章整理了 Spring Boot 和常見的應(yīng)用中間件配置含義,了解這些配置的目的和原理,避免因?yàn)殄e(cuò)誤配置導(dǎo)致生產(chǎn)出現(xiàn)問題,特別是有一些安全問題。
PS:寫下來發(fā)現(xiàn)東西非常多,很多時(shí)候我們都只是拷貝過來改改沒問題就不管了,但是這樣囫圇吞棗,會(huì)給項(xiàng)目帶來風(fēng)險(xiǎn)。
優(yōu)雅停機(jī)是指當(dāng)應(yīng)用接收到停機(jī)信號時(shí),能夠妥善地處理正在進(jìn)行的請求,釋放資源,并在完成這些工作后再停止應(yīng)用。
如果不開啟優(yōu)雅停機(jī),有可能在部署的過程中讓少量未完成的任務(wù)和請求直接終止,帶來意想不到的問題。
默認(rèn)情況下,Spring Boot 沒有啟用優(yōu)雅停機(jī),而且往往需要和云環(huán)境配合使用。
在 Spring Boot 中的配置方式為(本文以 yaml 的格式):
server: shutdown: graceful
同時(shí)可以設(shè)置一個(gè)優(yōu)雅停機(jī)的超時(shí)時(shí)間,如果在超時(shí)時(shí)間內(nèi)請求沒有完成,應(yīng)用將強(qiáng)制停機(jī)。
spring: lifecycle: timeout-per-shutdown-phase: 30s
Kubernetes 在停止 Pod 時(shí),會(huì)先發(fā)送一個(gè) SIGTERM
,并通過 Readiness Probe和Liveness Probe 兩個(gè)探針來決定是否釋放容器資源。
探針就是應(yīng)用通過一個(gè) API(可以是 HTTP 或者 TCP,通常都是 HTTP)告訴 Kubernetes 它當(dāng)前的狀態(tài),讓 Kubernetes 來決策何時(shí)重啟,關(guān)于優(yōu)雅停機(jī)的內(nèi)容比較多,后面單獨(dú)一篇文章討論。
在 Spring Boot 中,探針就是 Spring Boot 的 health 接口,可以通過 Indicator 配置。
Spring Boot 提供了一些健康狀態(tài)的 API,這樣就可以給云平臺優(yōu)雅停機(jī)使用,也可以提供給監(jiān)控系統(tǒng)用來撥測,如果系統(tǒng)長時(shí)間不健康,可以進(jìn)行告警。
在代碼中實(shí)現(xiàn)健康狀態(tài)的類叫做 Indicator,基本上默認(rèn)配置的 Indicator 就夠用了,但有時(shí)候需要根據(jù)自己需要配置一些 Indicator。
比如依賴了一個(gè)重要的三方系統(tǒng),這個(gè)三方系統(tǒng)不啟動(dòng)起來,當(dāng)前系統(tǒng)啟動(dòng)了也沒意義,于是就可以加一個(gè) Indicator,甚至把三方系統(tǒng)的狀態(tài)暴露到當(dāng)前系統(tǒng)的健康狀態(tài)信息中。
暴露相關(guān)健康 API 需要引入一個(gè) actuator 依賴:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId></dependency>
下面是一個(gè)例子:
import org.springframework.boot.actuate.health.Health;import org.springframework.boot.actuate.health.HealthIndicator;import org.springframework.stereotype.Component;@Componentpublic class CustomHealthIndicator implements HealthIndicator { @Override public Health health() { boolean isHealthy = checkSomeServiceHealth(); if (isHealthy) { return Health.up().withDetail("customService", "UP").build(); } else { return Health.down().withDetail("customService", "DOWN").build(); } } private boolean checkSomeServiceHealth() { // 檢查邏輯 return true; }}
訪問 /actuator/health 接口,返回結(jié)果大概像下面這樣:
{ "status": "UP", "components": { "db": { "status": "UP", "details": { "database": "MySQL", "validationQuery": "isValid()" } }, "customService": { "status": "UP", "details": { "CustomService": "UP" } }, …… }}
打開相關(guān)配置:
management: endpoints: web: exposure: include: health,info
在這個(gè)配置中,info 類似 health, 提供了一些服務(wù)信息,例如名稱、版本之類的,但是要注意避免把敏感信息從這個(gè)接口中暴露出去了。
提到了 Actuator,這里有一些配置是不能在生產(chǎn)環(huán)境開啟的,這是比較常見的錯(cuò)誤,需要注意。
Actuator 除了提供了 health,info 兩個(gè)接口,還提供了一堆接口,方便觀察 Spring Boot 應(yīng)用,這些接口都可以在開發(fā)環(huán)境開啟。例如:
這些接口開啟后會(huì)造成安全、性能問題。
所以推薦的配置如下。
開發(fā)環(huán)境:
management: endpoints: web: exposure: include: "*" endpoint: health: show-details: always # 顯示詳細(xì)健康信息,方便調(diào)試
endpoints 只是暴露外部是否可以訪問,實(shí)際的功能需要單獨(dú)開啟,health,info,metrics 三個(gè)接口是默認(rèn)開啟的。
如果需要打開 beans,可以單獨(dú)開啟:
management: logfile: enabled: true # 允許查看日志文件,方便調(diào)試 env: enabled: true # 允許查看環(huán)境變量配置 configprops: enabled: true # 允許查看配置屬性,幫助調(diào)試 beans: enabled: true # 允許查看 Bean 信息,調(diào)試依賴關(guān)系 heapdump: enabled: true # 啟用 Heap Dump,用于內(nèi)存分析 threaddump: enabled: true # 啟用線程轉(zhuǎn)儲(chǔ),用于線程分析 mappings: enabled: true # 允許查看所有請求映射,調(diào)試路由問題 httptrace: enabled: true # 啟用 HTTP 請求追蹤
而生產(chǎn)環(huán)境,需要將其關(guān)閉,只保留需要開啟的配置:
management: endpoints: web: exposure: include: "health,info,metrics" endpoint: health: show-details: never # 隱藏健康檢查的詳細(xì)信息,防止敏感數(shù)據(jù)泄露
日志配置錯(cuò)誤會(huì)導(dǎo)致磁盤被日志寫滿,另外日志級別過低,性能會(huì)急劇下降。
在以前還不是容器時(shí)代,我們常常使用日志文件存儲(chǔ)日志,再使用一些工具轉(zhuǎn)存走,有時(shí)候清理日志的腳本失效,導(dǎo)致磁盤被日志寫爆的場景非常多。
下面是一個(gè)在容器環(huán)境下 Spring Boot 默認(rèn)日志庫的配置:
logging: level: root: INFO org.springframework: WARN #這里放上特定包的日志配置 pattern: console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" file: enabled: false # 生產(chǎn)環(huán)境通常不直接寫入文件,而是由 K8s 日志收集系統(tǒng)處理 stdout: enabled: true
在生產(chǎn)上我們一般將日志級別設(shè)置為 INFO,并關(guān)閉文件輸出,而是將日志輸出到 stdout 中,由容器捕獲。
在開發(fā)環(huán)境,我們通常把日志設(shè)置為 DEBUG,更加方便調(diào)試。
正常情況下,大多數(shù)應(yīng)用都不會(huì)把口令存放到配置文件中,敏感信息需要放到秘鑰管理系統(tǒng)中(Key Management System)。
例如,在 k8s 中,我們可以使用 Secrets 代替明文的 ConfigMap;云平臺往往提供了相關(guān)的 KMS 產(chǎn)品,例如 Alicloud KMS。
這里給出一個(gè) Mysql 和 Mybatis 的典型配置,并解釋一下關(guān)鍵配置的含義和避坑經(jīng)驗(yàn)。
spring: datasource: url: jdbc:mysql://localhost:3306/mydatabase?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC&autoReconnect=true&rewriteBatchedStatements=true username: your_username password: your_password driver-class-name: com.mysql.cj.jdbc.Driver hikari: maximum-pool-size: 10 minimum-idle: 5 idle-timeout: 30000 max-lifetime: 1800000 connection-timeout: 30000mybatis: mapper-locations: classpath*:mapper/*.xml type-aliases-package: com.example.project.domain configuration: map-underscore-to-camel-case: true log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
連接字符串中的配置:
關(guān)于 driver-class-name,對于 MySQL Connector/J 8.0 以上,類名換成了 com.mysql.cj.jdbc.Driver,舊版本是 com.mysql.jdbc.Driver。
關(guān)于 hikari 配置的含義:
hikari 的配置只是建議值,hikari 配置邏輯是什么呢?一般是基于性能測試反復(fù)調(diào)整,但還是有一些規(guī)律。
這里有個(gè)坑,有時(shí)候?yàn)榱藘?yōu)化性能,提高了最大連接數(shù)。但一般數(shù)據(jù)庫的連接數(shù)是有限制的,比如 1000。假設(shè)一個(gè)系統(tǒng)共同一個(gè)Mysql實(shí)例,系統(tǒng)共有 10 個(gè)服務(wù),每個(gè)服務(wù)如果有 10 個(gè)容器,最大連接數(shù)最多就只能配置到 10 了,否則就會(huì)報(bào)沒有鏈接的錯(cuò)誤(而且是偶爾出現(xiàn)這類問題)。
maximumPoolSize 通常設(shè)置為數(shù)據(jù)庫的并發(fā)連接限制的 50% 到 80% 之間,單個(gè)容器允許 10 個(gè) Mysql 連接并不大,maximum-pool-size 可以在 10 - 50 之間調(diào)整。
connection-timeout 過短,在數(shù)據(jù)庫負(fù)載高或網(wǎng)絡(luò)不穩(wěn)定的情況下,可能導(dǎo)致頻繁的連接超時(shí),可以嘗試往長一點(diǎn)調(diào)整。
max-lifetime、minimum-idle 取決于負(fù)載情況,如果持續(xù)負(fù)載比較高,可以設(shè)置長一些,不用為數(shù)據(jù)庫節(jié)省資源,讓連接長時(shí)間保持。
關(guān)于 Mybatis 的 map-underscore-to-camel-case 配置有一個(gè)坑,這個(gè)配置的含義是把數(shù)據(jù)庫列名中的下劃線自動(dòng)映射為 Java 對象中的駝峰命名。例如,user_name 列將映射為 userName 屬性。但有的時(shí)候,命名不規(guī)范,有些詞可能是一個(gè)詞組而沒有大寫,會(huì)導(dǎo)致匹配失敗。
本文鏈接:http://www.tebozhan.com/showinfo-26-112788-0.html系統(tǒng)設(shè)計(jì) | Java 應(yīng)用中的配置含義和避坑
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識,若有侵權(quán)等問題請及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。郵件:2376512515@qq.com