如何通过.ebextensions配置AWS Elastic Beanstalk中Tomcat 9的WAR启动参数

需求说明 #

需要为部署在Tomcat 9解决方案栈的War包添加数据库相关的JVM启动参数（-Ddatasource.dialect、-Ddatasource.url等），效果等同于执行以下命令：

java -Ddatasource.dialect=$DB_DIALECT \
     -Ddatasource.url=$DB_URL \
     -Ddatasource.username=$DB_USERNAME \
     -Ddatasource.password=$DB_PASSWORD \
     -jar application.war

实现方法 #

方法1：通过EB环境配置直接设置JVM参数 #

1. 在项目根目录创建.ebextensions文件夹。
2. 在该文件夹下新建配置文件（比如01-jvm-options.config），写入以下内容：

option_settings:
  # 定义基础环境变量（敏感信息建议后续在EB控制台修改）
  - namespace: aws:elasticbeanstalk:application:environment
    option_name: DB_DIALECT
    value: org.hibernate.dialect.MySQL8Dialect # 替换为你的数据库方言
  - namespace: aws:elasticbeanstalk:application:environment
    option_name: DB_URL
    value: jdbc:mysql://your-db-endpoint:3306/your-db-name # 替换为你的数据库URL
  - namespace: aws:elasticbeanstalk:application:environment
    option_name: DB_USERNAME
    value: your-db-username # 替换为你的数据库用户名
  - namespace: aws:elasticbeanstalk:application:environment
    option_name: DB_PASSWORD
    value: your-db-password # 建议后续在EB控制台修改，避免明文存储

  # 将环境变量映射为Tomcat的JVM启动参数
  - namespace: aws:elasticbeanstalk:container:tomcat:jvmoptions
    option_name: JVM Options
    value: >-
      -Ddatasource.dialect=$DB_DIALECT
      -Ddatasource.url=$DB_URL
      -Ddatasource.username=$DB_USERNAME
      -Ddatasource.password=$DB_PASSWORD

方法2：通过生成Tomcat的setenv.sh脚本配置 #

Tomcat启动时会自动加载bin/setenv.sh中的环境变量，可通过EB扩展配置生成该文件：

1. 在.ebextensions文件夹下新建02-setenv-config.config文件，内容如下：

files:
  "/usr/share/tomcat9/bin/setenv.sh":
    mode: "000755"
    owner: tomcat
    group: tomcat
    content: |
      # 从EB环境变量读取配置，添加到Tomcat启动参数
      export CATALINA_OPTS="$CATALINA_OPTS \
        -Ddatasource.dialect=$DB_DIALECT \
        -Ddatasource.url=$DB_URL \
        -Ddatasource.username=$DB_USERNAME \
        -Ddatasource.password=$DB_PASSWORD"

2. 登录EB控制台，进入配置 > 软件页面，添加DB_DIALECT、DB_URL、DB_USERNAME、DB_PASSWORD这几个环境变量并填写对应值（敏感信息在此设置更安全）。

注意事项 #

• 敏感信息（如数据库密码）不要直接写入配置文件，优先通过EB控制台的环境变量设置，避免代码库泄露。
• 配置文件建议以数字开头命名（如01-xxx.config），确保EB按顺序加载配置。
• 部署时需将.ebextensions文件夹与War包一同打包上传到Elastic Beanstalk。

内容的提问来源于stack exchange，提问作者KiborgSDonbassa