Spring Boot多环境打包实战：从Maven配置到Makefile自动化

在软件开发过程中，我们通常需要面对多个运行环境，如开发环境(dev)、测试环境(test)和生产环境(prod)。这些环境在数据库连接、第三方服务配置、日志级别等方面往往存在差异。手动管理这些配置不仅效率低下，而且容易出错，特别是在团队协作和持续集成/持续部署(CI/CD)的场景下。

常见的问题包括：

不同环境的配置信息混在一起，容易导致配置错误
每次部署都需要手动修改配置文件，增加出错风险
缺乏标准化的构建流程，导致团队成员操作不一致
无法快速切换环境，影响开发和测试效率

因此，我们需要一种可靠的方式来管理多环境配置，并实现自动化的打包流程。

解决方案

本文将介绍如何结合Spring Boot、Maven和Makefile实现一套完整的多环境打包方案，主要包括以下几个方面：

使用Maven Profile管理不同环境的构建配置
利用Spring Boot的配置分离机制管理环境相关的参数
编写Makefile脚本实现一键式打包和部署

1. Maven多环境配置

首先，在Maven的pom.xml中定义多个环境的Profile：

<profiles>
    <!-- 开发环境 -->
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <env>dev</env>
        </properties>
    </profile>
    
    <!-- 测试环境 -->
    <profile>
        <id>test</id>
        <properties>
            <env>test</env>
        </properties>
    </profile>
    
    <!-- 生产环境 -->
    <profile>
        <id>prod</id>
        <properties>
            <env>prod</env>
        </properties>
    </profile>
</profiles>

然后，配置资源过滤，确保Maven能够正确替换配置文件中的占位符：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
                <include>application.yml</include>
                <include>application-${env}.yml</include>
            </includes>
        </resource>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>false</filtering>
            <excludes>
                <exclude>application.yml</exclude>
                <exclude>application-${env}.yml</exclude>
            </excludes>
        </resource>
    </resources>
    
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

2. Spring Boot配置分离

在Spring Boot项目中，我们可以创建多个配置文件，每个环境对应一个：

application.yml - 公共配置
application-dev.yml - 开发环境配置
application-test.yml - 测试环境配置
application-prod.yml - 生产环境配置

主配置文件application.yml内容示例：

spring:
  application:
    name: my-application
  profiles:
    active: @env@  # 这里会被Maven替换为对应的env值

server:
  port: 8080

# 公共配置
logging:
  level:
    root: INFO

环境特定配置文件示例，如application-dev.yml：

# 开发环境配置
server:
  port: 8080

datasource:
  url: jdbc:mysql://localhost:3306/dev_db
  username: dev_user
  password: dev_pass

logging:
  level:
    com.example: DEBUG

类似地，可以创建application-test.yml和application-prod.yml，分别配置测试环境和生产环境的特定参数。

3. Makefile自动化脚本

下面是一个完整的Makefile脚本，用于自动化打包过程：

# Makefile for Spring Boot Application

# 项目配置
PROJECT_NAME = my-application
VERSION = 1.0.0
MAIN_CLASS = com.example.Application

# Maven配置
MAVEN_OPTS = -Dmaven.test.skip=true
MAVEN_CMD = mvn

# 默认目标
.PHONY: help
help:
    @echo "可用命令:"
    @echo "  make build-dev   - 构建开发环境"
    @echo "  make build-test  - 构建测试环境"
    @echo "  make build-prod  - 构建生产环境"
    @echo "  make clean       - 清理项目"
    @echo "  make run-dev     - 运行开发环境"
    @echo "  make run-test    - 运行测试环境"
    @echo "  make run-prod    - 运行生产环境"

# 清理项目
.PHONY: clean
clean:
    $(MAVEN_CMD) clean

# 构建开发环境
.PHONY: build-dev
build-dev:
    $(MAVEN_CMD) clean package -Pdev $(MAVEN_OPTS)
    @echo "开发环境构建完成"

# 构建测试环境
.PHONY: build-test
build-test:
    $(MAVEN_CMD) clean package -Ptest $(MAVEN_OPTS)
    @echo "测试环境构建完成"

# 构建生产环境
.PHONY: build-prod
build-prod:
    $(MAVEN_CMD) clean package -Pprod $(MAVEN_OPTS)
    @echo "生产环境构建完成"

# 运行开发环境
.PHONY: run-dev
run-dev: build-dev
    java -jar target/$(PROJECT_NAME)-$(VERSION).jar --spring.profiles.active=dev

# 运行测试环境
.PHONY: run-test
run-test: build-test
    java -jar target/$(PROJECT_NAME)-$(VERSION).jar --spring.profiles.active=test

# 运行生产环境
.PHONY: run-prod
run-prod: build-prod
    java -jar target/$(PROJECT_NAME)-$(VERSION).jar --spring.profiles.active=prod

# Docker构建 (可选)
.PHONY: docker-build-dev
docker-build-dev: build-dev
    docker build -t $(PROJECT_NAME):dev --build-arg JAR_FILE=target/$(PROJECT_NAME)-$(VERSION).jar .

.PHONY: docker-build-test
docker-build-test: build-test
    docker build -t $(PROJECT_NAME):test --build-arg JAR_FILE=target/$(PROJECT_NAME)-$(VERSION).jar .

.PHONY: docker-build-prod
docker-build-prod: build-prod
    docker build -t $(PROJECT_NAME):prod --build-arg JAR_FILE=target/$(PROJECT_NAME)-$(VERSION).jar .

难点讲解

1. Maven资源过滤机制

Maven的资源过滤是一个关键功能，它允许我们在构建过程中动态替换配置文件中的占位符。在上述配置中，我们使用了@env@作为占位符，Maven会将其替换为当前激活Profile中定义的env属性值。

注意事项：

确保在pom.xml中正确配置了资源过滤
占位符的默认格式是${property.name}，但为了避免与Spring的占位符冲突，我们使用了@property.name@格式
如果需要自定义占位符格式，可以通过Maven的maven-resources-plugin配置

2. 环境变量的传递

在某些情况下，我们可能需要从环境变量中获取敏感信息（如数据库密码），而不是直接写在配置文件中。Spring Boot支持这种做法：

datasource:
  url: ${DB_URL:jdbc:mysql://localhost:3306/default_db}
  username: ${DB_USERNAME:default_user}
  password: ${DB_PASSWORD:default_pass}

在Makefile中，我们可以这样传递环境变量：

.PHONY: build-prod
build-prod:
    DB_URL=${PROD_DB_URL} \
    DB_USERNAME=${PROD_DB_USERNAME} \
    DB_PASSWORD=${PROD_DB_PASSWORD} \
    $(MAVEN_CMD) clean package -Pprod $(MAVEN_OPTS)

3. Makefile中的条件判断和循环逻辑

Makefile本身不支持复杂的条件判断和循环逻辑，但我们可以通过一些技巧实现类似功能。例如，如果我们想要一个通用的构建目标，可以根据参数构建不同环境：

# 定义环境列表
ENVS = dev test prod

# 通用构建目标
.PHONY: build
build:
    @if [ -z "$(ENV)" ]; then \
        echo "请指定环境，例如: make build ENV=dev"; \
        exit 1; \
    fi
    @if ! echo $(ENVS) | grep -q -w "$(ENV)"; then \
        echo "无效的环境: $(ENV). 有效环境为: $(ENVS)"; \
        exit 1; \
    fi
    $(MAVEN_CMD) clean package -P$(ENV) $(MAVEN_OPTS)
    @echo "$(ENV)环境构建完成"

# 通用运行目标
.PHONY: run
run: build
    java -jar target/$(PROJECT_NAME)-$(VERSION).jar --spring.profiles.active=$(ENV)

使用方式：