使用 maven 创建 java web 工程

本文主要讲述使用 maven 命令行的形式来创建  java web 工程

开发环境

• jdk 1.7
• maven 3.5.0
• spring 3.2
• tomcat 7
• eclipse Mars Release (4.5.0)

1.  maven 来构建 java web 骨架

 mvn archetype:generate -DgroupId=com.reycg -DartifactId=MVC-HelloWorld -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false

2. 添加对 eclipse IDE 的支持

执行下面命令

mvn eclipse:eclipse -Dwtpversion=2.0

 上面命令中的选项 -Dwtpversion=2.0  表示告诉 maven 将该项目转化成 eclipse web 项目。

  在 eclipse 中 依次点击 Eclipse IDE – File -> Import… -> General -> Existing Projects into workspace 将项目导入到 eclipse 中。

 导入成功后的 eclipse 项目工程如下图

3.  在 pom.xml 中添加需要的项目依赖

添加必须项目依赖后的 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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.reycg</groupId>
  <artifactId>MVC-HelloWorld</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>MVC-HelloWorld Maven Webapp</name>
  <url>http://maven.apache.org</url>

  <properties>
    <jdk.version>1.7</jdk.version>
    <spring.version>3.2.0.RELEASE</spring.version>
    <junit.version>4.8.2</junit.version>
    <log4j.version>1.2.17</log4j.version>
    <jstl.version>1.2</jstl.version>
    <junit.version>4.11</junit.version>
  </properties>

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

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <!-- jstl -->
    <dependency>
      <groupId>jstl</groupId>
      <artifactId>jstl</artifactId>
      <version>${jstl.version}</version>
    </dependency>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>${junit.version}</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>MVC-HelloWorld</finalName>
    <plugins>
      <!-- Eclipse 项目工程配置 -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-eclipse-plugin</artifactId>
        <version>2.9</version>
        <configuration>
          <!-- Always download and attach dependencies source code -->
          <downloadSources>true</downloadSources>
          <downloadJavadocs>true</downloadJavadocs>
          <!-- mvn eclipse:eclipse -Dwtpversion=2.0 -->
          <wtpversion>2.0</wtpversion>
        </configuration>
      </plugin>

      <!-- 使用 JDK 1.7 进行编译 -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>2.3.2</version>
        <configuration>
          <source>${jdk.version}</source>
          <target>${jdk.version}</target>
        </configuration>
      </plugin>

      <!-- for tomcat run: mvn tomcat:run -->
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.2</version>
        <configuration>
          <path>/MVC-HelloWorld</path>
        </configuration>
      </plugin>
    </plugins>

  </build>
</project>

4. 添加部署描述文件 web.xml 以及 spring 配置文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://java.sun.com/xml/ns/javaee"
        xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
        version="3.0">
  <servlet>
    <servlet-name>mvc-dispatcher</servlet-name>
    <servlet-class>
      org.springframework.web.servlet.DispatcherServlet
    </servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>/WEB-INF/classes/spring/spring-all.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>mvc-dispatcher</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>/WEB-INF/classes/spring/spring-all.xml</param-value>
  </context-param>
  <listener>
    <listener-class>
      org.springframework.web.context.ContextLoaderListener
    </listener-class>
  </listener>
  <welcome-file-list>
      <welcome-file>/</welcome-file>
  </welcome-file-list>
  <display-name>MVC-HelloWorld</display-name>
</web-app>

在 web.xml 中可看出

• contextConfigLocation 加载的文件是 spring-all.xml，里面应该包含 spring 配置信息。
• DispatcherServlet 配置中的 init-param contextConfigLocation 也配置成了 spring-all.xml

根据 web.xml 中的配置， 在 resources/spring 目录下添加 spring-all.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="
               http://www.springframework.org/schema/beans
               http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
               http://www.springframework.org/schema/context
               http://www.springframework.org/schema/context/spring-context-3.2.xsd">

  <context:component-scan base-package="com.reycg.helloworld.controller.**" />
  <bean
      class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix">
      <value>/WEB-INF/jsp/</value>
    </property>
    <property name="suffix">
      <value>.jsp</value>
    </property>
  </bean>
</beans>

• <context:component-scan 用来配置要组件扫描的基础包

 5. 添加 controller 以及对应的视图

在 package com.reycg.helloworld.controller 中添加 BaseController 用来处理 MVC-HelloWorld 中的请求

package com.reycg.helloworld.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class BaseController {
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String Welcome(Model model) {
        model.addAttribute("WelcomeMsg", "HelloWorld!");
        return "index";
    }    
}

根据 spring-all.xml 中对视图解析器的配置， index.jsp 应该放在 /WEB-INF/jsp/ 目录下

<html>
<body>
<h2>${WelcomeMsg}</h2>
</body>
</html>

6.  打包和在 tomcat 中运行

可以在命令行中使用

mvn package

打包成 war 包，将其放在 tomcat/webapps 目录下运行 tomcat

在浏览器中输入 localhost:8080/MVC-HelloWorld 来运行这个工程。

也可以在 eclipse 中添加 server 来运行这个工程。

7. 参考 & 鸣谢

本文的实现部分参考了下面链接，在此对 mkyong 表示感谢！

https://www.mkyong.com/maven/how-to-create-a-web-application-project-with-maven/