1、mybatis入门(mybatis笔记)

由于之前我们已经有了hibernate的基础,所以这里很多细节就不再提及。

一、基本架构

这里从网络上找了几张mybatis的架构和执行图:

1、mybatis入门(mybatis笔记)_第1张图片
架构图
1、mybatis入门(mybatis笔记)_第2张图片
执行图

说明:其实基本过程和hibernate有点类似,

  • SqlMapConfig.xml是mybatis的全局配置文件,配置了数据源、事务等mybatis运行环境,还要配置mapper.xml(主要是配置要执行的sql语句)。
  • SqlSessionFactory(会话工厂)。作用:创建SqlSession
  • SqlSession(会话)。作用:操作数据层增删改查。不直接操作数据库,而是使用Executor执行器来操作数据库。通过mapped statement底层封装对象,其作用是对操作数据库存储的封装,包括sql,输入参数、输出结果类型。

二、入门程序

下面我们通过一个入门程序说明一下。(工程mybatis01

2.1 需求

  • 根据用户id(主键)查询用户信息
  • 根据用户名模糊查询
  • 添加、删除、更新

2.2 依赖包

  • mybatis-3.2.8.jar和lib目录下的所有包。
  • mysql驱动包。

2.3 全局配置文件

  • 其中SqlMapperConfig.xmllog4j.properties这里的配置我们可以参考包中的pdf文档。

  • SqlMapperConfig.xml




    
    
        
            
            
            
            
                
                
                
                
            
        
    
    
    
        
    

  • log4j.properties
# Global logging configuration
#在开发的环境下,日志级别要设置为DEBUG,生成环境设置为ERROR或INFO
log4j.rootLogger=DEBUG, stdout
# MyBatis logging configuration...
log4j.logger.org.mybatis.example.BlogMapper=TRACE
# 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.4 入门程序

(1)首先我们需要写一个映射文件config/sqlmap/User.xml






    
    
    

    
    
    

    
    
    
        
        
            SELECT LAST_INSERT_ID()
        
        INSERT INTO USER(username, birthday, sex, address) VALUE(#{username}, #{birthday}, #{sex} ,#{address}); 
        
        
    

    
    
    
        DELETE FROM USER WHERE id = #{value}
    

    
    
    
        UPDATE USER SET username = #{username}, birthday = #{birthday}, sex = #{sex}, address = #{address} WHERE id = #{id}
    

说明:

  • 1、一般我们需要使用namespace来指定命名空间,这样便于管理使用,在后面的例子中我们可以看到如何进行使用。而每个标签的id就是我们在后面需要定义的方法名,使用parameterType来指定输入参数的类型,使用resultType指定输出参数的类型。

  • 2、对于配置(1),id一般称为statement的id,因为将来sql会封装到mappedStatement对象中,#{}表示一个占位符,parameterType指定输入参数的类型,这里为int(Integer)#{id}中的id表示接收的参数,参数的名称就是id,如果输入参数类型是简单类型,名称可以任意,一般我们使用valueresultType指定sql输出结果所映射的java对象类型,这里select指定resultType表示单条记录映射成java对象。

  • 3、对于配置(2),使用#{value}和使用'%${value}%'是有区别的,前面这种语句我们在传参的时候还需要自己加上百分号。后面的${}表示拼接sql,将接收到的参数的内容不加任何修饰内容拼接在sql中,但是可能有sql注入的隐患。同时如果传入的是简单类型,则其中只能使用value,而不能使用任意的,如username不建议使用后一种。

  • 4、对于配置(3),parameterType指定参数是pojo(包括用户信息) ,#{}中指定pojo的属性名,接收到pojo对象的属性值,通过OGNL获取对象的属性值,id如果是自增的话可以不写。使用SELECT LAST_INSERT_ID()得到刚插入的主键,只适应于自增主键keyProperty指的是将查询到的主键值设置到parameterType指定的对象的哪个属性,order指的是相对于insert语句来说的执行顺序,必须在insert语句执行之后执行,于是我们使用order进行说明。在后面我们还提供了如果主键是使用数据库的UUID生成方式该如何取得其值,此种方式有所不同,必须在insert语句执行之前执行。当如对于这里给出的两个数据库函数LAST_INSERT_ID()UUID()需要掌握。

  • 5、对于配置(4)和(5),这里就不做过多的说明了。最后需要将此配置文件在全局配置文件中配置进去。

(2)实体类pojo(User.java

    private Integer id ;
    private String username ;
    private String sex ;
    private Date birthday ;
    private String address ;

说明:其实pojojavabean差不多。

(3)数据库表

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(32) NOT NULL COMMENT '用户名称',
  `birthday` date DEFAULT NULL COMMENT '生日',
  `sex` char(1) DEFAULT NULL COMMENT '性别',
  `address` varchar(256) DEFAULT NULL COMMENT '地址',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=28 DEFAULT CHARSET=utf8

(4)一个示范程序(cn.itcast.first/findUserById.java

package cn.itcast.first;
import java.io.IOException;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
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 cn.itcast.pojo.User;

//入门程序
public class MybatisFirst {
    //根据id查询用户信息
    @Test
    public void findUserById() throws IOException{
        
        //mybatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        //创建会话工厂,要想build方法中传入配置信息
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        
        //通过工厂得到SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        //通过SqlSession操作数据库
        //第一个参数是:映射文件中Statement的id,等于namespace+statement的id
        //第二个参数:指定和映射文件中所匹配的parameterType类型的参数
        //结果就是实体类,selectOne表示查询出一条记录
        User user = sqlSession.selectOne("test.findUserById", 1);
        
        System.out.println(user.getUsername());
        
        //释放资源
        sqlSession.close();
    }
    
    //根据用户名模糊查询用户信息
    @Test
    public void findUserByName() throws IOException{
        
        //mybatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        //创建会话工厂,要想build方法中传入配置信息
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        
        
        //通过工厂得到SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        //List users = sqlSession.selectList("test.findUserByName", "%小明%");
        List users = sqlSession.selectList("test.findUserByName", "小明");
        
        for(User user : users){
            System.out.println(user.getUsername());
        }
        
        //释放资源
        sqlSession.close();
    }
    //添加用户
    @Test
    public void insertUser() throws IOException{
        
        //mybatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        //创建会话工厂,要想build方法中传入配置信息
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        
        
        //通过工厂得到SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        User user = new User();
        user.setUsername("狗蛋");
        user.setBirthday(new Date());
        user.setSex("1");
        user.setAddress("西安");
        
        sqlSession.insert("test.insertUser", user);
        
        //提交事务
        sqlSession.commit();
        
        //获取用户信息主键
        System.out.println(user.getId());
        
        //释放资源
        sqlSession.close();
    }
    //根据id删除用户
    @Test
    public void deleteUserById() throws IOException{
        
        //mybatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        //创建会话工厂,要想build方法中传入配置信息
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        
        //通过工厂得到SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        sqlSession.delete("test.deleteUserById", 32);
        
        //提交事务
        sqlSession.commit();
        
        //释放资源
        sqlSession.close();
    }
    //根据id更新用户
    @Test
    public void updateUserById() throws IOException{
        
        //mybatis配置文件
        String resource = "SqlMapConfig.xml";
        //得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        //创建会话工厂,要想build方法中传入配置信息
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        
        //通过工厂得到SqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        
        User user = new User();
        user.setId(1);//必须设置id
        user.setUsername("赵四");
        user.setBirthday(new Date());
        user.setSex("1");
        user.setAddress("西安");
        
        sqlSession.update("test.updateUserById", user);
        
        //提交事务
        sqlSession.commit();
        
        //释放资源
        sqlSession.close();
    }
}

说明:

  • 1.首先我们需要定义一个会话工厂SqlSessionFactory 来产生会话SqlSession,这里通过一个构造函数进行注入。

  • 2.我们使用会话SqlSession的相关方法来进行数据库操作,对于单条记录我们使用方法selectOne来进行查询,如果是多条记录则使用selectList来进行查询,而它们的第一个参数都是命名空间加上id名,第二个参数是传入的值。当然对于单条记录也可以使用selectList方法。

  • 3.在方法findUserByName中我们还可以看到使用#{value}'${value}'的区别。在方法insertUser中我们在最后演示了获取数据库生成的主键的方式。当然这里主键的生成方式是自增。

  • 4.对于插入和更新不做过多解释,最后我们需要手动关闭会话,因为这里没有使用spring进行管理。很显然,各个方法中有很多重复的代码,所以这种dao层的开发方式mybatis不推荐。

  • 5.自增主键返回:Mysql自增主键,执行insert提交之前自动生成一个自增主键。通过mysql函数获取到刚刚提交记录的自增主键:LAST_INSERT_ID(),是在insert之后调用。非自增主键的返回:使用mysqlUUID来生成主键,需要修改表中id字段类型为String,长度为35,一般设置为36。执行顺序相对于insert是在其之前执行。

  • 6.通过Oracle的序列生成主键


            SELECT 序列名.nextval()

INSERT INTO USER(id, username, birthday, sex, address) VALUE(#{id}, #{username}, #{birthday}, #{sex} ,#{address});

三、dao层开发

3.1使用原始方式进行dao层开发

从上面的例子中我们基本知道mybatis的使用方法了。下面我们将上面的程序抽象为dao层。
dao接口(UserDaoI.java

package cn.itcast.dao;
import java.util.List;
import cn.itcast.pojo.User;

//用户管理接口
public interface UserDaoI {
    //根据id查询用户信息
    public User findUserById(int id );
    public List findUserByName(String username);
    
    //添加用户
    public void insertUser(User user);
    
    //根据id查询用户
    public void deleteUserById(int id);
}

实现类(UserDaoImpl.java

package cn.itcast.dao;
import java.util.Date;
import java.util.List;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import cn.itcast.pojo.User;

public class UserDaoImpl implements UserDaoI {

    private SqlSessionFactory sqlSessionFactory;

    // 注入一个SqlSessionFactory,这里通过构造函数注入
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public User findUserById(int id) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        User user = sqlSession.selectOne("test.findUserById", id);
        // 释放资源
        sqlSession.close();
        return user;
    }
    
    @Override
    public List findUserByName(String username) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        List users = sqlSession.selectList("test.findUserByName", username);
        // 释放资源
        sqlSession.close();
        return users;
    }

    @Override
    public void insertUser(User user) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.insert("test.insertUser", user);
        // 提交事务
        sqlSession.commit();
        sqlSession.close();
    }

    @Override
    public void deleteUserById(int id) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.delete("test.deleteUserById", id);
        // 提交事务
        sqlSession.commit();
        sqlSession.close();

    }
}

(5)测试

test/cn.itcast.dao/UserDaoImplTest.java
package cn.itcast.dao;
import static org.junit.Assert.*;
import java.io.InputStream;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import cn.itcast.pojo.User;

public class UserDaoImplTest {

    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void setUp() throws Exception {
        // 创建sqlSessionFactory
        
        // mybatis配置文件
        String resource = "SqlMapConfig.xml";
        // 得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        // 创建会话工厂,要想build方法中传入配置信息
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
    }

    @Test
    public void testFindUserById() {
        // 创建一个UserDao对象
        UserDaoI userDao = new UserDaoImpl(sqlSessionFactory);

        //调用UserDao的方法
        User user = userDao.findUserById(1);
        
        System.out.println(user.getUsername());
    }
}

说明:

  • 1、对于一些公共的代码我们放在setUp方法中执行,首先需要读取配置文件,然后创建出工厂。我们在测试相关方法的时候需要传入工厂。
  • 2.相关的测试方法我们在之前的例子中已经有了,这里不再说明。
  • 3.在查询的时候会自动提交,但是在删除和更新的时候我们必须手动提交事务。当然以后交给spring管理之后是不需要手动提交的。

3.2 hibernate和mybatis的区别和应用的场景

  • Hibernate:是一个标准的orm框架。不需要程序员写sql。对sql语句进行优化、修改比较困难。
    应用场景:使用于需求变化不多的中小型的项目,比如:后台管理系统等。

  • Mybatis:专注的是sql本身,需要自己写sql。是一个不完全的orm框架。
    应用场景:使用于需求变化较多的中小型的项目,比如:互联网项目。

3.3 使用mybatis的方式开发dao层(工程mybatis02

3.3.1相关概念

  • mybatis通过工厂创建SqlSession,工厂是由SqlSessionFactoryBuilder创建的。通过单例模式来管理SqlSessionFactory,和spring整合之后使用单例管理SqlSessionFactory。但是将SqlSessionFactoryBuilder可以只当成一个工具类即可,不需要使用单例管理SqlSessionFactory

  • SqlSession是一个面向用户的接口,提供了很多操作数据库的方法。SqlSession是线程不安全的,在SqlSession的实现类中除了有操作数据库的方法,还有数据域的属性。SqlSession最佳的应用场合在方法体内,定义为局部变量。

3.3.2 mybatis推荐方式开发dao层

原始dao开发方法需要写dao的接口和实现类
需要向dao实现类中注入SqlSessionFactory,在方法体内通过SqlSessionFactory创建SqlSession。于是我们总结出了这种开发方式的几个问题:

  • 1、 方法体中有很多大量的重复代码。
  • 2、 在调用sqlSession方法时将statement的id写死了。而且使用的是泛型,我们要是写错了,在编译的时候是不会报错的,不利于开发。

mabytis使用mapper代理的方法,只需要写mapper接口,这个接口其实和dao接口一样。不需要写实现类,但是这样的话其映射文件config/mapper/UserMapper.xml就必须尊需一定的规则:

  • (1)在UserMapper.xmlnamespace等于mapper接口的地址

  • (2)UserMapper.java接口中的方法名和UserMapper.xmlstatement的id一致。方法的输入类型和parameteType指定的类型一致。返回值和resultType指定的类型一致。

UserMapper.xml







    
        SELECT * FROM USER WHERE id = #{value}
    
    
    
    
    
    
    
    
        
            SELECT LAST_INSERT_ID()
        
        INSERT INTO USER(username, birthday, sex, address) VALUE(#{username}, #{birthday}, #{sex} ,#{address})
    
    
    
    
        DELETE FROM USER WHERE id = #{value}
    
    
    
    
        UPDATE USER SET username = #{username}, birthday = #{birthday}, sex = #{sex}, address = #{address} WHERE id = #{id}
    

说明:和之前一样,我们需要将此文件配置到全局配置文件中。

UserMapper.java

package cn.itcast.mapper;
import java.util.List;
import cn.itcast.pojo.User;
import cn.itcast.pojo.UserCustom;
import cn.itcast.pojo.UserQueryVo;

//用户管理接口
public interface UserMapper {
    //根据id查询用户信息
    public User findUserById(int id );
    //模糊查询
    public List findUserByName(String username);
    
    //添加用户
    public void insertUser(User user);
    
    //根据id查询用户
    public void deleteUserById(int id);
    
    //用户信息综合查询
    public List findUserList(UserQueryVo userQueryVo);
}

说明:可以看到其实和dao接口是一样的。

  • 测试UserMapperTest.java
package cn.itcast.mapper;
import static org.junit.Assert.*;
import java.io.InputStream;
import java.util.List;
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.Before;
import org.junit.Test;
import cn.itcast.pojo.User;
import cn.itcast.pojo.UserCustom;
import cn.itcast.pojo.UserQueryVo;

public class UserMapperTest {
    
    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void setUp() throws Exception {
        // 创建sqlSessionFactory
        
        // mybatis配置文件
        String resource = "SqlMapConfig.xml";
        // 得到配置文件流
        InputStream is = Resources.getResourceAsStream(resource);
        // 创建会话工厂,要想build方法中传入配置信息
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
    }
    
    @Test
    public void testFindUserById() {
        //创建一个UserMapper的对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //mybatis自动生成代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        
        User user = userMapper.findUserById(1);
        System.out.println(user.getUsername());
        
        sqlSession.close();
    }
    @Test
    public void testfindUserByName() {
        //创建一个UserMapper的对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //mybatis自动生成代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        
        List users = userMapper.findUserByName("小明");
        for(User user : users){
            System.out.println(user.getUsername());
        }
        sqlSession.close();
    }
}
  • 问题:mapper接口方法参数只能有一个,是否影响系统开发?
    系统框架中,dao层的代码是被业务层公用的。即使mapper接口只有一个参数,可以使用包装类型的pojo满足不同的业务方法的需求。

  • 注意:持久层中方法的参数可以用包装类型(map。。。),而service方法中不建议使用包装类型(不利于业务层的维护和可扩展性)。

最后:这就是mybatis的基本使用方式。

你可能感兴趣的:(1、mybatis入门(mybatis笔记))