在使用 spring boot 开发应用时,我们通常需要根据不同的环境(开发、测试、生产)或特定需求调整启动参数,例如:
- 修改默认端口
- 指定不同的配置文件
- 控制 jvm 内存大小
- 传递自定义参数
那么,spring boot 提供了哪些方式来配置这些启动参数?今天我们就来详细解析 spring boot 启动参数的各种用法,并附带代码示例,让你可以灵活掌控应用的启动过程。
一、启动参数的常见传递方式
spring boot 允许我们通过以下几种方式传递启动参数:
| 方式 | 适用场景 | 示例 |
|---|---|---|
| 命令行参数 | 适用于临时修改配置 | java -jar app.jar --server.port=8081 |
| application.properties/yml | 适用于项目默认配置 | server.port=8081 |
| 环境变量 | 适用于 docker/k8s 部署 | export server_port=8081 |
| jvm 启动参数 | 适用于调整 jvm 运行时行为 | -xmx512m -dspring.profiles.active=prod |
| system.getproperty() 读取 | 适用于自定义动态参数 | system.getproperty("custom.param") |
接下来,我们逐个解析这些方式的用法和示例代码。
二、通过命令行参数传递启动参数
最简单的方式是在启动 jar 文件时,使用 --参数名=值 的格式来传递参数。
示例:修改 spring boot 端口
java -jar myapp.jar --server.port=8081
效果:应用启动后,监听的端口会变为 8081。
如果想传递多个参数,可以这样写:
java -jar myapp.jar --server.port=8081 --spring.application.name=myapp
注意:命令行参数的优先级比 application.properties 更高,即使 application.properties 里定义了 server.port=8080,命令行传递的 8081 仍然会覆盖它。
三、使用 application.properties 或 application.yml 配置参数
spring boot 提供了 application.properties(或 application.yml)来管理应用配置,这种方式适用于默认参数配置。
示例:application.properties
server.port=8082 spring.application.name=myapp logging.level.root=info
示例:application.yml
server:
port: 8082
spring:
application:
name: myapp
logging:
level:
root: info
优点:
- 适用于长期配置,不用每次启动都传递参数。
- 配置清晰,可集中管理多个环境的参数。
缺点:
- 配置是静态的,运行时修改需要重启应用。
- 无法动态传递参数。
四、使用环境变量传递参数
在 docker 或 kubernetes(k8s)等容器环境中,通常使用环境变量传递参数。spring boot 默认支持从环境变量读取参数。
示例:设置环境变量并启动应用
export server_port=9090 export spring_application_name=myspringapp java -jar myapp.jar
或者在 windows cmd 中:
set server_port=9090 java -jar myapp.jar
效果:spring boot 会自动读取 server_port 并将其作为 server.port 的值,即应用会运行在 9090 端口。
五、使用 jvm 启动参数传递参数
如果我们希望在 jvm 层面传递参数,可以使用 -d 选项。
示例:指定运行环境
java -dspring.profiles.active=prod -jar myapp.jar
在代码中可以这样获取:
string profile = system.getproperty("spring.profiles.active");
system.out.println("当前环境:" + profile);
示例:限制 jvm 内存
java -xmx512m -xms256m -jar myapp.jar
- -xmx512m:最大内存 512mb
- -xms256m:初始内存 256mb
应用场景:
- 适用于不同环境(开发、测试、生产)的参数切换。
- 适用于 jvm 级别的优化(如 gc、线程管理等)。
六、spring boot 读取启动参数的代码示例
在 spring boot 应用中,我们可以通过 @value、environment 或 system.getproperty() 读取启动参数。
1. 通过 @value 读取参数
import org.springframework.beans.factory.annotation.value;
import org.springframework.web.bind.annotation.getmapping;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.restcontroller;
@restcontroller
@requestmapping("/config")
public class configcontroller {
@value("${server.port}")
private string serverport;
@value("${spring.application.name}")
private string appname;
@getmapping("/info")
public string getconfiginfo() {
return "app: " + appname + ", running on port: " + serverport;
}
}
2. 通过 environment 读取参数
import org.springframework.core.env.environment;
import org.springframework.web.bind.annotation.getmapping;
import org.springframework.web.bind.annotation.restcontroller;
@restcontroller
public class envcontroller {
private final environment env;
public envcontroller(environment env) {
this.env = env;
}
@getmapping("/env")
public string getenvinfo() {
return "profile: " + env.getproperty("spring.profiles.active") +
", server port: " + env.getproperty("server.port");
}
}
3. 通过 system.getproperty() 读取 jvm 级别参数
@getmapping("/jvm")
public string getjvmparams() {
return "jvm param: " + system.getproperty("custom.param", "默认值");
}
如果我们用以下方式启动应用:
java -dcustom.param=myvalue -jar myapp.jar
那么 /jvm 接口会返回:
jvm param: myvalue
七、总结:如何选择合适的启动参数方式
| 方式 | 适用场景 | 是否可动态修改 | 优先级 |
|---|---|---|---|
| 命令行参数 | 适用于临时配置,如测试 | ✅ | 🟢 最高 |
| application.properties | 适用于默认配置 | ❌ | 🔵 低 |
| 环境变量 | 适用于容器化部署 | ✅ | 🟢 高 |
| jvm 参数 | 适用于调整 jvm 行为 | ❌ | 🟢 高 |
最佳实践
1.开发环境:使用 application.properties 作为默认配置。
2.测试环境:使用命令行参数或环境变量传递测试配置。
3.生产环境:使用 -dspring.profiles.active=prod + 环境变量,实现动态配置管理。
掌握 spring boot 启动参数,你的应用将更加灵活高效!
到此这篇关于一文带你了解springboot中启动参数的各种用法的文章就介绍到这了,更多相关springboot启动参数内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论