SSM 框架整合
1、参考资料
2020年IDEA版黑马Java就业班-进阶篇(Mybatis、Spring、SpringMVC、Maven、springboot和项目等等
项目地址:Oneby / ssm-integration
2、原始方式整合
1、创建数据库表
创建 t_account
账户表,name
字段为账户名称,money
字段为账户金额
向其中插入两条测试数据
2、创建 Maven 工程
Maven 工程结构如下,注意 Maven 工程的打包方式为 war
包:<packaging>war</packaging>
导入 Spring、SpringMVC、Mybatis 相关依赖
<dependencies>
<!-- Spring 相关 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.0.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.7</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.0.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>5.0.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>5.0.5.RELEASE</version>
</dependency>
<!-- SpringMVC 相关 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.0.5.RELEASE</version>
</dependency>
<!-- Servlet 和 jsp -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>jstl</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!-- Mybatis 相关 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<dependency>
<groupId>c3p0</groupId>
<artifactId>c3p0</artifactId>
<version>0.9.1.2</version>
</dependency>
<!-- 单元测试相关 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
</dependencies>
3、编写实体类
创建 Account
实体类,其字段与数据库字段一一对应
/**
* @ClassName Account
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:46
* @Version 1.0
*/
public class Account {
private Integer id;
private String name;
private Double money;
4、编写 AccountMapper 映射接口和 AccountMapper.xml 映射文件
创建 AccountMapper
映射接口:save()
方法用于保存账户信息;findAll()
方法用于查询所有账户信息
/**
* @InterfaceName AccountMapper
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:46
* @Version 1.0
*/
public interface AccountMapper {
public void save(Account account);
public List<Account> findAll();
}
在 AccountMapper.xml 映射文件中实现上面两个方法,注:我在 Mybatis 配置文件中将 com.oneby.domain.Account
类的别名设置成了 account
,因此这里的 parameterType
和 resultType
可以写成 account
<?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.oneby.mapper.AccountMapper">
<insert id="save" parameterType="account">
insert into t_account values(#{id},#{name},#{money})
</insert>
<select id="findAll" resultType="account">
select * from t_account
</select>
</mapper>
5、编写 AccountService 接口和 AccountServiceImpl 实现类
在编写 Service 代码之前,我们需要先编写一个工具类 MyBatisUtils
:负责读取 Mybatis 的 sqlMapConfig.xml 配置文件信息,并返回一个 SqlSession
数据库连接实例
/**
* @ClassName MyBatisUtils
* @Description TODO
* @Author Oneby
* @Date 2021/4/3 18:18
* @Version 1.0
*/
public class MyBatisUtils {
public static SqlSession openSession() {
InputStream resourceAsStream = null;
try {
resourceAsStream = Resources.getResourceAsStream("sqlMapConfig.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
return sqlSessionFactory.openSession();
} catch (IOException e) {
e.printStackTrace();
}
return null;
}
}
创建 AccountService
接口:save()
方法用于保存账户信息;findAll()
方法用于查询所有账户信息
/**
* @ClassName AccountService
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:43
* @Version 1.0
*/
public interface AccountService {
public void save(Account account);
public List<Account> findAll();
}
创建 AccountServiceImpl
实现类:在每个方法中,我们通过 MyBatisUtils.openSession()
方法获取 SqlSession
实例;再通过 sqlSession.getMapper(AccountMapper.class)
方法获取 AccountMapper
对象;执行相应的数据库操作后,关闭数据库连接 sqlSession.close()
/**
* @ClassName AccountServiceImpl
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:43
* @Version 1.0
*/
@Service("accountService")
public class AccountServiceImpl implements AccountService {
public void save(Account account) {
SqlSession sqlSession = MyBatisUtils.openSession();
AccountMapper accountMapper = sqlSession.getMapper(AccountMapper.class);
accountMapper.save(account);
sqlSession.commit();
sqlSession.close();
}
public List<Account> findAll() {
SqlSession sqlSession = MyBatisUtils.openSession();
AccountMapper accountMapper = sqlSession.getMapper(AccountMapper.class);
List<Account> all = accountMapper.findAll();
sqlSession.close();
return all;
}
}
7、编写 AccountController
创建 AccountController
控制器:负责接收请求、执行业务逻辑、跳转页面
/**
* @ClassName AccountController
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:46
* @Version 1.0
*/
@Controller
@RequestMapping("/account")
public class AccountController {
@Autowired
private AccountService accountService;
//保存
@RequestMapping(value = "/save", produces = "text/html;charset=UTF-8")
@ResponseBody
public String save(Account account) {
accountService.save(account);
return "保存成功";
}
//查询
@RequestMapping("/findAll")
public ModelAndView findAll() {
List<Account> accountList = accountService.findAll();
ModelAndView modelAndView = new ModelAndView();
modelAndView.addObject("accountList", accountList);
modelAndView.setViewName("accountList");
return modelAndView;
}
}
8、编写显示页面
save.jsp 页面:负责收集账户信息,并提交给 AccountController
控制器
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h1>添加账户信息表单</h1>
<form name="accountForm" action="${pageContext.request.contextPath}/account/save" method="post">
账户名称:<input type="text" name="name"><br>
账户金额:<input type="text" name="money"><br>
<input type="submit" value="保存"><br>
</form>
</body>
</html>
accountList.jsp:负责展示所有的账户信息
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h1>展示账户数据列表</h1>
<table border="1">
<tr>
<th>账户id</th>
<th>账户名称</th>
<th>账户金额</th>
</tr>
<c:forEach items="${accountList}" var="account">
<tr>
<td>${account.id}</td>
<td>${account.name}</td>
<td>${account.money}</td>
</tr>
</c:forEach>
</table>
</body>
</html>
9、编写相应的配置文件
applicationContext.xml:Spring 配置文件
Spring 的容器负责扫描 Service 组件,Controller 组件交给 SpringMVC 扫描
<?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"
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">
<!--组件扫描:扫描service和mapper-->
<context:component-scan base-package="com.oneby">
<!--排除controller的扫描-->
<context:exclude-filter type="annotation"
expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
</beans>
log4j.properties:日志配置文件
#
# Hibernate, Relational Persistence for Idiomatic Java
#
# License: GNU Lesser General Public License (LGPL), version 2.1 or later.
# See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
#
### direct log messages to stdout ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.err
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
### direct messages to file hibernate.log ###
#log4j.appender.file=org.apache.log4j.FileAppender
#log4j.appender.file.File=hibernate.log
#log4j.appender.file.layout=org.apache.log4j.PatternLayout
#log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n
### set log levels - for more verbose logging change 'info' to 'debug' ###
log4j.rootLogger=all, stdout
spring-mvc.xml:SpringMVC 配置文件
SpringMVC 需要扫描 Controller 组件;配置视图解析器(视图的前缀和后缀);并开放对静态资源的访问
<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:context="http://www.springframework.org/schema/context"
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
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!--组件扫描 主要扫描controller-->
<context:component-scan base-package="com.oneby.controller"/>
<!--配置mvc注解驱动-->
<mvc:annotation-driven/>
<!--内部资源视图解析器-->
<bean id="resourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/pages/"/>
<property name="suffix" value=".jsp"/>
</bean>
<!--开发静态资源访问权限-->
<mvc:default-servlet-handler/>
</beans>
jdbc.properties:数据库配置文件
数据库连接信息
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=root
sqlMapConfig.xml:Mybatis 配置文件
Mybatis 需要配置数据库连接信息,以获取数据员,并加载 Mapper 对象
<?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文件-->
<properties resource="jdbc.properties"/>
<!--定义别名-->
<typeAliases>
<!--<typeAlias type="com.oneby.domain.Account" alias="account"></typeAlias>-->
<!--使用包扫描配置别名:默认为类名首字母小写-->
<package name="com.oneby.domain"/>
</typeAliases>
<!--数据库环境-->
<environments default="developement">
<environment id="developement">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"></property>
<property name="url" value="${jdbc.url}"></property>
<property name="username" value="${jdbc.username}"></property>
<property name="password" value="${jdbc.password}"></property>
</dataSource>
</environment>
</environments>
<!--加载映射-->
<mappers>
<!--<mapper resource="com/oneby/mapper/AccountMapper.xml"></mapper>-->
<package name="com.oneby.mapper"/>
</mappers>
</configuration>
web.xml:Web 环境配置文件
配置 Spring 监听器:在 Web 环境启动时就加载 Spring 配置文件,并初始化好 Spring IOC 容器
配置 SpringMVC 前端控制器:负责转发请求到指定控制器
配置 Servlet 乱码过滤器:编码格式为 UTF-8
<?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 监听器-->
<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的前端控制器-->
<servlet>
<servlet-name>DispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>DispatcherServlet</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>
10、代码测试
访问 http://localhost:8080/account/findAll
查询所有账户信息
访问 http://localhost:8080/save.jsp
保存账户信息
3、Spring 整合 Mybatis
0、整合思路
存在的问题:我们来看一看之前的 Service 层代码,在 AccountServiceImpl
中的每个方法中,除了业务逻辑不一样之外,其余操作均可提取取出,比如:通过 MyBatisUtils.openSession()
方法获取 SqlSession
实例;通过 sqlSession.getMapper(AccountMapper.class)
方法获取 AccountMapper
对象;关闭数据库连接 sqlSession.close()
等操作。
/**
* @ClassName AccountServiceImpl
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:43
* @Version 1.0
*/
@Service("accountService")
public class AccountServiceImpl implements AccountService {
public void save(Account account) {
SqlSession sqlSession = MyBatisUtils.openSession();
AccountMapper accountMapper = sqlSession.getMapper(AccountMapper.class);
accountMapper.save(account);
sqlSession.commit();
sqlSession.close();
}
public List<Account> findAll() {
SqlSession sqlSession = MyBatisUtils.openSession();
AccountMapper accountMapper = sqlSession.getMapper(AccountMapper.class);
List<Account> all = accountMapper.findAll();
sqlSession.close();
return all;
}
}
那么我们能不能把这些通用操作抽取出来呢?答案是可以的,我们需要让 Spring IOC 容器接管 SqlSessionFactory
对象,通过 SqlSessionFactory
对象来控制数据源 DataSource
,利用 DataSource
来为我们生成 Mapper 对象,并进行声明式事物的管理
1、Mybatis 配置文件的修改
删除之前的 sqlMapConfig.xml 配置文件,创建 sqlMapConfig-spring.xml 配置文件,Mybatis 无需再进行数据源的控制,因此只需要在 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>
<!--定义别名-->
<typeAliases>
<!--<typeAlias type="com.oneby.domain.Account" alias="account"></typeAlias>-->
<package name="com.oneby.domain"/>
</typeAliases>
</configuration>
2、Spring 配置文件的修改
1、配置数据库连接池 DataSource
数据库连接完全交由 Spring 管理
<!--加载propeties文件-->
<context:property-placeholder location="classpath:jdbc.properties"/>
<!--配置数据源信息-->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="${jdbc.driver}"></property>
<property name="jdbcUrl" value="${jdbc.url}"></property>
<property name="user" value="${jdbc.username}"></property>
<property name="password" value="${jdbc.password}"></property>
</bean>
2、将 SqlSessionFactory 配置到 Spring 容器中
sqlSessionFactory
对象也交由 Spring 管理,并通过 <property>
标签指定数据库连接池和 Mybatis 配置文件的路径
<!--配置sessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<!--加载mybatis核心文件-->
<property name="configLocation" value="classpath:sqlMapConfig-spring.xml"/>
</bean>
3、扫描 Mapper,让 Spring 容器产生 Mapper 接口的实现类
Mapper 对象也交由 Spring 管理
<!--扫描mapper所在的包 为mapper创建实现类-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.oneby.mapper"/>
</bean>
4、配置声明式事务控制
配置事务管理器和 XML 声明式事务
<!--声明式事务控制-->
<!--平台事务管理器-->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource"/>
</bean>
<!--配置事务增强-->
<tx:advice id="txAdvice">
<tx:attributes>
<tx:method name="*"/>
</tx:attributes>
</tx:advice>
<!--事务的aop织入-->
<aop:config>
<aop:advisor advice-ref="txAdvice" pointcut="execution(* com.oneby.service.impl.*.*(..))"/>
</aop:config>
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:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation=
"http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.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/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!--组件扫描:扫描service和mapper-->
<context:component-scan base-package="com.oneby">
<!--排除controller的扫描-->
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
<!--加载propeties文件-->
<context:property-placeholder location="classpath:jdbc.properties"/>
<!--配置数据源信息-->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="${jdbc.driver}"></property>
<property name="jdbcUrl" value="${jdbc.url}"></property>
<property name="user" value="${jdbc.username}"></property>
<property name="password" value="${jdbc.password}"></property>
</bean>
<!--配置sessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource"/>
<!--加载mybatis核心文件-->
<property name="configLocation" value="classpath:sqlMapConfig-spring.xml"/>
</bean>
<!--扫描mapper所在的包 为mapper创建实现类-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.oneby.mapper"/>
</bean>
<!--声明式事务控制-->
<!--平台事务管理器-->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource"/>
</bean>
<!--配置事务增强-->
<tx:advice id="txAdvice">
<tx:attributes>
<tx:method name="*"/>
</tx:attributes>
</tx:advice>
<!--事务的aop织入-->
<aop:config>
<aop:advisor advice-ref="txAdvice" pointcut="execution(* com.oneby.service.impl.*.*(..))"/>
</aop:config>
</beans>
3、Service 代码的修改
在 AccountServiceImpl
实现类中,只需要自动注入 AccountMapper
对象即可
/**
* @ClassName AccountServiceImpl
* @Description TODO
* @Author Oneby
* @Date 2021/4/2 22:43
* @Version 1.0
*/
@Service("accountService")
public class AccountServiceImpl implements AccountService {
@Autowired
private AccountMapper accountMapper;
@Override
public void save(Account account) {
accountMapper.save(account);
}
@Override
public List<Account> findAll() {
return accountMapper.findAll();
}
}
4、代码测试
访问 http://localhost:8080/account/findAll
查询所有账户信息
访问 http://localhost:8080/save.jsp
保存账户信息