Maven POM.xmlのフォーマット — 依存関係、プラグイン、プロファイル

Maven POM.xmlのフォーマット

Maven POM（Project Object Model）は、MavenベースのJavaプロジェクトの基本的なXML設定ファイルです。適切にフォーマットされたPOMファイルは、チームコラボレーションとプロジェクトメンテナンスに不可欠です。

標準的な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.example</groupId>
  <artifactId>my-project</artifactId>
  <version>1.0.0</version>
  <packaging>jar</packaging>

  <properties>
    <java.version>17</java.version>
    <spring.version>6.1.0</spring.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>
</project>

推奨される要素の順序

Mavenドキュメントではトップレベル要素の特定の順序を推奨しています：

1. modelVersion
2. parent
3. groupId、artifactId、version、packaging
4. name、description、url
5. properties
6. dependencyManagement
7. dependencies
8. build（plugins、resources）
9. profiles

この規則に従うことで、プロジェクト間でPOMが予測可能になります。

依存関係のフォーマット

各dependencyブロックは一貫してインデントされるべきです。依存関係を論理的にグループ化します：最初にcompile依存関係、次にtest依存関係、そしてprovided/runtime：

<dependencies>
  <!-- Compile依存関係 -->
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
  </dependency>

  <!-- Test依存関係 -->
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <scope>test</scope>
  </dependency>
</dependencies>

プラグイン設定

ビルドプラグインは複雑な設定ブロックを持つことがあります。適切なフォーマットにより設定エラーを防止します。

マルチモジュールPOM

<modules> セクションを持つ親POMは、複数の子プロジェクトを調整し、継承された依存関係管理やプラグイン管理セクションで複雑になりうるため、フォーマットの恩恵が大きいです。