Spring整合Mybatis案例
项目目录结构大致为:
这里有两个UserDao.xml,是为了在mybatis-config.xml,配置映射扫描的使用替换选择
一、准备工作
Ⅰ、创建项目
-
按照上图所示,选择maven-archetype-webapp,点击next
-
配置项目信息,next
-
点击finsh
-
初始目录为
Ⅱ、导入依赖
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<!--spring 版本号-->
<spring.version>5.0.5.RELEASE</spring.version>
<!--mybatis 版本号-->
<mybatis.version>3.2.4</mybatis.version>
<servlet-api.version>2.5</servlet-api.version>
</properties>
<dependencies>
<!-- spring start -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</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>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jms</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>${spring.version}</version>
</dependency>
<!-- spring end -->
<!--mybatis核Start-->
<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>1.2.2</version>
</dependency>
<!--mybatis核End-->
<!-- Junit-Start -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<!-- Junit-End -->
<!-- slf4j日志-Start -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.8.0-alpha0</version>
<scope>test</scope>
</dependency>
<!-- slf4j日志-End -->
<!-- j2ee相关包 servlet、jsp、jstl-Star -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
<version>${servlet-api.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!-- j2ee相关包 servlet、jsp、jstl-End -->
<!-- 数据库连接池相关 -Start -->
<!-- 导入dbcp的jar包,用来在applicationContext.xml中配置数据库 -->
<!-- dbcp -->
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.2.2</version>
</dependency>
<!-- c3p0 -->
<!-- <dependency>-->
<!-- <groupId>com.mchange</groupId>-->
<!-- <artifactId>c3p0</artifactId>-->
<!-- <version>0.9.5.2</version>-->
<!-- </dependency>-->
<!-- druid -->
<!-- <dependency>-->
<!-- <groupId>com.alibaba</groupId>-->
<!-- <artifactId>druid</artifactId>-->
<!-- <version>1.1.21</version>-->
<!-- </dependency>-->
<!-- 数据库连接池相关 End -->
<!--MySQL 驱动包-Start-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.39</version>
</dependency>
<!--MySQL 驱动包-End-->
<!-- fastJson- Json序列化工具 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.75</version>
</dependency>
<!-- fastJson- Json序列化工具 -->
<!-- tomcatmaven启动插件 -Start -->
<!-- 将tomcat 内嵌到 web项目中,这样可以直接运行 webapp项目。-->
<!-- 跟类似spring boot 项目一样,不需要再部署到额外的tomcat,直接就可以运行了。-->
<!-- 这里需要注意,第一次导入依赖的时候打开这里的依赖注释,后面要把这里注释掉,要不然会冲突 -->
<!-- <dependency>-->
<!-- <groupId>org.apache.tomcat.maven</groupId>-->
<!-- <artifactId>tomcat7-maven-plugin</artifactId>-->
<!-- <version>2.2</version>-->
<!-- </dependency>-->
<!-- <dependency>-->
<!-- <groupId>org.apache.maven.plugins</groupId>-->
<!-- <artifactId>maven-compiler-plugin</artifactId>-->
<!-- <version>3.3</version>-->
<!-- </dependency>-->
<!-- tomcatmaven启动插件 -->
<!-- 偷懒神器-Lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
<scope>provided</scope>
</dependency>
<!-- 偷懒神器-Lombok -->
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.tomcat.maven</groupId>
<artifactId>tomcat7-maven-plugin</artifactId>
<version>2.2</version>
<configuration>
<!--项目访问路径。当前配置的访问是localhost:9090/, -->
<!--如果配置是/aa,则访问路径为localhost:9090/aa -->
<path>/</path>
<port>9090</port>
<uriEncoding>UTF-8</uriEncoding>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins>
<!-- 静态资源导出问题 -->
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</build>
这里需要注意的是我们导入了tomcat插件之后,可以在maven里看到tomcat插件,如图:
Ⅲ、新建log4j.properties、db.properties配置文件
3.1 在resource目录下创建log4j.properties文件
### 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 mylog.log ###
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=D:\\java\\log\\mybatis-test\\mylog.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=debug, stdout
3.2 在resource目录下创建db.properties文件
db.driver=com.mysql.jdbc.Driver
#数据库连接字符串(改成自己的连接)
db.url=jdbc:mysql://localhost:3306/test?characterEncoding=utf-8&autoReconnect=true&allowMutiQueries=true&serverTimezone=Asia/Shanghai"
#数据库用户名(这里改成自己的用户名)
db.username=root
#数据库密码(这里改成自己的密码)
db.password=root
这里注意url后面的characterEncoding要设置成utf-8的,不然在修改数据的时候会出现乱码
二、框架搭建(整合)
Ⅰ、新建spring核心配置文件appilicationContext.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.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd">
<!--启用spring的一些annotation -->
<context:annotation-config/>
</beans>
Ⅱ、配置Mybatis
2.1 、新建mybatis-config.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>
<!--mybatis核心配置文件-->
<!--给类取别名,简化输入,方便映射配置文件中使用-->
<typeAliases>
<typeAlias type="com.balalaenergy.pojo.User" alias="user"/>
</typeAliases>
<!-- 这里还是提供两种方式加载Mapper配置文件-->
<!-- 1、通过resource去加载对应的xml文件-->
<!-- 2、通过扫描包去加载配置文件-->
<!-- 需注意的是第二种方式要保证UserMapper.java与UserMapper.xml-->
<!-- 所在的程序【目录层级】要一致,不然扫描不到-->
<mappers>
<!-- <mapper resource="mapper/UserMapper.xml"/>-->
<package name="com.balalaenergy.mapper"/>
</mappers>
</configuration>
该配置文件为mybatis核心配置文件
2.2、新建spring-dao配置文件
<?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">
<!-- 导入配置文件 -->
<!--引入数据库配置文件-->
<context:property-placeholder location="classpath:db.properties"/>
<!--配置数据源-->
<!-- 这里用的是dbcp连接池,也可以换成druid、c3p0 -->
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
<property name="driverClassName" value="${db.driver}" />
<property name="url" value="${db.url}"/>
<property name="username" value="${db.username}"/>
<property name="password" value="${db.password}"/>
<property name="maxActive" value="10"/>
<property name="maxIdle" value="5"/>
</bean>
<!--配置sqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!--指定Mybatis全局配置文件-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<!--指定数据源-->
<property name="dataSource" ref="dataSource"/>
</bean>
<!-- 配置mapper扫描,动态实现了mapper接口可以注册到spring容器中 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
<!-- 要扫描的mapper -->
<property name="basePackage" value="com.balalaenergy.mapper"/>
</bean>
</beans>
该配置主要为配置sqlSessionFactory以及对mapper接口的扫描
Ⅲ、配置springMVC
3.1、新建spring-mvc.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:mvc="http://www.springframework.org/schema/mvc"
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/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">
<!--此文件负责整个mvc中的配置-->
<!-- 自动扫描装配视图层,Controller -->
<context:component-scan base-package="com.balalaenergy.controller"/>
<!-- 静态资源过滤-->
<mvc:default-servlet-handler/>
<!-- 配置注解驱动 可以将request参数与绑定到controller参数上 -->
<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<property name="supportedMediaTypes">
<list>
<!-- 解决中文乱码问题 -->
<value>application/json;charset=UTF-8</value>
<value>text/plain;charset=UTF-8</value>
<value>text/html;charset=UTF-8</value>
</list>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
<!--静态资源映射-->
<!--本项目把静态资源放在了webapp的statics目录下,资源映射如下-->
<mvc:resources mapping="/css/**" location="/static/css/"/>
<mvc:resources mapping="/js/**" location="/static/js/"/>
<mvc:resources mapping="/image/**" location="/static/images/"/>
<mvc:default-servlet-handler /> <!--这句要加上,要不然可能会访问不到静态资源,具体作用自行百度-->
<!-- 对模型视图名称的解析,即在模型视图名称添加前后缀(如果最后一个还是表示文件夹,则最后的斜杠不要漏了) 使用JSP-->
<!-- 默认的视图解析器 在上边的解析错误时使用 (默认使用html)- -->
<bean id="defaultViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
<!--设置JSP文件的目录位置-->
<property name="prefix" value="/WEB-INF/views/"/>
<property name="suffix" value=".html"/>
<property name="exposeContextBeansAsAttributes" value="true"/>
</bean>
</beans>
Ⅳ、配置spring事务以及接口扫描
4.1 、新建spring-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"
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="com.balalaenergy.service"/>
<!-- 将所有业务类注入到spring,可以通过配置或者注解,配置通过<bean>标签,注解通过@Service等 -->
<!-- 申明事务 -->
<!-- 开启事务注解驱动 -->
<tx:annotation-driven />
<!-- (事务管理)transaction manager, use JtaTransactionManager for global tx -->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource"/>
</bean>
<!-- aop事务支持 -->
</beans>
Ⅴ、修改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"
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">
<!--开启spring注解 -->
<context:annotation-config/>
<!-- 导入配置文件 -->
<import resource="classpath:spring-service.xml"/>
<import resource="classpath:spring-dao.xml"/>
<import resource="classpath:spring-mvc.xml"/>
</beans>
Ⅵ、配置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_3_1.xsd"
version="3.1">
<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>
<init-param>
<param-name>forceEncoding</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
<!--welcome pages-->
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
</welcome-file-list>
<!--配置springmvc DispatcherServlet-->
<servlet>
<servlet-name>springMVC</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<!--配置dispatcher.xml作为mvc的配置文件-->
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext.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>
<!-- session -->
<session-config>
<session-timeout>15</session-timeout>
</session-config>
</web-app>
三、测试
Ⅰ、新建数据库、导入数据库文件
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(32) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`sex` int(11) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4;
INSERT INTO `user` VALUES ('1', '张三', '23', '1');
INSERT INTO `user` VALUES ('2', '李四', '23', '0');
Ⅱ、新建用户实体、Mapper、mapperXml、service、impl
2.1 User实体类
/**
* @author :BalalaEnergy
* @date :Created in 2021/4/10 16:47
* @description:注意这里没有Getter、Setter方法,是因为使用了Lombok插件,需要导入lombok依赖以及安装插件
* @modified By:
*/
@Data
public class User implements Serializable {
private Integer id;
private String name;
private Integer age;
private Integer sex;
}
2.2 UserMapper.java
/**
* @author :BalalaEnergy
* @date :Created in 2021/4/10 16:51
* @description:
* @modified By:
*/
public interface UserMapper {
/**
* 添加用户
* @param user
*/
void addUser(User user);
/**
* 通过用户ID删除用户
* @param id
*/
void delUserById(Integer id);
/**
* 查询所用用户信息
* @return
*/
List<User> findAllUser();
}
3.3 UserMapper.xml
<?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.balalaenergy.mapper.UserMapper">
<resultMap id="userResult" type="com.balalaenergy.pojo.User">
<id property="id" column="id" jdbcType="INTEGER"/>
<result property="name" column="name"/>
<result property="age" column="age"/>
<result property="sex" column="sex"/>
</resultMap>
<insert id="addUser" parameterType="com.balalaenergy.pojo.User">
insert into user(name, age, sex) value (#{name}, #{age}, #{sex})
</insert>
<delete id="delUserById" parameterType="integer">
delete from user where id=#{id}
</delete>
<select id="findAllUser" resultMap="userResult">
select * from user;
</select>
</mapper>
Ⅲ、创建测试类
3.1 创建userController
/**
* @author :BalalaEnergy
* @date :Created in 2021/4/11 14:01
* @description: 用户controller层
* @modified By:
*/
@Controller
@RequestMapping("/user")
public class UserController {
@Autowired
@Qualifier("userService")
private IUserService userService;
@RequestMapping("/index")
public String index(){
return "index";
}
@RequestMapping("/list")
@ResponseBody
public String getUser(){
List<User> users = userService.listUser();
System.out.println(users);
if (users == null){
return "未查询到数据";
}
return users.toString();
}
@RequestMapping("/add")
@Transactional(rollbackFor = Exception.class)
@ResponseBody
public String addUser(){
User user = new User();
user.setAge(99);
user.setName("甲");
user.setSex(0);
userService.addUser(user);
return "success";
}
}
Ⅳ、开启服务
4.1、点击run
- 启动结果:
可以看到这里的启动和手动配置tomcat效果一样,好处是不用本地安装tomcat,直接使用tomcat-maven插件。非常的方便
4.2、打开浏览器输入网址http://localhost:9090 或者 htpp://12.0.0.1:9090
可以看到我们访问到了默认的文件,默认访问的是WEB-INF下的index文件,我们也可以在web.xml中配置其他项
4.2、测试查询用户http://localhost:9090/user/list 或者 htpp://12.0.0.1:9090/user/list
可以看到页面返回了初始数据库中保存的用户数据,到此,spring整合SSM框架就算完成了,大家可以多多练习
4.3、整体项目目录结构![在这里插入图片描述](https://img-blog.csdnimg.cn/20210419205724970.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JsdWVsaWY=,size_16,color_FFFFFF,t_70#pic_center)
四、最后
小子不才,文章难免出现纰漏,如果有什么问题,请直接大声的批评我,如果有需要源码的,可以留言,留下您的邮箱,也欢迎大家一起交流学习。
还有一句话我想说,其实我这篇文章我写的不是很详细,怎样详细呢,就是相当于手把手教学那种,但是我觉得大家在学习的时候不能只是把代码跑起来,在整合的过程中如果遇到问题,然后找到办法解决之后印象会更深点,所以我写的这篇文章呢就不是那么的详尽,但是我相信有需要的同学也能够在我的文章的简要辅助下完成框架的整合搭建。
后面的话我应该不会在去写基于spring这种框架整合的了。我应该会去更新SpringBoot系列的框架整合。然后持续更新一个完整的后台项目,从零开始。冲!