MyBatis入门(搭建环境 增删改查)

MyBatis入门

一、Mybatis是什么？

MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis，实质上Mybatis对ibatis进行一些改进。

MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。

Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatemnt、CallableStatement）配置起来，并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。

二、分析原生态jdbc程序中存在的问题

public class Test {

	public static void main(String[] args) {
		Connection connection = null;
		PreparedStatement preparedStatement = null;
		ResultSet resultSet = null;
		
		try {
			//1、加载数据库驱动
			Class.forName("com.mysql.jdbc.Driver");
			//2、通过驱动管理类获取数据库链接
			connection =  DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8", "root", "root");
			//3、定义sql语句 ?表示占位符
		String sql = "select * from user where username = ?";
			//4、获取预处理statement
			preparedStatement = connection.prepareStatement(sql);
			//5、设置参数，第一个参数为sql语句中参数的序号（从1开始），第二个参数为设置的参数值
			preparedStatement.setString(1, "王五");
			//6、向数据库发出sql执行查询，查询出结果集
			resultSet =  preparedStatement.executeQuery();
			//7、遍历查询结果集
			while(resultSet.next()){
				System.out.println(resultSet.getString("id")+"  "+resultSet.getString("username"));
			}
		} catch (Exception e) {
			e.printStackTrace();
		}finally{
			//8、释放资源
			if(resultSet!=null){
				try {
					resultSet.close();
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
			if(preparedStatement!=null){
				try {
					preparedStatement.close();
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
			if(connection!=null){
				try {
					connection.close();
				} catch (SQLException e) {
					e.printStackTrace();
				}
			}
		}
	}
}

存在的问题：

1、  数据库连接频繁开启和关闭，会严重影响数据库的性能。

2、  代码中存在硬编码，分别是数据库部分的硬编码和SQL执行部分的硬编码。

三、Mybatis框架原理（核心）

1、  mybatis配置文件，包括Mybatis全局配置文件和Mybatis映射文件，其中全局配置文件配置了数据源、事务等信息；映射文件配置了SQL执行相关的信息。

2、  mybatis通过读取配置文件信息（全局配置文件和映射文件），构造出SqlSessionFactory，即会话工厂。

3、  通过SqlSessionFactory，可以创建SqlSession即会话。Mybatis是通过SqlSession来操作数据库的。

4、  SqlSession本身不能直接操作数据库，它是通过底层的Executor执行器接口来操作数据库的。Executor接口有两个实现类，一个是普通执行器，一个是缓存执行器（默认）。

5、  Executor执行器要处理的SQL信息是封装到一个底层对象MappedStatement中。该对象包括：SQL语句、输入参数映射信息、输出结果集映射信息。其中输入参数和输出结果的映射类型包括java的简单类型、HashMap集合对象、POJO对象类型。

四、Mybatis的下载

mybaits的代码由GitHub管理，下载地址：https://github.com/mybatis/mybatis-3/releases

或者去我的博客资源中心去下载也是可以的：

                        https://download.csdn.net/download/wangfengfans/10390416

Lib：mybatis的依赖包

Mybatis-3.2.7.jar：mybatis的核心包

Mybatis-3.2.7.pdf：mybatis的使用指南

五、入门程序

1.创建以下的目录规范并且导入jar包

2.写代码

2.1 创建PO类

public class User {
	
	private int id;
	private String username;// 用户姓名
	private String sex;// 性别
	private Date birthday;// 生日
	private String address;// 地址
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public String getUsername() {
		return username;
	}
	public void setUsername(String username) {
		this.username = username;
	}
	public String getSex() {
		return sex;
	}
	public void setSex(String sex) {
		this.sex = sex;
	}
	public Date getBirthday() {
		return birthday;
	}
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}
	public String getAddress() {
		return address;
	}
	public void setAddress(String address) {
		this.address = address;
	}
	@Override
	public String toString() {
		return "User [id=" + id + ", username=" + username + ", sex=" + sex + ", birthday=" + birthday + ", address="
				+ address + "]";
	}
	
}

2.2创建log4j.properties日志文件

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# 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

2.3 创建SqlMapConfig.xml配置文件

在classpath下，创建SqlMapConfig.xml文件

SqlMapConfig.xml（文件头可以从mybatis-3.2.7.pdf文档的2.1.2小节中拷贝）：

<?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的环境信息 -->
<environments default="development">
	<environment id="development">
		<!-- 配置JDBC事务控制，由mybatis进行管理 -->
		<transactionManager type="JDBC"></transactionManager>
		<!-- 配置数据源，采用mybatis连接池 -->
		<dataSource type="POOLED">
			<property name="driver" value="com.mysql.jdbc.Driver"/>
			<property name="url" value=
			"jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8"/>
			<property name="username" value="root"/>
			<property name="password" value="root"/>
		</dataSource>
	</environment>
</environments>
		
		<!-- 加载映射文件 -->
		<mappers>
			<mapper resource="User.xml"/>
		</mappers>	
</configuration>

2.4 创建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：命名空间，它的作用就是对SQL进行分类化管理，可以理解为SQL隔离
	注意：使用mapper代理开发时，namespace有特殊且重要的作用
 -->

<mapper namespace="test">
	<!-- 根据用户ID，查询用户信息 -->
	<!-- 
		[id]：statement的id，要求在命名空间内唯一  
		[parameterType]：入参的java类型
		[resultType]：查询出的单条结果集对应的java类型
		[#{}]： 表示一个占位符?
		[#{id}]：表示该占位符待接收参数的名称为id。注意：如果参数为简单类型时，#{}里面的参数名称可以是任意定义
	 -->
	<select id="findUserById" parameterType="int" resultType="com.cjw.mybatis.po.User">
		SELECT * FROM USER WHERE id=#{id}
	</select>
	
	<!-- 根据用户名称模糊查询用户列表 -->
		<!-- ${}：表示一个sql的连接符 -->
		<!-- ${value}：里面的value表示输入参数的参数名称，如果该参数是简单类型，那么${}里面的参数名称必须是value -->
		<!-- ${}这种写法存在sql注入的风险，所以要慎用！！但是在一些场景下，必须使用${}，比如排序时，动态传入排序的列名，${}会原样输出，不加解释 -->
	<select id="findUserByName" parameterType="java.lang.String" resultType="com.cjw.mybatis.po.User">
		SELECT * FROM USER WHERE username LIKE '%${value}%'
	</select>
	
	<!-- 添加用户 	 主键返回之MySQL自增主键 -->
		<!-- selectKey：查询主键，在标签内需要输入查询主键的sql -->
		<!-- keyProperty：指定存放生成主键的属性 -->
		<!-- resultType：生成主键所对应的Java类型 -->
		<!-- order：指定查询主键的sql和insert语句的执行顺序，相当于insert语句来说 -->
		<!-- LAST_INSERT_ID：该函数是mysql的函数，获取自增主键的ID，它必须配合insert语句一起使用 -->
	<insert id="insertUser" parameterType="com.cjw.mybatis.po.User">
		<selectKey keyProperty="id" resultType="int" order="AFTER">
			SELECT LAST_INSERT_ID()
		</selectKey>
		
		INSERT INTO USER
		(username,birthday,sex,address)
		VALUES(#{username},#{birthday},#{sex},#{address})
	 </insert>
	 
	 
	 
	<!-- 扩展 -->	
	<!-- 添加用户	    自增主键之UUID -->
	<!-- 
		order="BEFORE"：只要主键不是自增，order都设置为BEFORE
		#{id}：需要显式的给id赋值，因为该id的值不是通过自增主键来创建的
	 -->
	<insert id="insertUser2" parameterType="com.cjw.mybatis.po.User">
		<selectKey keyProperty="id" resultType="string" order="BEFORE">
			SELECT UUID() 
		</selectKey>
	
		INSERT INTO USER
		(id,username,birthday,sex,address)
		VALUES(#{id},#{username},#{birthday},#{sex},#{address})
	</insert>
	
	<!-- 扩展 -->
	<!-- 添加用户之sequence返回 -->
	<!-- 
		通过Oracle的sequence获取主键方式与MySQL的uuid方式基本一致	
		order="BEFORE"：只要主键不是自增，order都设置为BEFORE
		#{id}：需要显式的给id赋值，因为该id的值不是通过自增主键来创建的
	-->
	<insert id="insertUser3" parameterType="com.cjw.mybatis.po.User">
		<selectKey keyProperty="id" resultType="int" order="BEFORE">
			SELECT seq.nextval FROM dual
		</selectKey>
	
		INSERT INTO USER
		(id,username,birthday,sex,address)
		VALUES(#{id},#{username},#{birthday},#{sex},#{address})
	</insert>
	
	
	
	<!-- 根据ID删除用户 -->
	<delete id="deleteUser" parameterType="int">
		DELETE FROM USER WHERE id= #{id}
	</delete>
	
	<!-- 根据传入的用户信息修改用户 -->
	<update id="updateUser" parameterType="com.cjw.mybatis.po.User">
		UPDATE USER SET username = #{username},sex=#{sex} WHERE id=#{id}
	</update>

</mapper>

2.5 测试类

public class TestFirst {
	
	/**
	 * 根据ID查询
	 * @throws Exception
	 */
	@Test
	public void findUserByIdTest() throws Exception {
		//全局配置文件路径
		String resource="sqlMapConfig.xml";
		//读取配置文件
		InputStream inputStream=Resources.getResourceAsStream(resource);
		//创建SQLSessionFactory
		SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
		//创建SqlSession
		SqlSession sqlSession=sqlSessionFactory.openSession();
		//调用SQLSession增删改查方法
		   //参数1：表示statement的唯一标识  	
		   //参数2：入参的值，它的类型要和映射文件中对应的statement的入参类型一致
		User user=sqlSession.selectOne("test.findUserById",1);
		System.out.println(user);
		
		//关闭资源
		sqlSession.close();
		
	}
	
	
	/**
	 * 根据姓名查询
	 * @throws Exception
	 */
	@Test
	public void findUserByNameTest() throws Exception {
		//全局配置文件路径
		String resource="sqlMapConfig.xml";
		//读取配置文件
		InputStream inputStream=Resources.getResourceAsStream(resource);
		//创建SQLSessionFactory
		SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
		//创建SqlSession
		SqlSession sqlSession=sqlSessionFactory.openSession();
		// 4、SqlSession执行statement，并返回映射结果
			// 第一个参数：statement的id，建议：namespace.statementId（确保唯一）
			// 第二个参数：入参的值，它的类型要和映射文件中对应的statement的入参类型一致
		List<User> list=sqlSession.selectList("test.findUserByName","w");
		System.out.println(list);
		
		//关闭资源
		sqlSession.close();
		
	}
	
	/**
	 * 添加用户和主键返回之MySQL自增主键
	 * @throws Exception
	 */
	@Test
	public void insertUserTest() throws Exception {
		//全局配置文件路径
		String resource="sqlMapConfig.xml";
		//读取配置文件
		InputStream inputStream=Resources.getResourceAsStream(resource);
		//创建SQLSessionFactory
		SqlSessionFactory sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
		//创建SqlSession
		SqlSession sqlSession=sqlSessionFactory.openSession();
		
		User user=new User();
		user.setUsername("东哥hm19");
		user.setAddress("宝盛西里24号楼");
		
		//调用SqlSession的增删改查方法
			//第一个参数：表示statement的唯一标示
		sqlSession.insert("test.insertUser",user);
		
		System.out.println(user.getId());
		
		//提交事务
		sqlSession.commit();
		//关闭资源
		sqlSession.close();
		
	}
	
	
	/**
	 * 删除用户
	 * @throws Exception
	 */
	@Test
	public void deleteUserTest() throws Exception{
		// 1、读取配置文件
		String resource = "sqlMapConfig.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		// 2、根据配置文件创建SqlSessionFactory
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
		// 3、SqlSessionFactory创建SqlSession
		SqlSession sqlSession = sqlSessionFactory.openSession();
		// 4、SqlSession执行statement，并返回映射结果
		// 第一个参数：statement的id，建议：namespace.statementId（确保唯一）
		// 第二个参数：入参的值，它的类型要和映射文件中对应的statement的入参类型一致
		sqlSession.delete("test.deleteUser", 27);
			
		//切记：增删改操作时，要执行commit操作
		sqlSession.commit();

		// 5、关闭SqlSession
		sqlSession.close();
	}
	
	
	/**
	 * 修改用户
	 * @throws Exception
	 */
	@Test
	public void updateUserTest() throws Exception{
		// 1、读取配置文件
		String resource = "sqlMapConfig.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		// 2、根据配置文件创建SqlSessionFactory
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
		// 3、SqlSessionFactory创建SqlSession
		SqlSession sqlSession = sqlSessionFactory.openSession();
		// 4、SqlSession执行statement，并返回映射结果
			
		//构建user参数，没有赋值的属性采取默认值
		User user = new User();
		user.setId(28);
		user.setUsername("东哥11");
		user.setAddress("清河宝盛西里");
			
		// 第一个参数：statement的id，建议：namespace.statementId（确保唯一）
		// 第二个参数：入参的值，它的类型要和映射文件中对应的statement的入参类型一致
		sqlSession.update("test.updateUser", user);
			
		//切记：增删改操作时，要执行commit操作
		sqlSession.commit();

		// 5、关闭SqlSession
		sqlSession.close();
	}
}

六、总结

1.错误总结

问题的来源：

当我们在项目中和src同级的目录创建一个文件config时，在此文件中编写了SqlMapConfig.xml ，此时我们需要读取此配置文件来创建SqlSessionFactory来作为一个测试类来测试，却发现报出Could not find resource SqlMapConfig.xml 

解决方法：

选中目录config，右键build path-->useas source folder。

2.知识点总结

l #{}和${}

#{}表示占位符?，#{}接收简单类型的参数时，里面的名称可以任意

${}表示拼接符，${}接收简单类型的参数时，里面的名称必须是value

${}里面的值会原样输出，不加解析（如果该参数值是字符串，有不会添加引号）

${}存在sql注入的风险，但是有些场景下必须使用，比如排序后面会动态传入排序的列名

l parameterType和resultType

parameterType指定输入参数的java类型，parameterType只有一个，也就是说入参只有一个。

resultType指定输出结果的java类型（是单条记录的java类型）

l selectOne和selectList

selectOne查询单个对象

selectList查询集合对象