Управление Maven окончательное имя артефакта банку

174

Я пытаюсь определить свойство в нашем супер-помпе, которое будет использоваться всеми дочерними проектами в качестве места назначения сгенерированного артефакта.

Для этого я думал об использовании, project/build/finalNameно это не похоже на работу, даже для простых poms:

команда

 mvn archetype:create \ 
   -DarchetypeGroupId=org.apache.maven.archetypes \
   -DgroupId=com.mycompany.app \
   -DartifactId=my-app

POM

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.mycompany.app</groupId>
  <artifactId>my-app</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>my-app</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <build>
        <finalName>${project.name}-testing</finalName>
  </build>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

И когда я казнил:

$ mvn install

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Building my-app
[INFO]    task-segment: [install]
[INFO] ------------------------------------------------------------------------
[INFO] [resources:resources {execution: default-resources}]
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /tmp/mvn_test/my-app/src/main/resources
[INFO] [compiler:compile {execution: default-compile}]
[INFO] Nothing to compile - all classes are up to date
[INFO] [resources:testResources {execution: default-testResources}]
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /tmp/mvn_test/my-app/src/test/resources
[INFO] [compiler:testCompile {execution: default-testCompile}]
[INFO] Nothing to compile - all classes are up to date
[INFO] [surefire:test {execution: default-test}]
[INFO] Surefire report directory: /tmp/mvn_test/my-app/target/surefire-reports

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running com.mycompany.app.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.024 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO] [jar:jar {execution: default-jar}]
[INFO] [install:install {execution: default-install}]
[INFO] Installing /tmp/mvn_test/my-app/target/my-app-testing.jar to /home/maxim/.m2/repository/com/mycompany/app/my-app/1.0-SNAPSHOT/my-app-1.0-SNAPSHOT.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2 seconds
[INFO] Finished at: Sun Nov 21 18:37:02 IST 2010
[INFO] Final Memory: 17M/162M
[INFO] ------------------------------------------------------------------------

Я ожидаю, что строка «testing» появится где-то в сгенерированном имени артефакта.

Я неправильно понимаю цель "finalName"?

Максим Векслер
источник
Приятно знать - все значения по умолчанию (включая окончательное имя) унаследованы от Super Pom (и является хорошим справочным источником) - books.sonatype.com/mvnref-book/reference/…
Andrejs

Ответы:

291

Вы устанавливаете finalNameсвойство в разделе конфигурации плагина:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>2.3.2</version>
    <configuration>
        <finalName>myJar</finalName>                   
    </configuration>
</plugin>       

Как указано в официальной документации .

Обновить:

Для Maven> = 3

Основываясь на комментарии Мэтью, вы можете сделать это следующим образом:

 <packaging>jar</packaging>
 <build>
   <finalName>WhatEverYouLikey</finalName>
 </build>

Смотрите отчет об ошибках / документацию .

Кристиан Вьельма
источник
2
Можете ли вы указать "finalName" в командной строке? (-Djar.finalName = x) не работает.
jayunit100
Я не пробовал использовать командную строку. Вы пробовали решение Maven?
Кристиан Вьельма
1
Немного обновления, 2.4 является последней версией. Все еще работает хорошо, хотя.
PaulBGD
1
С плагинами Maven не обязательно включать версию. Я предполагаю, что это выбирает самое последнее. И если кому-то интересно, имя jar без суффикса файла, поэтому не «myJar.jar», а «myJar», как это правильно показано в примере.
Эспиноза
13
Начиная с версии 3.0.0 finalNameконфигурация была удалена. Однако метод ОП должен работать. См. Questions.apache.org/jira/browse/MJAR-233
Матфея
42

Все предоставленные ответы являются более сложными, чем необходимо. Предполагая, что вы создаете JAR-файл, все, что вам нужно сделать, это добавить <jar.finalName>тег в ваш <properties>раздел:

<properties>
    <jar.finalName>${project.name}</jar.finalName>
</properties>

Это создаст банку:

project/target/${project.name}.jar

Это в документации - обратите внимание на User Property:

finalName:
Name of the generated JAR.
Type: java.lang.String
Required: No
User Property: jar.finalName
Default: ${project.build.finalName}

Использование командной строки

Вы также должны иметь возможность использовать эту опцию в командной строке с:

mvn -Djar.finalName=myCustomName ...

Вы должны получить myCustomName.jar, хотя я не проверял это.

JBCP
источник
6
С Spring Boot это не работает как stackoverflow.com/a/14490656/2294031 . Принимая во внимание, что <jar.finalName>foo</jar.finalName>создает два jar-файла: исполняемый jar-файл с именованными зависимостями foo-${project.version}.jarи второй jar -файл, содержащий только названный проект ${project.name}-${project.version}.jar, <build><finalName>foo</finalName></build>создает только исполняемый jar-файл с именованными зависимостямиfoo.jar
Snozzlebert
Работает, и я согласен, что это простой ответ, и вы даже можете сделать <jar.finalName> $ {groupId} - $ {artifactId} - $ {version} </ jar.finalName>
MG Developer
37

@ Максим
попробуй это ...

pom.xml

 <groupId>org.opensource</groupId>
 <artifactId>base</artifactId>
 <version>1.0.0.SNAPSHOT</version>

  ..............
<properties>
    <my.version>4.0.8.8</my.version>
</properties>

<build>
    <finalName>my-base-project</finalName>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-install-plugin</artifactId>
            <version>2.3.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>install-file</goal>
                    </goals>
                    <phase>install</phase>
                    <configuration>
                        <file>${project.build.finalName}.${project.packaging}</file>
                        <generatePom>false</generatePom>
                        <pomFile>pom.xml</pomFile>
                        <version>${my.version}</version>
                    </configuration>
                </execution>
            </executions>
        </plugin>
</plugins>
</build>

Commnad mvn clean install

Вывод

[INFO] --- maven-jar-plugin:2.3.1:jar (default-jar) @ base ---
[INFO] Building jar: D:\dev\project\base\target\my-base-project.jar
[INFO]
[INFO] --- maven-install-plugin:2.3.1:install (default-install) @ base ---
[INFO] Installing D:\dev\project\base\target\my-base-project.jar to H:\dev\.m2\repository\org\opensource\base\1.0.0.SNAPSHOT\base-1.0.0.SNAPSHOT.jar
[INFO] Installing D:\dev\project\base\pom.xml to H:\dev\.m2\repository\org\opensource\base\1.0.0.SNAPSHOT\base-1.0.0.SNAPSHOT.pom
[INFO]
[INFO] --- maven-install-plugin:2.3.1:install-file (default) @ base ---
[INFO] Installing D:\dev\project\base\my-base-project.jar to H:\dev\.m2\repository\org\opensource\base\4.0.8.8\base-4.0.8.8.jar
[INFO] Installing D:\dev\project\base\pom.xml to H:\dev\.m2\repository\org\opensource\base\4.0.8.8\base-4.0.8.8.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------


Ссылка

Dira
источник
5
в моем случае <file> должен был быть <file> $ {build.directory} / $ {project.build.finalName}. $ {project.packaging} </ file>
Cpt. Senkfuss
2
В чем разница между размещением тега finalName непосредственно в maven-install-plugin VS maven-jar-plugin?
Pocketkid2
Это здорово, я смог использовать этот трюк для публикации XML-файла непосредственно как артефакт.
Бенджамин Дамм
1
Это сначала сборка base-1.0.0.SNAPSHOT.jar, а затем base-4.0.8.8.jar?
Марк W
1
Почему артефакт установлен дважды с двумя разными именами? Пожалуйста, покажите конфигурацию, чтобы установить ее только один раз.
chrisinmtown
18

На этапе упаковки плагин позволяет настраивать имена импортируемых файлов с помощью сопоставления файлов:

Maven-уха плагин

http://maven.apache.org/plugins/maven-ear-plugin/examples/customize-file-name-mapping.html

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-ear-plugin</artifactId>
    <version>2.7</version>
    <configuration>
       [...]
        <fileNameMapping>full</fileNameMapping>
    </configuration>
</plugin>

http://maven.apache.org/plugins/maven-war-plugin/war-mojo.html#outputFileNameMapping

Если вы настроили свою версию для «тестирования» через профиль или что-то еще, это будет работать для пакета war:

Maven-плагин войны

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-war-plugin</artifactId>
    <version>2.2</version>
    <configuration>
        <encoding>UTF-8</encoding>                        
        <outputFileNameMapping>@{groupId}@-@{artifactId}@-@{baseVersion}@@{dashClassifier?}@.@{extension}@</outputFileNameMapping>
    </configuration>
</plugin>
Никол
источник
1
А для баночного архива?
Стефан
8

Это работает для меня

mvn jar:jar -Djar.finalName=custom-jar-name
Олег Михайлов
источник
3

Подход, который вы использовали, действительно делает файл jar со строкой 'testing' в названии, как вы указали, но команда установки по умолчанию отправляет его в каталог ~ / .m2 / repository, как показано в следующей строке вывода:

/tmp/mvn_test/my-app/target/my-app-testing.jar to /home/maxim/.m2/repository/com/mycompany/app/my-app/1.0-SNAPSHOT/my-app-1.0-SNAPSHOT.jar

Мне кажется, что вы пытаетесь создать банку с таким именем, а затем скопировать ее в каталог по вашему выбору.

Попробуйте использовать свойство outputDirectory, как описано здесь: http://maven.apache.org/plugins/maven-jar-plugin/jar-mojo.html

Горан Йович
источник
На самом деле моя полная настройка следующая: у меня есть superpom, в котором я хотел бы определить текущую версию, для которой я создаю. Тогда у меня есть несколько проектов, которые определяют этот пом как своего родителя. Я использую Hudson-Ci для создания всех этих проектов. Затем Гудзон толкнул проекты в артефакт. Я ищу что-то, что позволило бы мне изменить версию, которая в настоящее время создается. Я посмотрю, как я могу использовать ваш новый вклад. Спасибо.
Максим Векслер
Итак ... чтобы контролировать версию, которая будет установлена, мне нужно переопределить другой параметр maven?
Максим Векслер
7
Это не правильно. Имя в местном репо нормализуются: groupId/artifactId/version/artifactId-version-classifier.packaging. finalName применяется только к локальному имени файла в выходном каталоге.
Шон Патрик Флойд
Спасибо, что заметили. На самом деле, та самая строка, которую я цитировал, показывает мою ошибку. Однако у меня сложилось впечатление, что Максиму нужна была банка в локальном каталоге (по его выбору).
Горан Йович
@SeanPatrickFloyd, так есть ли способ изменить artifactId-version-classifier.packaging на имя cutom?
Халид Абу Эль-Соуд
2

Я использую следующее

        ....
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.0.2</version>
            <configuration>
                <finalName>${project.groupId}/${project.artifactId}-${baseVersion}.${monthlyVersion}.${instanceVersion}</finalName>
            </configuration>
        </plugin>
        ....

Таким образом, вы можете определить каждое значение индивидуально или прагматично из Jenkins какой-либо другой системы.

mvn package -DbaseVersion=1 -monthlyVersion=2 -instanceVersion=3

Это поместит папку target\{group.id}\projectName-1.2.3.jar

Лучший способ сэкономить время может быть

        ....
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.0.2</version>
            <configuration>
                <finalName>${project.groupId}/${project.artifactId}-${baseVersion}</finalName>
            </configuration>
        </plugin>
        ....

Как то же самое, за исключением того, что я использую переменную.

  mvn package -DbaseVersion=0.3.4

Это поместит папку target\{group.id}\projectName-1.2.3.jar

Вы также можете использовать outputDirectoryвнутри, configurationчтобы указать местоположение, в котором вы хотите разместить пакет.

GetBackerZ
источник
1

В моем проекте Maven EE я использую:

<build>
    <finalName>shop</finalName>

    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <version>${maven.war.version}</version>
            <configuration><webappDirectory>${project.build.directory}/${project.build.finalName}     </webappDirectory>
            </configuration>
        </plugin>
    </plugins>
</build>
Мирча Станчу
источник