Mybatis 框架课程第一天
第1章框架概述
1.1 什么是框架
1.1.1什么是框架
框架(Framework)是整个或部分系统的可重用设计,表现为一组抽象构件及构件实例间交互的方法;另一种
定义认为,框架是可被应用开发者定制的应用骨架。前者是从应用方面而后者是从目的方面给出的定义。
简而言之,框架其实就是某种应用的半成品,就是一组组件,供你选用完成你自己的系统。简单说就是使用别
人搭好的舞台,你来做表演。而且,框架一般是成熟的,不断升级的软件。
1.1.2框架要解决的问题
框架要解决的最重要的一个问题是技术整合的问题,在 J2EE 的框架中,有着各种各样的技术,不同的
软件企业需要从 J2EE中选择不同的技术,这就使得软件企业最终的应用依赖于这些技术,技术自身的复杂性和技
术的风险性将会直接对应用造成冲击。而应用是软件企业的核心,是竞争力的关键所在,因此应该将应用自身的设
计和具体的实现技术解耦。这样,软件企业的研发将集中在应用的设计上,而不是具体的技术实现,技术实现是应
用的底层支撑,它不应该直接对应用产生影响。
框架一般处在低层应用平台(如J2EE)和高层业务逻辑之间的中间层。
1.1.3软件开发的分层重要性
框架的重要性在于它实现了部分功能,并且能够很好的将低层应用平台和高层业务逻辑进行了缓和。为了实现
软件工程中的“高内聚、低耦合”。把问题划分开来各个解决,易于控制,易于延展,易于分配资源。我们常见的
MVC软件设计思想就是很好的分层思想。
通过分层更好的实现了各个部分的职责,在每一层将再细化出不同的框架,分别解决各层关注的问题。
1.1.4分层开发下的常见框架
常见的JavaEE开发框架:
1、解决数据的持久化问题的框架
作为持久层的框架,还有一个封装程度更高的框架就是Hibernate,但这个框架因为各种原因目前在国内的
流行程度下降太多,现在公司开发也越来越少使用。目前使用Spring Data来实现数据持久化也是一种趋势。
2、解决WEB层问题的MVC框架
3、解决技术整合问题的框架
1.1.5 MyBatis框架概述
mybatis是一个优秀的基于java的持久层框架,它内部封装了jdbc,使开发者只需要关注sql语句本身,
而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。
mybatis通过xml或注解的方式将要执行的各种statement配置起来,并通过java对象和statement中
sql的动态参数进行映射生成最终执行的sql语句,最后由mybatis框架执行sql并将结果映射为java对象并
返回。
采用ORM思想解决了实体和数据库映射的问题,对jdbc进行了封装,屏蔽了jdbcapi底层访问细节,使我
们不用与jdbc api打交道,就可以完成对数据库的持久化操作。
为了我们能够更好掌握框架运行的内部过程,并且有更好的体验,下面我们将从自定义 Mybatis框架开始来
学习框架。此时我们将会体验框架从无到有的过程体验,也能够很好的综合前面阶段所学的基础。
1.2 JDBC编程的分析
1.2.1 jdbc程序的回顾
public static void main(String[] args) {
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try {
//加载数据库驱动
Class.forName("com.mysql.jdbc.Driver");
//通过驱动管理类获取数据库链接
connection = DriverManager
.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8","ro
ot", "root");
//定义sql语句 ?表示占位符
String sql = "select * from user where username = ?";
//获取预处理statement
preparedStatement = connection.prepareStatement(sql);
//设置参数,第一个参数为sql语句中参数的序号(从1开始),第二个参数为设置的
参数值
preparedStatement.setString(1, "王五");
//向数据库发出sql执行查询,查询出结果集
resultSet = preparedStatement.executeQuery();
//遍历查询结果集
while(resultSet.next()){
System.out.println(resultSet.getString("id")+"
"+resultSet.getString("username"));
}
} catch (Exception e) {
e.printStackTrace();
}finally{
//释放资源
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) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
}
上边使用jdbc的原始方法(未经封装)实现了查询数据库表记录的操作。
1.2.2 jdbc问题分析
1、数据库链接创建、释放频繁造成系统资源浪费从而影响系统性能,如果使用数据库链接池可解决此问题。
2、Sql语句在代码中硬编码,造成代码不易维护,实际应用sql变化的可能较大,sql变动需要改变java
代码。
3、使用preparedStatement向占有位符号传参数存在硬编码,因为sql语句的where条件不一定,可能
多也可能少,修改sql还要修改代码,系统不易维护。
4、对结果集解析存在硬编码(查询列名),sql变化导致解析代码变化,系统不易维护,如果能将数据库记
录封装成pojo对象解析比较方便。
第2章 Mybatis框架快速入门
通过前面的学习,我们已经能够使用所学的基础知识构建自定义的 Mybatis框架了。这个过程是基本功的考
验,我们已经强大了不少,但现实是残酷的,我们所定义的Mybatis框架和真正的Mybatis框架相比,还是显得
渺小。行业内所流行的Mybatis框架现在我们将开启学习。
2.1 Mybatis框架开发的准备
2.1.1官网下载 Mybatis框架
从百度中“mybatis download”可以下载最新的Mybatis开发包。
进入选择语言的界面,进入中文版本的开发文档。
我们可以看到熟悉的中文开发文档了。
下载相关的jar包或maven开发的坐标。
下载的zip文件如下(我们的资料文件夹):
我们所使用的Mybatis版本是3.4.5版本。
2.2 搭建 Mybatis开发环境
2.2.1创建 maven工程
创建mybatis01的工程,工程信息如下:
Groupid:com.itheima
ArtifactId:mybatis01
Packing:jar
2.2.2添加 Mybatis3.4.5的坐标
在 pom.xml文件中添加 Mybatis3.4.5的坐标,如下:
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
</dependencies>
2.2.3编写 User实体类
/**
*
* <p>Title: User</p>
* <p>Description:用户的实体类</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class User implements Serializable {
private Integer id;
private String username;
private Date birthday;
private String sex;
private String address;
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 String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", birthday=" + birthday
+ ", sex=" + sex + ", address="
+ address + "]";
}
}
2.2.4编写持久层接口 IUserDao
IUserDao接口就是我们的持久层接口(也可以写成UserDao或者UserMapper),具体代码如下:
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
List<User> findAll();
}
2.2.5编写持久层接口的映射文件 IUserDao.xml
要求:
创建位置:必须和持久层接口在相同的包中。
名称:必须以持久层接口名称命名文件名,扩展名是.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="com.itheima.dao.IUserDao">
<!--配置查询所有操作 -->
<select id="findAll" resultType="com.itheima.domain.User">
select * from user
</select>
</mapper>
2.2.6编写 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>
<!--配置mybatis的环境 -->
<environments default="mysql">
<!--配置mysql的环境 -->
<environment id="mysql">
<!--配置事务的类型 -->
<transactionManager type="JDBC"></transactionManager>
<!--配置连接数据库的信息:用的是数据源(连接池) -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/ee50"/>
<property name="username" value="root"/>
<property name="password" value="1234"/>
</dataSource>
</environment>
</environments>
<!--告知mybatis映射配置的位置 -->
<mappers>
<mapper resource="com/itheima/dao/IUserDao.xml"/>
</mappers>
</configuration>
2.2.7编写测试类
/**
*
* <p>Title: MybatisTest</p>
* <p>Description:测试mybatis的环境</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class MybatisTest {
public static void main(String[] args)throws Exception {
//1.读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory的构建者对象
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
//3.使用构建者创建工厂对象SqlSessionFactory
SqlSessionFactory factory = builder.build(in);
//4.使用SqlSessionFactory生产SqlSession对象
SqlSession session = factory.openSession();
//5.使用SqlSession创建dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//6.使用代理对象执行查询所有方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//7.释放资源
session.close();
in.close();
}
}
2.3 小结
通过快速入门示例,我们发现使用 mybatis是非常容易的一件事情,因为只需要编写 Dao接口并且按照
mybatis要求编写两个配置文件,就可以实现功能。远比我们之前的jdbc方便多了。(我们使用注解之后,将变得
更为简单,只需要编写一个mybatis配置文件就够了。)
但是,这里面包含了许多细节,比如为什么会有工厂对象(SqlSessionFactory),为什么有了工厂之后还
要有构建者对象(SqlSessionFactoryBuilder),为什么IUserDao.xml在创建时有位置和文件名的要求等等。
这些问题我们在自定义mybatis框架的章节,通过层层剥离的方式,给大家讲解。
请注意:我们讲解自定义 Mybatis框架,不是让大家回去自己去写个 mybatis,而是让我们能更好了了解
mybatis内部是怎么执行的,在以后的开发中能更好的使用mybatis框架,同时对它的设计理念(设计模式)有
一个认识。
2.4 补充(基于注解的 mybatis使用)
2.4.1在持久层接口中添加注解
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
}
2.4.2修改 SqlMapConfig.xml
<!--告知mybatis映射配置的位置 -->
<mappers>
<mapper class="com.itheima.dao.IUserDao"/>
</mappers>
2.4.3注意事项:
在使用基于注解的Mybatis配置时,请移除xml的映射配置(IUserDao.xml)。
补充
第3章自定义Mybatis框架
3.1 自定义 Mybatis框架的分析
3.1.1涉及知识点介绍
本章我们将使用前面所学的基础知识来构建一个属于自己的持久层框架,将会涉及到的一些知识点:工厂模式
(Factory工厂模式)、构造者模式(Builder模式)、代理模式,反射,自定义注解,注解的反射,xml解析,
数据库元数据,元数据的反射等。
3.1.2分析流程
3.2 前期准备
3.2.1创建 Maven工程
创建mybatis02的工程,工程信息如下:
Groupid:com.itheima
ArtifactId:mybatis02
Packing:jar
3.2.2引入相关坐标
<dependencies>
<!--日志坐标 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<!--解析xml的dom4j -->
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.6.1</version>
</dependency>
<!-- mysql驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<!-- dom4j的依赖包jaxen -->
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>
<version>1.1.6</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
</dependencies>
3.2.3引入工具类到项目中
/**
* @author黑马程序员
* @Company http://www.ithiema.com
*
用于解析配置文件
*/
public class XMLConfigBuilder {
/**
*解析主配置文件,把里面的内容填充到DefaultSqlSession所需要的地方
*使用的技术:
*
dom4j+xpath
* @param session
*/
public
static
void loadConfiguration(DefaultSqlSession session,InputStream
config){
try{
//定义封装连接信息的配置对象(mybatis的配置对象)
Configuration cfg = new Configuration();
//1.获取SAXReader对象
SAXReader reader = new SAXReader();
//2.根据字节输入流获取Document对象
Document document = reader.read(config);
//3.获取根节点
Element root = document.getRootElement();
//4.使用xpath中选择指定节点的方式,获取所有property节点
List<Element> propertyElements = root.selectNodes("//property");
//5.遍历节点
for(Element propertyElement : propertyElements){
//判断节点是连接数据库的哪部分信息
//取出name属性的值
String name = propertyElement.attributeValue("name");
if("driver".equals(name)){
//表示驱动
//获取property标签value属性的值
String driver = propertyElement.attributeValue("value");
cfg.setDriver(driver);
}
if("url".equals(name)){
//表示连接字符串
//获取property标签value属性的值
String url = propertyElement.attributeValue("value");
cfg.setUrl(url);
}
if("username".equals(name)){
//表示用户名
//获取property标签value属性的值
String username = propertyElement.attributeValue("value");
cfg.setUsername(username);
}
if("password".equals(name)){
//表示密码
//获取property标签value属性的值
String password = propertyElement.attributeValue("value");
cfg.setPassword(password);
}
}
//取出mappers中的所有mapper标签,判断他们使用了resource还是class属性
List<Element> mapperElements = root.selectNodes("//mappers/mapper");
//遍历集合
for(Element mapperElement : mapperElements){
//判断mapperElement使用的是哪个属性
Attribute attribute = mapperElement.attribute("resource");
if(attribute != null){
System.out.println("使用的是XML");
//表示有resource属性,用的是XML
//取出属性的值
String
mapperPath
= attribute.getValue();//获取属性的值
"com/itheima/dao/IUserDao.xml"
//把映射配置文件的内容获取出来,封装成一个map
Map<String,Mapper>mappers= loadMapperConfiguration(mapperPath);
//给configuration中的mappers赋值
cfg.setMappers(mappers);
}else{
System.out.println("使用的是注解");
//表示没有resource属性,用的是注解
//获取class属性的值
String daoClassPath = mapperElement.attributeValue("class");
//根据daoClassPath获取封装的必要信息
Map<String,Mapper> mappers = loadMapperAnnotation(daoClassPath);
//给configuration中的mappers赋值
cfg.setMappers(mappers);
}
}
//把配置对象传递给DefaultSqlSession
session.setCfg(cfg);
}catch(Exception e){
throw new RuntimeException(e);
}finally{
try {
config.close();
}catch(Exception e){
e.printStackTrace();
}
}
}
/**
*根据传入的参数,解析XML,并且封装到Map中
* @param mapperPath
* @return map中包含了获取的唯一标识(key是由dao的全限定类名和方法名组成)
以及执行所需的必要信息(value是一个Mapper对象,里面存放的是执行的SQL语句和
映射配置文件的位置
*
要封装的实体类全限定类名)
*/
private
static
Map<String,Mapper>
loadMapperConfiguration(String
mapperPath)throws IOException {
InputStream in = null;
try{
//定义返回值对象
Map<String,Mapper> mappers = new HashMap<String,Mapper>();
//1.根据路径获取字节输入流
in = Resources.getResourceAsStream(mapperPath);
//2.根据字节输入流获取Document对象
SAXReader reader = new SAXReader();
Document document = reader.read(in);
//3.获取根节点
Element root = document.getRootElement();
//4.获取根节点的namespace属性取值
String namespace = root.attributeValue("namespace");//是组成map中key的
部分
//5.获取所有的select节点
List<Element> selectElements = root.selectNodes("//select");
//6.遍历select节点集合
for(Element selectElement : selectElements){
//取出id属性的值
组成map中key的部分
String id = selectElement.attributeValue("id");
//取出resultType属性的值组成map中value的部分
String resultType = selectElement.attributeValue("resultType");
//取出文本内容
组成map中value的部分
String queryString = selectElement.getText();
//创建Key
String key = namespace+"."+id;
//创建Value
Mapper mapper = new Mapper();
mapper.setQueryString(queryString);
mapper.setResultType(resultType);
//把key和value存入mappers中
mappers.put(key,mapper);
}
return mappers;
}catch(Exception e){
throw new RuntimeException(e);
}finally{
in.close();
}
}
/**
*根据传入的参数,得到dao中所有被select注解标注的方法。
*根据方法名称和类名,以及方法上注解value属性的值,组成Mapper的必要信息
* @param daoClassPath
* @return
*/
private
static
Map<String,Mapper>
loadMapperAnnotation(String
daoClassPath)throws Exception{
//定义返回值对象
Map<String,Mapper> mappers = new HashMap<String, Mapper>();
//1.得到dao接口的字节码对象
Class daoClass = Class.forName(daoClassPath);
//2.得到dao接口中的方法数组
Method[] methods = daoClass.getMethods();
//3.遍历Method数组
for(Method method : methods){
//取出每一个方法,判断是否有select注解
boolean isAnnotated = method.isAnnotationPresent(Select.class);
if(isAnnotated){
//创建Mapper对象
Mapper mapper = new Mapper();
//取出注解的value属性值
Select selectAnno = method.getAnnotation(Select.class);
String queryString = selectAnno.value();
mapper.setQueryString(queryString);
//获取当前方法的返回值,还要求必须带有泛型信息
Type type = method.getGenericReturnType();//List<User>
//判断type是不是参数化的类型
if(type instanceof ParameterizedType){
//强转
ParameterizedType ptype = (ParameterizedType)type;
//得到参数化类型中的实际类型参数
Type[] types = ptype.getActualTypeArguments();
//取出第一个
Class domainClass = (Class)types[0];
//获取domainClass的类名
String resultType = domainClass.getName();
//给Mapper赋值
mapper.setResultType(resultType);
}
//组装key的信息
//获取方法的名称
String methodName = method.getName();
String className = method.getDeclaringClass().getName();
String key = className+"."+methodName;
//给map赋值
mappers.put(key,mapper);
}
}
return mappers;
}
}
/**
* @author黑马程序员
* @Company http://www.ithiema.com
*负责执行SQL语句,并且封装结果集
*/
public class Executor {
public <E> List<E> selectList(Mapper mapper, Connection conn) {
PreparedStatement pstm = null;
ResultSet rs = null;
try {
//1.取出mapper中的数据
String queryString = mapper.getQueryString();//select * from user
String resultType = mapper.getResultType();//com.itheima.domain.User
Class domainClass = Class.forName(resultType);//User.class
//2.获取PreparedStatement对象
pstm = conn.prepareStatement(queryString);
//3.执行SQL语句,获取结果集
rs = pstm.executeQuery();
//4.封装结果集
List<E> list = new ArrayList<E>();//定义返回值
while(rs.next()) {
//实例化要封装的实体类对象
E obj = (E)domainClass.newInstance();//User对象
//取出结果集的元信息:ResultSetMetaData
ResultSetMetaData rsmd = rs.getMetaData();
//取出总列数
int columnCount = rsmd.getColumnCount();
//遍历总列数
for (int i = 1; i <= columnCount; i++) {
//获取每列的名称,列名的序号是从1开始的
String columnName = rsmd.getColumnName(i);
//根据得到列名,获取每列的值
Object columnValue = rs.getObject(columnName);
//给obj赋值:使用Java内省机制(借助PropertyDescriptor实现属性的封装)
PropertyDescriptor
pd
=
new
PropertyDescriptor(columnName,domainClass);//要求:实体类的属性和数据库表的列名保持一种
//获取它的写入方法
Method
writeMethod = pd.getWriteMethod();//setUsername(String
username);
//把获取的列的值,给对象赋值
writeMethod.invoke(obj,columnValue);
}
//把赋好值的对象加入到集合中
list.add(obj);
}
return list;
} catch (Exception e) {
throw new RuntimeException(e);
} finally {
release(pstm,rs);
}
}
private void release(PreparedStatement pstm,ResultSet rs){
if(rs != null){
try {
rs.close();
}catch(Exception e){
e.printStackTrace();
}
}
if(pstm != null){
try {
pstm.close();
}catch(Exception e){
e.printStackTrace();
}
}
}
}
/**
*
* <p>Title: DataSourceUtil</p>
* <p>Description:数据源的工具类</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class DataSourceUtil {
/**
*获取连接
* @param cfg
* @return
*/
public static Connection getConnection(Configuration cfg) {
try {
Class.forName(cfg.getDriver());
Connection
conn
=
DriverManager.getConnection(cfg.getUrl(),cfg.getUsername() , cfg.getPassword());
return conn;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
3.2.4编写 SqlMapConfig.xml
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" ></property>
<property name="url" value="jdbc:mysql:///eesy" ></property>
<property name="username" value="root"></property>
<property name="password" value="1234"></property>
</dataSource>
</environment>
</environments>
</configuration>
注意:
此处我们直接使用的是mybatis的配置文件,但是由于我们没有使用mybatis的jar包,所以要把配
置文件的约束删掉否则会报错(如果电脑能接入互联网,不删也行)
3.2.5编写读取配置文件类
/**
*
* <p>Title: Resources</p>
* <p>Description:用于读取配置文件的类</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class Resources {
/**
*用于加载xml文件,并且得到一个流对象
* @param xmlPath
* @return
*在实际开发中读取配置文件:
*
第一:使用类加载器。但是有要求:a文件不能过大。 b文件必须在类路径下(classpath)
第二:使用ServletContext的getRealPath()
*
*/
public static InputStream getResourceAsStream(String xmlPath) {
return Resources.class.getClassLoader().getResourceAsStream(xmlPath);
}
}
3.2.6编写 Mapper类
/**
*
* <p>Title: Mapper</p>
* <p>Description:用于封装查询时的必要信息:要执行的SQL语句和实体类的全限定类名</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class Mapper {
private String queryString;//sql
private String resultType;//结果类型的全限定类名
public String getQueryString() {
return queryString;
}
public void setQueryString(String queryString) {
this.queryString = queryString;
}
public String getResultType() {
return resultType;
}
public void setResultType(String resultType) {
this.resultType = resultType;
}
}
3.2.7编写 Configuration配置类
/**
*核心配置类
*
1.数据库信息
*
2.sql的map集合
*/
public class Configuration {
private String username; //用户名
private String password;//密码
private String url;//地址
private String driver;//驱动
//map集合 Map<唯一标识,Mapper>用于保存映射文件中的sql标识及sql语句
private Map<String,Mapper> mappers;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public String getDriver() {
return driver;
}
public void setDriver(String driver) {
this.driver = driver;
}
public Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
this.mappers = mappers;
}
}
3.2.8编写 User实体类
User实体类:
public class User implements Serializable {
private int id;
private String username;//用户姓名
private String sex;//性别
private Date birthday;//生日
private String address;//地址
//省略getter与setter
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", sex=" + sex
+ ", birthday=" + birthday + ", address=" + address + "]";
}
}
3.3 基于 XML的自定义 mybatis框架
3.3.1编写持久层接口和 IUserDao.xml
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
List<User> findAll();
}
<?xml version="1.0" encoding="UTF-8"?>
<mapper namespace="com.itheima.dao.IUserDao">
<!--配置查询所有操作 -->
<select id="findAll" resultType="com.itheima.domain.User">
select * from user
</select>
</mapper>
注意:
此处我们使用的也是mybatis的配置文件,所以也要把约束删除了
3.3.2编写构建者类
/**
*
* <p>Title: SqlSessionFactoryBuilder</p>
* <p>Description:用于构建SqlSessionFactory的</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class SqlSessionFactoryBuilder {
/**
*根据传入的流,实现对SqlSessionFactory的创建
* @param in它就是SqlMapConfig.xml的配置以及里面包含的IUserDao.xml的配置
* @return
*/
public SqlSessionFactory build(InputStream in) {
DefaultSqlSessionFactory factory = new DefaultSqlSessionFactory();
//给factory中config赋值
factory.setConfig(in);
return factory;
}
}
3.3.3编写 SqlSessionFactory接口和实现类
/**
*
* <p>Title: SqlSessionFactory</p>
* <p>Description: SqlSessionFactory的接口</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface SqlSessionFactory {
/**
*创建一个新的SqlSession对象
* @return
*/
SqlSession openSession();
}
/**
*
* <p>Title: DefaultSqlSessionFactory</p>
* <p>Description:SqlSessionFactory的默认实现 </p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class DefaultSqlSessionFactory implements SqlSessionFactory {
private InputStream config = null;
public void setConfig(InputStream config) {
this.config = config;
}
@Override
public SqlSession openSession() {
DefaultSqlSession session = new DefaultSqlSession();
//调用工具类解析xml文件
XMLConfigBuilder.loadConfiguration(session, config);
return session;
}
}
3.3.4编写 SqlSession接口和实现类
/**
*
* <p>Title: SqlSession</p>
* <p>Description:操作数据库的核心对象</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface SqlSession {
/**
*创建Dao接口的代理对象
* @param daoClass
* @return
*/
<T> T getMapper(Class<T> daoClass);
/**
*释放资源
*/
void close();
}
/**
*
* <p>Title: DefaultSqlSession</p>
* <p>Description: SqlSession的具体实现</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class DefaultSqlSession implements SqlSession {
//核心配置对象
private Configuration cfg;
public void setCfg(Configuration cfg) {
this.cfg = cfg;
}
//连接对象
private Connection conn;
//调用DataSourceUtils工具类获取连接
public Connection getConn() {
try {
conn = DataSourceUtil.getDataSource(cfg).getConnection();
return conn;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
*动态代理:
*
涉及的类:Proxy
*
使用的方法:newProxyInstance
*
方法的参数:
*
ClassLoader:和被代理对象使用相同的类加载器,通常都是固定的
Class[]:代理对象和被代理对象要求有相同的行为。(具有相同的方法)
InvocationHandler:如何代理。需要我们自己提供的增强部分的代码
*
*
*/
@Override
public <T> T getMapper(Class<T> daoClass) {
conn = getConn();
System.out.println(conn);
T daoProxy = (T) Proxy.newProxyInstance(daoClass.getClassLoader(),new
Class[] {daoClass}, new MapperProxyFactory(cfg.getMappers(),conn));
return daoProxy;
}
//释放资源
@Override
public void close() {
try {
System.out.println(conn);
conn.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
//查询所有方法
public <E> List<E> selectList(String statement){
Mapper mapper = cfg.getMappers().get(statement);
return new Executor().selectList(mapper,conn);
}
}
3.3.5编写用于创建 Dao接口代理对象的类
/**
*
* <p>Title: MapperProxyFactory</p>
* <p>Description:用于创建代理对象是增强方法</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class MapperProxyFactory implements InvocationHandler {
private Map<String,Mapper> mappers;
private Connection conn;
public MapperProxyFactory(Map<String, Mapper> mappers,Connection conn) {
this.mappers = mappers;
this.conn = conn;
}
/**
*对当前正在执行的方法进行增强
*
取出当前执行的方法名称
*
取出当前执行的方法所在类
拼接成key
*
*
去Map中获取Value(Mapper)
使用工具类Executor的selectList方法
*
*/
@Override
publicObjectinvoke(Objectproxy,Methodmethod,Object[]args) throwsThrowable
{
//1.取出方法名
String methodName = method.getName();
//2.取出方法所在类名
String className = method.getDeclaringClass().getName();
//3.拼接成Key
String key = className+"."+methodName;
//4.使用key取出mapper
Mapper mapper = mappers.get(key);
if(mapper == null) {
throw new IllegalArgumentException("传入的参数有误,无法获取执行的必要条件
");
}
//5.创建Executor对象
Executor executor = new Executor();
return executor.selectList(mapper, conn);
}
}
3.3.6运行测试类
/**
*
* <p>Title: MybatisTest</p>
* <p>Description:测试mybatis的环境</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class MybatisTest {
public static void main(String[] args)throws Exception {
//1.读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory的构建者对象
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
//3.使用构建者创建工厂对象SqlSessionFactory
SqlSessionFactory factory = builder.build(in);
//4.使用SqlSessionFactory生产SqlSession对象
SqlSession session = factory.openSession();
//5.使用SqlSession创建dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//6.使用代理对象执行查询所有方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//7.释放资源
session.close();
in.close();
}
}
3.4 基于注解方式定义 Mybatis框架
3.4.1自定义@Select注解
/**
*
* <p>Title: Select</p>
* <p>Description:自定义查询注解</p>
* <p>Company: http://www.itheima.com/ </p>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Select {
String value();
}
3.4.2修改持久层接口
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
}
3.4.3修改 SqlMapConfig.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--配置mybatis的环境 -->
<environments default="mysql">
<!--配置mysql的环境 -->
<environment id="mysql">
<!--配置事务的类型 -->
<transactionManager type="JDBC"></transactionManager>
<!--配置连接数据库的信息:用的是数据源(连接池) -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/ee50"/>
<property name="username" value="root"/>
<property name="password" value="1234"/>
</dataSource>
</environment>
</environments>
<!--告知mybatis映射配置的位置 -->
<mappers>
<mapper class="com.itheima.dao.IUserDao"/>
</mappers>
</configuration>
3.5 自定义 Mybatis的设计模式说明
3.5.1工厂模式(SqlSessionFactory)
工厂模式的原理如下图:
3.5.2代理模式(MapperProxyFactory)
代理模式分为静态和动态代理。静态代理,我们通常都很熟悉。有一个写好的代理类,实现与要代理的类的一
个共同的接口,目的是为了约束也为了安全。具体不再多说。
这里主要想说的是关于动态代理。我们知道静态代理若想代理多个类,实现扩展功能,那么它必须具有多个代
理类分别取代理不同的实现类。这样做的后果是造成太多的代码冗余。那么我们会思考如果做,才能既满足需求,
又没有太多的冗余代码呢?——————动态代理。通过前面的课程我们已经学过了基于 JDK的动态代理实现方式,今
天我们就会使用JDK动态代理方式来编写MapperProxyFactory类。
动态代理模型图:
3.5.3构建者模式(SqlSessionFactoryBuilder)
首先我们一起来学习构建者模式,通过百度百科如下:
具体设计模式的模型图如下:
从图中我们可以看出,创建者模式由四部分组成。
抽象创建者角色:给出一个抽象接口,以规范产品对象的各个组成成分的建造。一般而言,此接口独立于应用
程序的商业逻辑。模式中直接创建产品对象的是具体创建者角色。具体创建者必须实现这个接口的两种方法:一是
建造方法,比如图中的 buildPart1和 buildPart2方法;另一种是结果返回方法,即图中的 getProduct方
法。一般来说,产品所包含的零件数目与建造方法的数目相符。换言之,有多少零件,就有多少相应的建造方法。
具体创建者角色:他们在应用程序中负责创建产品的实例。这个角色要完成的任务包括:
1、实现抽象创建者所声明的抽象方法,给出一步一步的完成产品创建实例的操作。
2、在创建完成后,提供产品的实例。
导演者角色:这个类调用具体创建者角色以创建产品对象。但是导演者并没有产品类的具体知识,真正拥有产
品类的具体知识的是具体创建者角色。
产品角色:产品便是建造中的复杂对象。一般说来,一个系统中会有多于一个的产品类,而且这些产品类并不
一定有共同的接口,而完全可以使不相关联的。
3.5.4小结
通过自定义 Mybatis框架的学习,我们将前面的基础知识很好的结合在一起,并且强化了我们的设计模式及
使用。希望大家能够抽时间多练习,这也是系统架构师的必由之路。
第1章框架概述
1.1 什么是框架
1.1.1什么是框架
框架(Framework)是整个或部分系统的可重用设计,表现为一组抽象构件及构件实例间交互的方法;另一种
定义认为,框架是可被应用开发者定制的应用骨架。前者是从应用方面而后者是从目的方面给出的定义。
简而言之,框架其实就是某种应用的半成品,就是一组组件,供你选用完成你自己的系统。简单说就是使用别
人搭好的舞台,你来做表演。而且,框架一般是成熟的,不断升级的软件。
1.1.2框架要解决的问题
框架要解决的最重要的一个问题是技术整合的问题,在 J2EE 的框架中,有着各种各样的技术,不同的
软件企业需要从 J2EE中选择不同的技术,这就使得软件企业最终的应用依赖于这些技术,技术自身的复杂性和技
术的风险性将会直接对应用造成冲击。而应用是软件企业的核心,是竞争力的关键所在,因此应该将应用自身的设
计和具体的实现技术解耦。这样,软件企业的研发将集中在应用的设计上,而不是具体的技术实现,技术实现是应
用的底层支撑,它不应该直接对应用产生影响。
框架一般处在低层应用平台(如J2EE)和高层业务逻辑之间的中间层。
1.1.3软件开发的分层重要性
框架的重要性在于它实现了部分功能,并且能够很好的将低层应用平台和高层业务逻辑进行了缓和。为了实现
软件工程中的“高内聚、低耦合”。把问题划分开来各个解决,易于控制,易于延展,易于分配资源。我们常见的
MVC软件设计思想就是很好的分层思想。
通过分层更好的实现了各个部分的职责,在每一层将再细化出不同的框架,分别解决各层关注的问题。
1.1.4分层开发下的常见框架
常见的JavaEE开发框架:
1、解决数据的持久化问题的框架
作为持久层的框架,还有一个封装程度更高的框架就是Hibernate,但这个框架因为各种原因目前在国内的
流行程度下降太多,现在公司开发也越来越少使用。目前使用Spring Data来实现数据持久化也是一种趋势。
2、解决WEB层问题的MVC框架
3、解决技术整合问题的框架
1.1.5 MyBatis框架概述
mybatis是一个优秀的基于java的持久层框架,它内部封装了jdbc,使开发者只需要关注sql语句本身,
而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。
mybatis通过xml或注解的方式将要执行的各种statement配置起来,并通过java对象和statement中
sql的动态参数进行映射生成最终执行的sql语句,最后由mybatis框架执行sql并将结果映射为java对象并
返回。
采用ORM思想解决了实体和数据库映射的问题,对jdbc进行了封装,屏蔽了jdbcapi底层访问细节,使我
们不用与jdbc api打交道,就可以完成对数据库的持久化操作。
为了我们能够更好掌握框架运行的内部过程,并且有更好的体验,下面我们将从自定义 Mybatis框架开始来
学习框架。此时我们将会体验框架从无到有的过程体验,也能够很好的综合前面阶段所学的基础。
1.2 JDBC编程的分析
1.2.1 jdbc程序的回顾
public static void main(String[] args) {
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try {
//加载数据库驱动
Class.forName("com.mysql.jdbc.Driver");
//通过驱动管理类获取数据库链接
connection = DriverManager
.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8","ro
ot", "root");
//定义sql语句 ?表示占位符
String sql = "select * from user where username = ?";
//获取预处理statement
preparedStatement = connection.prepareStatement(sql);
//设置参数,第一个参数为sql语句中参数的序号(从1开始),第二个参数为设置的
参数值
preparedStatement.setString(1, "王五");
//向数据库发出sql执行查询,查询出结果集
resultSet = preparedStatement.executeQuery();
//遍历查询结果集
while(resultSet.next()){
System.out.println(resultSet.getString("id")+"
"+resultSet.getString("username"));
}
} catch (Exception e) {
e.printStackTrace();
}finally{
//释放资源
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) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
}
上边使用jdbc的原始方法(未经封装)实现了查询数据库表记录的操作。
1.2.2 jdbc问题分析
1、数据库链接创建、释放频繁造成系统资源浪费从而影响系统性能,如果使用数据库链接池可解决此问题。
2、Sql语句在代码中硬编码,造成代码不易维护,实际应用sql变化的可能较大,sql变动需要改变java
代码。
3、使用preparedStatement向占有位符号传参数存在硬编码,因为sql语句的where条件不一定,可能
多也可能少,修改sql还要修改代码,系统不易维护。
4、对结果集解析存在硬编码(查询列名),sql变化导致解析代码变化,系统不易维护,如果能将数据库记
录封装成pojo对象解析比较方便。
第2章 Mybatis框架快速入门
通过前面的学习,我们已经能够使用所学的基础知识构建自定义的 Mybatis框架了。这个过程是基本功的考
验,我们已经强大了不少,但现实是残酷的,我们所定义的Mybatis框架和真正的Mybatis框架相比,还是显得
渺小。行业内所流行的Mybatis框架现在我们将开启学习。
2.1 Mybatis框架开发的准备
2.1.1官网下载 Mybatis框架
从百度中“mybatis download”可以下载最新的Mybatis开发包。
进入选择语言的界面,进入中文版本的开发文档。
我们可以看到熟悉的中文开发文档了。
下载相关的jar包或maven开发的坐标。
下载的zip文件如下(我们的资料文件夹):
我们所使用的Mybatis版本是3.4.5版本。
2.2 搭建 Mybatis开发环境
2.2.1创建 maven工程
创建mybatis01的工程,工程信息如下:
Groupid:com.itheima
ArtifactId:mybatis01
Packing:jar
2.2.2添加 Mybatis3.4.5的坐标
在 pom.xml文件中添加 Mybatis3.4.5的坐标,如下:
<dependencies>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
</dependencies>
2.2.3编写 User实体类
/**
*
* <p>Title: User</p>
* <p>Description:用户的实体类</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class User implements Serializable {
private Integer id;
private String username;
private Date birthday;
private String sex;
private String address;
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 String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", birthday=" + birthday
+ ", sex=" + sex + ", address="
+ address + "]";
}
}
2.2.4编写持久层接口 IUserDao
IUserDao接口就是我们的持久层接口(也可以写成UserDao或者UserMapper),具体代码如下:
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
List<User> findAll();
}
2.2.5编写持久层接口的映射文件 IUserDao.xml
要求:
创建位置:必须和持久层接口在相同的包中。
名称:必须以持久层接口名称命名文件名,扩展名是.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="com.itheima.dao.IUserDao">
<!--配置查询所有操作 -->
<select id="findAll" resultType="com.itheima.domain.User">
select * from user
</select>
</mapper>
2.2.6编写 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>
<!--配置mybatis的环境 -->
<environments default="mysql">
<!--配置mysql的环境 -->
<environment id="mysql">
<!--配置事务的类型 -->
<transactionManager type="JDBC"></transactionManager>
<!--配置连接数据库的信息:用的是数据源(连接池) -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/ee50"/>
<property name="username" value="root"/>
<property name="password" value="1234"/>
</dataSource>
</environment>
</environments>
<!--告知mybatis映射配置的位置 -->
<mappers>
<mapper resource="com/itheima/dao/IUserDao.xml"/>
</mappers>
</configuration>
2.2.7编写测试类
/**
*
* <p>Title: MybatisTest</p>
* <p>Description:测试mybatis的环境</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class MybatisTest {
public static void main(String[] args)throws Exception {
//1.读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory的构建者对象
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
//3.使用构建者创建工厂对象SqlSessionFactory
SqlSessionFactory factory = builder.build(in);
//4.使用SqlSessionFactory生产SqlSession对象
SqlSession session = factory.openSession();
//5.使用SqlSession创建dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//6.使用代理对象执行查询所有方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//7.释放资源
session.close();
in.close();
}
}
2.3 小结
通过快速入门示例,我们发现使用 mybatis是非常容易的一件事情,因为只需要编写 Dao接口并且按照
mybatis要求编写两个配置文件,就可以实现功能。远比我们之前的jdbc方便多了。(我们使用注解之后,将变得
更为简单,只需要编写一个mybatis配置文件就够了。)
但是,这里面包含了许多细节,比如为什么会有工厂对象(SqlSessionFactory),为什么有了工厂之后还
要有构建者对象(SqlSessionFactoryBuilder),为什么IUserDao.xml在创建时有位置和文件名的要求等等。
这些问题我们在自定义mybatis框架的章节,通过层层剥离的方式,给大家讲解。
请注意:我们讲解自定义 Mybatis框架,不是让大家回去自己去写个 mybatis,而是让我们能更好了了解
mybatis内部是怎么执行的,在以后的开发中能更好的使用mybatis框架,同时对它的设计理念(设计模式)有
一个认识。
2.4 补充(基于注解的 mybatis使用)
2.4.1在持久层接口中添加注解
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
}
2.4.2修改 SqlMapConfig.xml
<!--告知mybatis映射配置的位置 -->
<mappers>
<mapper class="com.itheima.dao.IUserDao"/>
</mappers>
2.4.3注意事项:
在使用基于注解的Mybatis配置时,请移除xml的映射配置(IUserDao.xml)。
补充
第3章自定义Mybatis框架
3.1 自定义 Mybatis框架的分析
3.1.1涉及知识点介绍
本章我们将使用前面所学的基础知识来构建一个属于自己的持久层框架,将会涉及到的一些知识点:工厂模式
(Factory工厂模式)、构造者模式(Builder模式)、代理模式,反射,自定义注解,注解的反射,xml解析,
数据库元数据,元数据的反射等。
3.1.2分析流程
3.2 前期准备
3.2.1创建 Maven工程
创建mybatis02的工程,工程信息如下:
Groupid:com.itheima
ArtifactId:mybatis02
Packing:jar
3.2.2引入相关坐标
<dependencies>
<!--日志坐标 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.12</version>
</dependency>
<!--解析xml的dom4j -->
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.6.1</version>
</dependency>
<!-- mysql驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
<!-- dom4j的依赖包jaxen -->
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>
<version>1.1.6</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</version>
</dependency>
</dependencies>
3.2.3引入工具类到项目中
/**
* @author黑马程序员
* @Company http://www.ithiema.com
*
用于解析配置文件
*/
public class XMLConfigBuilder {
/**
*解析主配置文件,把里面的内容填充到DefaultSqlSession所需要的地方
*使用的技术:
*
dom4j+xpath
* @param session
*/
public
static
void loadConfiguration(DefaultSqlSession session,InputStream
config){
try{
//定义封装连接信息的配置对象(mybatis的配置对象)
Configuration cfg = new Configuration();
//1.获取SAXReader对象
SAXReader reader = new SAXReader();
//2.根据字节输入流获取Document对象
Document document = reader.read(config);
//3.获取根节点
Element root = document.getRootElement();
//4.使用xpath中选择指定节点的方式,获取所有property节点
List<Element> propertyElements = root.selectNodes("//property");
//5.遍历节点
for(Element propertyElement : propertyElements){
//判断节点是连接数据库的哪部分信息
//取出name属性的值
String name = propertyElement.attributeValue("name");
if("driver".equals(name)){
//表示驱动
//获取property标签value属性的值
String driver = propertyElement.attributeValue("value");
cfg.setDriver(driver);
}
if("url".equals(name)){
//表示连接字符串
//获取property标签value属性的值
String url = propertyElement.attributeValue("value");
cfg.setUrl(url);
}
if("username".equals(name)){
//表示用户名
//获取property标签value属性的值
String username = propertyElement.attributeValue("value");
cfg.setUsername(username);
}
if("password".equals(name)){
//表示密码
//获取property标签value属性的值
String password = propertyElement.attributeValue("value");
cfg.setPassword(password);
}
}
//取出mappers中的所有mapper标签,判断他们使用了resource还是class属性
List<Element> mapperElements = root.selectNodes("//mappers/mapper");
//遍历集合
for(Element mapperElement : mapperElements){
//判断mapperElement使用的是哪个属性
Attribute attribute = mapperElement.attribute("resource");
if(attribute != null){
System.out.println("使用的是XML");
//表示有resource属性,用的是XML
//取出属性的值
String
mapperPath
= attribute.getValue();//获取属性的值
"com/itheima/dao/IUserDao.xml"
//把映射配置文件的内容获取出来,封装成一个map
Map<String,Mapper>mappers= loadMapperConfiguration(mapperPath);
//给configuration中的mappers赋值
cfg.setMappers(mappers);
}else{
System.out.println("使用的是注解");
//表示没有resource属性,用的是注解
//获取class属性的值
String daoClassPath = mapperElement.attributeValue("class");
//根据daoClassPath获取封装的必要信息
Map<String,Mapper> mappers = loadMapperAnnotation(daoClassPath);
//给configuration中的mappers赋值
cfg.setMappers(mappers);
}
}
//把配置对象传递给DefaultSqlSession
session.setCfg(cfg);
}catch(Exception e){
throw new RuntimeException(e);
}finally{
try {
config.close();
}catch(Exception e){
e.printStackTrace();
}
}
}
/**
*根据传入的参数,解析XML,并且封装到Map中
* @param mapperPath
* @return map中包含了获取的唯一标识(key是由dao的全限定类名和方法名组成)
以及执行所需的必要信息(value是一个Mapper对象,里面存放的是执行的SQL语句和
映射配置文件的位置
*
要封装的实体类全限定类名)
*/
private
static
Map<String,Mapper>
loadMapperConfiguration(String
mapperPath)throws IOException {
InputStream in = null;
try{
//定义返回值对象
Map<String,Mapper> mappers = new HashMap<String,Mapper>();
//1.根据路径获取字节输入流
in = Resources.getResourceAsStream(mapperPath);
//2.根据字节输入流获取Document对象
SAXReader reader = new SAXReader();
Document document = reader.read(in);
//3.获取根节点
Element root = document.getRootElement();
//4.获取根节点的namespace属性取值
String namespace = root.attributeValue("namespace");//是组成map中key的
部分
//5.获取所有的select节点
List<Element> selectElements = root.selectNodes("//select");
//6.遍历select节点集合
for(Element selectElement : selectElements){
//取出id属性的值
组成map中key的部分
String id = selectElement.attributeValue("id");
//取出resultType属性的值组成map中value的部分
String resultType = selectElement.attributeValue("resultType");
//取出文本内容
组成map中value的部分
String queryString = selectElement.getText();
//创建Key
String key = namespace+"."+id;
//创建Value
Mapper mapper = new Mapper();
mapper.setQueryString(queryString);
mapper.setResultType(resultType);
//把key和value存入mappers中
mappers.put(key,mapper);
}
return mappers;
}catch(Exception e){
throw new RuntimeException(e);
}finally{
in.close();
}
}
/**
*根据传入的参数,得到dao中所有被select注解标注的方法。
*根据方法名称和类名,以及方法上注解value属性的值,组成Mapper的必要信息
* @param daoClassPath
* @return
*/
private
static
Map<String,Mapper>
loadMapperAnnotation(String
daoClassPath)throws Exception{
//定义返回值对象
Map<String,Mapper> mappers = new HashMap<String, Mapper>();
//1.得到dao接口的字节码对象
Class daoClass = Class.forName(daoClassPath);
//2.得到dao接口中的方法数组
Method[] methods = daoClass.getMethods();
//3.遍历Method数组
for(Method method : methods){
//取出每一个方法,判断是否有select注解
boolean isAnnotated = method.isAnnotationPresent(Select.class);
if(isAnnotated){
//创建Mapper对象
Mapper mapper = new Mapper();
//取出注解的value属性值
Select selectAnno = method.getAnnotation(Select.class);
String queryString = selectAnno.value();
mapper.setQueryString(queryString);
//获取当前方法的返回值,还要求必须带有泛型信息
Type type = method.getGenericReturnType();//List<User>
//判断type是不是参数化的类型
if(type instanceof ParameterizedType){
//强转
ParameterizedType ptype = (ParameterizedType)type;
//得到参数化类型中的实际类型参数
Type[] types = ptype.getActualTypeArguments();
//取出第一个
Class domainClass = (Class)types[0];
//获取domainClass的类名
String resultType = domainClass.getName();
//给Mapper赋值
mapper.setResultType(resultType);
}
//组装key的信息
//获取方法的名称
String methodName = method.getName();
String className = method.getDeclaringClass().getName();
String key = className+"."+methodName;
//给map赋值
mappers.put(key,mapper);
}
}
return mappers;
}
}
/**
* @author黑马程序员
* @Company http://www.ithiema.com
*负责执行SQL语句,并且封装结果集
*/
public class Executor {
public <E> List<E> selectList(Mapper mapper, Connection conn) {
PreparedStatement pstm = null;
ResultSet rs = null;
try {
//1.取出mapper中的数据
String queryString = mapper.getQueryString();//select * from user
String resultType = mapper.getResultType();//com.itheima.domain.User
Class domainClass = Class.forName(resultType);//User.class
//2.获取PreparedStatement对象
pstm = conn.prepareStatement(queryString);
//3.执行SQL语句,获取结果集
rs = pstm.executeQuery();
//4.封装结果集
List<E> list = new ArrayList<E>();//定义返回值
while(rs.next()) {
//实例化要封装的实体类对象
E obj = (E)domainClass.newInstance();//User对象
//取出结果集的元信息:ResultSetMetaData
ResultSetMetaData rsmd = rs.getMetaData();
//取出总列数
int columnCount = rsmd.getColumnCount();
//遍历总列数
for (int i = 1; i <= columnCount; i++) {
//获取每列的名称,列名的序号是从1开始的
String columnName = rsmd.getColumnName(i);
//根据得到列名,获取每列的值
Object columnValue = rs.getObject(columnName);
//给obj赋值:使用Java内省机制(借助PropertyDescriptor实现属性的封装)
PropertyDescriptor
pd
=
new
PropertyDescriptor(columnName,domainClass);//要求:实体类的属性和数据库表的列名保持一种
//获取它的写入方法
Method
writeMethod = pd.getWriteMethod();//setUsername(String
username);
//把获取的列的值,给对象赋值
writeMethod.invoke(obj,columnValue);
}
//把赋好值的对象加入到集合中
list.add(obj);
}
return list;
} catch (Exception e) {
throw new RuntimeException(e);
} finally {
release(pstm,rs);
}
}
private void release(PreparedStatement pstm,ResultSet rs){
if(rs != null){
try {
rs.close();
}catch(Exception e){
e.printStackTrace();
}
}
if(pstm != null){
try {
pstm.close();
}catch(Exception e){
e.printStackTrace();
}
}
}
}
/**
*
* <p>Title: DataSourceUtil</p>
* <p>Description:数据源的工具类</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class DataSourceUtil {
/**
*获取连接
* @param cfg
* @return
*/
public static Connection getConnection(Configuration cfg) {
try {
Class.forName(cfg.getDriver());
Connection
conn
=
DriverManager.getConnection(cfg.getUrl(),cfg.getUsername() , cfg.getPassword());
return conn;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
3.2.4编写 SqlMapConfig.xml
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" ></property>
<property name="url" value="jdbc:mysql:///eesy" ></property>
<property name="username" value="root"></property>
<property name="password" value="1234"></property>
</dataSource>
</environment>
</environments>
</configuration>
注意:
此处我们直接使用的是mybatis的配置文件,但是由于我们没有使用mybatis的jar包,所以要把配
置文件的约束删掉否则会报错(如果电脑能接入互联网,不删也行)
3.2.5编写读取配置文件类
/**
*
* <p>Title: Resources</p>
* <p>Description:用于读取配置文件的类</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class Resources {
/**
*用于加载xml文件,并且得到一个流对象
* @param xmlPath
* @return
*在实际开发中读取配置文件:
*
第一:使用类加载器。但是有要求:a文件不能过大。 b文件必须在类路径下(classpath)
第二:使用ServletContext的getRealPath()
*
*/
public static InputStream getResourceAsStream(String xmlPath) {
return Resources.class.getClassLoader().getResourceAsStream(xmlPath);
}
}
3.2.6编写 Mapper类
/**
*
* <p>Title: Mapper</p>
* <p>Description:用于封装查询时的必要信息:要执行的SQL语句和实体类的全限定类名</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class Mapper {
private String queryString;//sql
private String resultType;//结果类型的全限定类名
public String getQueryString() {
return queryString;
}
public void setQueryString(String queryString) {
this.queryString = queryString;
}
public String getResultType() {
return resultType;
}
public void setResultType(String resultType) {
this.resultType = resultType;
}
}
3.2.7编写 Configuration配置类
/**
*核心配置类
*
1.数据库信息
*
2.sql的map集合
*/
public class Configuration {
private String username; //用户名
private String password;//密码
private String url;//地址
private String driver;//驱动
//map集合 Map<唯一标识,Mapper>用于保存映射文件中的sql标识及sql语句
private Map<String,Mapper> mappers;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getUrl() {
return url;
}
public void setUrl(String url) {
this.url = url;
}
public String getDriver() {
return driver;
}
public void setDriver(String driver) {
this.driver = driver;
}
public Map<String, Mapper> getMappers() {
return mappers;
}
public void setMappers(Map<String, Mapper> mappers) {
this.mappers = mappers;
}
}
3.2.8编写 User实体类
User实体类:
public class User implements Serializable {
private int id;
private String username;//用户姓名
private String sex;//性别
private Date birthday;//生日
private String address;//地址
//省略getter与setter
@Override
public String toString() {
return "User [id=" + id + ", username=" + username + ", sex=" + sex
+ ", birthday=" + birthday + ", address=" + address + "]";
}
}
3.3 基于 XML的自定义 mybatis框架
3.3.1编写持久层接口和 IUserDao.xml
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
List<User> findAll();
}
<?xml version="1.0" encoding="UTF-8"?>
<mapper namespace="com.itheima.dao.IUserDao">
<!--配置查询所有操作 -->
<select id="findAll" resultType="com.itheima.domain.User">
select * from user
</select>
</mapper>
注意:
此处我们使用的也是mybatis的配置文件,所以也要把约束删除了
3.3.2编写构建者类
/**
*
* <p>Title: SqlSessionFactoryBuilder</p>
* <p>Description:用于构建SqlSessionFactory的</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class SqlSessionFactoryBuilder {
/**
*根据传入的流,实现对SqlSessionFactory的创建
* @param in它就是SqlMapConfig.xml的配置以及里面包含的IUserDao.xml的配置
* @return
*/
public SqlSessionFactory build(InputStream in) {
DefaultSqlSessionFactory factory = new DefaultSqlSessionFactory();
//给factory中config赋值
factory.setConfig(in);
return factory;
}
}
3.3.3编写 SqlSessionFactory接口和实现类
/**
*
* <p>Title: SqlSessionFactory</p>
* <p>Description: SqlSessionFactory的接口</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface SqlSessionFactory {
/**
*创建一个新的SqlSession对象
* @return
*/
SqlSession openSession();
}
/**
*
* <p>Title: DefaultSqlSessionFactory</p>
* <p>Description:SqlSessionFactory的默认实现 </p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class DefaultSqlSessionFactory implements SqlSessionFactory {
private InputStream config = null;
public void setConfig(InputStream config) {
this.config = config;
}
@Override
public SqlSession openSession() {
DefaultSqlSession session = new DefaultSqlSession();
//调用工具类解析xml文件
XMLConfigBuilder.loadConfiguration(session, config);
return session;
}
}
3.3.4编写 SqlSession接口和实现类
/**
*
* <p>Title: SqlSession</p>
* <p>Description:操作数据库的核心对象</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface SqlSession {
/**
*创建Dao接口的代理对象
* @param daoClass
* @return
*/
<T> T getMapper(Class<T> daoClass);
/**
*释放资源
*/
void close();
}
/**
*
* <p>Title: DefaultSqlSession</p>
* <p>Description: SqlSession的具体实现</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class DefaultSqlSession implements SqlSession {
//核心配置对象
private Configuration cfg;
public void setCfg(Configuration cfg) {
this.cfg = cfg;
}
//连接对象
private Connection conn;
//调用DataSourceUtils工具类获取连接
public Connection getConn() {
try {
conn = DataSourceUtil.getDataSource(cfg).getConnection();
return conn;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
*动态代理:
*
涉及的类:Proxy
*
使用的方法:newProxyInstance
*
方法的参数:
*
ClassLoader:和被代理对象使用相同的类加载器,通常都是固定的
Class[]:代理对象和被代理对象要求有相同的行为。(具有相同的方法)
InvocationHandler:如何代理。需要我们自己提供的增强部分的代码
*
*
*/
@Override
public <T> T getMapper(Class<T> daoClass) {
conn = getConn();
System.out.println(conn);
T daoProxy = (T) Proxy.newProxyInstance(daoClass.getClassLoader(),new
Class[] {daoClass}, new MapperProxyFactory(cfg.getMappers(),conn));
return daoProxy;
}
//释放资源
@Override
public void close() {
try {
System.out.println(conn);
conn.close();
} catch (SQLException e) {
e.printStackTrace();
}
}
//查询所有方法
public <E> List<E> selectList(String statement){
Mapper mapper = cfg.getMappers().get(statement);
return new Executor().selectList(mapper,conn);
}
}
3.3.5编写用于创建 Dao接口代理对象的类
/**
*
* <p>Title: MapperProxyFactory</p>
* <p>Description:用于创建代理对象是增强方法</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class MapperProxyFactory implements InvocationHandler {
private Map<String,Mapper> mappers;
private Connection conn;
public MapperProxyFactory(Map<String, Mapper> mappers,Connection conn) {
this.mappers = mappers;
this.conn = conn;
}
/**
*对当前正在执行的方法进行增强
*
取出当前执行的方法名称
*
取出当前执行的方法所在类
拼接成key
*
*
去Map中获取Value(Mapper)
使用工具类Executor的selectList方法
*
*/
@Override
publicObjectinvoke(Objectproxy,Methodmethod,Object[]args) throwsThrowable
{
//1.取出方法名
String methodName = method.getName();
//2.取出方法所在类名
String className = method.getDeclaringClass().getName();
//3.拼接成Key
String key = className+"."+methodName;
//4.使用key取出mapper
Mapper mapper = mappers.get(key);
if(mapper == null) {
throw new IllegalArgumentException("传入的参数有误,无法获取执行的必要条件
");
}
//5.创建Executor对象
Executor executor = new Executor();
return executor.selectList(mapper, conn);
}
}
3.3.6运行测试类
/**
*
* <p>Title: MybatisTest</p>
* <p>Description:测试mybatis的环境</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public class MybatisTest {
public static void main(String[] args)throws Exception {
//1.读取配置文件
InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
//2.创建SqlSessionFactory的构建者对象
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
//3.使用构建者创建工厂对象SqlSessionFactory
SqlSessionFactory factory = builder.build(in);
//4.使用SqlSessionFactory生产SqlSession对象
SqlSession session = factory.openSession();
//5.使用SqlSession创建dao接口的代理对象
IUserDao userDao = session.getMapper(IUserDao.class);
//6.使用代理对象执行查询所有方法
List<User> users = userDao.findAll();
for(User user : users) {
System.out.println(user);
}
//7.释放资源
session.close();
in.close();
}
}
3.4 基于注解方式定义 Mybatis框架
3.4.1自定义@Select注解
/**
*
* <p>Title: Select</p>
* <p>Description:自定义查询注解</p>
* <p>Company: http://www.itheima.com/ </p>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Select {
String value();
}
3.4.2修改持久层接口
/**
*
* <p>Title: IUserDao</p>
* <p>Description:用户的持久层操作</p>
* <p>Company: http://www.itheima.com/ </p>
*/
public interface IUserDao {
/**
*查询所有用户
* @return
*/
@Select("select * from user")
List<User> findAll();
}
3.4.3修改 SqlMapConfig.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--配置mybatis的环境 -->
<environments default="mysql">
<!--配置mysql的环境 -->
<environment id="mysql">
<!--配置事务的类型 -->
<transactionManager type="JDBC"></transactionManager>
<!--配置连接数据库的信息:用的是数据源(连接池) -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/ee50"/>
<property name="username" value="root"/>
<property name="password" value="1234"/>
</dataSource>
</environment>
</environments>
<!--告知mybatis映射配置的位置 -->
<mappers>
<mapper class="com.itheima.dao.IUserDao"/>
</mappers>
</configuration>
3.5 自定义 Mybatis的设计模式说明
3.5.1工厂模式(SqlSessionFactory)
工厂模式的原理如下图:
3.5.2代理模式(MapperProxyFactory)
代理模式分为静态和动态代理。静态代理,我们通常都很熟悉。有一个写好的代理类,实现与要代理的类的一
个共同的接口,目的是为了约束也为了安全。具体不再多说。
这里主要想说的是关于动态代理。我们知道静态代理若想代理多个类,实现扩展功能,那么它必须具有多个代
理类分别取代理不同的实现类。这样做的后果是造成太多的代码冗余。那么我们会思考如果做,才能既满足需求,
又没有太多的冗余代码呢?——————动态代理。通过前面的课程我们已经学过了基于 JDK的动态代理实现方式,今
天我们就会使用JDK动态代理方式来编写MapperProxyFactory类。
动态代理模型图:
3.5.3构建者模式(SqlSessionFactoryBuilder)
首先我们一起来学习构建者模式,通过百度百科如下:
具体设计模式的模型图如下:
从图中我们可以看出,创建者模式由四部分组成。
抽象创建者角色:给出一个抽象接口,以规范产品对象的各个组成成分的建造。一般而言,此接口独立于应用
程序的商业逻辑。模式中直接创建产品对象的是具体创建者角色。具体创建者必须实现这个接口的两种方法:一是
建造方法,比如图中的 buildPart1和 buildPart2方法;另一种是结果返回方法,即图中的 getProduct方
法。一般来说,产品所包含的零件数目与建造方法的数目相符。换言之,有多少零件,就有多少相应的建造方法。
具体创建者角色:他们在应用程序中负责创建产品的实例。这个角色要完成的任务包括:
1、实现抽象创建者所声明的抽象方法,给出一步一步的完成产品创建实例的操作。
2、在创建完成后,提供产品的实例。
导演者角色:这个类调用具体创建者角色以创建产品对象。但是导演者并没有产品类的具体知识,真正拥有产
品类的具体知识的是具体创建者角色。
产品角色:产品便是建造中的复杂对象。一般说来,一个系统中会有多于一个的产品类,而且这些产品类并不
一定有共同的接口,而完全可以使不相关联的。
3.5.4小结
通过自定义 Mybatis框架的学习,我们将前面的基础知识很好的结合在一起,并且强化了我们的设计模式及
使用。希望大家能够抽时间多练习,这也是系统架构师的必由之路。
版权说明
文章采用: 《署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)》许可协议授权。版权声明:未标注转载均为本站原创,转载时请以链接形式注明文章出处。如有侵权、不妥之处,请联系站长删除。敬请谅解!
常见资源合集和破解beqptwpmc...