[JAVA] Présentez Maven au projet Tomcat

introduction

Nous n'avons jamais utilisé d'outils de construction dans notre projet, nous avons donc résumé Maven pour l'implémentation. Cet article est conçu pour vous donner les informations dont vous avez besoin pour vous comprendre et les déployer auprès des membres de votre projet. De plus, puisque Maven3 est utilisé, la description est basée sur cela.

Qu'est-ce que Maven

Maven est un outil de gestion de projet qui peut contrôler l'exécution des constructions de programmes Java (gérer les bibliothèques jar, compiler, tester, générer des WAR et des JAR) et générer des rapports de résultats. Vous pouvez également étendre le plugin pour ajouter des fonctionnalités à vos builds et rapports. Maven peut contrôler des instructions détaillées en décrivant le processus que vous souhaitez exécuter dans pom.xml (Project Object Model). Par exemple, vous pouvez générer un WAR en spécifiant la version de la bibliothèque jar à utiliser ou en spécifiant des paramètres dépendants de l'environnement, tels que la destination de la connexion à la base de données.

pom.xml Je ne résumerai que les grandes lignes. Veuillez consulter Référence Maven-POM pour plus de détails. groupId / artifactId / version est une valeur de paramètre obligatoire.

Gestion des versions

La gestion des versions du projet spécifiée par la balise version suit généralement Semantic Versioning. Autrement dit, il est représenté par "X.Y.Z (patch mineur majeur) -identifier (alpha / beta / m / rc / SNAPSHOT, etc.)". Lors de la création d'un nouveau projet Maven dans Eclipse ou IntelliJ IDEA, la version par défaut est 0.0.1-SNAPSHOT.

Résolution des dépendances

La résolution des dépendances est une fonctionnalité importante de Maven et gère les bibliothèques (jars externes) dont dépend votre projet. En décrivant la dépendance [dépendance] dans pom.xml, la bibliothèque requise est automatiquement téléchargée depuis le référentiel de Maven. Cette fonctionnalité élimine le besoin de télécharger vous-même les bibliothèques requises à partir du site et de les ajouter au chemin de compilation ou de vous engager dans un système de contrôle de version. Vous pouvez également éliminer les conflits de paramètres d'environnement causés par différents chemins de classe en fonction de l'environnement de développement.

Dépôt Maven

Le référentiel Maven est l'endroit où les bibliothèques sont gérées. Maven téléchargera les bibliothèques requises à partir du référentiel lorsque vous exécuterez la compilation. Les artefacts de projet peuvent également être téléchargés dans le référentiel pour être utilisés par d'autres projets.

Dépôt central

Dépôt officiel de Maven publié sur Internet. Des versions de diverses bibliothèques sont disponibles ici, et vous pouvez télécharger les bibliothèques requises localement. Dépôt central

Référentiel distant

Gérez la bibliothèque comme vous le feriez pour un référentiel central. Vous pouvez également créer votre propre référentiel distant en utilisant Sonatype NEXUS. Par exemple, les référentiels suivants sont des référentiels distants.

• Dépôt propriétaire tiers
• Miroir du référentiel central
• Dépôt privé limité au réseau interne

Dépôt local

Un référentiel construit dans l'environnement de développement. Lorsque Maven recherche une bibliothèque, il recherche d'abord le référentiel local, et sinon, recherche le référentiel central ou le référentiel distant et le télécharge. Le référentiel local est situé dans ~ / .m2 / repository.

Scope Si vous spécifiez la portée, vous pouvez spécifier l'état de la définition de la bibliothèque dans classpath. S'il n'est pas spécifié, ce sera compile.

Exécutez Maven

objectif

Le processus exécuté par Maven est appelé "objectif" pour chaque fonction. Le "goal" est fourni par le plugin et s'exécute sous mvn plugin name: Goal name. Un plug-in a plusieurs objectifs.

Phase

Chez Maven, ce que vous voulez faire s'appelle une «phase». Plusieurs "buts" sont liés à une phase, et si vous exécutez la phase que vous voulez exécuter avec le nom de phase mvn, les" buts "liés à la" phase "seront exécutés dans l'ordre. L'ordre dans lequel les phases sont exécutées est déterminé par le cycle de vie décrit plus loin.

Construire le cycle de vie

Les builds Maven exécutent un nombre défini de "phases" en séquence en fonction de leur cycle de vie. Il y a trois cycles de vie définis

cycle par défaut

C'est littéralement un cycle de vie standard. Puisqu'il y a 23 Phases au total, seules les Phases principales seront expliquées ici. (La phase non décrite sera le prétraitement de la phase suivante et le post-traitement de la phase précédente.) "Artéfact" fait référence à la guerre, au pot, etc.

Par exemple, l'exécution de mvn package exécute 17 phases de la validation au package et génère des artefacts. L'exécution jusqu'à mvn deploy exécutera les 23 phases de la validation au déploiement.

cycle de nettoyage

Le cycle de nettoyage est un cycle de vie pour la suppression des fichiers temporaires générés par une compilation. Les fichiers temporaires sont des fichiers de classe et de ressources générés localement, tels que la compilation et le test. (Dans un projet Maven normal, le fichier est sorti dans le répertoire cible)

C'est une bonne idée de toujours exécuter propre avant d'exécuter la compilation dans le cycle par défaut, car les fichiers temporaires restants lors de la reconstruction peuvent être réutilisés. Exemple mvn clean package

cycle de site

Le cycle de vie du site génère la documentation du projet. Par exemple, à l'aide du plug-in décrit plus loin, générez javadoc, des rapports de résultats d'analyse statique tels que les styles de contrôle et FindBugs, les résultats des tests et les rapports de couverture.

Si vous spécifiez le site en même temps que la construction et l'exécutez, le document du résultat de la construction sera généré. Exemple'mvn install site '

Brancher

Les plugins sont des fonctionnalités Maven écrites en Java. Le plug-in fournit également des objectifs liés aux phases du cycle de vie. En plus de cela, divers plug-ins sont publiés et vous pouvez également créer votre propre plug-in. Veuillez vérifier le HP de chaque plug-in car l'utilisation est différente pour chaque plug-in.

Construire

Il définit principalement le plug-in que vous souhaitez exécuter dans le cycle de vie par défaut.

rapport

site Définit un plug-in pour générer un rapport d'exécution. Par exemple, vous pouvez vérifier les résultats de l'analyse statique tels que le style de vérification et trouver des bogues, et vous pouvez parcourir le javadoc du code du projet.

Projet multi-modules

Dans Maven, un projet peut être géré en le divisant en "modules" pour chaque rôle et service. Par exemple, module de base, module de plugin, module de fonction commun, etc. Pour une telle configuration de projet, vous pouvez définir la configuration du module et les paramètres communs dans pom.xml du module parent qui gère l'ensemble du projet et en hériter dans pom.xml de chaque module.

Exemple de configuration de projet multi-module

Dans pom.xml, définissez ce qui suit dans le module parent du projet multi-module.

• Spécifiez «pom» pour l'emballage.
• Spécifiez l'ArtifactId du module à gérer dans les modules.
• Les informations gérées par properties peuvent également être référencées dans le module pom.xml.
• Vous pouvez définir un modèle de dépendance ou de plugin dans dependencyManagement ou pluginManagement. Dans pom.xml côté module, vous pouvez utiliser la définition en fonction du modèle simplement en spécifiant le groupId et artifactId, et vous pouvez le remplacer.

Dans le module enfant, spécifiez le groupId / artifactId / version du module parent dans la balise parent et héritez-en.

Exemple d'introduction au projet de développement

Prenons comme exemple le processus de migration d'un projet en cours de développement par un groupe vers un projet Maven.

Dans Eclipse, vous pouvez convertir un projet existant en projet Maven en sélectionnant Faites un clic droit sur le projet> Configuration> Convertir en projet Maven, mais comme il s'agit du premier projet Maven créé, j'ai décidé de copier le module dans le projet créé à partir de zéro.

supposition

• Windows
• En utilisant All in One Eclipse, le plug-in Maven est déjà installé.
• Le projet existant est un projet Tomcat.
• La base de données utilise Oracle, donc OJDBC est utilisé.

Installez Maven

Voir Installation de Maven pour plus d'informations. Décompressez le fichier compressé et placez le dossier bin dans la variable d'environnement PATH. Ouvrez une invite de commande et exécutez mvn --version pour voir les informations de version.

Ensuite, créez un dossier de travail .m2 pour Maven. Les dossiers de travail sont généralement créés dans le répertoire utilisateur ~ / .m2. En outre, créez les répertoires et fichiers suivants sous le dossier de travail. ~ / .m2 / repository C'est le répertoire qui sera le dépôt local. ~ / .m2 / setting.xml Ceci est un fichier de configuration utilisateur.

paramètres du proxy

Si vous accédez à Internet via un proxy, vous devez définir un proxy. Décrivez comme suit dans ~ / .m2 / setting.xml.

• S'il ne s'agit pas d'un proxy d'authentification, le nom d'utilisateur et le mot de passe ne sont pas requis.

setting.xml

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                          http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <proxies>
    <proxy>
      <id>http_proxy</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>Compte d'authentification</username>
      <password>Mot de passe d'authentification</password>
      <host>Adresse IP du serveur proxy</host>
      <port>numéro de port du serveur proxy</port>
    </proxy>
    <proxy>
      <id>https_proxy</id>
      <active>true</active>
      <protocol>https</protocol>
      <username>Compte d'authentification</username>
      <password>Mot de passe d'authentification</password>
      <host>Adresse IP du serveur proxy</host>
      <port>numéro de port du serveur proxy</port>
    </proxy>
  </proxies>
</settings>

Paramètres Eclipse

1. Sélectionnez Fenêtre> Préférences> Maven> Paramètres utilisateur.
2. Spécifiez ~ / .m2 / setting.xml dans les paramètres utilisateur.
3. Pour Local Repository, spécifiez ~ / .m2 / repository.

Créer un projet Maven

Cette fois, nous convertirons un projet Tomcat existant en un projet Maven. Il est géré dans la configuration multi-modules suivante.

project ├─ main module ├─ sub module1 ├─ sub module2 └─ sub module3

• le module principal est une application Web.
• le sous-module 1-3 est la source de la bibliothèque utilisée par le module principal.
• Ces modules sont gérés dans un projet.

Créer un pom parent

Créez un pom parent qui constitue le multi-module.

1. Sélectionnez Fichier> Nouveau> Projet Maven.
2. Dans le projet Nouveau Maven, cochez "créer un projet simple (ignorer la sélection d'archétype)" et appuyez sur Suivant.
3. Dans Configurer l'artefact du projet, saisissez ce qui suit, puis appuyez sur Terminer.

groupId ・ ・ ・ ・ Identifiant unique pour le projet (jp.co. nom de l'entreprise. nom du produit / com. nom du produit, etc.) artifactId ・ ・ ・ Nom d'identification du projet version ・ ・ ・ Version (Tout d'abord, la valeur par défaut 0.0.1-SNAPSHOT convient.) paquet ・ ・ ・ ** pom **

Une fois créé, vous aurez un dossier src et pom.xml. Cette fois, src n'est pas nécessaire, supprimez-le.

Spécification de la version Jave utilisée par Maven pour la compilation

Java5 (1.5) est spécifié par défaut, alors ouvrez la propriété dans pom.xml et spécifiez la version. En le spécifiant comme pom parent, il sera également reflété dans le sous-module. Si vous souhaitez changer la version du sous-module, spécifiez également la propriété dans le pom.xml de ce module.

pom.xml[JDK version]

<properties>
  <java-version>1.8</java-version>
  <maven.compiler.source>${java-version}</maven.compiler.source>
  <maven.compiler.target>${java-version}</maven.compiler.target>
</properties>

Créer un sous-module

Créez un sous-module sous le projet parent. Le sous-module créé cette fois sera la bibliothèque jar référencée dans le module Web décrit plus loin.

1. Cliquez avec le bouton droit sur le projet parent> Maven> Nouveau projet de module Maven.
2. Dans le projet New Maven, décochez "créer un projet simple (ignorer la sélection d'archétype)".
3. Entrez le nom du module dans Nom du module, confirmez que le projet parent est spécifié dans Projet parent et appuyez sur Suivant.
4. Sous Select an Archetype, sélectionnez Artifact ID: maven-archetype-quickstart et appuyez sur Next.
5. Confirmez et entrez ce qui suit dans Artefact du projet Configure, puis appuyez sur Terminer.

groupId ・ ・ ・ ・ Identique au projet parent artifactId ・ ・ ・ nom du module version ・ ・ ・ Identique au projet parent paquet ・ ・ ・ ** pot **

Un sous-module est créé avec la structure de dossiers suivante. sub module ├src/main/java └src/test/java

Création d'un module principal (module Web)

Créez un module d'application Web qui sera cette fois le module principal.

1. Cliquez avec le bouton droit sur le projet parent> Maven> Nouveau projet de module Maven.
2. Dans le projet New Maven, décochez "créer un projet simple (ignorer la sélection d'archétype)".
3. Entrez le nom du module dans Nom du module, confirmez que le projet parent est spécifié dans Projet parent et appuyez sur Suivant.
4. Sous Select an Archetype, sélectionnez Artifact ID: maven-archetype-webapp et appuyez sur Next.
5. Confirmez et entrez ce qui suit dans Artefact du projet Configure, puis appuyez sur Terminer.

groupId ・ ・ ・ ・ Identique au projet parent artifactId ・ ・ ・ nom du module version ・ ・ ・ Identique au projet parent package ・ ・ ・ ** guerre **

Un module Web est créé avec la structure de dossiers suivante. web module ├src/main/resources └src / main / webapp (dossier racine de l'application Web. META-INF et WEB-INF existent sous celui-ci.)

maven-archetype-webapp ne crée pas de dossier source java ou de dossier de test, alors créez-en un.

web module ├src/main/java ├src/main/resources ├src/main/webapp └src/test/java

Résolution des dépendances

Ajoutez une dépendance à pom.xml pour chaque module. De plus, dans Eclipse, vous pouvez utiliser l'éditeur dédié Maven POM pour entrer d'une manière visuellement facile à comprendre.

Ouvrez pom.xml dans l'éditeur Maven POM et ouvrez l'onglet Dépendances. Cliquez sur Ajouter pour les dépendances sur la gauche pour ouvrir la fenêtre Sélectionner une dépendance. Spécifiez l'ID de groupe / l'ID d'artefact / la version / l'étendue de la bibliothèque que vous souhaitez ajouter et appuyez sur OK. Si vous ne savez pas, vous pouvez rechercher par Entrée ... au milieu.

Si vous souhaitez ajouter la bibliothèque ajoutée à la gestion des dépendances du Pom parent et y faire référence en commun avec d'autres sous-modules, appuyez sur Géré. Sélectionnez la bibliothèque que vous souhaitez ajouter au pom parent à partir de la gauche, sélectionnez le pom parent à droite et appuyez sur OK. Cela ajoutera la bibliothèque à la gestion des dépendances du Pom parent, mais si vous voulez l'utiliser avec d'autres sous-modules, ouvrez ce pom.xml et ajoutez la bibliothèque.

Spécifier un plug-in

Exécutez le plug-in suivant pour générer le rapport sur mvn site. Si vous créez le rapport à l'aide de Jenkins, vous pouvez également le générer dans le résultat de la génération.

• checkstyle * Créez un dossier de configuration et placez le fichier de configuration (google_checks.xm, etc.).
• findBugs
• JaCoCo
• javadoc

Un exemple de réglage peut être trouvé à [ici](exemple http://qiita.com/kazokmr/items/971ec5cc8e3a07f2429a#pomxml). (Ceci est mon article.)

Paramètres dépendant de l'environnement

pom.xml a une balise profile. Par exemple, il est utilisé lorsque vous souhaitez modifier une certaine valeur de réglage en fonction de la situation. Je pense qu'il existe une destination de connexion DB comme méthode souvent utilisée. Par exemple, la définition de la destination de connexion est un fichier resourceProperty

jdbc.url=jdbc:oracle://xxxxxxxx:1521/ora
jdbc.username=username
jdbc.password=password

Pour construire pour les trois environnements d'environnement de développement (dev), d'environnement de vérification (staging) et d'environnement de production (prod), définissez comme suit dans le profil.

pom.xml

<profiles>
  <profile>
    <id>dev</id>
    <activation>
      <activeByDefault>true</activeByDefault>
    </activation>
    <properties>
      <jdbc.url>jdbc:oracle://xxxxxxxx:1521/oradev</jdbc.url>
      <jdbc.username>Nom d'utilisateur de l'environnement de développement</jdbc.username>
      <jdbc.password>Mot de passe de l'environnement de développement</jdbc.password>
    </properties>
  </profile>
  <profile>
    <id>staging</id>
    <properties>
      <jdbc.url>jdbc:oracle://xxxxxxxx:1521/orastaging</jdbc.url>
      <jdbc.username>Nom d'utilisateur de l'environnement de vérification</jdbc.username>
      <jdbc.password>Mot de passe de l'environnement de vérification</jdbc.password>
    </properties>
  </profile>
  <profile>
    <id>prod</id>
    <properties>
      <jdbc.url>jdbc:oracle://xxxxxxxx:1521/oraprod</jdbc.url>
      <jdbc.username>Nom d'utilisateur de production</jdbc.username>
      <jdbc.password>Mot de passe de l'environnement de production</jdbc.password>
    </properties>
  </profile>
</profiles>

ʻActiveByDefault = trueest la valeur par défaut, alors faites-y référence lors de la construction sans rien spécifier ou lors du démarrage d'une application Web sur l'EDI. Si vous souhaitez basculer vers l'environnement de vérification ou l'environnement de production, spécifiez l'ID de profil avec les optionsmvn -P staging package, man -P prod packageet-P`.

Le fichier de paramètres dépendant de l'environnement est géré par un module dédié, et en le séparant du module d'application Web, le fichier war peut être réutilisé.

C'est une méthode pour changer certaines propriétés, mais le profil peut également changer le fichier de propriétés lui-même. Par exemple, supposons que les fichiers de propriétés soient gérés dans les répertoires suivants pour chaque environnement.

src/main/resources/··· Répertoire des fichiers de ressources de l'environnement de développement (par défaut)
resources/staging/··· Répertoire de fichiers de ressources pour l'environnement de vérification
resources/prod/··· Répertoire de fichiers de ressources pour l'environnement de production

Le pom.xml pour remplacer les fichiers sous src / main / resources / pour chaque environnement est le suivant.

pom.xml

<profiles>
  <profile>
    <id>dev</id>
    <activation>
      <activeByDefault>true</activeByDefault>
    </activation>
    <properties>
      <resources.directory>${basedir}/src/main/resources</resources.directory>
    </properties>
  </profile>
  <profile>
    <id>staging</id>
    <properties>
      <resources.directory>${basedir}/resources/staging</resources.directory>
    </properties>
  </profile>
  <profile>
    <id>prod</id>
    <properties>
      <resources.directory>${basedir}/resources/prod</resources.directory>
    </properties>
  </profile>
</profiles>
···
<build>
  <resources>
    <resource>
      <directory>${resources.directory}</directory>
    </resource>
  </resources>
</build>

Dans la balise de construction, le chemin du répertoire des ressources est défini dans $ {resources.directory}, et le chemin du répertoire de chaque environnement est défini dans le profil. En faisant cela, une guerre indépendante de l'environnement est créée et elle peut être réutilisée dans un autre environnement.

De plus, je pense qu'il vaut mieux gérer le fichier de paramètres d'environnement avec un module dédié au lieu du module d'application Web, sortir comme bibliothèque de référence et ne pas l'inclure dans la guerre.

Les instructions Terasoluna expliquent également comment créer des fichiers dépendants de l'environnement. Terasoluna --3.5. Build Development Project

~~ Je voulais utiliser le profil car il y a 3 destinations de connexion DB, environnement de développement / environnement de vérification / environnement de production, dans ce projet également, mais le fichier de configuration de la destination de connexion n'était pas sous le dossier de ressources et sous le dossier de ressources. En raison du grand nombre de fichiers, il était difficile de tous les gérer, j'ai donc d'abord migré sans utiliser de profil. ~~ Je l'ai essayé dans cet article.

Comment se référer au pilote OJDBC

Le pilote OJDBC (oracle.jar) n'est pas géré par le référentiel Maven et doit être importé dans le projet Maven en effectuant l'une des opérations suivantes: (Dans ce projet, Oracle.jar est défini sur runtime et sur le serveur de production, le jar est placé dans la bibliothèque de Tomcat.)

1. Inscrivez-vous avec une dépendance dans la portée du système

1. Téléchargez le fichier oracle.jar requis sur le site Web officiel d'Oracle.
2. Placez oracle.jar n'importe où dans votre projet. (Dossier Lib, etc.)
3. Ajouter à la dépendance dans pom.xml. (Écrivez groupId, artifactId, version comme d'habitude.)
4. Définissez la portée de la dépendance sur SYSTEM et spécifiez le PATH sur oracle.jar situé dans SYSTEMPATH.

• Veuillez noter que si vous ne définissez pas le chemin de construction du projet avec un fichier jar externe, vous ne serez pas connecté à Oracle DB lorsque vous démarrez Tomcat dans l'environnement de développement.

2. Mettez oracle.jar dans votre référentiel local

1. Téléchargez le fichier oracle.jar requis sur le site Web officiel d'Oracle.
2. Placez oracle.jar dans le référentiel local ~ / .m2 / repository.
3. Ajouter à la dépendance dans pom.xml. (Écrivez groupId, artifactId, version comme d'habitude)

• Puisque oracle.jar n'est pas inclus dans les livrables de ce projet, la portée est définie sur runtime.

3. Rendez-le disponible à partir du référentiel Maven officiel d'Oracle.

Comment utiliser le référentiel Oracle Maven officiel

Cette méthode elle-même n'est ni confirmée ni vérifiée. Cependant, il semble qu'il soit nécessaire de définir la licence OTN dans chaque environnement de développement et qu'il soit nécessaire d'exécuter la commande mvn pour la première fois dans Eclipse.

Exécuter la construction

1. Cliquez avec le bouton droit sur le projet ou le module que vous souhaitez créer> Exécuter en tant que> Construction Maven.
2. L'écran de paramétrage Maven s'affiche. Saisissez l'objectif ou la phase que vous souhaitez exécuter dans les objectifs. Exemple clean compile`` site d'installation propre etc.
3. Le résultat de l'exécution de Maven est affiché sur la console. S'il s'agit d'un succès, il est complet. S'il y a une erreur, éliminez la cause.
4. Si vous exécutiez install, les fichiers war et jar seront téléchargés dans votre référentiel local.

Paramètres du serveur

Bien que cela n'ait rien à voir avec Maven, lors de l'exécution d'une application Web dans Eclipse, le plug-in Tomcat a été installé jusqu'à présent, mais cette fois, je vais vous expliquer comment exécuter l'application Tomcat à l'aide du plug-in WTP. (On suppose que le plug-in WTP est installé dans Eclipse)

1. Ouvrez la vue Serveur et faites un clic droit> Nouveau> Serveur.
2. Sous Définir un nouveau serveur, sélectionnez Apache> Serveur Tomcat vX.X. (X.X est la version de Tomcat que vous souhaitez utiliser)
3. Lorsque l'écran des paramètres du serveur Tomcat s'affiche, spécifiez le répertoire local Tomcat dans le répertoire d'installation de Tomcat ou installez Tomcat à partir du bouton Télécharger et installer.
4. De même pour JRE, sélectionnez local ou install et appuyez sur Terminer.
5. Revenez à la vue Sever, cliquez avec le bouton droit sur le serveur Tomcat vX.X ajouté> et sélectionnez Ajouter et supprimer.
6. Les modules Web disponibles s'affichent, sélectionnez-les et appuyez sur Ajouter pour terminer.
7. Après avoir ajouté le module Web, cliquez avec le bouton droit de la souris sur Tomcat vX.X Server> Démarrer pour démarrer Tomcat.

• Une erreur peut survenir au démarrage et il se peut qu'elle ne démarre pas, mais si vous cliquez avec le bouton droit sur Tomcat vX.X Server> nettoyer puis démarrez-le, ou après un certain temps, démarrez-le normalement.

Site de référence

Apache Maven Project Wikipedia Principes de base de Maven Comment démarrer avec Maven3 Résumé de l'écriture de POM pour Maven2 et Maven3 ~ Présentation ~ Cycle de vie Maven Build Je vais expliquer "Qu'est-ce qu'un outil de construction?" À un nouveau venu qui n'a exécuté que des applications Java depuis Eclipse ... puis vers CI 6. Profil | TECHSCORE