Maven2: лучшие практики для корпоративного проекта (файл EAR)

100

Я просто переключаюсь с Ant на Maven и пытаюсь понять, как лучше всего настроить проект Enterprise на основе EAR-файла?

Допустим, я хочу создать довольно стандартный проект с файлом jar для EJB, файлом WAR для веб-уровня и инкапсулирующим файлом EAR с соответствующими дескрипторами развертывания.

Как бы я это сделал? Создать проект archetypeArtifactId=maven-archetype-webappкак с файлом war, и распространить оттуда? Какая структура проекта (и пример файла POM) лучше всего подходит для этого? Куда вы вставляете дескрипторы развертывания, относящиеся к ушным файлам, и т. Д.?

Спасибо за любую помощь.

Maik
источник

Ответы:

96

Вы создаете новый проект. Новый проект - это ваш проект сборки EAR, который содержит две ваши зависимости для вашего проекта EJB и вашего проекта WAR.

Итак, у вас на самом деле есть три проекта maven. Один EJB. Одна ВОЙНА. Одно УШИ, которое соединяет две части вместе и образует ухо.

Дескрипторы развертывания могут быть созданы maven или помещены в каталог ресурсов в структуре проекта EAR.

Плагин maven-ear-plugin - это то, что вы используете для его настройки, и документация хороша, но не совсем ясна, если вы все еще разбираетесь, как работает maven в целом.

В качестве примера вы можете сделать что-то вроде этого:

<?xml version="1.0" encoding="utf-8"?>
<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.mycompany</groupId>
  <artifactId>myEar</artifactId>
  <packaging>ear</packaging>
  <name>My EAR</name>

  <build>
    <plugins>
      <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.5</source>
          <target>1.5</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
      <plugin>
        <artifactId>maven-ear-plugin</artifactId>
        <configuration>
          <version>1.4</version>
          <modules>
            <webModule>
              <groupId>com.mycompany</groupId>
              <artifactId>myWar</artifactId>
              <bundleFileName>myWarNameInTheEar.war</bundleFileName>
              <contextRoot>/myWarConext</contextRoot>
            </webModule>
            <ejbModule>
              <groupId>com.mycompany</groupId>
              <artifactId>myEjb</artifactId>
              <bundleFileName>myEjbNameInTheEar.jar</bundleFileName>
            </ejbModule>
          </modules>
          <displayName>My Ear Name displayed in the App Server</displayName>
          <!-- If I want maven to generate the application.xml, set this to true -->
          <generateApplicationXml>true</generateApplicationXml>
        </configuration>
      </plugin>
      <plugin>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.3</version>
        <configuration>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
    </plugins>
    <finalName>myEarName</finalName>
  </build>

  <!-- Define the versions of your ear components here -->
  <dependencies>
    <dependency>
      <groupId>com.mycompany</groupId>
      <artifactId>myWar</artifactId>
      <version>1.0-SNAPSHOT</version>
      <type>war</type>
    </dependency>
    <dependency>
      <groupId>com.mycompany</groupId>
      <artifactId>myEjb</artifactId>
      <version>1.0-SNAPSHOT</version>
      <type>ejb</type>
    </dependency>
  </dependencies>
</project>
Майк Корнелл
источник
98
Я нашел свой собственный ответ год спустя, когда у меня возник тот же вопрос. Хорошая работа!
Майк Корнелл
1
Для меня это сработало, когда я установил typeкакejb <type>ejb</type>
gammay
Этот помпон выдает некоторые предупреждения: 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-ear-plugin is missingи 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-compiler-plugin is missing, так что вы можете обновить свой в остальном отличный ответ
DiegoAlfonso
46

Что мне очень помогло, так это запустить архетип Maven: создать цель и выбрать один из архетипов, некоторые из которых, кажется, регулярно обновляются (в частности, JBoss, кажется, поддерживается в хорошем состоянии).

mvn archetype:generate

Сотни архетипов появились в пронумерованном списке, из которого можно было выбрать (519 на данный момент!). Цель, которая все еще выполняется, побудила меня сделать выбор, введя число или введя строку поиска, например:

513: remote -> org.xwiki.commons:xwiki-commons-component-archetype
514: remote -> org.xwiki.rendering:xwiki-rendering-archetype-macro
515: remote -> org.zkoss:zk-archetype-component
516: remote -> org.zkoss:zk-archetype-webapp
517: remote -> ru.circumflex:circumflex-archetype (-)
518: remote -> se.vgregion.javg.maven.archetypes:javg-minimal-archetype (-)
Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains):

Я ввел строку поиска «ухо», в результате чего список сократился до 8 пунктов (на сегодняшний день):

Choose archetype:
1: remote -> org.codehaus.mojo.archetypes:ear-j2ee14 (-)
2: remote -> org.codehaus.mojo.archetypes:ear-javaee6 (-)
3: remote -> org.codehaus.mojo.archetypes:ear-jee5 (-)
4: remote -> org.hibernate:hibernate-search-quickstart (-)
5: remote -> org.jboss.spec.archetypes:jboss-javaee6-ear-webapp 
6: remote -> org.jboss.spec.archetypes:jboss-javaee6-webapp-ear-archetype
7: remote -> org.jboss.spec.archetypes:jboss-javaee6-webapp-ear-archetype-blank
8: remote -> org.ow2.weblab.tools.maven:weblab-archetype-searcher

Я выбрал "org.jboss.spec.archetypes: jboss-javaee6-ear-webapp" (введя значение "5" в этом примере).

Затем цель попросила меня ввести groupId, artifactId, имена пакетов и т. Д., И затем был создан следующий хорошо документированный пример приложения:

[pgarner@localhost Foo]$ tree
.
|-- Foo-ear
|   `-- pom.xml
|-- Foo-ejb
|   |-- pom.xml
|   `-- src
|       |-- main
|       |   |-- java
|       |   |   `-- com
|       |   |       `-- foo
|       |   |           |-- controller
|       |   |           |   `-- MemberRegistration.java
|       |   |           |-- data
|       |   |           |   `-- MemberListProducer.java
|       |   |           |-- model
|       |   |           |   `-- Member.java
|       |   |           `-- util
|       |   |               `-- Resources.java
|       |   `-- resources
|       |       |-- import.sql
|       |       `-- META-INF
|       |           |-- beans.xml
|       |           `-- persistence.xml
|       `-- test
|           |-- java
|           |   `-- com
|           |       `-- foo
|           |           `-- test
|           |               `-- MemberRegistrationTest.java
|           `-- resources
|-- Foo-web
|   |-- pom.xml
|   `-- src
|       `-- main
|           |-- java
|           |   `-- com
|           |       `-- foo
|           |           `-- rest
|           |               |-- JaxRsActivator.java
|           |               `-- MemberResourceRESTService.java
|           `-- webapp
|               |-- index.html
|               |-- index.xhtml
|               |-- resources
|               |   |-- css
|               |   |   `-- screen.css
|               |   `-- gfx
|               |       |-- banner.png
|               |       `-- logo.png
|               `-- WEB-INF
|                   |-- beans.xml
|                   |-- faces-config.xml
|                   `-- templates
|                       `-- default.xhtml
|-- pom.xml
`-- README.md

32 directories, 23 files

После прочтения четырех файлов POM, которые были хорошо прокомментированы, я получил почти всю необходимую информацию.

./pom.xml
./Foo-ear/pom.xml
./Foo-ejb/pom.xml
./Foo-web/pom.xml
Патрик Гарнер
источник
3
Это работает, но в конечном итоге приводит к тому, что в ваш проект добавляется кучка зависимостей, специфичных для jboss, которые вы можете или не захотите очищать постфактум.
Ian McLaird
24

Я сделал репозиторий github, чтобы показать, что я считаю хорошей (или передовой практикой) структурой проекта запуска ...

https://github.com/StefanHeimberg/stackoverflow-1134894

некоторые ключевые слова:

  • Maven 3
  • Спецификация (DependencyManagement собственных зависимостей)
  • Родительский для всех проектов (DependencyManagement от внешних зависимостей и PluginManagement для глобальной конфигурации проекта)
  • JUnit / Mockito / DBUnit
  • Проект Clean War без WEB-INF / lib, потому что зависимости находятся в папке EAR / lib.
  • Проект «Чистое ухо».
  • Минимальные дескрипторы развертывания для Java EE7
  • Нет локального интерфейса EJB, потому что достаточно @LocalBean.
  • Минимальная конфигурация maven через свойства пользователя maven
  • Фактические дескрипторы развертывания для Servlet 3.1 / EJB 3.2 / JPA 2.1
  • использование macker-maven-plugin для проверки правил архитектуры
  • Интеграционные тесты включены, но пропущены. (skipITs = false) полезно включить на сервере сборки CI

Выход Maven:

Reactor Summary:

MyProject - BOM .................................... SUCCESS [  0.494 s]
MyProject - Parent ................................. SUCCESS [  0.330 s]
MyProject - Common ................................. SUCCESS [  3.498 s]
MyProject - Persistence ............................ SUCCESS [  1.045 s]
MyProject - Business ............................... SUCCESS [  1.233 s]
MyProject - Web .................................... SUCCESS [  1.330 s]
MyProject - Application ............................ SUCCESS [  0.679 s]
------------------------------------------------------------------------
BUILD SUCCESS
------------------------------------------------------------------------
Total time: 8.817 s
Finished at: 2015-01-27T00:51:59+01:00
Final Memory: 24M/207M
------------------------------------------------------------------------
Стефан Хаймберг
источник
2
Мне очень нравится ваша упаковка и архитектурный подход. Вы должны думать об упаковке вашего проекта как об архетипе знатока.
Jörg
2
Очень красивое решение! Однако у меня есть один вопрос: почему бы не упаковать спецификацию в родительский проект? зачем дополнительный слой?
sschober
1
причина разделения озабоченностей. бомба могла быть импортирована другими проектами. им нужен только dependencyManagement ваших зависимостей, а не dependencyManagement используемых вами зависимостей. хорошо. вы можете сказать, что если никто не использует ваш проект, этот дополнительный уровень не нужен ... но я думаю, что это тоже имеет смысл ... читаемость. dependencyManagement родительского проекта не смешивается с вашими зависимостями ... в более крупном проекте с> 50 внутренними проектами maven управление dependencyManagement внутри родительского проекта может быть беспорядочным ..
StefanHeimberg
2
другая причина в том, что это та же структура, что задокументирована на maven.apache.org/guides/introduction/… . это помогает работать в команде, в которой члены команды часто меняются, потому что это задокументированный способ "по умолчанию".
StefanHeimberg
2
Кстати. Я однажды создал проект GitHub, чтобы показать, как можно выполнить настройку нескольких проектов: github.com/StefanHeimberg/maven3-multiapplication-setup (для внутреннего обсуждения в компании)
StefanHeimberg
7

IDE NetBeans автоматически определяет структуру, которая почти аналогична структуре, предложенной Патриком Гарнером. Для пользователей NetBeans

Файл -> Новый проект -> В левой части выберите Maven, а в правой части выберите Maven Enterprise Application и нажмите Далее -> Запрашивает имена проектов для war, ejb и настроек.

IDE автоматически создаст структуру для вас.

переполнение стека
источник
Я согласен с вами, особенно при соблюдении спецификаций JEE6
Sym-Sym
3

Это хороший пример части maven-ear-plugin .

Вы также можете проверить архетипы maven , доступные в качестве примера. Если вы просто наберете mvn archetype: generate, вы получите список доступных архетипов. Один из них является

maven-archetype-j2ee-simple
hcpl
источник
10
maven-archetype-j2ee-simpleкажется излишне сложной по структуре - особенно с модулями внутри модулей и отдельными модулями для таких вещей, как ведение журнала. Я не понимал
смысла
2

Я долго искал сквозной пример полного приложения на основе maven, упакованного для ушей, и, наконец, наткнулся на это . В инструкциях предлагается выбрать вариант 2 при запуске через интерфейс командной строки, но для ваших целей используйте вариант 1.

Рой Трулав
источник
Ссылка выдает неавторизованную ошибку. И это причина для написания полных решений вместо того, чтобы полагаться на ссылки.
Пако Абато