1. 前言
这篇文章会分层讲一下整合的思路,不想看的朋友可以直接跳到最后一节看配置文件及 jar 包依赖。
2. Dao 层 —— Spring 整合 Mybatis
- 所需 jar 包
- 数据库驱动的 jar 包
- 数据库连接池的 jar 包
- Mybatis 的 jar 包
- Mybatis 和 Spring 整合的 jar 包
- Spring 的 jar 包
- 整合需要做的事
- 把 Mybatis 核心配置文件(
SqlMapConfig.xml
)中内容配置到 Spring 配置文件中
- 把 Mybatis 核心配置文件(
- 配置文件
- Mybatis 核心配置文件(
sqlMapConfig.xml
) - Spring 整合 Mybatis 的配置文件 (这里命名为
applicationContext-dao.xml
,方便管理)- 配置数据源
- 配置
SqlSessionFactory
- 配置
Mapper
的扫描器
- Mybatis 核心配置文件(
3. Service 层 —— Spring
- 所需 jar 包
- Spring 的核心容器 jar 包
- 整合需要做的事
- 扫描除了带
@Controller
注解的类(例如@Service
、@Component
等,@Controller
要让 SpringMVC 来管理),将其加入到 IoC 容器中 - 声明式事务管理
- 扫描除了带
- 配置文件
- 负责扫描注解的配置文件(
applicationContext-service.xml
) - 负责事务管理的配置文件 (
applicationContext-tx.xml
)- 配置事务管理器
- 配置事务通知
- 配置切面
- 负责扫描注解的配置文件(
4. Web 层 —— Spring 整合 SpringMVC
- 所需 jar 包
- SpringMVC 的 jar 包
- 整合需要做的事
- 扫描带
@Controller
注解的类 - 与另外的 Spring 配置文件建立起关联
- 扫描带
- 配置文件
- SpringMVC 的配置文件 (
springmvc.xml
) - 应用的配置文件 (
web.xml
)- 配置 Spring 提供的监听器,用于服务器启动时加载 Spring 的其它配置文件,创建 IoC 容器
- SpringMVC 的配置文件 (
5. 配置步骤
- 依赖的 jar 包
<properties>
<spring.version>5.0.2.RELEASE</spring.version>
<slf4j.version>1.6.6</slf4j.version>
<log4j.version>1.2.12</log4j.version>
<mysql.version>5.1.6</mysql.version>
<mybatis.version>3.4.5</mybatis.version>
</properties>
<dependencies>
<!-- spring -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.5</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</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>
<!-- 整合junit,spring5需要junit4.12以上 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!-- servlet和jsp -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>2.5</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>jstl</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!-- log start -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>${slf4j.version}</version>
</dependency>
<!-- log end -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>${mybatis.version}</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>c3p0</groupId>
<artifactId>c3p0</artifactId>
<version>0.9.1.2</version>
<type>jar</type>
<scope>compile</scope>
</dependency>
<!-- junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
- Mybatis 配置文件
SqlMapConfig.xml
(建议不要删除,因为可能后面会用到 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>
</configuration>
- Spring 整合 Mybatis 配置文件
applicationContext-dao.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
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-3.2.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.2.xsd">
<!-- 引入数据库连接信息配置文件 -->
<context:property-placeholder location="classpath:jdbcConfig.properties"/>
<!-- 配置数据源 -->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="${jdbc.driver}"/>
<property name="jdbcUrl" value="${jdbc.url}"/>
<property name="user" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</bean>
<!-- 配置 SqlSessionFactory -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注入数据源 -->
<property name="dataSource" ref="dataSource"/>
<!-- 配置Mybatis 核心配置文件位置 -->
<property name="configLocation" value="classpath:mybatis/config/SqlMapConfig.xml"/>
<!-- 配置 Mapper 配置文件的扫描路径,如果配置文件与接口目录结构相同可以不用配置 -->
<property name="mapperLocations">
<array>
<value>classpath:mybatis/mappers/*.xml</value>
</array>
</property>
</bean>
<!-- 配置 Mapper 扫描器 -->
<bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="cn.ykf.dao"/>
</bean>
</beans>
- 关于
sqlSessionFactory
的mapperLocations
属性。这是用来指定 Dao 接口对应的配置文件的位置,如果配置文件所在目录结构和接口所在包接口一致的话,就可以忽略,像这样:
如果使用映射配置文件,那么配置文件名可以不用和接口名一致,只需要在配置文件中namespace
属性指定对应的接口。而使用注解的话,直接在接口的对应方法使用相应注解即可。- 数据库连接信息使用配置文件保存
jdbcConfig.properties
jdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/db_demo jdbc.username=root jdbc.password=123456
- 负责扫描注解的配置文件 (
applicationContext-service.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"
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.xsd">
<context:component-scan base-package="cn.ykf">
<!-- 排除 Controller 注解-->
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>
</beans>
- 负责事务管理的配置文件 (
applicationContext-tx.xml
)
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:aop="http://www.springframework.org/schema/aop"
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-3.2.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx-3.2.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-3.2.xsd">
<!-- 配置事务管理器 -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<!-- 数据源在 applicationContext-dao.xml 中配置了 -->
<property name="dataSource" ref="dataSource"/>
</bean>
<!-- 配置事务通知 -->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
<tx:attributes>
<!-- 默认所有方法都有事务支持,读写型事务 -->
<tx:method name="*" read-only="false" propagation="REQUIRED"/>
<!-- 查询方法支持事务,只读型 -->
<tx:method name="list*" read-only="true" propagation="SUPPORTS"/>
</tx:attributes>
</tx:advice>
<!-- 事务织入 -->
<aop:config>
<aop:advisor advice-ref="txAdvice" pointcut="execution(* cn.ykf.service.impl.*ServiceImpl.*(..))"/>
</aop:config>
</beans>
数据源
dataSource
是在applicationContext-dao.xml
中配置的,如果此时报红是因为还没有建立起这几个配置文件的关系。
- SpringMVC 的配置文件 (
springmvc.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: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">
<context:component-scan base-package="cn.ykf" use-default-filters="false">
<!-- 只扫描 Controller -->
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
</context:component-scan>>
<!-- 配置视图解析器 -->
<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/pages/"/>
<property name="suffix" value=".jsp"/>
</bean>
<!-- 配置不拦截的静态资源 -->
<mvc:resources mapping="/css/**" location="/css/"/>
<mvc:resources mapping="/js/**" location="/js/"/>
<mvc:resources mapping="/images/**" location="/images/"/>
<!-- 开启注解springmvc支持 -->
<mvc:annotation-driven/>
</beans>
- 关于
context:include-filter
的使用,必须与属性use-default-filters="false"
搭配使用,表示只扫描指定的注解。因为user-default-filters
的默认值为true
,表示默认会对@Component
、@Controller
、@Service
、@Repository
标注的 Bean 进行扫描- 如果想省事,也可以直接指定只扫描 controller 包,譬如:
<context:component-scan base-package="cn.ykf.controller" />
- 应用的配置文件 (
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">
<display-name>Archetype Created Web Application</display-name>
<!-- 配置编码过滤器 -->
<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>
<!-- 配置前端控制器 -->
<servlet>
<servlet-name>dispatcherServlet</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>dispatcherServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- 配置加载 Spring 容器的监听器,默认只加载 WEB-INF 下的 applicationContext.xml -->
<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>
</web-app>
ContextLoaderListener
监听器默认只会加载WEB-INF
目录下的applicationContext.xml
,所以我们需要显示地指定配置文件。至此,配置完成,每个配置文件间都建立起了联系。- 注意
@Service
是加在业务层实现类上,而@Repository
是加在持久层接口上,因为我们采用的代理 Dao 的方式。
- 最终配置文件项目如图