如何配置Spring Shell中{userconfig}占位符指定日志路径

问题描述 #

根据文档说明，Spring Shell默认将日志文件生成在当前工作目录，可通过spring.shell.config.location指定路径，该属性支持{userconfig}占位符，解析为通用共享配置目录。我的application.properties配置如下：

spring.shell.config.location: "{userconfig}/mycli"
spring.shell.history.name: mycli.log

运行应用后，日志仍从应用启动位置生成。查看UserConfigAutoConfiguration类，预期日志会生成在System.getProperty("user.home") + "/" + ".config"路径下，但并未生效。

解决方案 #

1. 移除配置值的引号 #

配置中的引号会导致Spring将"{userconfig}/mycli"当作字面量字符串处理，不会解析占位符。修改配置为：

spring.shell.config.location: {userconfig}/mycli
spring.shell.history.name: mycli.log

2. 确认UserConfigAutoConfiguration自动配置生效 #

确保项目已正确引入Spring Shell Starter依赖，UserConfigAutoConfiguration会自动生效，默认将{userconfig}解析为~/.config（即System.getProperty("user.home") + "/.config"）。如果是自定义构建，需确保该自动配置类被Spring上下文扫描到。

3. 手动指定{userconfig}的解析路径（可选） #

如果自动配置未生效或需要自定义路径，可通过以下方式指定：

• 启动时通过系统属性指定：
  在启动命令中添加参数：

  java -jar your-app.jar -Dspring.shell.user-config.location=/your/custom/config/path
  

• 通过环境变量指定：
  设置环境变量：

  export SPRING_SHELL_USER_CONFIG_LOCATION=/your/custom/config/path
  

  再启动应用，此时{userconfig}会解析为你指定的路径。

4. 验证实际路径 #

启动应用后，可通过打印UserConfigProperties的配置值来验证实际路径，例如在代码中注入该类：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.shell.userconfig.UserConfigProperties;
import org.springframework.stereotype.Component;

@Component
public class ConfigVerifier {
    @Autowired
    public ConfigVerifier(UserConfigProperties properties) {
        System.out.println("User config location: " + properties.getLocation());
        System.out.println("Resolved config path: " + properties.getResolvedLocation());
    }
}

运行后控制台会输出实际解析的路径，确认是否符合预期。

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