{"id":5993,"date":"2012-09-18T08:38:34","date_gmt":"2012-09-18T13:38:34","guid":{"rendered":"http:\/\/jianmingli.com\/wp\/?p=5993"},"modified":"2012-09-18T08:38:34","modified_gmt":"2012-09-18T13:38:34","slug":"sample-maven-webapp-project","status":"publish","type":"post","link":"https:\/\/jianmingli.com\/wp\/?p=5993","title":{"rendered":"Sample Maven Webapp Project"},"content":{"rendered":"

Sample Webapp Project<\/h2><\/span>\n

Generate Project<\/h3><\/span>\n

* Generate sample webapp by choosing archetype174<\/em>.
\n* Note that the numbers do change day by day so I ran command mvn archetype:generate > mvn_archetypes.txt<\/em> to find the exact number.<\/p>\n

\r\nmvn archetype:generate\r\n\r\nChoose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): 171: 174\r\nChoose org.apache.maven.archetypes:maven-archetype-webapp version:\r\n1: 1.0-alpha-1\r\n2: 1.0-alpha-2\r\n3: 1.0-alpha-3\r\n4: 1.0-alpha-4\r\n5: 1.0\r\nChoose a number: 5:\r\nDownloading: http:\/\/repo1.maven.org\/maven2\/org\/apache\/maven\/archetypes\/maven-archetype-webapp\/1.0\/maven-archetype-webapp-1.0.jar\r\n\r\nDownloading: http:\/\/repo1.maven.org\/maven2\/org\/apache\/maven\/archetypes\/maven-archetype-webapp\/1.0\/maven-archetype-webapp-1.0.pom\r\n\r\nDefine value for property 'groupId': : test.maven.one\r\nDefine value for property 'artifactId': : sample-webapp\r\nDefine value for property 'version': 1.0-SNAPSHOT:\r\nDefine value for property 'package': test.maven.one:\r\nConfirm properties configuration:\r\ngroupId: test.maven.one\r\nartifactId: sample-webapp\r\nversion: 1.0-SNAPSHOT\r\npackage: test.maven.one\r\nY:\r\n[INFO] ----------------------------------------------------------------------------\r\n[INFO] Using following parameters for creating project from Old (1.x) Archetype: maven-archetype-webapp:1.0\r\n[INFO] ----------------------------------------------------------------------------\r\n[INFO] Parameter: groupId, Value: test.maven.one\r\n[INFO] Parameter: packageName, Value: test.maven.one\r\n[INFO] Parameter: package, Value: test.maven.one\r\n[INFO] Parameter: artifactId, Value: sample-webapp\r\n[INFO] Parameter: basedir, Value: C:\\Users\\jli\r\n[INFO] Parameter: version, Value: 1.0-SNAPSHOT\r\n[INFO] project created from Old (1.x) Archetype in dir: C:\\Users\\jli\\sample-webapp\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] BUILD SUCCESSFUL\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Total time: 5 minutes 23 seconds\r\n[INFO] Finished at: Mon Feb 20 17:04:32 EST 2012\r\n[INFO] Final Memory: 22M\/215M\r\n[INFO] ------------------------------------------------------------------------\r\n<\/pre>\n
* sample-webapp folder generated <\/p>\n
\"\"<\/a><\/h6><\/span>\n
* Generated pom.xml
\n<\/em><\/p>\n
\r\n\r\n  4.0.0<\/modelVersion>\r\n  test.maven.one<\/groupId>\r\n  sample-webapp<\/artifactId>\r\n  war<\/packaging>\r\n  1.0-SNAPSHOT<\/version>\r\n  sample-webapp Maven Webapp<\/name>\r\n  http:\/\/maven.apache.org<\/url>\r\n  \r\n    \r\n      junit<\/groupId>\r\n      junit<\/artifactId>\r\n      3.8.1<\/version>\r\n      test<\/scope>\r\n    <\/dependency>\r\n  <\/dependencies>\r\n  \r\n    sample-webapp<\/finalName>\r\n  <\/build>\r\n<\/project>\r\n<\/pre>\n
* Run package<\/em>:<\/p>\n
\r\ncd sample-webapp\r\nmvn package\r\n<\/pre>\n
target <\/em>folder is generated for all packaging artifacts:<\/p>\n
\"\"<\/a><\/h6><\/span>\n
* Run install<\/em>: copy war file to local repository (while deploy <\/em>phase copy war file to remote repository)<\/p>\n
\r\n[INFO] [install:install {execution: default-install}]\r\n[INFO] Installing C:\\jml\\demo\\sample-webapp\\target\\sample-webapp.war to C:\\Users\\jli\\.m2\\repository\\test\\maven\\one\\sample-webapp\\1.0-SNAPSHOT\\sample-webapp-1.0-SNAPSHOT.war\r\n<\/pre>\n
Add a Java Source File<\/h3><\/span>\n
* Create package directories: test\/maven\/one<\/strong>
\n* Create a Java source file named HelloWorld.java<\/strong>:<\/p>\n
\r\npackage test.maven.one;\r\n\r\nimport org.apache.log4j.*;\r\n\r\npublic class HelloWorld {\r\n  Logger log = LogManager.getLogger(HelloWorld.class);\r\n\r\n  public String sayHello() {\r\n    String hello = \"Hello world!\";\r\n\t  log.info(hello);\r\n    return hello;\r\n  }\r\n}\r\n<\/pre>\n
* Create log4j.properties<\/strong> file in src\\main\\resources<\/em> directory:<\/p>\n
\r\nlog4j.rootLogger=debug, stdout\r\n \r\nlog4j.appender.stdout=org.apache.log4j.ConsoleAppender\r\nlog4j.appender.stdout.layout=org.apache.log4j.PatternLayout\r\n \r\n# Pattern to output the caller's file name and line number.\r\nlog4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n\r\n<\/pre>\n
* Add log4j dependency to pom.xml<\/em> file:<\/p>\n
\r\n   ...\r\n   \r\n     log4j<\/groupId>\r\n     log4j<\/artifactId>\r\n     1.2.14<\/version>\r\n   <\/dependency>\r\n\r\n  <\/dependencies>\r\n<\/pre>\n
* Do build<\/em>. Note that
\n– Log4j dependency is automatically resolved
\n– log4j-1.2.14.jar<\/em> is automatically downloaded and included in WEB-INF\/lib<\/em> directory
\n– Java class is compiled<\/p>\n
\r\nC:\\jml\\demo\\sample-webapp>mvn compile\r\n[INFO] Scanning for projects...\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Building sample-webapp Maven Webapp\r\n[INFO]    task-segment: [compile]\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] [resources:resources {execution: default-resources}]\r\n[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!\r\n[INFO] Copying 0 resource\r\nDownloading: http:\/\/repo1.maven.org\/maven2\/log4j\/log4j\/1.2.14\/log4j-1.2.14.pom\r\n\r\nDownloading: http:\/\/repo1.maven.org\/maven2\/log4j\/log4j\/1.2.14\/log4j-1.2.14.jar\r\n\r\n[INFO] [compiler:compile {execution: default-compile}]\r\n[INFO] Compiling 1 source file to C:\\jml\\demo\\sample-webapp\\target\\classes\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] BUILD SUCCESSFUL\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Total time: 2 seconds\r\n[INFO] Finished at: Mon Feb 20 17:51:20 EST 2012\r\n[INFO] Final Memory: 9M\/152M\r\n[INFO] ------------------------------------------------------------------------\r\n<\/pre>\n
* Do package<\/em>:<\/p>\n
\r\nmvn package\r\n<\/pre>\n
Specify JDK 1.5 Dependency<\/h3><\/span>\n
* In pom.xml, use build plugin to specify using jdk1.5 for compiling:<\/p>\n
\r\n  \r\n    sample-webapp<\/finalName>\r\n    \r\n        \r\n            org.apache.maven.plugins<\/groupId> \r\n            maven-compiler-plugin<\/artifactId>\r\n            2.0.2<\/version>\r\n            \r\n                1.5<\/source>\r\n                1.5<\/target>\r\n            <\/configuration>\r\n        <\/plugin>\r\n    <\/plugins>\r\n  <\/build>\r\n<\/pre>\n
Enforce Dependencies<\/h3><\/span>\n
* Enforce that commons-logging not <\/strong>to be used.<\/p>\n
\r\n     \r\n        org.apache.maven.plugins<\/groupId>\r\n        maven-enforcer-plugin<\/artifactId>\r\n        1.0-beta-1<\/version>\r\n         \r\n            \r\n                enforce-dependencies<\/id>\r\n                 \r\n                    enforce<\/goal> \r\n                <\/goals>\r\n                \r\n                    \r\n                        \r\n                            \r\n                                commons-logging:commons-logging<\/exclude>\r\n                            <\/excludes>\r\n                        <\/bannedDependencies>\r\n                    <\/rules> \r\n                <\/configuration>\r\n            <\/execution> \r\n        <\/executions>\r\n    <\/plugin>\r\n<\/plugins>\r\n<\/build>\r\n<\/pre>\n
* You will see in the output message when you do mvn compile<\/strong><\/p>\n
\r\n[INFO] [enforcer:enforce {execution: enforce-dependencies}]\r\n<\/pre>\n
Enable Unit Testing<\/h3><\/span>\n
* Add a test library dependency for TestNG<\/em><\/p>\n
\r\n     \r\n        org.testng<\/groupId>\r\n        testng<\/artifactId>\r\n        5.8<\/version>\r\n        jdk15<\/classifier>\r\n        test<\/scope>\r\n    <\/dependency>\r\n<\/pre>\n
* Add a test Java class file named HelloWorldTest  <\/strong>to test HelloWorld<\/em> in src\/main\/test\/java<\/em> directory:<\/p>\n
\r\npackage test.maven.one;\r\n\r\nimport org.apache.log4j.*;\r\nimport org.testng.annotations.*;\r\n\r\npublic class HelloWorldTest {\r\n\r\n  Logger log = LogManager.getLogger(HelloWorldTest.class);\r\n  private HelloWorld hw = new HelloWorld();\r\n\r\n  @Test\r\n  public void testSayHello() {\r\n    log.info(\"testSayHello...\");\r\n\r\n    assert \"Hello world!\".equals(hw.sayHello());\r\n  }\r\n\r\n}\r\n<\/pre>\n
* Run mvn test<\/strong><\/p>\n
\r\n-------------------------------------------------------\r\n T E S T S\r\n-------------------------------------------------------\r\nRunning TestSuite\r\n INFO [main] (HelloWorldTest.java:13) - testSayHello...\r\n INFO [main] (HelloWorld.java:12) - Hello world!\r\nTests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.36 sec\r\n\r\nResults :\r\n\r\nTests run: 1, Failures: 0, Errors: 0, Skipped: 0\r\n\r\n[INFO] -----------------------------------------------------------------\r\n[INFO] BUILD SUCCESSFUL\r\n[INFO] -----------------------------------------------------------------\r\n[INFO] Total time: 1 second\r\n[INFO] Finished at: Wed Feb 22 09:24:44 EST 2012\r\n[INFO] Final Memory: 14M\/215M\r\n[INFO] -----------------------------------------------------------------\r\n<\/pre>\n
* Report also generated in surefire-reports directory:<\/p>\n
\"\"<\/a><\/h6><\/span>\n
Test Webapp with Jetty Servlet Container<\/h3><\/span>\n
* Add Jetty plugin to pom.xml<\/p>\n
\r\n  \r\n    org.mortbay.jetty<\/groupId>\r\n    maven-jetty-plugin<\/artifactId>\r\n    6.1.10<\/version>\r\n    \r\n      9966<\/stopPort>\r\n      foo<\/stopKey>\r\n    <\/configuration>\r\n  <\/plugin>\r\n    <\/plugins>\r\n<\/build>\r\n<\/pre>\n
* Run Jetty with mvn jetty:run<\/strong><\/p>\n
\r\n[INFO] [jetty:run {execution: default-cli}]\r\n[INFO] Configuring Jetty for project: sample-webapp Maven Webapp\r\n[INFO] Webapp source directory = C:\\jml\\demo\\sample-webapp\\src\\main\\webapp\r\n[INFO] web.xml file = C:\\jml\\demo\\sample-webapp\\src\\main\\webapp\\WEB-INF\\web.xml\r\n[INFO] Classes = C:\\jml\\demo\\sample-webapp\\target\\classes\r\n2012-02-21 13:43:04.667::INFO:  Logging to STDERR via org.mortbay.log.StdErrLog\r\n[INFO] Context path = \/sample-webapp\r\n[INFO] Tmp directory =  determined at runtime\r\n[INFO] Web defaults = org\/mortbay\/jetty\/webapp\/webdefault.xml\r\n[INFO] Web overrides =  none\r\n[INFO] Webapp directory = C:\\jml\\demo\\sample-webapp\\src\\main\\webapp\r\n[INFO] Starting jetty 6.1.10 ...\r\n2012-02-21 13:43:05.029::INFO:  jetty-6.1.10\r\n2012-02-21 13:43:05.398::INFO:  No Transaction manager found - if your webapp re\r\nquires one, please configure one.\r\n2012-02-21 13:43:06.115::INFO:  Started SelectChannelConnector@0.0.0.0:8080\r\n[INFO] Started Jetty Server\r\n<\/pre>\n
* View page from web browser:<\/p>\n
\"\"<\/a><\/h6><\/span>\n
* Stop Jetty with: mvn jetty:stop<\/strong> (or ctr-C)<\/p>\n
\r\nC:\\jml\\demo\\sample-webapp>mvn jetty:stop\r\n[INFO] Scanning for projects...\r\n[INFO] -----------------------------------------------------\r\n[INFO] Building sample-webapp Maven Webapp\r\n[INFO]    task-segment: [jetty:stop]\r\n[INFO] -----------------------------------------------------\r\n[INFO] Preparing jetty:stop\r\n[INFO] [enforcer:enforce {execution: enforce-dependencies}]\r\n[INFO] [jetty:stop {execution: default-cli}]\r\n[INFO] -----------------------------------------------------\r\n[INFO] BUILD SUCCESSFUL\r\n[INFO] -----------------------------------------------------\r\n[INFO] Total time: 4 seconds\r\n[INFO] Finished at: Tue Feb 21 14:00:43 EST 2012\r\n[INFO] Final Memory: 12M\/218M\r\n[INFO] -----------------------------------------------------\r\n<\/pre>\n
Generate Site Report<\/h3><\/span>\n
* Run mvn site<\/strong>
\n* Site report generated in target\/site<\/em> directory
\n* Double click index.html to view site:<\/p>\n
\"\"<\/a><\/h6><\/span>\n
References<\/h2><\/span>\n
* Apache Maven 2 Effective Implementation By: Brett Porter; Maria Odea Ching<\/p>\n","protected":false},"excerpt":{"rendered":"
Sample Webapp Project Generate Project * Generate sample webapp by choosing archetype174. * Note that the numbers do change day by day so I ran command mvn archetype:generate > mvn_archetypes.txt to find the exact number. mvn archetype:generate Choose a number … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[128],"tags":[605,249,250],"class_list":["post-5993","post","type-post","status-publish","format-standard","hentry","category-maven","tag-maven","tag-sample","tag-webapp"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p8cRUO-1yF","_links":{"self":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts\/5993","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5993"}],"version-history":[{"count":2,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts\/5993\/revisions"}],"predecessor-version":[{"id":5995,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=\/wp\/v2\/posts\/5993\/revisions\/5995"}],"wp:attachment":[{"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5993"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5993"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/jianmingli.com\/wp\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5993"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}