框架
框架(Framework)是整个或部分系统的可重用设计,表现为一组抽象构件及构件实例间交互
的方法;
mybatis 是一个基于Java的持久层框架
项目集成
1 引入依赖
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
2 创建配置文件
在resource目录下创建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>
<!-- 链接数据库只需要一个属性来配置文件,就会自动解析 -->
<properties resource="jdbc.properties" />
<!-- 设置别名,然后就可以使用别名来代替前面的路径 -->
<typeAliases>
<typeAlias type="com.tledu.zrz.model.User" alias="User"/>
<typeAlias type="com.tledu.zrz.model.Address" alias="Address"/>
</typeAliases>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!-- 映射文件 -->
<mappers>
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
</mappers>
</configuration>
创建jdbc.properties配置数据库
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/erp16?useUnicode=true&characterEncoding=UTF-8
username=root
password=root
3 准备一些测试数据
create table t_user(
id int(11) primary key auto_increment,
username varchar(100),
password varchar(100),
nickname varchar(100),
`type` int (2)
);
create table t_address(
id int(11) primary key auto_increment,
addr varchar(255),
phone varchar(100),
postcode varchar(100),
user_id int(11),
CONSTRAINT foreign key (user_id) references t_user(id)
);
insert into t_user(username,password,nickname,type) values('admin','123','超级管理员',1);
insert into t_address(addr,phone,postcode,user_id) values ('123','123','123',1);
4 .创建对应实体
5 创建数据库操作的xml文件
这里以user为例,Address作为练习,在resource目录下创建一个User.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">
<!--
namespace 是用于调用的时候的映射
-->
<mapper namespace="User">
<!--
id : 表示调用的SQL的名字,相当于方法名
parameterType : 表示传入参数的类型,写类全名,但是由于设置的别名,所以可以写User
resultType : 结果集类型
-->
<insert id="add" parameterType="User" >
<!-- 这里的#username 就等于是用 ? 的方式,等方法调用的时候,会传递一个参数,就会自动映射到username的属性上 -->
insert into t_user (username,password,nickname,type) values (#{username},#{password},#{nickname},#{type})
</insert>
</mapper>
修改mybatis-config.xml中的映射关系
<mappers>
<mapper resource="mapper/User.xml"/>
</mappers>
如果想把xml文件放到java目录中,则需要在maven的build中配置资源路径
<project>
...
<build>
...
<resources>
<resource>
<!-- directory:指定资源文件的位置 -->
<directory>src/main/java</directory>
<includes>
<!-- “**” 表示任意级目录 “*”表示任意任意文件 -->
<!-- mvn resources:resources :对资源做出处理,先于compile阶段 -->
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<!-- filtering:开启过滤,用指定的参数替换directory下的文件中的参数(eg. ${name}) -->
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
</resource>
</resources>
...
</build>
...
</project>
6 执行该插入操作案例
编写一个servlet执行该操作
@WebServlet("/test")
public class TestServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
String resource = "mybatis-config.xml";
// 读取总配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
// 获取session工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 获取session
SqlSession session = sqlSessionFactory.openSession();
// 调用xml中的sql
User user = new User();
user.setUsername("1234");
user.setPassword("1234");
user.setNickname("1234");
// 调用
session.insert("User.add", user);
// 提交
session.commit();
}
}
总结:到此为止,我们就是用mybatis的一个最基础的用法
日志日志打印操作方法
由于mybatis对sql进行了封装,这个时候我们在项目运行过程中,如果出现问题了就需要进行日志的打印,在这里可以通过log4j这个工具打印对应sql日志,帮助我们进行错误的排查。
1 引入日志的依赖
<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
2 设置mybatis通过log4j打印日志
<settings>
<setting name="logImpl" value="LOG4J"/>
</settings>
3 在resource目录下添加log4j.properties配置文件
### Log4j配置 ###
#定义log4j的输出级别和输出目的地(目的地可以自定义名称,和后面的对应)
#[ level ] , appenderName1 , appenderName2
log4j.rootLogger=DEBUG,console,file
#-----------------------------------#
#1 定义日志输出目的地为控制台
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
####可以灵活地指定日志输出格式,下面一行是指定具体的格式 ###
#%c: 输出日志信息所属的类目,通常就是所在类的全名
#%m: 输出代码中指定的消息,产生的日志具体信息
#%n: 输出一个回车换行符,Windows平台为"/r/n",Unix平台为"/n"输出日志信息换行
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n
#-----------------------------------#
#2 文件大小到达指定尺寸的时候产生一个新的文件
log4j.appender.file = org.apache.log4j.RollingFileAppender
#日志文件输出目录
log4j.appender.file.File=log/info.log
#定义文件最大大小
log4j.appender.file.MaxFileSize=10mb
###输出日志信息###
#最低级别
log4j.appender.file.Threshold=ERROR
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n
#-----------------------------------#
#3 druid
log4j.logger.druid.sql=INFO
log4j.logger.druid.sql.DataSource=info
log4j.logger.druid.sql.Connection=info
log4j.logger.druid.sql.Statement=info
log4j.logger.druid.sql.ResultSet=info
#4 mybatis 显示SQL语句部分
log4j.logger.org.mybatis=DEBUG
#log4j.logger.cn.tibet.cas.dao=DEBUG
#log4j.logger.org.mybatis.common.jdbc.SimpleDataSource=DEBUG
#log4j.logger.org.mybatis.common.jdbc.ScriptRunner=DEBUG
#log4j.logger.org.mybatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG
#log4j.logger.java.sql.Connection=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
之后控制台就可以打印出sql语句了
进行单元测试
我们现在在测试mybatis的时候,每次都需要启动tomcat服务,每次还需要开发一个接口,就比较麻烦,这个时候我们可以基于JUnit进行单元测试,帮我们快速测试代码。
1 添加依赖
这里在我们创建项目的时候maven已经为我们增加了junit的配置,所以我们这里就不用在重复添加了。
<!-- https://mvnrepository.com/artifact/junit/junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
2 添加测试用例
import com.tledu.erp.model.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
public class UserDao {
@Test
public void insert() throws IOException {
String resource = "mybatis-config.xml";
// 读取总配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
// 获取session工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 获取session
SqlSession session = sqlSessionFactory.openSession();
// 调用xml中的sql
User user = new User();
user.setUsername("1234");
user.setPassword("1234");
user.setNickname("1234");
// 调用
session.insert("User.add", user);
// 提交
session.commit();
}
}
3 运行测试样例
直接右键即可运行测试样例
4 可以执行mvn clean test 运行所有的测试样例
我们需要注意的是测试样例要以Test结尾
如果没有自动执行对应的@Test的方法,则可以添加插件
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.19</version>
<configuration>
<includes>
<include>**/*Test.java</include>
</includes>
</configuration>
</plugin>
5 可以通过assertEquals进行断言操作
// 断定res = 1 如果res不等于1 则代表测试失败
assertEquals(res, 1);
Mapper三种形式
常用的三种mapper
- sqlSession执行对应语句,就是我们上面测试的那种
- 使用注解(简单sql)
- 利用接口代理(常用)
1 sqlSession执行对应语句
上面的测试就是第一种
2 使用注解
- 注解方式不需要User.xml
- 需要再对应的接口上添加对应的注解语句
- mybatis-config.xml中添加映射配置
在dao层接口上直接添加sql注解
public interface IUserMapper {
@Select("select * from t_user where id = #{id}")
User getById(int id);
}
配置mybatis
<mappers>
<!--配置到对应的包-->
<package name="com.tledu.erp.mapper"/>
</mappers>
运行测试样例
...
// 调用xml中的sql
User user = new User();
user.setUsername("1234");
user.setPassword("1234");
user.setNickname("1234");
User user1 = session.getMapper(IUserMapper.class).getById(1);
...
对于一些简单sql可以采用这种方式
3 利用接口代理(常用)
- 需要xml
- 接口中不需要添加注解
- mybatis-config.xml中添加映射配置
创建User.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">
<!--
namespace 是用于调用的时候的映射,对应绑定的接口类
-->
<mapper namespace="com.tledu.erp.mapper.IUserMapper">
<insert id="add" parameterType="User" >
<!-- 这里的#username 就等于是用 ? 的方式,等方法调用的时候,会传递一个参数,就会自动映射到username的属性上 -->
insert into t_user (username,password,nickname) values (#{username},#{password},#{nickname})
</insert>
<select id="getList" resultType="User">
select * from t_user
</select>
<select id="getById" parameterType="int" resultType="User">
select * from t_user where id = #{id}
</select>
</mapper>
在mubatis-config.xml中配置
<mapper resource="com/tledu/erp/mapper/User.xml"/>