前言:
背景
:IDEA+JDK8+Mysql8
前部分我已经学习了Spring和Mybatis两大框架。
现在这篇文章就来讲讲,使用IDEA整合Spring+Mybatis,过程中用log4j来输出sql语句,以便查看软件与数据库之间的具体交流过程,而不是一个简简单单的返回结果。
如:
为了方便起见,栗子也只是简简单单的一个查询功能,主要的重点是:
Spring+Mybatis+IDEA+Maven+log4j的整合过程
代码我也放到了git上:有兴趣的同学可以下载看看
https://github.com/jjc123/LookUserDemo
首先看看目录结构:
--------src:源文件
--------main:存放类接口之类的根节点
-------entity:存放实体类跟数据库表映射
-------User:实体类
-------mapper:存dao类的接口和sql映射文件
-------UserMapper:接口
-------UserMapper:对应接口的sql映射文件
-------test:测试文件
-------UserTest:测试文件
--------resources:存放配置文件
--------mybatis
--------SqlMapConfig.xml:配置Mybatis
--------spring
--------applicationContext.xml:配置spring
--------db.properties:配置外部数据库连接信息
--------log4j.properties:配置log4j输出配置
--------pom.xml:Maven的导入jar管理代码
首先建立Maven的模板:
创造maven项目:别人写的更详细
https://blog.csdn.net/qq_27093465/article/details/63683873
添加Mybatis配置文件模板(创建一次,以后直接新建就行了)
https://blog.csdn.net/qq_26819733/article/details/73441374
1. 配置pom.xml的maven:
<dependencies>
<!--配置单元测试-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>compile</scope>
</dependency>
<!--配置日志输出 需要这个四个jar 其实log4j就行 但是有这四个 输出会比较完整-->
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.2</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.8.0-beta2</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.8.0-beta2</version>
<scope>test</scope>
</dependency>
<!--配置spring-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.0.8.RELEASE</version>
</dependency>
<!--配置与数据库的连接-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.0.8.RELEASE</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
<!--配置dbcp连接数据库-->
<dependency>
<groupId>commons-dbcp</groupId>
<artifactId>commons-dbcp</artifactId>
<version>1.4</version>
</dependency>
<!--配置mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<!--配置Spring和mybatis适配包-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
2. log4j.properties:配置log4j输出配置
# Global logging configuration
log4j.rootLogger=ERROR, stdout
#MyBatis logging configuration...
log4j.logger.com.kiss=DEBUG
#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
3. db.properties:配置外部数据库连接信息
jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/sm?useAffectedRows=true&serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&useSSL=false
jdbc.username=root
jdbc.password=123456
4. 配置实体类:User
省略了set和get方法,看起来简洁一点 其实是有的。
public class User {
int id;
String name;
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
'}';
}
}
4. 配置Mapper接口:
package mapper;
import entity.User;
import java.util.List;
public interface UserMapper {
User findUserById(int id);
}
5. 配置Mapper的sql映射文件:
注意:<mapper namespace="mapper.UserMapper">
填的是Mapper接口的地址。
而且Mapper的sql映射文件名字要和Mapper接口的名字要相同。
<?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="mapper.UserMapper">
<select id="findUserById" parameterType="int" resultType="user">
SELECT * FROM user WHERE id =#{id}
</select>
</mapper>
6. 配置Mybatis配置文件:SqlMapConfig.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>
<!--当返回行的所有列都是空时,MyBatis默认返回null-->
<setting name="returnInstanceForEmptyRow" value="true"/>
<!--显示的指定每个我们需要更改的配置的值,即使他是默认的。防止版本更新带来的问题 -->
<!--关联的值在使用的时候被延迟加载true-->
<setting name="lazyLoadingEnabled" value="true"/>
<!--在你需要属性的时候全部加载true 按需加载false-->
<setting name="aggressiveLazyLoading" value="false"/>
<!--打开二级缓存-->
<setting name="cacheEnabled" value="true"></setting>
<setting name="mapUnderscoreToCamelCase" value="true"/>
<!--设置打印信息,不然看不到sql-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
<!--取别名-->
<typeAliases>
<package name="entity"></package>
</typeAliases>
</configuration>
7. 配置Spring配置文件:applicationContext.xml
主要配置的是:
- 数据库DataSource连接配置
- sqlSessionFactory 的Bean配置
要将DataSource配置注入 还有Mybatis配置注入. - 配置Mapper映射文件
扫描包下的接口,自动创建代理对象并在Spring容器中注入。 自动扫描的Mapper的bean的id为Mapper类名(首字母小写)
<?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="db.properties"></context:property-placeholder>
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
<property name="url" value="${jdbc.url}"></property>
<property name="driverClassName" value="${jdbc.driver}"></property>
<property name="username" value="${jdbc.username}"></property>
<property name="password" value="${jdbc.password}"></property>
</bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="mybatis/SqlMapConfig.xml"></property>
<property name="dataSource" ref="dataSource"></property>
</bean>
<!--扫描包下的接口,自动创建代理对象并在Spring容器中注入。 自动扫描的Mapper的bean的id为Mapper类名(首字母小写)
如果扫描多个包,包之间使用逗号分隔-->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="mapper"></property>
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
</bean>
</beans>
7. 配置测试文件:
注意:
@Before标注的方法是每个测试方法执行之前都会执行的方法。
@Test标注的方法才是测试方法。
还有:
import org.junit.Before;
import org.junit.jupiter.api.Test;
无法调用Before的初始化方法
package test;
import entity.User;
import mapper.UserMapper;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class UserTest {
private ApplicationContext applicationContext;
@Before
public void setup() {
applicationContext = new ClassPathXmlApplicationContext("spring/applicationContext.xml");
}
@Test
public void findUserById(){
UserMapper userMapper = (UserMapper)applicationContext.getBean("userMapper");
User user = userMapper.findUserById(1);
System.out.println(user);
}
}
输出:
==> Preparing: SELECT * FROM user WHERE id =?
==> Parameters: 1(Integer)
<== Columns: id, name
<== Row: 1, 小明
<== Total: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@7ea9e1e2]
User{id=1, name='小明'}
总结:
-
resources文件存放的都是配置文件。
-
Mapper接口名字要和Mapper映射文件的名字要相同,
而且<mapper namespace="mapper.UserMapper">
要是Mapper接口地址 -
实体类属性尽量要和数据库列对应,而且不能少set方法。
-
测试类中Spring 每次调用@Test都会调用@Before注解的方法,重复创建IOC容器,效率低。
-
Mybatis配置文件配置的是优化配置如开启二级缓存之类的,
还有给实体类取别名(Mapper的sql映射文件实体类类名开头使用小写字母)。 如果需要log4j的话 也要在Mybatis设置相应的配置。 -
Spring配置文件配置的是数据库连接信息,还有sqlSessionFactory工厂信息和Mapper扫描类MapperScannerConfigurer(用于扫描Mapper代理接口).
关系:
数据库连接信息 注入到 sqlSessionFactory
sqlSessionFactory 注入到 MapperScannerConfigurer
MapperScannerConfigurer介绍:
是Spring拥有自己的Mapper批量扫描类。
从Mapper包中扫描Mapper接口,自动创建代理对象并在Spring容器中注入。
自动扫描的Mapper的bean的id为Mapper类名(首字母小写)
如此,就可以通过IOC容器的Bean来调用接口对应的代理对象(首字母小写)
UserMapper userMapper = (UserMapper)applicationContext.getBean("userMapper");