配置中心说明
config-server 为所有后端服务统一提供运行配置。常规部署使用本地文件模式,默认从 API 源码同级的 config 目录读取配置。
一、下载配置
在 API 源码同级目录下载配置项目:
cd /opt/source
git clone https://gitee.com/bbc-se/config.git
推荐目录结构:
/opt/source
├── <API源码目录>
│ └── start.sh
└── config
├── application.yml
├── application-dev.yml
└── application-prod.yml
如果配置目录不在源码同级位置,启动时通过 --config-dir 指定:
bash start.sh --config-dir /data/shoptnt/config
二、配置文件说明
| 文件 | 作用 |
|---|---|
application.yml | 公共配置及默认环境,开发和生产环境都会读取 |
application-dev.yml | 开发环境配置 |
application-prod.yml | 生产环境配置 |
默认使用 dev 环境。部署生产环境时,先将 application.yml 中的激活环境改为 prod:
spring:
profiles:
active: prod
启动时同时指定 prod,两处环境名称应保持一致:
bash start.sh --profile prod
三、需要修改的配置
部署前,根据实际环境修改 application-dev.yml 或 application-prod.yml。使用 Docker Compose 部署基础设施时,可以使用 shoptnt-mysql、shoptnt-redis 等容器名称;使用源码或外部中间件部署时,应改为实际 IP 或域名。
1. SBA 监控配置
用于将后端服务注册到 sba-server,并配置监控后台的登录账号:
spring:
boot:
admin:
client:
enabled: true
url: http://SBA服务器地址:7006
username: admin
password: 请替换密码
instance:
service-host-type: ip
prefer-ip: true
security:
user:
name: admin
password: 请替换密码
url 应填写 API 服务能够访问的 SBA 地址,客户端和服务端账号密码应保持一致。
2. MySQL 配置
spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://MySQL地址:3306/shoptnt?useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false
username: 数据库用户名
password: 数据库密码
重点检查 MySQL 地址、端口、数据库名称和账号密码。部署前需要确保业务数据库已经完成初始化。
3. Redis 配置
spring:
data:
redis:
host: Redis地址
port: 6379
password: Redis密码
database: 1
timeout: 20000
connect-timeout: 10000
没有设置 Redis 密码时,password 留空。多个项目共用 Redis 时,应合理分配 database,避免缓存数据冲突。
4. RabbitMQ 配置
spring:
rabbitmq:
host: RabbitMQ地址
port: 5672
username: RabbitMQ用户名
password: RabbitMQ密码
virtual-host: /
生产环境不建议继续使用默认的 guest/guest,应创建独立账号并授予对应虚拟主机权限。
5. Elasticsearch 配置
elastic-jest:
index-name: shoptnt
index:
number-of-replicas: 0
number-of-shards: 5
ssl: off
cluster-ips: Elasticsearch地址
cluster-rest-port: 9200
username:
password:
单节点 Elasticsearch 的副本数建议设置为 0;集群部署时按节点数量调整。多个节点地址使用英文逗号分隔,开启认证后填写用户名和密码。
6. 日志配置
logging:
level:
org.springframework: ERROR
io.seata: ERROR
com.enation.app: INFO
开发环境可将 com.enation.app 设置为 DEBUG;生产环境建议使用 INFO 或 ERROR,避免产生过多日志。
7. ShopTNT 系统配置
javashop:
product: stand
runmode: cluster
debugger: off
token-secret: 请替换为高强度随机值
isDemoSite: no
ssl: on
domain:
buyer: pc.example.com
mobileBuyer: m.example.com
callback: https://api.example.com
referer:
- 'servicewechat.com'
- 'unitradeprod.alipay.com'
- '*.weixin.qq.com'
- '*.example.com'
主要配置说明:
| 配置项 | 说明 |
|---|---|
product | 集群产品使用 stand,微服务产品使用 microservice |
runmode | 集群模式使用 cluster |
debugger | 生产环境设置为 off |
token-secret | Token 加密密钥,生产环境必须替换 |
ssl | 站点启用 HTTPS 时设置为 on |
domain | 买家端、移动端及 API 回调地址 |
referer | 允许访问 API 的来源域名 |
生产配置检查
当前配置项目的 application-prod.yml 中系统配置顶层名称为 shoptnt:,但 BBC 8.0 程序读取的是 javashop.*。使用生产环境前,请将该配置块改为 javashop:,否则域名、Token 密钥等系统配置不会生效。
8. XXL-Job 配置
xxl:
job:
admin:
addresses: http://XXL-JOB地址:8080/xxl-job-admin
executor:
appname: timing-job-execute
port: 6999
logpath: /opt/xxl-serverlogs
logretentiondays: -1
accessToken:
addresses 填写调度中心地址。启用访问令牌时,accessToken 必须与 XXL-Job 服务端保持一致。
9. Actuator 配置
management:
endpoints:
web:
exposure:
include: '*'
endpoint:
health:
show-details: ALWAYS
该配置用于 SBA 采集服务状态。生产环境不应将 Actuator 管理端点直接暴露到公网。
四、Seata 配置
Seata 公共配置位于 application.yml:
seata:
enabled: true
service:
grouplist:
default: shoptnt-seata-server:8091
Docker Compose 部署时可以使用默认容器名称。Seata 部署在其他服务器时,将 default 修改为实际的 IP:端口;不使用分布式事务时,可将 seata.enabled 设置为 false。
五、启动与验证
配置完成后,在 API 源码根目录启动服务:
bash start.sh install
验证开发环境配置:
curl http://127.0.0.1:8888/application/dev/master
验证生产环境配置:
curl http://127.0.0.1:8888/application/prod/master
能够返回 YAML 配置内容,说明配置中心读取正常。修改配置后,需要重启配置中心和全部 API 服务,使新配置生效:
bash start.sh restart
如启动失败,可查看配置中心日志:
bash start.sh logs config-server