Spring整合系列： idea Spring5+SpringMVC+Mybatis

最近有個師弟在問我關於SSM整合的問題，我也閒來無事搞了一個基礎架構起來，給他們做模板使用。

所需的框架：

1. 主要框架：Spring5、SpringMVC、Mybatis
2. 輔助框架：mysql驅動、Druid數據連接池、Junit4、Spring-test、Json（阿里）、Lombok、Log4j

開發的平台：IDEA 2018.3.2、tomcat9
開始構建項目：
1.第一步：

使用模板構建Maven項目，選擇org.apache.maven開頭的。

編寫GroupId與ArtifactId

選擇Maven版本

然後繼續點擊Next，再點擊Finish即可；
進來項目以後，點擊Enable Auto-Import，稍等一會兒。項目文件就會加載完成。

生成後點擊右上角的文件項目文件管理器，手動創建文件。

之後在pom.xml文件裡開始添加框架
PS:搜索框架用的Maven存儲庫。https://mvnrepository.com/

<?xml version="1.0" encoding="UTF-8"?>

<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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.moonlit</groupId>
  <artifactId>TestSSM</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>TestSSM Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>

  <dependencies>
    <!-- Spring -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>5.1.6.RELEASE</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-orm</artifactId>
      <version>5.1.6.RELEASE</version>
    </dependency>
    <!-- spring-test -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
      <version>5.1.6.RELEASE</version>
      <scope>test</scope>
    </dependency>

    <!-- Spring-mvc -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.1.6.RELEASE</version>
    </dependency>

    <!-- mybatis -->
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.5.1</version>
    </dependency>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>2.0.1</version>
    </dependency>

    <!-- mysql -->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>8.0.16</version>
    </dependency>
    <!-- Druid -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid</artifactId>
      <version>1.1.16</version>
    </dependency>

    <!-- Json -->
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.58</version>
    </dependency>

    <!-- lombok -->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.6</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok-maven</artifactId>
      <version>1.18.6.0</version>
      <type>pom</type>
    </dependency>

    <!-- 日志 -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.21</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.21</version>
    </dependency>

    <!-- Junit4 -->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
      <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.12</version>
          <scope>compile</scope>
      </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
      <version>5.1.6.RELEASE</version>
      <scope>compile</scope>
    </dependency>

  <build>
    <finalName>TestSSM</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

順便吐槽下，很多新手在添加Spring的jar包時添加一大堆，實際上Spring-web這個包已經幫我們整合很多需要使用到的jar包，包括以下這些

項目文件

1. 開始添加Spring的配置文件，applicationContext
   
   
   上代碼

<?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">

    <!-- 包掃描 -->
    <context:component-scan base-package="com.moonlit.demo"/>

    <!-- 加載數據庫配置文件 -->
    <context:property-placeholder location="classpath:/db.properties"/>

    <!-- 創建連接池 -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
    </bean>

    <!-- 配置SessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <!-- 读取MyBatis总配置文件 -->
        <property name="configLocation" value="classpath:/mybatis.xml"/>
        <!-- 配置别名扫描 -->
        <property name="typeAliasesPackage" value="com.moonlit.demo.entity"/>
        <!-- 自动扫描mapper.xml文件 -->
        <property name="mapperLocations" value="classpath:/mapper/*Mapper.xml"/>
    </bean>

    <!-- 配置事务 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>

    <tx:annotation-driven/>

    <!--Mapper接口代理扫描器-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
        <property name="basePackage" value="com.moonlit.demo.dao"/>
    </bean>
</beans>

2. 配置spring-mvc.xml文件

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

    <!-- 包含Spring的核心配置 -->
    <import resource="classpath:spring/applicationContext.xml"/>

    <!--MVC的注解解析器 -->
    <mvc:annotation-driven/>

    <!-- 静态资源处理器 -->
    <mvc:default-servlet-handler/>

    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/user/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

當配置完上面這兩個文件之後

完成後，上面的提示就會消失

3. 配置mybatis.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>
   <!-- 可以不配置 -->
   <settings>
       <!-- 配置允許懶加載 -->
       <setting name="lazyLoadingEnabled" value="true"/>
       <!-- 取消關聯查詢 -->
       <setting name="aggressiveLazyLoading" value="false"/>
       <!-- 哪些方法會觸發關係查詢 -->
       <setting name="lazyLoadTriggerMethods" value="clone"/>
   </settings>
   <!-- 配置别名 -->
   <typeAliases>
       <typeAlias type="com.moonlit.demo.entity.User" alias="User"></typeAlias>
   </typeAliases>
</configuration>

4. 配置數據庫文件

jdbc.driver = com.mysql.cj.jdbc.Driver
#testssm是數據庫名，後面的那一段是字符編碼跟時區
jdbc.url = jdbc:mysql://localhost:3306/testssm?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8
jdbc.username = root
jdbc.password = qwe123

5. 配置log4j

# Global logging configuration
log4j.rootLogger=ERROR, stdout
# MyBatis logging configuration...
log4j.logger.cn.wolfcode.ssm.mapper=TRACE
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

6. 編寫entity （PS：因為使用lombok框架的原因，所以不需要編寫Get、Set、ToString方法，只需要添加@Data註解即可）

package com.moonlit.demo.entity;

import lombok.Data;
import org.springframework.stereotype.Repository;

/**
 1. @Author: Joshua_Zheng
 2. @Date: 2019/5/7 17:37
 3. @Email: [email protected]
 4. @Version 1.0
 */
@Data
@Repository
public class User {
    private Integer id;
    private String name;
}

7. 編寫UserService與UserServiceImpl

package com.moonlit.demo.service;

import com.moonlit.demo.entity.User;

import java.util.List;

/**
 * @Author: Joshua_Zheng
 * @Date: 2019/5/7 17:39
 * @Email: [email protected]
 * @Version 1.0
 */
public interface UserService {
    List<User> listUsers();
}

Ps：快速創建接口實現類


Idea會自動創建，UserServiceImpl

package com.moonlit.demo.service.impl;

import com.moonlit.demo.dao.UserDaoMapper;
import com.moonlit.demo.entity.User;
import com.moonlit.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 1. @Author: Joshua_Zheng
 2. @Date: 2019/5/7 17:39
 3. @Email: [email protected]
 4. @Version 1.0
 */
@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserDaoMapper mapper;

    @Override
    public List<User> listUsers() {
        return mapper.listUsers();
    }
}

9. 創建Dao層 UserDaoMapper.java跟UserDaoMapper.xml（兩個文件不在同一包下）

package com.moonlit.demo.dao;

import com.moonlit.demo.entity.User;
import org.springframework.stereotype.Repository;

import java.util.List;

/**
 1. @Author: Joshua_Zheng
 2. @Date: 2019/5/7 17:40
 3. @Email: [email protected]
 4. @Version 1.0
 */
@Repository
public interface UserDaoMapper {
    /**
     * 查詢所有用戶
     * @return
     */
    List<User> listUsers();
}

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.moonlit.demo.dao.UserDaoMapper">
    <!-- 结果集映射处理-->
    <resultMap id="User" type="User">
        <result column="id" property="id"/>
        <result column="name" property="name"/>
    </resultMap>

    <select id="listUsers" resultMap="User">
      select id,name from user;
    </select>
</mapper>

10. 創建測試類

import com.moonlit.demo.entity.User;
import com.moonlit.demo.service.UserService;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import java.util.List;

/**
 * @Author: Joshua_Zheng
 * @Date: 2019/5/7 17:42
 * @Email: [email protected]
 * @Version 1.0
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(value = "classpath:spring/applicationContext.xml")
public class App {
    @Autowired
    private UserService userService;

    @Test
    public void testList(){
        List<User> users = userService.listUsers();
        for (User user : users) {
            System.out.println("user = " + user);
        }
    }
}

數據庫中的字段

Ps:這裡使用了junit，使用junit需要在idea中安裝插件

當可以看到輸出結果時就說明你的框架整合完成了，並且可以獲取數據庫中的信息。

11. 編寫Controller層 UserController

package com.moonlit.demo.controller;

import com.alibaba.fastjson.JSON;
import com.moonlit.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 1. @Author: Joshua_Zheng
 2. @Date: 2019/5/7 17:44
 3. @Email: [email protected]
 4. @Version 1.0
 */
@Controller
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 顯示所有用戶信息
     * @return
     */
    @RequestMapping("/user")
    @ResponseBody
    public String listUsers(){
        String users = JSON.toJSONString(userService.listUsers());
        return users;
    }
}

12. 配置web.xml文件

<?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"
        id="WebApp_ID" version="3.0">

 <!-- 配置Spring的核心監聽器 -->
 <listener>
   <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 </listener>
 <context-param>
   <param-name>contextConfigLocation</param-name>
   <param-value>classpath:spring/applicationContext.xml</param-value>
 </context-param>

 <!-- 字符編碼 -->
 <filter>
   <filter-name>encodingFilter</filter-name>
   <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
   <init-param>
     <param-name>encoding</param-name>
     <param-value>UTF-8</param-value>
   </init-param>
 </filter>
 <filter-mapping>
   <filter-name>encodingFilter</filter-name>
   <url-pattern>/*
 

 
   SpringMVC
   org.springframework.web.servlet.DispatcherServlet
   
     contextConfigLocation
     classpath:spring/spring-mvc.xml
   
   1
 
 
   SpringMVC
   /
 

13. 添加Tomcat
    
    

-Dfile.encoding=UTF-8

14. 將項目放進Tomcat裡

回到Server選項菜單，開啟熱部署，然後點擊Ok

15. 啟動項目

16. 發送請求
http://localhost:8080/SSMDome/user

Ps：這裡因為沒轉碼所以輸出中文時會變成？？