在MyBatis的第一篇的学习中我们了解了MyBatis是什么和为什么学习MyBatis,本次我们将学习MyBatis的具体使用。
思路:环境搭建——>MyBatis导入——>代码编写——>测试。
一、环境搭建
1.建立数据库
CREATE DATABASE `MyBaties`;CREATE TABLE `user`( `id` INT(20) NOT NULL PRIMARY KEY, `username` VARCHAR(30) NOT NULL, `password` VARCHAR(30) NOT NULL);INSERT INTO `user` (`id`,`username`,`password`)VALUES(10000,'jms1','123456'),(10001,'jms2','123456'),(10003,'jms3','123456')
2.建立一个maven项目
这个项目作为父项目。
修改pom.xml导入需要的依赖:mysql驱动、mydatis、junit。
<dependencies> <!-- 导入依赖--> <!-- mysql驱动--> <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.30</version> </dependency> <!-- mybatis--> <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.10</version> </dependency> <!-- junit--> <!-- https://mvnrepository.com/artifact/junit/junit --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.13.2</version> <scope>test</scope> </dependency> </dependencies>
3.建立一个子模块
(1)编写mybatis的核心配置文件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> <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>
这是我个人的使用:
<?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> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Dirver"/> <property name="url" value="jdbc:mysql://localhost:3306/mybaties?useSSL=true&useUnicode=true&characterEncoding=UTF-8"/> <property name="username" value="root"/> <property name="password" value="123456"/> </dataSource> </environment> </environments></configuration>
(2)编写mybatis工具类MyBatisUtil.class
每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。
从 XML 文件中构建 SqlSessionFactory 的实例非常简单,建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流(InputStream)实例,比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类,它包含一些实用方法,使得从类路径或其它位置加载资源文件更加容易。
官方文档给出了以下三行代码:
String resource = "org/mybatis/example/mybatis-config.xml";InputStream inputStream = Resources.getResourceAsStream(resource);SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
我们要做的就是把这三行代码封装到MyBatisUtil.class中:
1 package com.jms.utils; 2 3 4 import java.io.IOException; 5 import java.io.InputStream; 6 7 import org.apache.ibatis.io.Resources; 8 import org.apache.ibatis.session.SqlSession; 9 import org.apache.ibatis.session.SqlSessionFactory;10 import org.apache.ibatis.session.SqlSessionFactoryBuilder;11 12 //SqlSessionFactory-->SqlSession13 public class MyBatisUtil {14 15 private static SqlSessionFactory sqlSessionFactory;16 17 //获取SqlSessionFactory对象18 static {19 try {20 String resource = "mybatis-config.xml";21 InputStream inputStream = Resources.getResourceAsStream(resource);22 sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); 23 } catch (IOException e) {24 e.printStackTrace();25 }26 }27 28 //通过SqlSessionFactory获取SqlSession对象,其中包含了面向数据库执行执行SQL命令所需要的方法29 public static SqlSession getSqlSession() {30 return sqlSessionFactory.openSession();31 }32 }
官网上也有着不进行核心配置,直接用纯代码进行编写的模式,本文就不做过多赘述,可自行了解。
3.编写代码
(1)首先我们要写一个实体类user.class,这个实体类应该与我们前面数据库建立的user表对应。
1 package com.jms.pojo; 2 3 public class user { 4 5 private int id; 6 private String username; 7 private String password; 8 9 public user() {10 11 }12 13 public user(int id, String username, String password) {14 super();15 this.id = id;16 this.username = username;17 this.password = password;18 }19 20 public int getId() {21 return id;22 }23 public void setId(int id) {24 this.id = id;25 }26 public String getUsername() {27 return username;28 }29 public void setUsername(String username) {30 this.username = username;31 }32 public String getPassword() {33 return password;34 }35 public void setPassword(String password) {36 this.password = password;37 }38 39 @Override40 public String toString() {41 return "user [id=" + id + ", username=" + username + ", password=" + password + "]";42 }43 }
(2)编写一个Mapper接口UserMapper
1 package com.jms.dao; 2 3 import java.util.List; 4 5 import com.jms.pojo.User; 6 7 public interface UserMapper { 8 9 List getUsers();10 11 }
(3)编写Mapper配置文件UserMapper.xml
一般来说接口都会有实现类,但是这里我们用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"><!-- 命名空间namespace对应Mapper接口 --><mapper namespace="com.jms.dao.userMapper"> <!-- id对应接口中的方法 --> <select id="getUsers" resultType="com.jms.pojo.User"> select * from mybaties.user </select></mapper>
4.注册Mapper
修改mybatis的核心配置文件mybatis-config.xml,添加以下三行:
<mappers> <mapper resource="com/jms/dao/UserMapper.xml"/> </mappers>
resource对应的是实现接口的Mapper的路径。
5.junit测试
建立测试类UserMapperTest.class
package com.jms.dao;import java.util.List;import org.apache.ibatis.session.SqlSession;import org.junit.Test;import com.jms.pojo.User;import com.jms.utils.MyBatisUtil;public class UserMapperTest { @Test public void test() { //利用工具类获取SqlSession SqlSession sqlSession = MyBatisUtil.getSqlSession(); try { //方法一 //利用SqlSession获取UserMapper接口 UserMapper userMapper = sqlSession.getMapper(UserMapper.class); //调用方法 List users = userMapper.getUsers(); //方法二,老方法不推荐用 List users2 = sqlSession.selectList("com.jms.dao.UserMapper.getUsers"); System.out.println("这是方法一的结果"); for(User user: users) { System.out.println(user); } System.out.println("这是方法二的结果"); for(User user: users2) { System.out.println(user); } } catch(Exception e) { e.printStackTrace(); } finally{ sqlSession.close(); } } }
上面有两种方法,方法二不推荐。
SqlSession用完后应及时关闭。
测试结果如下:
可以看到成功地查到了数据库中的信息。
(本文仅作个人学习记录用,如有纰漏敬请指正)