有没有办法在编译期间在Java类中使用maven属性

Question

我只是想在编译时在我的Java类中使用maven占位符以减少重复。

像这样的东西：

的pom.xml

<properties>
  <some.version>1.0</some.version>
</properties>

SomeVersion.java

package some.company;

public class SomeVersion {

    public static String getVersion() {
        return "${some.version}"
    }

}

Answer 1

只需使用这样的内容在src / main / resources中创建文件app.properties

application.version=${project.version}

然后像这样启用maven过滤

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
        </resource>
    </resources>

这就是全部 - 在应用程序代码中只读取属性文件

ClassPathResource resource = new ClassPathResource( "app.properties" );
p = new Properties();
InputStream inputStream = null;
try {
    inputStream = resource.getInputStream();
    p.load( inputStream );
} catch ( IOException e ) {
    LOGGER.error( e.getMessage(), e );
} finally {
    Closeables.closeQuietly( inputStream );
}

并提供这样的方法

public static String projectVersion() {
    return p.getProperty( "application.version" );
}

Answer 2

即使它不是一个非常好的解决方案，也可以使用默认的maven资源插件。

首先，您需要指定资源插件。

<project>
  <build>
    <!-- Configure the source files as resources to be filtered
      into a custom target directory -->
    <resources>
      <resource>
        <directory>src/main/java</directory>
        <filtering>true</filtering>
        <targetPath>../filtered-sources/java</targetPath>
      </resource>
      <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
      </resource>
    </resources>
  </build>
</project>

之后，您将需要更改编译器插件的“默认”配置。

<project>
  <build>
      <!-- Overrule the default pom source directory to match
            our generated sources so the compiler will pick them up -->
      <sourceDirectory>target/filtered-sources/java</sourceDirectory>
  </build>
</project> 

Answer 3

我知道这样做的最简单方法是使用Templating Maven插件 。

将插件声明添加到您的pom：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>templating-maven-plugin</artifactId>
    <version>1.0.0</version>
    <executions>
        <execution>
            <id>filter-src</id>
            <goals>
                <goal>filter-sources</goal><!-- add this if you filter main sources -->
                <goal>filter-test-sources</goal><!-- add this if you filter test sources -->
            </goals>
        </execution>
    </executions>
</plugin>

如果您要过滤主要来源：

• 创建文件夹src/main/java-templates
• 将要过滤的源文件移动到该文件夹​​。 重现包树结构，就好像你在src/main 。

如果您还要过滤测试源：

• 创建文件夹src/test/java-templates
• 将要过滤的源文件移动到该文件夹​​。 重现包树结构，就好像你在src/test 。

假设您的源包含有效占位符，例如：

package some.company;

public class SomeVersion {

    public static String getVersion() {
        return "${project.version}"
    }

}

现在，当您compile或test项目时，这些占位符应该已经被重视了。

希望能帮助到你。

Answer 4

如果您正在使用Spring，您可以注入一个属性。 步骤是：

1. 在POM文件中，您可以定义所需的所有配置文件，并且每个配置文件都必须具有您的自定义属性

 <profile> <id>dev</id> <properties> <some.version>Dev Value</some.version> </properties> </profile> 

2. 在配置文件的部分构建中，您可以定义过滤注入。
3. 在您的项目资源目录下，您创建一个属性文件（任何助记符基础名称）并将您的道具注入：

custom.some.version = $ {} some.version

4. 在spring-context文件中，您可以定义属性占位符并定义bean或beanProperty：

 <context:property-placeholder location="classpath*:/META-INF/*.properties"/> ... <bean id="customConfig" class="com.brand.CustomConfig"> <property name="someVersion" value="${custom.some.version}" /> </bean> ... 

5. 创建你的课程。

 package com.brand; public class CustomConfig { private String someVersion; public getSomeVersion() { return this.someVersion; } public setSomeVersion(String someVersion) { this.someVersion = someVersion; } } 

6. 注入您要使用的位置。 此示例使用自动装配的bean，但您也可以使用和自动装配的属性。

 package com.brand.sub public class YourLogicClass { @Autowired private CustomConfig customConfig; // ... your code } 

在最终编译中，您具有正确的值。