YOUR FEEDBACK
Apple Making No Allowance for Linux, Firefox and the Creative Commons
Scott wrote: What the hell? What a waste of time - here I thought I was g...
Did you read today's front page stories & breaking news?

AJAXWorld Call For Papers!

SYS-CON.TV

2007 East

  Diamond Sponsor:  
Laszlo
The Browser, the Portal, and the Desktop

  Platinum Sponsors:  

Adobe
'HDUX' - High Definition User Experience with Flex & Apollo
Cynergy
It Takes A Village: Building a World Class RIA Development Group
JackBe
The User is the Killer App. Empower Them!
Tibco
AJAX RIAs and the Service-Oriented Platform

      Gold Sponsors:     
Backbase
AJAX Best Practices
Helmi
Helmi Open Source RIA Platform
ICESoft
Secure Enterprise AJAX with ICEfaces
JetBrains
Is An IDE the Fifth Wheel or Sixth Sense?
Kapow
Serving Mashups from the Long Tail of the Web
Nexaweb
Enterprise Web 2.0 - Programming with Levers, Dials and maybe Switches
Click For 2006 Event Webcasts

TOP THREE LINKS YOU MUST CLICK ON


JDJ Feature — Introduction to Maven 2
A promising application development lifecycle management framework

Digg This!

age 1 of 2   next page »

Maven is a promising application development lifecycle management framework coming from Apache's armory of open source tools. Maven was originally developed as a framework to manage and mitigate the complexities of building the Jakarta Turbine project and soon became a core entity of the Apache Software Foundation project.

Without a uniform application development lifecycle management framework, different development teams would create their own build frameworks with varying flavors and complexity and this tendency would only proliferate as more and more new projects get developed. The creation of different build approaches for different projects would lead to build system disparity lacking reuse of build logic that would impede developers in moving easily between the projects because every time a developer starts working on a different project, the developer would spend too much time understanding the prevalent build system, its configuration, and usage instead of focusing on the core components.

This type of perplexity was particularly felt in the open source community. There was a definite need for a standardized project development lifecycle management system. The advent of Maven as part of the Jakarta Turbine project was the perfect remedy for the old malady.

As the name suggests, Maven is a connoisseur of build process. It encapsulates years of project development lifecycle management knowledge and tremendously simplifies the build process by extensively reusing build logic and eliminating most of the grunt work typical of the usual application development process. Ever since, Maven has been extensively used in the open source community for building projects and in the process was enhanced and extended to bring it to its current mature state. Maven, currently at version 2, has become the de facto build system in many open source initiatives and is being adopted by many software development organizations.

Development teams usually would have a plethora of challenges and concerns during typical application project development. The following are a few such examples:

  • What should the project directory structure be?
  • How should source, test source, libraries, configuration, documentation, and report directories be laid out?
  • Where should the dependent library Jars be downloaded from?
  • What versions of library Jars should be used for the project?
  • What about the other Jars that the project library Jars depend on internally? Where should such Jars be downloaded from? What versions of such Jars should be used? Is there an easy way to know the compatible versions?
  • What is the best way to resolve dependent library Jar version conflicts?
  • Where should the library Jars be located?
  • How should the project keep up with the latest versions of dependent Jar files?
  • How should the compile time, runtime, and testing time classpath libraries be separated?
  • How should compile time, runtime, and testing time resources be separated?
  • Is there an easy way to execute all test cases during the build process and immediately evaluate percentage test coverage?
  • Is there an easy way to test code quality during the build process?
  • Is there a way to integrate code profiling during the build process?
  • Is there a way to run integration tests during the build process? How can continuous integration be achieved by developing custom build scripts?
  • How should the build scripts be designed for different project building tasks?
  • Where should build scripts be located in the overall project directory structure?
  • Should there be a dedicated resource to maintain the build scripts while the project is being developed?
  • How can consistent company-wide Jar libraries be maintained?
  • Should new team members learn the custom build process?
  • Should each project have its own inconsistent and typically non-standard build process?
Maven thoroughly addresses such concerns by providing a common project build model that can be reused by all software projects. Maven abstracts the project structure and contents by following a set of guiding principles such as "convention over configuration," "declarative execution of development lifecycle process," "reuse of build logic across projects," and "logical organization of project dependencies."

The key benefit of this approach is that developers will follow one consistent build lifecycle management process without having to reinvent such processes time and again. Ultimately this will make developers to become more productive, agile, disciplined, and focused on the work at hand rather than spending time and effort doing grunt work understanding, developing, and configuring yet another non-standard build system.

Standard Conventions Used by Maven
Maven goes by the notion of "convention over configuration." Some of the common concerns when building a project are project directory structure, directory naming conventions, and the build output. For example, the directory structure of a Web application project will be slightly different from that of an EJB application project. Similarly the output of a Web application project is typically a WAR file while that of an EJB application is a JAR file. However, for a specific project type, the typical requirements in terms of directory layout and naming conventions are almost the same. Without a unified framework such as Maven, developers would typically spend time configuring such nitty-gritty details as setting up directories for source, resources, test case source, testing time resources, classes, and project dependencies. Moreover, developers will have to spend a good chunk of time creating build scripts such as ANT scripts to execute build tasks according to the project layout. This entire endeavor ends up being chaotic and in a large-scale project it can lead to a maintenance nightmare demanding dedicated resources just to focus on such build aspects.

Maven inculcates three main conventions to address common concerns:

1.  Projects of the same project type will have one common standard project directory structure: At project creation, Maven uses a standard project directory layout for source files, resources, test case source files, test resources, configuration files, output files, reports, and documentation. In almost all cases, this standard project directory layout is sufficient to carry out development tasks. However, a custom directory structure can also be configured by overriding Maven's defaults. This override is not generally recommended unless there's a compelling reason and will deviate from Maven's best practice propositions.

2.  Every project results in one primary artifact of specific type: Every project in Maven will result in one primary output file known as an artifact. For example, a Maven project containing a mathematical utility API will yield a JAR file containing compiled utility classes. The output JAR file is the resulting artifact of that project. Some other common artifact types are WAR, EAR, and RAR. Each artifact in Maven is uniquely designated by three Maven coordinates; artifact Id is the actual name of the artifact, group Id is the name of the group the artifact belongs to and the artifact version. This convention helps tremendously while resolving dependencies because every dependency in Maven is an artifact and so every dependency can be uniquely identified. This convention enables developers to think in terms of modularization at the code base level so that each project module yields one specific artifact specializing in one area of concern. This type of modularization encourages maximum reusability with different projects can now depend on only one functionally specialized and distinct artifact without having to include multiple disparate artifacts that may contain pieces of the required functionality.

3.  Use of standard naming conventions: Maven uses standard names for project directories and output files. For example, Maven creates a standard 'projectDirectory/src/main/java' directory for all Java source files and 'projectDirectory/src/test/java' directory for all Java test case source files. Similarly, while creating a project artifact, Maven follows a standard naming convention such as 'artifactName-version.' An artifact version is typically represented in a standard format of 'MMM.mmm.bbb-qqqqqqq-nn' where 'MMM' is the major version number, 'mmm' is the minor version number, 'bbb' is the bug fix number,' 'qqqqqqq' is an optional qualifier, and 'nn' is an optional build number. Such naming conventions offer immediate clarity and in the case of artifacts, enable cohesive and consistent organization of dependencies using their respective artifact coordinates.



Page 1 of 2   next page »
About Murali Kashaboina
Murali Kashaboina is a lead architect at Ecommerce Technology, United Airlines, Inc. He has more than 10 years of enterprise software development experience utilizing a broad range of technologies, including JEE, CORBA, Tuxedo, and Web services. Murali previously published articles in WLDJ and SilverStream Developer Center. He has masterÂ’s degree in mechanical engineering from the University of Dayton, Ohio.

About Geeth Narayanan
Geeth Narayanan is a senior architect at Ecommerce Technology, United Airlines, Inc. He has 10 years of experience in the IT industry, specializing in solutions using Java EE technologies. Geeth has master?s degree in electrical engineering from the University of Toledo, Ohio.

  Subscribe to our RSS feeds now and receive the next article instantly!
In It? Reprint It! Contact advertising(at)sys-con.com to order your reprints!
TODAY'S LATEST JAVA STORIES
JDJ Feature — Introduction to Maven 2
Maven is a promising application development lifecycle management framework coming from Apache's armory of open source tools. Maven was originally developed as a framework to manage and mitigate the complexities of building the Jakarta Turbine project and soon became a core entity of t
SOA, RIA and the Human Factor
While delivering a talk on SOA I've asked the audience the following question, 'What do you think is the driving force for implementing any technology or architecture in a decent size Enterprise?' The answers were typical: better code re-usability, accessibility? But I was looking for
JDJ Feature — Java API for XML Web Services (JAX-WS)
WebLogic Server 10 Technology Preview supports JEE 5. A feature of JEE 5 is the Java API for XML Web Services (JAX-WS) used to create Web Services and Web Service clients. WebLogic Server 10 provides the jwsc task to create the Web Service artifacts and the clientgen task to create the
What If I Actually Like HTML, CSS, and JavaScript?
I actually find the development experience between a modern web-application framework, Firebug, and current JavaScript libraries more than just bearable, I find it downright pleasant. Even more so because it's born out of the pragmatism of not needing to be perfect. It has evolved over
AJAX World - Spring and Java EE 5 (PART 1)
The Java Platform, Enterprise Edition, or Java EE, is the most popular middleware platform for developing and deploying enterprise applications. Java EE offers developers a choice of vendors, portability, scalability, and robustness. However, it has been criticized for its complexity a

FEATURED WHITE PAPERS
SUBSCRIBE TO THE WORLD'S MOST POWERFUL NEWSLETTERS
Receive Breaking i-Technology News as it Happens...
AJAX Newsletter
Java Newsletter
Open Source/Linux Newsletter
Microsoft .NET Newsletter
Flex Newsletter
Internet TV Newsletter
IT Solution's Guide Newsletter
 
SOA/Web Services Newsletter
Virtualization Newsletter
Web 2.0 Newsletter
ColdFusion Newsletter
PowerBuilder Newsletter
XML Newsletter
Eclipse Newsletter
Your E-Mail: 
State: 
Zip Code: 




TODAY'S TOP LINKS YOU MUST CLICK ON !
ADS BY GOOGLE