Faster, Higher, Stronger
更快,更高,更强

MAC Pro下使用IntelliJ IDEA创建maven spring mvc项目

为了接下来能比较容易上手后端项目,结合目前所做项目的后端开发们使用的是spring mvc而非spring boot。决定先把基本的java开发环境配置好,先跑一个本地服务能看到页面再说。我是按着http://www.cnblogs.com/Sinte-Beuve/p/5730553.html这篇文章的教程来的,所以内容大体一致,再写一遍主要是为了加深自己的印象。

最最基础的,你需要先装好java、maven和tomcat(tomcat选装,如果用jetty等其他web容器,就用不到tomcat了,不过tomcat还是用的最广泛的,出于学习的目的,还是装下比较好),这部分内容之前有写过文章《Macbook Pro安装Maven 3 》。然后开始下面的流程:

一、预备信息

因为软件什么的更新频率还是蛮快的,我先亮一下我用的软件相关信息,咱们的工具越像的话,这篇文章的参考价值会越高:

关于IDEA:

其他信息:

mvn -v
Apache Maven 3.5.0 (ff8f5e7444045639af65f6095c62210b5713f426; 2017-04-04T03:39:06+08:00)
Maven home: /usr/local/apache-maven-3.5.0
Java version: 1.8.0_131, vendor: Oracle Corporation
Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk/Contents/Home/jre
Default locale: zh_CN, platform encoding: UTF-8
OS name: "mac os x", version: "10.12.6", arch: "x86_64", family: "mac"

二、用maven创建webapp骨架

首先,菜单栏:File=>New=>Project…,然后按下面这样操作:

  1. 选择Maven;
  2. 勾选Create from archetype;
  3. 选择org.apache.maven.archetypes:maven-archetype-webapp;
  4. 点Next。

然后填写GroupId、ArtifactId,版本号默认1.0-SNAPSHOT就行:

再一个然后,选择maven相关设置(/Users/yakima/.m2/settings.xml这个文件我本地还没有,截图里这个是默认的路径,我用maven中央仓库速度就挺好的了,这种demo项目也不涉及私有架包,所以感觉目前也没必要写一个setting.xml文件,都用默认的就好了),这里选一下Maven home directory里的东西就可以了。

然后填写项目名和项目地址,最后点击Finish按钮:

三、完善项目目录结构

下面是最终的目录结构(如果按上面的步骤走到这里,你的目录结构肯定跟这里是有差异的,先放出来是为了让大家有个大概的轮廓在脑子里,而且下面单独说文件的时候也不至于出现不知道我说的文件该放在哪个位置的问题)。

src/main/java:开发目录(程序源码,Sources Root)

src/main/java目录本来是没有的,是我们手动添加的目录,请注意java目录的图标是有特别的颜色的(截图里是蓝色),这是我将其标记为Sources Root目录的结果,只有将文件夹标记为Sources Root后,才能通过IDEA右键该文件夹后通过菜单直接在其下创建package和class。要将一个目录标记为Sources Root,只需要鼠标右键该文件夹=>Mark Directory as=>Sources Root。将src/main/java目录标记为Sources Root后在其下创建com.example.controller包,并在controller同级位置创建dao、pojo和service三个微笑(就叫微笑吧,我不知道这个该叫啥,下面一个文件都没有,不知道算不算包-_-)。

src/main/resources:资源目录(Resources Root)

资源目录下的文件是会被编译到输出目录下的。跟上面标记src/main/java目录的方法类似,若src/main/resources目录尚未被标记为Resources Root则需要手动将其标记为Resources Root。不过好像这个文件夹默认就已经被标注为Resources Root了。

src/test:单元测试目录

下面的开发目录为src/test/java,资源目录为src/test/resources。

四、配置Maven的pom.xml

完整的配置文件贴于此:

<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.example</groupId>
  <artifactId>maven-springmvc</artifactId>
  <packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <name>maven-springmvc Maven Webapp</name>
  <url>http://maven.apache.org</url>
  <dependencies>
    <!--日志包-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.21</version>
    </dependency>

    <!--j2ee相关包 servlet、jsp、jstl-->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>jsp-api</artifactId>
      <version>2.2</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>jstl</artifactId>
      <version>1.2</version>
    </dependency>

    <!--mysql驱动包-->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.35</version>
    </dependency>

    <!--spring相关包-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>4.3.1.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>4.3.1.RELEASE</version>
    </dependency>

    <!--其他需要的包-->
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-lang3</artifactId>
      <version>3.4</version>
    </dependency>
    <dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.3.1</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>maven-springmvc</finalName>
    <resources>
      <!--表示把java目录下的有关xml文件,properties文件编译/打包的时候放在resource目录下-->
      <resource>
        <directory>${basedir}/src/main/java</directory>
        <includes>
          <include>**/*.properties</include>
          <include>**/*.xml</include>
        </includes>
      </resource>
      <resource>
        <directory>${basedir}/src/main/resources</directory>
      </resource>
    </resources>
    <plugins>
      <!--servlet容器 jetty插件-->
      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.3.10.v20160621</version>
      </plugin>
    </plugins>
  </build>
</project>

更新完pom.xml后,IDEA应该会自动下载相应的jar包,如果没有自动下载,请手动右键pom.xml文件,选择Maven=>Reimport来手下载相应的jar包。

五、配置web.xml

maven项目默认生成的2.3版。覆盖为以下内容:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
          http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
         version="3.0">
  <!--welcome pages-->
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>

  <!--配置springmvc DispatcherServlet-->
  <servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <!--Resources标注的文件夹下需要新建一个spring文件夹-->
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring/spring-mvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
    <async-supported>true</async-supported>
  </servlet>
  <servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
</web-app>

其中DispatcherServlet是分发http请求用的。

六、配置contextConfigLocation

在刚才的web.xml文件中,可以看到contextConfigLocation这个param name,其值为classpath:spring/spring-mvc.xml。我们在src/main/resources下新建一个spring目录,并在其下新建一个spring-mvc.xml文件。spring-mvc.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:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       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
                        http://www.springframework.org/schema/mvc
                        http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--启用spring的一些annotation -->
    <context:annotation-config/>

    <!-- 自动扫描该包,使SpringMVC认为包下用了@controller注解的类是控制器 -->
    <context:component-scan base-package="com.example.controller">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

    <!--HandlerMapping 无需配置,springmvc可以默认启动-->

    <!--静态资源映射-->
    <!--本项目把静态资源放在了WEB-INF的statics目录下,资源映射如下-->
    <mvc:resources mapping="/css/**" location="/WEB-INF/statics/css/"/>
    <mvc:resources mapping="/js/**" location="/WEB-INF/statics/js/"/>
    <mvc:resources mapping="/image/**" location="/WEB-INF/statics/image/"/>

    <!--但是项目部署到linux下发现WEB-INF的静态资源会出现无法解析的情况,但是本地tomcat访问正常,因此建议还是直接把静态资源放在webapp的statics下,映射配置如下-->
    <!--<mvc:resources mapping="/css/**" location="/statics/css/"/>-->
    <!--<mvc:resources mapping="/js/**" location="/statics/js/"/>-->
    <!--<mvc:resources mapping="/image/**" location="/statics/images/"/>-->

    <!-- 配置注解驱动 可以将request参数与绑定到controller参数上 -->
    <mvc:annotation-driven/>

    <!-- 对模型视图名称的解析,即在模型视图名称添加前后缀(如果最后一个还是表示文件夹,则最后的斜杠不要漏了) 使用JSP-->
    <!-- 默认的视图解析器 在上边的解析错误时使用 (默认使用html)- -->
    <bean id="defaultViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
        <property name="prefix" value="/WEB-INF/views/"/><!--设置JSP文件的目录位置-->
        <property name="suffix" value=".jsp"/>
    </bean>

    <!-- springmvc文件上传需要配置的节点-->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <property name="maxUploadSize" value="20971500"/>
        <property name="defaultEncoding" value="UTF-8"/>
        <property name="resolveLazily" value="true"/>
    </bean>
</beans>

七、配置log4j.properties

日志文件是debug中一个不可缺少的工具,因此添加log4j日志包。在src/main/resources下新建log4j.properties文件,该配置文件内容如下:

#配置根Logger 后面是若干个Appender
log4j.rootLogger=DEBUG,A1,R
#log4j.rootLogger=INFO,A1,R

# ConsoleAppender 输出
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n

# File 输出 一天一个文件,输出路径可以定制,一般在根路径下
log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File=log.txt
log4j.appender.R.MaxFileSize=500KB
log4j.appender.R.MaxBackupIndex=10
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%t] [%c] [%p] - %m%n

八、controller和view的编写

在src/main/java/com.example.controller下新建HomeController文件,内容如下:

package com.example.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * Created by yakima on 2017/10/9.
 */
// 注解标注此类springmvc的controller, url映射为"/home"
@Controller
@RequestMapping("/home")
public class HomeController {
    // 添加一个日志器
    private static final Logger logger = LoggerFactory.getLogger(HomeController.class);

    // 添加一个action
    @RequestMapping("/index")
    public String index () {
        // 输出日志文件
        logger.info("the first jsp pages");
        // 用户访问/home/index会返回webapp/WEB-INF/views/index.jsp这个视图
        return "index";
    }
}

在src/main/webapp/WEB-INF/views下新建index.jsp文件,内容如下:

<%--
  Created by IntelliJ IDEA.
  User: yakima
  Date: 2017/10/9
  Time: 下午3:32
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
This is a placeholder html page!
</body>
</html>

至此,基本的代码编写工作就完成了。

九、servlet容器的配置和运行

servlet容器有两种配置方式:

  1. 配置本地的tomcat服务器;
  2. 配置maven插件;

下面分别介绍(要跑服务的话,只要配一个就可以了,当然你配两个选一个来跑也是可以的)。

方法一:配置本地的tomcat服务器

菜单栏=>Run=>Edit Configurations…,然后按下图操作:

请注意,上图3处的Update classes and resources选项一开始是没有的,一开始只有一个Restart Server选项。需要点击Server选项卡旁边的Deployment选项卡,点击+号=>Artifact…来添加war exploded,然后再切换回Server选项卡,这时候就有Update classes and resources这个选项可以选来。

方法二:配置maven插件

maven插件有tomcat和jetty等,两者都是servlet容器。jetty插件的配置我们已经在pom.xml文件中完成了。现在在IDEA中配置jetty。

菜单栏=>Run=>Edit Configurations…,然后按下图操作:

十、运行程序

选择jetty或tomcat然后点击Run按钮即可,示例如图(选择了tomcat):

赞(0) 打赏
未经允许不得转载:峰间的云 » MAC Pro下使用IntelliJ IDEA创建maven spring mvc项目

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏