{"id":6131,"date":"2022-10-10T20:18:33","date_gmt":"2022-10-10T20:18:33","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=6131"},"modified":"2022-10-10T20:18:33","modified_gmt":"2022-10-10T20:18:33","slug":"maven-file-structure-basics","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/maven-file-structure-basics\/","title":{"rendered":"Maven file structure basics"},"content":{"rendered":"

This is an old blog post that sat in draft for years, int looks complete, so I thought I’d publish it. Hopefully it’s still upto date.<\/em><\/p>\n

As I’m working in Java again and using Maven a lot to get my projects up and running. Whilst I’ve covered some of this stuff in other posts, they’ve tended to be part of working with some specific code. So this post is mean’t to be more about using Maven itself.<\/p>\n

Maven convention file structure<\/strong><\/p>\n

By default the following file structure is expected<\/p>\n

\/src\/main\/java
\n\/src\/main\/resources
\n\/src\/test\/java<\/p>\n

Optionally we might have the test\/resources<\/p>\n

\/src\/test\/resources<\/p>\n

POM starting point<\/strong><\/p>\n

Maven (be default) expects a file name pom.xml to exist which contains version information and may include plugins, code generation, dependencies etc.<\/p>\n

\r\n<?xml version="1.0" encoding="UTF-8"?>\r\n<project xmlns="http:\/\/maven.apache.org\/POM\/4.0.0"\r\n         xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance"\r\n         xsi:schemaLocation="http:\/\/maven.apache.org\/POM\/4.0.0 http:\/\/maven.apache.org\/xsd\/maven-4.0.0.xsd">\r\n    <modelVersion>4.0.0<\/modelVersion>\r\n\r\n    <groupId>com.putridparrot.common<\/groupId>\r\n    <artifactId>JsonPatch<\/artifactId>\r\n    <version>1.0-SNAPSHOT<\/version>\r\n<\/project>\r\n<\/pre>\n
Naming conventions (see references) <\/p>\n
groupId<\/strong> – “identifies the project uniquely across all projects” hence might best be represented by the package name.
\nartifactId<\/strong> – is the name of the JAR
\nversion<\/strong> – standard numbers with dots, i.e. 1.0, 1.0.1 etc.  This is a string so in situations where we want a version to include the word SNAPSHOT (for example) <\/p>\n
Maven commands<\/strong><\/p>\n
Before we get into more POM capabilities, let’s look at the basic set of Maven command’s we’ll use most.<\/p>\n
Compiling to specific Java versions<\/strong><\/p>\n
\r\n<properties>\r\n   <maven.compiler.source>1.8<\/maven.compiler.source>\r\n   <maven.compiler.target>1.8<\/maven.compiler.target>\r\n<\/properties>\r\n<\/pre>\n
OR<\/p>\n
\r\n<build>\r\n   <plugins>\r\n      <plugin>\r\n        <groupId>org.apache.maven.plugins<\/groupId>\r\n        <artifactId>maven-compiler-plugin<\/artifactId>\r\n        <version>3.7.0<\/version>\r\n        <configuration>\r\n          <source>1.8<\/source>\r\n          <target>1.8<\/target>\r\n        <\/configuration>\r\n      <\/plugin>\r\n    <\/plugins>\r\n<\/build>\r\n<\/pre>\n
References<\/strong><\/p>\n
Guide to naming conventions on groupId, artifactId and version<\/a>
\nSetting the -source and -target of the Java Compiler<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
This is an old blog post that sat in draft for years, int looks complete, so I thought I’d publish it. Hopefully it’s still upto date. As I’m working in Java again and using Maven a lot to get my projects up and running. Whilst I’ve covered some of this stuff in other posts, they’ve […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[160],"tags":[],"class_list":["post-6131","post","type-post","status-publish","format-standard","hentry","category-maven"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/6131","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=6131"}],"version-history":[{"count":5,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/6131\/revisions"}],"predecessor-version":[{"id":9543,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/6131\/revisions\/9543"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=6131"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=6131"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=6131"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}