springboot中怎么读取pom文件信息

# SpringBoot中怎么读取POM文件信息

## 前言

在Spring Boot项目中，`pom.xml`文件作为Maven项目的核心配置文件，包含了项目的基本信息、依赖管理、构建配置等关键内容。有时我们需要在代码中动态获取这些信息（如版本号、项目名称等），本文将详细介绍几种常见的读取方式。

---

## 一、使用Maven内置属性

Maven在编译时会自动解析`pom.xml`并生成一组内置属性，可以通过`@Value`注解直接注入：

```java
@RestController
public class ProjectInfoController {
    
    // 读取项目版本号
    @Value("${project.version}")
    private String projectVersion;
    
    // 读取项目名称
    @Value("${project.name}")
    private String projectName;
    
    @GetMapping("/info")
    public String getProjectInfo() {
        return "Project: " + projectName + ", Version: " + projectVersion;
    }
}

注意：需确保pom.xml中已定义<name>标签，否则project.name可能为空。

二、通过MavenXpp3Reader解析POM文件

对于需要完整访问pom.xml内容的场景，可以使用MavenXpp3Reader手动解析：

1. 添加依赖：

<dependency>
    <groupId>org.apache.maven</groupId>
    <artifactId>maven-model</artifactId>
    <version>3.8.6</version>
</dependency>

1. 实现解析工具类：

import org.apache.maven.model.Model;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;

public class PomReaderUtil {
    public static Model readPom() throws IOException, XmlPullParserException {
        MavenXpp3Reader reader = new MavenXpp3Reader();
        // 从项目根目录读取pom.xml
        File pomFile = new File("pom.xml");
        return reader.read(new FileReader(pomFile));
    }
}

1. 使用示例：

Model model = PomReaderUtil.readPom();
String groupId = model.getGroupId();
String artifactId = model.getArtifactId();
String version = model.getVersion();

三、利用Spring Boot的BuildProperties

Spring Boot提供了自动生成的build-info.properties，需先配置Maven插件：

1. 添加插件到pom.xml：

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>build-info</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

1. 注入BuildProperties：

@Autowired
private BuildProperties buildProperties;

public void printInfo() {
    System.out.println("Version: " + buildProperties.getVersion());
    System.out.println("Build Time: " + buildProperties.getTime());
}

四、通过Manifest文件读取

对于打包后的应用，可以从MANIFEST.MF中获取信息：

1. 配置maven-jar-plugin：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.3.0</version>
    <configuration>
        <archive>
            <manifest>
                <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
            </manifest>
        </archive>
    </configuration>
</plugin>

1. Java代码读取：

public class ManifestReader {
    public static String getVersion() {
        return ManifestReader.class.getPackage().getImplementationVersion();
    }
}

五、对比与最佳实践

推荐场景： - 开发阶段：优先使用BuildProperties - 需要完整POM信息：选择MavenXpp3Reader - 简单版本获取：@Value注入或Manifest

六、常见问题解决

1. @Value注入值为null

检查： - 属性是否在pom.xml中正确定义 - 是否使用了spring-boot-starter-parent作为父POM

2. 文件读取路径问题

建议使用ClassLoader获取资源路径：

InputStream pomStream = getClass().getClassLoader()
    .getResourceAsStream("META-INF/maven/your.group/id/pom.xml");

3. 多模块项目处理

在子模块中读取父POM信息时，需显式设置相对路径：

Model parentModel = reader.read(new File("../pom.xml"));

结语

本文介绍了四种主流的POM信息读取方式，开发者可根据实际需求选择合适方案。对于Spring Boot项目，结合BuildProperties和自动装配机制是最优雅的实现方式。

扩展建议： - 对于复杂场景，可考虑自定义Spring Boot Starter自动配置 - 敏感信息建议使用application.yml而非存储在POM中 “`