IntelliJ IDEA 创建 Maven 管理下的 SSM 项目基础全过程

2018.06

本文适合SSM新手玩家，同样作为作者SSM搭建过程的中文记录。

1. Maven安装及配置 —— 多模块工程依赖管理解决方案

Maven官方文档

Maven依赖搜索

i.安装

这里仅给出macOS系统的安装方式：

homebrew —— 一条命令完成下载安装以及环境变量的配置

brew install maven

将 /usr/local/Cellar/maven/3.5.3/libexec/conf/setting.xml 文件拷贝至Users/你的用户名/.m2目录

（该文件配置将优先于前者）

推荐一些源（在.m2/setting.xml文件里面配置）

<mirror>
      <id>UK</id>
      <mirrorOf>central</mirrorOf>
      <name>UK Central</name>
      <url>http://uk.maven.org/maven2</url>
    </mirror>

    <!-- 中央仓库1 -->
    <mirror>
        <id>repo1</id>
        <mirrorOf>central</mirrorOf>
        <name>Human Readable Name for this Mirror.</name>
        <url>http://repo1.maven.org/maven2/</url>
    </mirror>

    <!-- 中央仓库2 -->
    <mirror>
        <id>repo2</id>
        <mirrorOf>central</mirrorOf>
        <name>Human Readable Name for this Mirror.</name>
        <url>http://repo2.maven.org/maven2/</url>
    </mirror>

    <!-- 阿里云 -->
    <mirror>
      <id>alimaven</id>
      <mirrorOf>central</mirrorOf>
      <name>aliyun maven</name>
      <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
    </mirror>

    <!-- 开源中国 -->
    <mirror>
      <id>nexus-osc</id>
      <mirrorOf>*</mirrorOf>
      <name>Nexus osc</name>
      <url>http://maven.oschina.net/content/groups/public/</url>
  </mirror>

国内的源，阿里、163、网易等，速度较快，但部分不常用jar包可能没有。

ii . 选择maven的webapp模版

 

iii. GroupId和ArtifactId的配置 。

GroupId和ArtifactId“坐标”，保证项目唯一性，在maven本地仓库，根据这两个id去查找。

GroupID对应项目组织唯一的标识符, main目录里java的目录结构, 第一段为域，第二段为公司名称,第三段为项目名， 常见的域org为非营利组织，com为商业组织. cn为中国。

ArtifactID对应Maven项目(模块)的唯一的标识符, 项目根目录的名, 如果是模块用项目名作为前缀比较好。

 

iv. 选择maven路径及配置。

该行指定下载archetype元数据，目的是加快Maven项目创建时的数据下载速度，根据实际情况添加，我的网络环境测试结果为无差别。

 

v. Finish ->等待下载生成src目录。

 

vi. 手动创建目录结构如下, 配置文件显红，IDEA强大的自动纠错功能大概可以帮你解决。

 

v. pom.xml概览

该配置文件主要分为三个区域：

<properties>属性区

<dependencies>依赖区

<plugins>插件区

按照固定的格式，向项目添加对应的依赖（jar）和插件，属性是针对于Maven的。

了解它们的作用，用时再添加。

2. mysql-connector-java（jdbc连接mysql驱动）

官网地址

根据自己mysql版本选择合适的Connector/J 

目前最新版为5.1.46

加入依赖如下：

<!--mysql-->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.46</version>
</dependency>

在 main/resources目录下创建 .properties文件, 我的命名为jdbc.properties，基本配置代码如下

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/1806_mall?autoReconnect=true&useSSL=false
jdbc.username=root
jdbc.password=

3. 安装Mybatis   —— 持久层框架

i. 下载

Mybatis下载地址

Mybatis官方文档

下载release（发布）版本，同时可以下载Source code（源码）其中包含一些示范代码。

 

ii. 将mybatis-3.4.5.jar放至lib文件夹中，右键->点击Add as Library

确定即可

 

iii. 推荐maven安装的方式

前面简单的体验一下一般的安装方式，这里推荐maven安装，在pow.xml中加入如下依赖配置即可maven会帮助你，一步到位。

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.4.6</version>
</dependency>

如未自动下载可点击右下角图标，弹出窗口点击import Changes，也可选择自动引入。

 

iv. 感受一波mybatis的应用

若有实战需求可参考以下视频，重在感受mybatis的使用

通过自动回复机器人学Mybatis---基础版

a. 创建mybatis配置文件

在src/main/resources/mybatis中创建SqlMapConfig.xml文件。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
  <properties resource="./properties/jdbc.properties"/>
  <environments default="development">
    <!-- development:开发环境 work:工作模式 -->
    <environment id="development">
      <transactionManager type="JDBC" />
      <!-- 数据库连接方式 -->
      <dataSource type="POOLED">
        <property name="driver" value="${jdbc.driver}" />
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="" />
      </dataSource>
    </environment>
  </environments>
</configuration>

该配置并非必要的，SSM项目中连接数据库的文件并不是它。

3. Mybatis-generator —— “逆向工程”根据数据库表自动生成Java代码

官方文档

中文文档

这里我选择使用Maven通过插件运行Mybatis-generator的方式

i. 在maven配置文件插件部分加入如下代码：

<!--mybatis代码自动生成-->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>${mybatis-generator.version}</version>
  <!--让MGB作为Maven构建的一部分自动执行-->
    <executions>
      <execution>
        <id>Generate MyBatis Artifacts</id>
        <goals>
          <goal>generate</goal>
        </goals>
      </execution>
    </executions>
</plugin>

ii. 创建 main/resources/generatorConfig.xml 文件

这个应该是会自动扫描的，可放在resources目录下任意处

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
  <!--引入配置文件-->
  <properties resource="jdbc.properties"/>
  <!--指定数据连接驱动mysql-connector-java.jar地址-->
  <classPathEntry location="/Users/yangxinyu/.m2/repository/mysql/mysql-connector-java/5.1.46/mysql-connector-java-5.1.46.jar" />

  <!--一个数据库一个context-->
  <context id="mysqlTables" targetRuntime="MyBatis3">

    <commentGenerator>
      <property name="suppressAllComments" value="true"/>
      <property name="suppressDate" value="true"/>
    </commentGenerator>

    <jdbcConnection driverClass="${jdbc.driver}"
                    connectionURL="${jdbc.url}"
                    userId="${jdbc.username}"
                    password="">
    </jdbcConnection>

    <!--指定生成的类型为java类型, false可自动转化以下类型（Long, Integer, Short, etc.）-->
    <javaTypeResolver>
      <property name="forceBigDecimals" value="false" />
    </javaTypeResolver>

    <!--生成的实体类地址-->
    <javaModelGenerator targetPackage="cn.yang.ssm.model" targetProject="src/main/java">
      <!-- false路径com.oop.eksp.user.model，true:com.oop.eksp.user.model.[schemaName] -->
      <property name="enableSubPackages" value="true" />
      <!--是否针对string类型的字段在set的时候进行trim调用-->
      <property name="trimStrings" value="true" />
    </javaModelGenerator>

    <!--生成Mapper.xml文件地址-->
    <sqlMapGenerator targetPackage="cn.yang.ssm.mapper" targetProject="src/main/java">
      <property name="enableSubPackages" value="true" />
    </sqlMapGenerator>

    <!--自动生成的*Mapper.java存放路径-->
    <javaClientGenerator targetPackage="cn.yang.ssm.dao" targetProject="src/main/java" type="XMLMAPPER">
      <property name="enableSubPackages" value="true" />
    </javaClientGenerator>

    <!--配置数据库表信息-->
    <table tableName="%">
      <!--<generatedKey column="ID" sqlStatement="DB2" identity="true" />-->
      <!--<columnOverride column="DATE_FIELD" property="startDate" />-->
      <!--<ignoreColumn column="FRED" />-->
      <!--<columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />-->
    </table>
  </context>
</generatorConfiguration>

iii. 在终端项目路径下执行：mvn mybatis-generator:generate

mapper.xml累加，其他会覆盖。

遇到问题如下： [WARNING] The specified target project directory .\src\main\java does not exist

解决方法：先用绝对路径运行，再改回相对路径（这个坑有点奇怪额。。。）

iv. 总结

逆向工程大大提升了我们编写程序的效率，自动生成的文件可以基本满足前期的开发需求。

如果将前面的这段代码：

<sqlMapGenerator targetPackage="cn.yang.ssm.mapper" targetProject="src/main/java">

改为：

<sqlMapGenerator targetPackage="src.main.java.cn.yang.ssm.mapper" targetProject="MAVEN">

mapper文件夹将在target目录里面生成。

 

4. Spring整合mybatis

mybatis-spring官方文档

mybatis-spring中文文档

druid数据库连接池下载地址

i. 导入jar包

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>1.3.2</version>
</dependency>
<!--druid-->
  <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>${druid.version}</version>
</dependency>

ii. 创建配置文件，applicationContext.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:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">

  <!-- 扫描service包下所有使用注解的类型 -->
  <context:component-scan base-package="cn.yang.ssm.service"/>
  <!-- 配置数据库相关参数properties的属性：${url} -->
  <context:property-placeholder location="classpath:properties/jdbc.properties"/>
  <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
    <!-- 基本属性 url、user、password -->
    <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />

    <!-- 配置初始化大小、最小、最大 -->
    <property name="initialSize" value="1" />
    <property name="minIdle" value="1" />
    <property name="maxActive" value="20" />

    <!-- 配置获取连接等待超时的时间 -->
    <property name="maxWait" value="60000" />

    <!-- 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 -->
    <property name="timeBetweenEvictionRunsMillis" value="60000" />

    <!-- 配置一个连接在池中最小生存的时间，单位是毫秒 -->
    <property name="minEvictableIdleTimeMillis" value="300000" />

    <property name="validationQuery" value="SELECT 'x'" />
    <property name="testWhileIdle" value="true" />
    <property name="testOnBorrow" value="false" />
    <property name="testOnReturn" value="false" />

    <!-- 打开PSCache，并且指定每个连接上PSCache的大小,分库分表较多的数据库，建议配置为false-->
    <property name="poolPreparedStatements" value="true" />
    <property name="maxPoolPreparedStatementPerConnectionSize" value="20" />

    <!-- 配置监控统计拦截的filters -->
    <property name="filters" value="stat" />
  </bean>

  <!-- 配置SqlSessionFactory对象 -->
  <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <!-- 注入数据库连接池 -->
    <property name="dataSource" ref="dataSource"/>
    <!-- 扫描entity包 使用别名 -->
    <property name="typeAliasesPackage" value="cn.yang.ssm.model"/>
    <!-- 扫描sql配置文件:mapper需要的xml文件 -->
    <property name="mapperLocations" value="classpath:/mybatis/mapper/*.xml"/>
  </bean>

  <!-- 配置扫描Dao接口包，动态实现Dao接口，注入到spring容器中 -->
  <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <!-- 注入sqlSessionFactory -->
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    <!-- 给出需要扫描Dao接口包 -->
    <property name="basePackage" value="cn.yang.ssm.mapper"/>
  </bean>

  <!--事务管理-->
</beans>

iii. Spring特性

相对于单纯的使用mybatis，这里实现了动态实现Dao接口注入到spring容器。

5. SpringMVC配置

i. 导入jar包

    <!-- Spring -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-core</artifactId>
      <version>${spring.version}</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-beans</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>

ii. 配置web.xml

  <!-- 配置DispatcherServlet -->
  <servlet>
    <servlet-name>SpringMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 配置springMVC需要加载的配置文件-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring-*.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>

iii. 资源文件目录下子目录spring中创建springmvc-servlet.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.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd">
  <!-- scan the package and the sub package -->
<context:component-scan base-package="cn.yang.ssm.controller"/>
  <!-- don't handle the static resource -->
<mvc:default-servlet-handler/>
  <!-- if you use annotation you must configure following setting -->
<mvc:annotation-driven/>
  <!-- configure the InternalResourceViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
      id="internalResourceViewResolver">
  <!-- 前缀 -->
  <property name="prefix" value="/WEB-INF/views/"/>
  <!-- 后缀 -->
  <property name="suffix" value=".jsp"/>
</bean>
</beans>

IV. 创建控制器文件，TestController.java

package cn.yang.ssm.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @program: ssm
 * @description: 静态页面测试控制
 * @author: yangxinyu
 * @create: 2018-07-17 11:33
 **/
@Controller
@RequestMapping("/admin")
public class TestController {

    @RequestMapping("/login")
    public String test(){
        return "login";
    }
}

V. 前端代码布置   SSM中的View层

a. 目录介绍

WEB-INF是客户端无法访问，只有服务端可以访问的目录。

webapp是根目录，若index.jsp放在该目录下，通过http://127.0.0.1:8080/index.jsp可以访问。

验证WEB-INF为安全目录的方法:

http://127.0.0.1:8080/WEB-INF/views/admin/login/login.jsp 浏览器显示404

b. jsp样式引用

AdminlLTE后台模版使用MIT协议

<link rel="stylesheet" href="${pageContext.request.contextPath}/resources/adminlte/

踩坑：修改AdminLTE的文件名为小写，重新运行，IDEA的target未更新。

Maven自动生成的web.xml为2.4版本，${pageContext.request.contextPath}未能解析，EL表达式不支持

替换代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">

c. servlet映射

  <!-- 配置DispatcherServlet -->
  <servlet>
    <servlet-name>SpringMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 配置springMVC需要加载的配置文件-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring/springmvc-*.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>SpringMVC</servlet-name>
    <!-- 匹配所有请求 -->
    <url-pattern>/</url-pattern>
  </servlet-mapping>

d. 创建springmvc-servlet.xml在资源目录的spring文件夹下

<?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.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd">
  <!-- 自动扫描包 -->
  <context:component-scan base-package="cn.yang.ssm.controller"/>
  <!-- 处理静态资源被拦截问题，如果web.xml中如果配置了/则此处需要配置，否则不需要 -->
  <mvc:default-servlet-handler/>
  <!-- if you use annotation you must configure following setting -->
  <mvc:annotation-driven/>
  <!-- configure the InternalResourceViewResolver -->
  <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
      id="internalResourceViewResolver">
    <!-- 前缀 -->
    <property name="prefix" value="/WEB-INF/views/"/>
    <!-- 后缀 -->
    <property name="suffix" value=".jsp"/>
  </bean>
</beans>

VI. Tomctat配置

VI. 运行程序

http://localhost:8080/admin/login

6.单元测试

i. 引入jar包

  <dependencies>
    <!--junit-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.0.1</version>
      <scope>test</scope>
    </dependency>

ii. 与main目录同级建立test文件夹

在需要建立单元测试的类中点击快捷键command+shift+t（command很多情况下相当于windows系统的ctrl键）

iii. 点击创建，选中member

iv. 编写测试类

- 对pojo进行测试

package cn.yang.ssm.controller;

import org.junit.Test;
import static org.junit.Assert.*;

public class LoginControllerTest {

    @Test
    public void test1() throws Exception{
        LoginController controller = new LoginController();
        assertEquals("/admin/login/login",controller.test());
    }
}

- SpringMVC特性测试

package cn.yang.ssm.controller;

import org.junit.Test;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.view;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup;

public class LoginControllerTest {
    @Test
    public void test1() throws Exception {
        LoginController controller = new LoginController();
        MockMvc mockMvc =
                standaloneSetup(controller).build();
        mockMvc.perform(get("/admin/login"))
                .andExpect(view().name("/admin/login/login"));
    }
}

踩坑点：Java.lang.NoClassDefFoundError: javax/servlet/SessionCookieConfig

原因：未添加javax.servlet依赖

-- NORMAL --