How to set order of repositories in Maven settings.xml

In Maven, the order of repositories is critical because Maven resolves dependencies in the order declared in settings.xml or pom.xml files. If multiple repositories contain the same dependency, Maven downloads it from the first matching repository. Therefore, correctly configuring the repository order can optimize build performance and efficiency.

Open the settings.xml file: This file is typically located in the .m2 folder under the user's directory (e.g., on Windows, it might be C:\Users\username\.m2\settings.xml).

Edit or add the <repositories> element: Locate or create a <repositories> element in settings.xml. If the file lacks this element, you can manually add it.

Add <repository> elements in priority order: Inside the <repositories> element, add multiple <repository> elements. Each <repository> element represents a repository, and Maven accesses them in the sequence they appear in the file.

Set repository details: For each <repository> element, configure <id>, <url>, and optional elements like <releases> and <snapshots> to control version policies.

For example, if you want to prioritize retrieving dependencies from your company's internal repository before falling back to the central repository, set it up as follows:

xml
<settings>
    <repositories>
        <repository>
            <id>internal-repo</id>
            <url>http://repo.mycompany.com/maven2</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
        <repository>
            <id>central</id>
            <url>https://repo.maven.apache.org/maven2</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
</settings>

In this configuration, Maven first attempts to retrieve dependencies from internal-repo. If the dependency is unavailable there, it proceeds to central. This setup accelerates build times and provides a reliable fallback when the internal repository is inaccessible.

By implementing this approach, you can effectively manage dependency resolution order and sources in Maven projects, optimize build performance, and ensure the correct library versions are used.