05 mybatis

【Mybatis介绍】

  MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。
  2013年11月迁移到Github。
  MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，
  而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
  Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatemnt、CallableStatement）配置起来，
  并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。

【使用jdbc编程问题总结】

    1、数据库连接创建、释放频繁造成系统资源浪费，从而影响系统性能。如果使用数据库连接池可解决此问题。
    2、Sql语句在代码中硬编码，造成代码不易维护，实际应用中sql变化的可能较大，sql变动需要改变java代码。
    3、使用preparedStatement向占有位符号传参数存在硬编码，因为sql语句的where条件不一定，可能多也可能少，修改sql还要修改代码, 系统不易维护。
    4、对结果集解析存在硬编码（查询列名），sql变化导致解析代码变化，系统不易维护，如果能将数据库记录封装成pojo对象解析比较方便。

【Mybatis架构】

    1、mybatis配置

     SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。

     mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.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="User">
	<select id="findById" parameterType="int" resultType="com.wowowo.bean.User">
		select * from user where id = #{id}
	</select>
</mapper>

    2、通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂

package com.wowowo.query;

import java.io.IOException;
import java.io.Reader;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class QueryById {

	public static void main(String[] args) {

		String resource = "SqlMapConfig.xml";
		Reader reader;
		try {
			reader = Resources.getResourceAsReader(resource);
			SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(reader);
			SqlSession openSession = ssf.openSession();
			Object user = openSession.selectOne("User.findById", 10);
			System.out.println(user);
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}
		
	}

}

    3、由会话工厂创建sqlSession即会话，操作数据库需要通过sqlSession进行。

    4、mybatis底层自定义了Executor执行器接口操作数据库，Executor接口有两个实现，一个是基本执行器、一个是缓存执行器。

    5、Mapped Statement也是mybatis一个底层封装对象，它包装了mybatis配置信息及sql映射信息等。
     mapper.xml文件中一个sql对应一个MappedStatement对象，sql的id即是Mapped statement的id。

    6、Mapped Statement对sql执行输入参数进行定义，包括HashMap、基本类型、pojo，
     Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中，
     输入参数映射就是jdbc编程中对preparedStatement设置参数。

    7、Mapped Statement对sql执行输出结果进行定义，包括HashMap、基本类型、pojo，
     Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中，
     输出结果映射过程相当于jdbc编程中对结果的解析处理过程。

【快速入门】

    1.要求使用MyBatis实现以下功能：

     根据用户id查询一个用户
     根据用户名称模糊查询用户列表
     添加用户
     更新用户
     删除用户

单元测试的用法,有些非主方法如果需要单独测试,可以在方法名上一行写上@test,导入org.junit.Test,然后右键方法名-->run as-->Junit test

    2. 步骤

     a. 创建java工程，加入mybatis核心包、依赖包、数据驱动包。

     b. 加入配置文件
        (1)log4j.properties(需要有log4j的jar包)

        放到src下
            (mybatis默认使用log4j作为输出日志信息,用于DEBUG程序)
        (2)sqlMapConfig.xml

        元素的配置顺序:鼠标移动到configuration元素上即可查看
        (SqlMapConfig.xml是mybatis核心(全局)配置文件，配置文件内容为数据源、事务管理。)

<?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.Driver" />
				<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
				<property name="username" value="root" />
				<property name="password" value="root" />
			</dataSource>
		</environment>
	</environments>
	<mappers>
<mapper resource="com/wowowo/sqlmap/usermap.xml"/>
</mappers>
</configuration>

注意:这里的访问数据源参数datasource是写死的,后面可以通过配置properties元素动态导入

     c. 创建pojo

        POJO（Plain Ordinary Java Object）简单的Java对象，实际就是普通JavaBeans，是为了避免和EJB混淆所创造的简称。

        pojo类作为mybatis进行sql映射使用，po类通常与数据库表对应

package com.wowowo.bean;

import java.util.Date;

public class User {

	
	private Integer id;
	private String username;
	private Date birthday;
	private Integer sex;
	private String adress;
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getUsername() {
		return username;
	}
	public void setUsername(String username) {
		this.username = username;
	}
	public Date getBirthday() {
		return birthday;
	}
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}
	public Integer getSex() {
		return sex;
	}
	public void setSex(Integer sex) {
		this.sex = sex;
	}
	public String getAdress() {
		return adress;
	}
	public void setAdress(String adress) {
		this.adress = adress;
	}
	@Override
	public String toString() {
		return "User [id=" + id + ", username=" + username + ", birthday=" + birthday + ", sex=" + sex + ", adress="
				+ adress + "]";
	}
	
}

     d. sql映射文件
        sqlmap目录下创建sql映射文件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">

<!-- 命名空间, 类似于java中的包名 -->
<mapper namespace="user">

	<!-- 
	#{id} 		表示一个占位符, 相当于jdbc中的 ?, 左右两边会自动加上一个'', 防止SQL注入
	${value}	表示替换, 就是个简单的字符串拼接, 不会加上'', 不防SQL注入
	id:在命名空间中唯一的标识符，可以被用来引用这条语句
    parametertype:将会传入这条语句的参数类的完全限定名或别名
    resultType:返回类型
-->
	<select id="findById" parameterType="int" resultType="User">
		SELECT * from user WHERE id = #{id}
	</select>
	
	<!-- 根据姓名模糊查询 -->
	<select id="findLikeName" parameterType="String" resultType="com.bwf.bean.User">
		SELECT * FROM user WHERE username LIKE '%${value}%';
	</select>
    <!-- 根据姓名模糊查询 -->
	<!-- 用#代替$, 实现了模糊查询中可以防止SQL注入 -->
	<select id="findLikeName2" parameterType="String" resultType="com.bwf.bean.User">
		SELECT * FROM user WHERE username LIKE "%"#{haha}"%";
	</select>

<!--  添加用户 -->
	<insert id="insert" parameterType="com.bwf.bean.User">
<!--  插入时生成主键keyProperty （仅对insert有用）标记一个属性，MyBatis 会通过getGeneratedKeys或者通过 insert 语句的 selectKey 子元素设置它的值。默认：不设置。
 -->
		<selectKey keyProperty="id" resultType="Integer" order="AFTER">
			SELECT LAST_INSERT_ID();
		</selectKey>
		INSERT INTO user (username, birthday, sex, address) 
		VALUES 
		(#{username}, #{birthday}, #{sex}, #{address});
	</insert>
	<!-- 更新用户 -->
	<update id="updateById" parameterType="com.bwf.bean.User">
		UPDATE user SET username = #{username}, birthday = #{birthday}, 
		sex = #{sex}, address = #{address}
		WHERE id = #{id};
	</update>
	<!--  删除用户 -->
	<delete id="deleteById" parameterType="Integer">
		DELETE FROM user WHERE id = #{id};
	</delete>
	
</mapper>

     e. 加载映射文件
        mybatis框架需要加载Mapper.xml映射文件
        将users.xml添加在SqlMapConfig.xml

    <mappers>
    <mapper resource="com/wowowo/sqlmap/usermap.xml"/>
    </mappers>

【Mybatis解决jdbc编程的问题】

    1、数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能，如果使用数据库连接池可解决此问题。
    解决：在SqlMapConfig.xml中配置数据连接池，使用连接池管理数据库链接。

    2、Sql语句写在代码中造成代码不易维护，实际应用sql变化的可能较大，sql变动需要改变java代码。
    解决：将Sql语句配置在XXXXmapper.xml文件中与java代码分离。

    3、向sql语句传参数麻烦，因为sql语句的where条件不一定，可能多也可能少，占位符需要和参数一一对应。
    解决：Mybatis自动将java对象映射至sql语句，通过statement中的parameterType定义输入参数的类型。

    4、对结果集解析麻烦，sql变化导致解析代码变化，且解析前需要遍历，如果能将数据库记录封装成pojo对象解析比较方便。
    解决：Mybatis自动将sql执行结果映射至java对象，通过statement中的resultType定义输出结果的类型。

【原始Dao开发】

    SqlSession中封装了对数据库的操作，如：查询、插入、更新、删除等。
    SqlSession通过SqlSessionFactory创建。
    SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。

    SqlSessionFactoryBuilder
        SqlSessionFactoryBuilder用于创建SqlSessionFacoty，
        SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，
        因为SqlSession是通过SqlSessionFactory创建的。所以可以将SqlSessionFactoryBuilder当成一个工具类使用，
        最佳使用范围是方法范围即方法体内局部变量。

    SqlSessionFactory
        SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，
        SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，
        通常以单例模式管理SqlSessionFactory。

    SqlSession
        SqlSession是一个面向用户的接口，sqlSession中定义了数据库操作方法。
        每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。
        因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。

        打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到 finally 块中以确保每次都能执行关闭

SSFB:静态块用于读取全局配置文件并构造SqlSessionFactoryBuilder和SqlSessionFactory,静态方法用于给dao层返回SqlSessionFactory,从而实现单例模式

package com.wowowo.database;

import java.io.IOException;
import java.io.Reader;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class SSFB {
	private static SqlSessionFactory ssf;
	static {
		String resource = "SqlMapConfig.xml";
		 Reader reader;
		try {
			// 读取全局配置文件
			reader = Resources.getResourceAsReader(resource);
			
			ssf = new SqlSessionFactoryBuilder().build(reader);

		} catch (IOException e) {

			e.printStackTrace();
		}
	}

	public static SqlSessionFactory getSqlSessionFactory() {
			
		return ssf;

	}

}

监听器:服务器一开启就加载ssfb类,构造SqlSessionFactory

package com.wowowo.listener;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class ContextServletListener implements ServletContextListener {

	@Override
	public void contextDestroyed(ServletContextEvent arg0) {

	}

	@Override
	public void contextInitialized(ServletContextEvent arg0) {

		//服务器启动时加载ssfb,创建SqlSessionFactory
		try {
			Class.forName("com.wowowo.database.SSFB");
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}

}

dao实现层:通过调用SSFB.getSqlSessionFactory()获取全局SqlSessionFactory 对象,在每个方法里获取sqlsession,保证了sqlsession线程安全

其实吧,应该在service层获取sqlsession,传入dao层进行数据交互,dao层方法结束,service层提交事务,并在finally里关闭sqlsession

package com.wowowo.dao.impl;

import java.sql.SQLException;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import com.wowowo.bean.User;
import com.wowowo.dao.UserDao;
import com.wowowo.database.SSFB;

public class UserDaoImpl implements UserDao {
	private SqlSessionFactory ssf = SSFB.getSqlSessionFactory();

	@Override
	public User queryByUname(String uname) throws SQLException {
		
		SqlSession openSession = ssf.openSession();
		User u = openSession.selectOne("User.findByUname", uname);
		openSession.close();

		return u;
//		String sql="select * from user where uname=?";
//		PreparedStatement ps = conn.prepareStatement(sql);
//		ps.setObject(1, uname);
//		ResultSet rs = ps.executeQuery();
//
//		return rs.next();
	}
	@Override
	public void insert(String uname, String upwd) throws SQLException {
		SqlSession openSession = ssf.openSession();
		User u=new User();
		u.setUname(uname);
		u.setUpwd(upwd);
		openSession.insert("User.insert", u);
		openSession.commit();
		openSession.close();

	}
	@Override
	public boolean queryByUnameandUpwd(String uname, String upwd) throws SQLException {
		SqlSession openSession = ssf.openSession();

		User u=new User();
		u.setUname(uname);
		u.setUpwd(upwd);
		
		
		u = openSession.selectOne("User.findByUnameAndUpwd", u);
		openSession.close();
		return (u!=null);
	}
}

    * 原始Dao开发中存在以下问题：
    Dao方法体存在重复代码：通过SqlSessionFactory创建SqlSession，调用SqlSession的数据库操作方法
    调用sqlSession的数据库操作方法需要指定statement的id，这里存在硬编码，不得于开发维护。

【Mapper动态代理方式】

    Mapper接口开发方法只需要程序员编写Mapper接口（相当于Dao接口），
    由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。

    Mapper接口开发需要遵循以下规范：
    1、Mapper.xml文件中的namespace与mapper接口的类路径相同。
    2、Mapper接口方法名和Mapper.xml中定义的每个statement的id相同 
    3、Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
    4、Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

mapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- doctype文档类型用来约束xml的标签 -->
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.wowowo.mapper.UserMapper">
	<select id="findById" parameterType="int" resultType="User">
		select *
		from user where id = #{id}
	</select>

</mapper>

mapper.java(接口)

package com.wowowo.mapper;

import com.wowowo.bean.User;

public interface UserMapper {

	User findById(int id);
	
}

测试动态代理

package com.wowowo.mapper;

import java.io.IOException;
import java.io.Reader;

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 com.wowowo.bean.User;

public class Demo01 {
	@Test
	public void test() {

		String resource = "SqlMapConfig.xml";
		Reader reader;
		try {
			reader = Resources.getResourceAsReader(resource);
			SqlSessionFactory ssf = new SqlSessionFactoryBuilder().build(reader);
			SqlSession openSession = ssf.openSession();
			//实例化接口,调用findbyid方法
			UserMapper mapper = openSession.getMapper(UserMapper.class);
			User user = mapper.findById(10);
			System.out.println(user);
		} catch (IOException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

	}

}

    *小结    
        selectOne和selectList
        动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定，
        如果返回list则调用selectList方法，如果返回单个对象则调用selectOne方法。

        namespace
        mybatis官方推荐使用mapper代理方法开发mapper接口，程序员不用编写mapper接口实现类，
        使用mapper代理方法时，输入参数可以使用pojo包装对象或map对象，保证dao的通用性。

【SqlMapConfig.xml配置文件】

元素的配置顺序:鼠标移动到configuration元素上即可查看

    1. properties

这些是外部化的，可替代的属性，这些属性也可以配置在典型的 Java 属性配置文件中，
或者通过 properties 元素的子元素来传递。例如:datasource

其中的属性就可以在整个配置文件中使用，使用可替换的属性来实现动态配置。

例:添加properties标签,resource属性表示读取的文件路径(在src下)

通过动态读取dbconfig.properties文件的方式加载数据库参数

<properties resource="dbconfig.properties"></properties>
	<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="${uname}" />
				<property name="password" value="${upwd}" />
			</dataSource>
		</environment>
	</environments>

    2. typeAliases
        mybatis支持别名：
        别名        映射的类型
        _byte         byte 
        _long         long 
        _short         short 
        _int         int 
        _integer     int 
        _double     double 
        _float         float 
        _boolean     boolean 
        string         String 
        byte         Byte 
        long         Long 
        short         Short 
        int         Integer 
        integer     Integer 
        double         Double 
        float         Float 
        boolean     Boolean 
        date         Date 
        decimal     BigDecimal 
        bigdecimal     BigDecimal 
        map        Map

如果是自己写的pojo类,那么就可以自己定义别名:

	<typeAliases>
	<!-- alias表示你取的别名,type表示原本的类名 -->
		<typeAlias alias="User" type="com.wowowo.bean.User" />
	</typeAliases>

如果到了开发后期,想定义的别名过多,那么可以批量定义别名

<typeAliases>
<!-- 批量定义com.wowowo.bean包内, 所有别名自动起为简单类名-->
<package name="com.wowowo.bean"/>
</typeAliases>

【mybatis与hibernate不同】

  Mybatis和hibernate不同，它不完全是一个ORM框架，因为MyBatis需要程序员自己编写Sql语句。
mybatis可以通过XML或注解方式灵活配置要运行的sql语句，并将java对象和sql语句映射生成最终执行的sql，
最后将sql执行的结果再映射生成java对象。

  Mybatis学习门槛低，简单易学，程序员直接编写原生态sql，可严格控制sql执行性能，灵活度高，非常适合对关系数据模型要求不高的软件开发，
例如互联网软件、企业运营类软件等，因为这类软件需求变化频繁，一但需求变化要求成果输出迅速。
但是灵活的前提是mybatis无法做到数据库无关性，如果需要实现支持多种数据库的软件则需要自定义多套sql映射文件，工作量大。

  Hibernate对象/关系映射能力强，数据库无关性好，对于关系模型要求高的软件（例如需求固定的定制化软件）
如果用hibernate开发可以节省很多代码，提高效率。但是Hibernate的学习门槛高，要精通门槛更高，
而且怎么设计O/R映射，在性能和对象模型之间如何权衡，以及怎样用好Hibernate需要具有很强的经验和能力才行。

  总之，按照用户的需求在有限的资源环境下只要能做出维护性、扩展性良好的软件架构都是好架构，所以框架只有适合才是最好。