SSM整合思路与配置详解
文章目录
- SSM（Spring+SpringMvc+Mybatis）整合与配置
- 一、配置准备
- 二、配置过程
- 1.引入依赖
- 2.配置Web.xml文件
- 3.配置SpringMvc.xml文件
- 4.配置mybatis.xml文件
- 5.配置applicationContext.xml文件
- 三、mybatis逆向工程
SSM（Spring+SpringMvc+Mybatis）整合与配置
在网上扒拉了好久各种SSM整合后，觉得每次做项目都去网上扒配置特别麻烦，所以做了如下总结。
一、配置准备
在进行配置前，先想清楚要配置哪些文件，如图，除web.xml外，其余三个配置文件名称均可自定义。
如图所示，一共有四个需要手动配置的文件：
- web.xml:配置servlet、filter、listener
- applicationContext.xml:配置相关的bean，与mybatis整合
- SpringMvc.xml:用于配置视图解析器、控制器等
- Mybatis.xml:用于生成Mybatis用到的实体类、Mapper接口、Map配置文件 (由于要与spring进行整合，所以在真正配置的时候有些会合并到spring配置文件中配置)
二、配置过程
配置之前要在pom.xml中添加一定的依赖包。
下面是我做的时候进行的一些简单的依赖配置。
1.引入依赖
<?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.may</groupId>
<artifactId>ssm_crud</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>war</packaging>
<name>ssm_crud 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>
<junit.version>4.12</junit.version>
<jstl.version>1.2</jstl.version>
<spring.version>4.3.7.RELEASE</spring.version>
<pagehelper.version>5.1.11</pagehelper.version>
<servlet-api.version>3.1.0</servlet-api.version>
<mybatis.version>3.4.2</mybatis.version>
<mybatis.spring.version>1.3.1</mybatis.spring.version>
<mybatis.generator.version>1.3.5</mybatis.generator.version>
<c3p0.version>0.9.1.2</c3p0.version>
<mysql.version>5.1.41</mysql.version>
</properties>
<!-- 引入jar包 -->
<!-- springmvc spring mybatis -->
<dependencies>
<!-- 分页 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>${pagehelper.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- springJdbc spring事务控制 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- spring 面向切面编程 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- spring 单元测试 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
<!--<scope>test</scope>-->
</dependency>
<!-- mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
<!-- mybatis整合spring的适配包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>${mybatis.spring.version}</version>
</dependency>
<!-- 数据库连接池、驱动 -->
<dependency>
<groupId>c3p0</groupId>
<artifactId>c3p0</artifactId>
<version>${c3p0.version}</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!-- 其它(jstl servlet-api junit)-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>${jstl.version}</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>${servlet-api.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<!-- <scope>test</scope>-->
</dependency>
<!-- MBG mybatis逆向工程-->
<!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>${mybatis.generator.version}</version>
</dependency>
</dependencies>
<build>
<finalName>ssm_crud</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>
2.配置Web.xml文件
依赖引入完后，先来配置一下Web.xml文件。
首先要明确一下Web.xml中必要配置的一些信息：
-
配置spring的核心监听器ContextLoaderListener。
作用：在tomcat启动的时候，创建spring 的工厂类对象，把工厂类对象绑定到tomcat的上下文中，以前写java项目第一步都是创建spring的工厂类对象（如下代码）。而在运行web项目时还是需要Spring的工厂类对象，所以spring就为我们提供了这个监听器来在tomcat启动的时候来实现这些代码。
注意：默认spring会从WEB-INF目录下加载applicationContext.xml作为spring的主配置文件，如果我们不喜欢把主配置文件放到这个地方，我们可以通过手动来指定Spring主配置文件的位置和名称。
-
配置springMvc的前端控制器DispatcherServlet。
作用：拦截相应的请求交给spring mvc处理。
注意：默认spring mvc会从WEB-INF下去加载[servlet的name]-servlet.xml 这个主配置文件，针对下面代码中的例子主配置文件的名称应该是spring-mvc-servlet.xml. 如果我们不喜欢把主配置文件放到这个地方，我们可以通过手动来指定springMvc主配置文件的位置和名称。
-
配置字符编码过滤器CharacterEncodingFilter
作用：配置该过滤器拦截所有的资源并设置好编码格式，用来防止中文乱码问题。
注意：该过滤器一定要配置在其他过滤器之前。
下面是web.xml中的全部配置代码：
<?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_4_0.xsd"
version="4.0">
<!-- ===================== Spring配置 ===================== -->
<!-- 配置spring环境 -->
<!-- 手动来指定Spring主配置文件的位置和名称 -->
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<!-- ===================== SpringMVC配置 ===================== -->
<!-- 配置SpringMVC前端控制器，负责处理所有请求 -->
<servlet>
<servlet-name>spring-mvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!-- 手动来指定SpringMVC主配置文件的位置和名称 -->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:SpringMvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<!-- 代表拦截所有请求 -->
<servlet-mapping>
<servlet-name>spring-mvc</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
<filter>
<filter-name>characterEncodingFilter</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>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
</web-app>
3.配置SpringMvc.xml文件
这一步中你要先创建一个存放控制器的包（本例使用com.may.controller）
在该文件中需要明确的配置信息：
-
需要配置扫描器（用于扫描控制器）
作用：识别指定包中含有@Controller标签的类
-
需要配置视图解析器InternalResourceViewResolver
作用：存放在/WEB-INF/下面的内容是不能直接通过request请求的方式请求到的，为了安全性考虑，我们通常会把jsp文件放在WEB-INF目录下，而InternalResourceView在服务器端跳转的方式可以很好的解决这个问题（下面是对这个的解释）。
InternalResourceViewResolver会把返回的视图名称都解析为InternalResourceView对象，InternalResourceView会把Controller处理器方法返回的模型属性都存放到对应的request属性中，然后通过RequestDispatcher在服务器端把请求forword重定向到目标URL。比如在InternalResourceViewResolver中定义了prefix=/WEB-INF/，suffix=.jsp，然后请求的Controller处理器方法返回的视图名称为test，那么这个时候InternalResourceViewResolver就会把test解析为一个InternalResourceView对象，先把返回的模型属性都存放到对应的HttpServletRequest属性中，然后利用RequestDispatcher在服务器端把请求forword到/WEB-INF/test.jsp。
-
两个标准配置mvc:default-servlet-handler和mvc:annotation-driven
作用：能支持springmvc更高级的一些功能，JS303校验，快捷的ajax…映射动态请求，将springmvc不能处理的请求交给tomcat等。
这里只是片面的说出其作用，如果想深入了解可以看这里：
mvc:annotation-driven的作用
mvc:default-servlet-handler的作用
下面是SpringMvc.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.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 启动spring的一些annotation -->
<context:annotation-config/>
<!-- SpringMVC的配置文件，含网站跳转的逻辑控制，配置 -->
<context:component-scan base-package="com.may" use-default-filters="false">
<!-- 只扫描控制器-->
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
<!-- 配置视图解析器-->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!--前缀-->
<property name="prefix" value="/WEB-INF/views"></property>
<!--后缀-->
<property name="suffix" value=".jsp"></property>
</bean>
<!--两个标准配置-->
<!--将springmvc不能处理的请求交给tomcat-->
<!--能支持springmvc更高级的一些功能，JS303校验，快捷的ajax...映射动态请求-->
<mvc:default-servlet-handler></mvc:default-servlet-handler>
<!-- 开启springmvc注解支持 -->
<mvc:annotation-driven></mvc:annotation-driven>
</beans>
4.配置mybatis.xml文件
在ssm整合中，mybatis被spring整合，mybatis大部分配置都被spring整合到一起，所以此处mybatis就简单配置个别名和驼峰命名。还有必要的分页插件配置。
该配置文件的所有代码如下：
<?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="mapUnderscoreToCamelCase" value="true"/>
</settings>
<typeAliases>
<!-- 起别名-->
<package name="com.may.crud.bean"/>
</typeAliases>
<!-- 分页插件 -->
<plugins>
<plugin interceptor="com.github.pagehelper.PageInterceptor"></plugin>
</plugins>
</configuration>
5.配置applicationContext.xml文件
该文件中要实现spring和mybatis的整合，必要配置如下：
-
配置数据库连接池(此处使用的是c3p0)
作用：连接数据库。
-
配置Mybatis工厂SqlSessionFactoryBean
作用：这是一个工厂类，用于创建sqlSession对象，用来对数据库进行增删改查以及事务操作等。
注意：需要在里面配置数据源和mybatis配置文件的位置以及指定mapper文件的位置。
-
配置Mapper接口的扫描器MapperScannerConfigurer
作用：将mapper接口生成代理注入springIoc容器中。
注意：需要配置其所在的位置。
-
配置事务管理器DataSourceTransactionManager
作用：访问数据库时对数据事务进行管理。
注意：需要配置数据源，另外可以配置tx:annotation-driven用来使事务支持注解。
-
配置扫描器，来扫除了控制器所在的包之外的包
作用：主要用来扫描Service。
完整的配置代码如下：
注意：此处多加入了关于批处理的SqlSessionTemplate用于批量生成数据。
<?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:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx" xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
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
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/cache
http://www.springframework.org/schema/cache/spring-cache.xsd http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">
<!-- 扫描器，不扫控制器-->
<context:component-scan base-package="com.may">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
<!-- spring配置文件，这里主要配置和业务逻辑有关的-->
<!-- ==================数据源，事务控制。。。===============-->
<!-- 加载文件 -->
<context:property-placeholder location="classpath:db.properties"></context:property-placeholder>
<bean id="pooledDataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="jdbcUrl" value="${jdbc.jdbcUrl}"></property>
<property name="driverClass" value="${jdbc.driverClass}"></property>
<property name="user" value="${jdbc.user}"></property>
<property name="password" value="${jdbc.password}"></property>
</bean>
<!-- ============================== -->
<!-- ======================配置和mybatis的整合============== -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 指定mybatis全局配置文件的位置-->
<property name="configLocation" value="classpath:mybatis-config.xml"></property>
<property name="dataSource" ref="pooledDataSource"></property>
<!-- 指定mybatis，mapper文件的位置-->
<property name="mapperLocations" value="classpath:mapper/*.xml"></property>
</bean>
<!-- 配置扫描器，将mybatis接口的实现加入到ioc容器中 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<!-- 扫描所有的dao接口的实现，加入到ioc容器中-->
<property name="basePackage" value="com.may.crud.dao"></property>
</bean>
<!-- 配置一个可以执行批量的sqlSession-->
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
<constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory"></constructor-arg>
<!-- 设置批量生成 -->
<constructor-arg name="executorType" value="BATCH"></constructor-arg>
</bean>
<!-- <mybatis:scan base-package="com.may.crud.dao"></mybatis:scan>-->
<!-- ====================================== -->
<!-- ==============事务控制配置====================== -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<!-- 控制数据源 -->
<property name="dataSource" ref="pooledDataSource"></property>
</bean>
<!--支持注解驱动的事务管理，指定事务管理器-->
<tx:annotation-driven transaction-manager="transactionManager"/>
另外附上db.properties的文件内容：
jdbc.jdbcUrl=jdbc:mysql://localhost:3306/ssm_crud
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.user=root
jdbc.password=123
至此我们就将ssm整合所需要的基础配置文件就全部配置好了。
在引入依赖的时候我们引入了mybatis逆向工程的依赖。所以我们可以用其来为我们生成mapper配置文件、mapper接口和实体类等。
三、mybatis逆向工程
此处我们使用代码加配置的形式来实现。
- 编写配置文件。
<?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>
<context id="DB2Tables" targetRuntime="MyBatis3">
<!--设置是否生成注释-->
<commentGenerator>
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--配置数据库连接信息-->
<jdbcConnection
driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/ssm_crud"
userId="root"
password="123">
</jdbcConnection>
<!--JAVA类型解析-->
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!--指定JAVAbean生成的位置-->
<javaModelGenerator
targetPackage="com.may.crud.bean"
targetProject=".\src\main\java">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!--指定SQL映射文件生成的位置-->
<sqlMapGenerator
targetPackage="mapper"
targetProject=".\src\main\resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!--指定dao接口生成的位置-->
<javaClientGenerator
type="XMLMAPPER"
targetPackage="com.may.crud.dao"
targetProject=".\src\main\java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--table指定每个表的生成策略-->
<!--domainObjectName生成的javaBean名-->
<table tableName="tbl_emp" domainObjectName="Employee"></table>
<table tableName="tbl_dept" domainObjectName="Department"></table>
</context>
</generatorConfiguration>
- 编写生成代码。
package com.may.crud.test;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
/**
* @author may
* @date 2020/4/27 - 16:23
*/
public class MGBTest {
public static void main(String[] args) throws IOException, XMLParserException, InvalidConfigurationException, SQLException, InterruptedException {
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
File configFile = new File("mbg.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(null);
}
}
配置完成后编写该代码然后运行即可。
注意：要提前创建好数据库和数据表